Paperless NGXInstall

Overview

The node integrates with the Paperless NGX API to manage custom fields within the system. Specifically, the "Delete" operation for the "Custom Field" resource allows users to remove a custom field by specifying its unique ID. This is useful in scenarios where obsolete or incorrect custom fields need to be cleaned up to maintain data integrity and relevance.

Practical examples include:

• Removing a custom metadata field that is no longer used in document processing.
• Cleaning up test or temporary custom fields created during configuration or testing phases.

Properties

Output

The output JSON contains the response from the Paperless NGX API after attempting to delete the specified custom field. Typically, this will confirm successful deletion or provide error details if the operation failed.

No binary data output is expected from this operation.

Dependencies

• Requires an active connection to the Paperless NGX API.
• Needs an API authentication token configured in the node credentials.
• The base URL for the API instance must be set correctly in the credentials.

Troubleshooting

• Common Issues:

  • Providing an invalid or non-existent Custom Field ID will result in an error.
  • Missing or incorrect API credentials will prevent the node from authenticating.
  • Network connectivity issues can cause request failures.

• Error Messages:

  • "Not Found" or similar indicates the specified Custom Field ID does not exist.
  • "Unauthorized" suggests missing or invalid API authentication.
  • "Bad Request" may indicate malformed input or missing required parameters.

• Resolutions:

  • Verify the Custom Field ID is correct and exists in the system.
  • Ensure API credentials are properly configured and have sufficient permissions.
  • Check network connectivity and API endpoint URL correctness.

Links and References

• Paperless NGX API Documentation (for detailed API endpoints and usage)
• n8n Documentation on Creating Custom Nodes