Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node integrates with the Paperless NGX API to manage various resources, including Storage Paths. Specifically, the "Get by ID" operation for the Storage Path resource retrieves detailed information about a single storage path using its unique numeric ID. This is useful when you need to fetch metadata or configuration details of a specific storage location within the Paperless NGX system.

Practical examples include:

  • Fetching storage path details before updating or deleting it.
  • Retrieving storage path info to display or log in workflows.
  • Validating that a storage path exists before performing further operations on documents linked to it.

Properties

Name Meaning
Note Informational notice explaining that Owner and permissions fields accept numeric IDs. It suggests retrieving available Users and Groups via separate API calls.
Storage Path ID The unique numeric identifier of the storage path to retrieve. This is a required field for the "Get by ID" operation.

Output

The output JSON contains the detailed data of the requested storage path as returned by the Paperless NGX API. This typically includes properties such as the storage path's ID, name, description, owner, permissions, and other relevant metadata.

If the node supports binary data output (not indicated here), it would represent any files or attachments related to the storage path, but this operation primarily returns JSON metadata.

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 set correctly in the node credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:
    • Invalid or missing Storage Path ID will cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent reaching the Paperless NGX API.
  • Error messages:
    • "Not Found" or similar indicates the provided Storage Path ID does not exist.
    • Authentication errors suggest checking the API key/token and instance URL.
  • Resolutions:
    • Verify the Storage Path ID is correct and exists in the Paperless NGX system.
    • Ensure API credentials are valid and have sufficient permissions.
    • Confirm network access to the Paperless NGX API endpoint.

Links and References

Discussion