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 manage document types within the system. Specifically, the "Delete" operation for the "Document Type" resource allows users to remove a document type by specifying its unique ID. This is useful in scenarios where obsolete or incorrect document types need to be cleaned up to maintain an organized document management system.
Practical examples include:
- Automating cleanup of unused document types after a migration.
- Removing test or temporary document types created during development or testing phases.
Properties
| Name | Meaning |
|---|---|
| Note | Informational message indicating that owner and permissions fields accept numeric IDs, and how to retrieve available Users and Groups using other nodes. |
| Document Type ID | The unique numeric identifier of the document type to delete. This property is required to specify which document type will be removed. |
Output
The node outputs JSON data representing the result of the delete operation. Typically, this would include confirmation of successful deletion or details about any errors encountered. The exact structure depends on the Paperless NGX API response but generally confirms whether the document type was deleted.
No binary data output is involved in 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 provided credentials.
- The node depends on the Paperless NGX API being accessible and properly configured to allow deletion of document types.
Troubleshooting
Common Issues:
- Attempting to delete a non-existent document type ID will likely result in an error.
- Insufficient permissions or invalid API credentials can cause authorization failures.
- Network connectivity issues may prevent communication with the Paperless NGX API.
Error Messages:
- "Document type not found": Verify the Document Type ID is correct.
- "Unauthorized" or "Forbidden": Check API credentials and user permissions.
- Timeout or network errors: Ensure the API endpoint is reachable and stable.
Resolving these typically involves verifying input parameters, checking API credentials, and ensuring the Paperless NGX server is operational.