QAction icon

QAction

Consume QAction API

Actions4

Document → Query

AI-generated

Overview

This node interacts with the QAction API to query documents based on specified criteria. It allows users to filter documents by classification IDs, document type IDs, and various query fields with different types of searches such as date, date range, primitive values, and text queries. It supports pagination options to manage large result sets. This node is useful for scenarios where users need to search and retrieve documents from a document management system or database using flexible and detailed search parameters.

Use Case Examples

  1. A user wants to find all documents classified under certain categories and created within a specific date range.
  2. A user needs to search documents by title or content using text queries and retrieve results in paginated form for easier processing.

Properties

Name Meaning
Classification IDs Comma-separated list of classification IDs to filter documents by (optional).
Document Type IDs Comma-separated list of document type IDs to filter documents by (optional).
Query Fields Fields to search by, each with a field name, value, and type of query (e.g., date, date range, primitive, text query, or list of text queries).
Options Additional options including enabling pagination, page size, and page number for paginated results.
Request Options Node-level request options such as batching, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • documents - Array of documents matching the query criteria.
  • pagination - Pagination details including page size, page number, and total results if pagination is enabled.

Dependencies

  • QAction API

Troubleshooting

  • Ensure that the API credentials are correctly configured to avoid authentication errors.
  • If using pagination, verify that page size and page number are set correctly to avoid empty or incomplete results.
  • Check network settings such as proxy and SSL options if requests fail or time out.
  • Batching settings should be adjusted carefully to avoid overwhelming the API or causing rate limits.

Links

Discussion