Paperless NGX icon

Paperless NGX

Interact with the Paperless NGX API
Join our community

Actions38

Overview

The node interacts with the Paperless NGX API to retrieve tag information. Specifically, the "Get" operation under the "Tag" resource allows users to fetch tags from the system with various filtering and sorting options. This is useful for scenarios where you want to list or search tags based on criteria such as name patterns or specific IDs, or when you need to paginate through large sets of tags.

Practical examples include:

  • Retrieving a paginated list of tags to display in a dashboard.
  • Searching for tags that start with or contain certain keywords.
  • Filtering tags by multiple IDs to get detailed information about specific tags.
  • Including full permission details for each tag when needed.

Properties

Name Meaning
Note Informational notice about using numeric IDs for owner and permissions fields; suggests retrieving Users and Groups via separate nodes.
Page Page number to retrieve (for pagination).
Page Size Number of items to return per page (pagination size).
Sort By Field name to sort the results by.
Tag ID The unique numeric ID of the tag to get. Required for operations like get, delete, update.
Full Permissions Boolean flag indicating whether to include full permission information in the response.
Filter by IDs Comma-separated list of tag IDs to filter the results by multiple IDs.
Name Contains Filter tags where the tag name contains this text (case-insensitive).
Name Ends With Filter tags where the tag name ends with this text (case-insensitive).
Name Exact Match Filter tags where the tag name exactly matches this text (case-insensitive).
Name Starts With Filter tags where the tag name starts with this text (case-insensitive).

Output

The output JSON contains the retrieved tag data matching the specified filters and pagination settings. Each item typically includes tag properties such as its ID, name, and potentially permission details if requested.

If the "Full Permissions" option is enabled, the output will also include detailed permission information related to each tag.

The node does not output binary data.

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.
  • No additional external services are required beyond the Paperless NGX API.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials can cause authentication failures.
    • Providing invalid tag IDs or filters may result in empty responses or errors.
    • Pagination parameters out of range might lead to no results returned.
    • Network connectivity issues to the Paperless NGX API endpoint.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; reconfigure credentials.
    • "Tag not found" errors occur if the specified Tag ID does not exist.
    • Validation errors may appear if input parameters do not meet expected formats (e.g., non-numeric IDs).

  • Resolutions:

    • Verify and update API credentials.
    • Confirm tag IDs and filter values are correct and exist in the system.
    • Adjust pagination parameters to valid ranges.
    • Ensure network access to the API endpoint is available.

Links and References

Discussion