Actions38
- Correspondent Actions
- Custom Field Actions
- Document Actions
- Document Type Actions
- Group Actions
- Storage Path Actions
- Tag Actions
- User Actions
Overview
The node integrates with the Paperless NGX API to perform operations related to document management. Specifically, for the "Document Type" resource and the "Get by ID" operation, it retrieves detailed information about a specific document type using its unique numeric ID. This is useful in scenarios where you need to fetch metadata or configuration details of a document type within your document processing workflows.
Practical examples include:
- Automatically fetching document type details before processing documents of that type.
- Validating if a document type exists before assigning documents to it.
- Integrating document type data into reporting or auditing workflows.
Properties
| Name | Meaning |
|---|---|
| Note | Informational message explaining that owner and permissions fields accept numeric IDs, and how to retrieve available Users and Groups via other nodes. |
| Document Type ID | The unique numeric identifier of the document type to retrieve. Required for the "Get by ID" operation. |
Output
The node outputs JSON data representing the retrieved document type's details. This typically includes all properties associated with the document type as defined in the Paperless NGX system, such as its name, description, permissions, and any other metadata.
If the node supports binary data output (not indicated here), it would represent file attachments or similar content related to the document type, but this is not applicable for the "Get by ID" operation on document types.
Dependencies
- Requires an active connection to the Paperless NGX API.
- Needs an API authentication token or key configured in the node credentials.
- The base URL for the API instance must be correctly set in the credentials.
- No additional external dependencies are required beyond the API access.
Troubleshooting
Common Issues:
- Providing an invalid or non-existent Document Type ID will result in an error or empty response.
- Incorrect API credentials or base URL misconfiguration can cause authentication failures.
- Network connectivity issues may prevent the node from reaching the Paperless NGX API.
Error Messages:
- "Document Type not found": Verify the Document Type ID is correct and exists in the system.
- "Authentication failed": Check that the API key/token is valid and properly configured.
- "Network error" or timeout: Ensure the API endpoint is reachable and there are no firewall restrictions.