Paperless Document Details

Get detailed information about Paperless-ngx documents

Actions3

Document → Get Document History

AI-generated

Overview

This node, named "Paperless Document Details," interacts with a document management API to retrieve detailed information about documents. Specifically, the "Get Document History" operation fetches the history of a specified document by its ID. This is useful for tracking changes, updates, or actions performed on a document over time.

Practical examples include:

  • Auditing document modifications in a digital archive.
  • Displaying a timeline of document activities in a workflow.
  • Integrating document history into reporting or compliance systems.

Properties

Name Meaning
Document ID The unique numeric identifier of the document whose history you want to retrieve. This property is required.

Output

The output is a JSON array representing the history entries of the specified document. Each entry typically contains details about an event or change related to the document, such as timestamps, user actions, or status updates.

If multiple history records exist, they are returned as an array of JSON objects, each corresponding to one history item.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Paperless-ngx API.
  • The base URL of the Paperless-ngx instance must be configured in the node credentials.
  • The node uses HTTP GET requests to endpoints like /api/documents/{documentId}/history/.

Troubleshooting

  • Common issues:

    • Invalid or missing Document ID will cause the request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent access to the API endpoint.

  • Error messages:

    • "error": "Request failed with status code 404" indicates the document ID does not exist.
    • Authentication errors usually mention unauthorized access; verify API credentials.
    • Timeout or network errors suggest checking connectivity and API availability.

To resolve these, ensure the Document ID is correct, credentials are valid, and the API server is reachable.

Links and References

Discussion