Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node interacts with the Paperless NGX API to perform various operations on different resources. Specifically, for the Custom Field resource with the Partial Update operation, it allows users to update selected fields of an existing custom field without needing to provide all details. This is useful when you want to modify only certain attributes such as the name, owner, or permissions of a custom field while leaving other properties unchanged.
Practical examples include:
- Changing the owner of a custom field by specifying a new user ID.
- Updating the name of a custom field partially.
- Adjusting view or change permissions by providing updated user and group IDs in the permissions object.
This partial update capability helps maintain data integrity by avoiding overwriting unspecified fields.
Properties
| Name | Meaning |
|---|---|
| Note (globalPermissionsNote) | Informational notice that owner and permissions fields require numeric IDs. Users and Groups can be retrieved via separate API calls. |
| Name (name) | The new name for the custom field. Optional in partial updates; if provided, it will update the field's name. |
| Owner User ID (owner) | Numeric ID of the user to set as the owner of this custom field. |
| Set Permissions (setPermissions) | JSON object defining permissions structure: { "view": { "users": [], "groups": [] }, "change": { "users": [], "groups": [] } }. Lists user and group IDs allowed to view or change the custom field. |
| Note (permissionsNote) | Informational notice reminding users to use separate endpoints to look up user and group IDs. No create/update/delete for users/groups is provided by this node. |
| Custom Field ID (id) | Required numeric ID of the custom field to update. |
Output
The node outputs JSON data representing the updated custom field object returned from the Paperless NGX API after the partial update operation. This typically includes the custom field’s current state reflecting any changes made.
If the node supports binary data output (not indicated here), it would represent file attachments or similar content related to the custom field, but this is not applicable for this operation.
Dependencies
- Requires an API key credential for authenticating with the Paperless NGX API.
- The base URL for API requests is configured dynamically based on the instance URL provided in credentials.
- To correctly set owner and permissions, users must retrieve valid numeric user and group IDs using separate nodes/endpoints (
/api/users/and/api/groups/).
Troubleshooting
- Invalid or missing Custom Field ID: The operation requires a valid numeric ID. Ensure the
idproperty is provided and corresponds to an existing custom field. - Incorrect user/group IDs in permissions or owner: Using invalid or non-existent user/group IDs will cause API errors. Verify IDs by fetching users and groups before updating.
- API authentication errors: Confirm that the API key credential is correctly configured and has sufficient permissions.
- Malformed JSON in permissions: The
setPermissionsproperty expects a well-formed JSON object. Invalid JSON syntax will cause request failures. - Partial update ignored: If no updatable fields are provided besides the ID, the API may return the original object unchanged.