Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node enables interaction with the Paperless NGX API specifically for managing storage paths. The "Create Storage Path" operation allows users to define a new storage path in the Paperless NGX system by specifying its name, file system path, and optional matching criteria to automatically assign documents to this path.

This node is beneficial in scenarios where automated document organization is needed based on content matching or predefined storage locations. For example, an organization can create storage paths that automatically categorize incoming scanned documents into folders based on keywords or patterns detected in the document content.

Properties

Name Meaning
Note Informational notice explaining that owner and permissions fields accept numeric IDs, and users/groups can be retrieved via separate API calls.
Name The name of the storage path to create. This is a required string input.
Path The file system path associated with the storage path. This is a required string input.
Match A string pattern that Paperless NGX will try to match against document contents to automatically assign documents to this storage path.
Matching Algorithm The algorithm used to match documents to this storage path. Options include: None, Any (match any word), All (match all words), Literal (exact string), Regular Expression, Fuzzy Match, and Auto (automatic selection).
Case Insensitive Boolean flag indicating whether the matching should ignore case differences.
Owner User ID Numeric user ID to set as the owner of this storage path.
Set Permissions JSON object defining view and change permissions for users and groups. Format: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}.
Note (Permissions) Informational notice about using Users and Groups endpoints to look up IDs for owner and permissions. No user/group creation or modification is provided by this node.

Output

The node outputs JSON data representing the created storage path resource as returned by the Paperless NGX API. This typically includes details such as the storage path's unique identifier, name, path, matching criteria, ownership, and permissions.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a Paperless NGX instance via an API key credential.
  • The node expects the base URL of the Paperless NGX API to be configured in the credentials.
  • To set owner and permissions, numeric user and group IDs must be obtained separately using the corresponding Users and Groups API endpoints.

Troubleshooting

  • Invalid or missing required fields: Ensure that both "Name" and "Path" are provided; these are mandatory.
  • Incorrect user or group IDs: Owner and permission IDs must correspond to existing users/groups in Paperless NGX. Use the Users and Groups endpoints to verify valid IDs.
  • API connection errors: Verify that the API URL and authentication credentials are correctly configured.
  • Matching algorithm issues: If automatic document assignment does not work as expected, review the "Match" string and selected matching algorithm for correctness.
  • Permission denied errors: Confirm that the API key has sufficient rights to create storage paths and assign ownership/permissions.

Links and References

Discussion