Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node integrates with the Paperless NGX API to perform a partial update on a Document Type resource. This operation allows users to modify specific fields of an existing document type without needing to provide all properties, making it efficient for incremental updates.

Common scenarios include:

  • Adjusting the matching criteria used by Paperless NGX to automatically classify documents.
  • Changing ownership or permissions of a document type.
  • Updating the name or other metadata of a document type without affecting other settings.

Practical example:

  • A user wants to refine how documents are matched to a particular document type by changing the matching algorithm and match string, without altering other properties like permissions or owner.

Properties

Name Meaning
Note Informational notice that Owner and Permissions fields accept numeric IDs. Users should retrieve available User and Group IDs using the provided nodes for those resources.
Name The new name for the document type (optional; only included if updating).
Match A string pattern that Paperless NGX will try to match against document content to assign this document type automatically.
Matching Algorithm The algorithm used to match documents to this document type. Options: None, Any, All, Literal, Regular Expression, Fuzzy Match, Auto (let Paperless NGX decide).
Case Insensitive Boolean indicating whether the matching should ignore case differences.
Owner User ID Numeric ID of the user to set as the owner of this document type.
Set Permissions JSON object defining view and change permissions for users and groups. Structure: {"view":{"users":[],"groups":[]},"change":{"users":[],"groups":[]}}.
Note (Permissions) Informational notice reminding users to use the Users and Groups endpoints to look up IDs for owner and permissions. No create/update/delete operations for users/groups are provided by this node.
Document Type ID Numeric ID of the document type to be partially updated. This is required to identify which document type to modify.

Output

The node outputs JSON data representing the updated state of the Document Type after the partial update operation. This typically includes the document type's ID, name, matching criteria, permissions, owner information, and any other relevant metadata returned by the Paperless NGX API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Paperless NGX instance.
  • The base URL for the API is configured dynamically from the credential's instance URL.
  • To correctly set owner and permissions, users must have access to User and Group IDs, which can be retrieved via separate nodes interacting with /api/users/ and /api/groups/.

Troubleshooting

  • Invalid or missing Document Type ID: The operation requires a valid numeric ID of the document type to update. Ensure this ID exists in the Paperless NGX system.
  • Permission errors: If the API key lacks sufficient rights to update document types or modify ownership/permissions, the request will fail. Verify API credentials and user permissions.
  • Malformed permissions JSON: The setPermissions property must be a valid JSON object with the correct structure. Invalid JSON or incorrect keys may cause errors.
  • Matching algorithm mismatch: Providing an invalid value for the matching algorithm option could result in API rejection. Use one of the predefined options.
  • Case sensitivity issues: If matching does not behave as expected, verify the isInsensitive flag aligns with your intended matching behavior.

Links and References

Discussion