QAction icon

QAction

Consume QAction API

Actions4

Object → Search

AI-generated

Overview

This node performs a search operation on custom objects within the QAction API. It allows users to specify the type of custom object to search (e.g., QPerson, QInvoice) and define multiple search criteria fields with different query types such as primitive values, date ranges, and text queries. The node supports pagination options to control the number of results per page and the page number, making it suitable for handling large datasets. This node is beneficial for scenarios where users need to retrieve specific custom object data based on flexible and complex search conditions, such as filtering customer records, invoices, or other domain-specific objects.

Use Case Examples

  1. Searching for customer records where the first name matches a given value.
  2. Retrieving invoices within a specific date range.
  3. Performing text-based searches on custom object fields.

Properties

Name Meaning
Custom Object Type The type of the custom object to search (e.g., QPerson, QInvoice)
Search Criteria Fields to search by, including field name, value, and query type (e.g., primitive, date range, text query)
Options Additional options such as enabling pagination, page size, and page number
Request Options Node-level request options including batching, SSL certificate validation, proxy settings, and timeout

Output

JSON

  • results - Array of objects matching the search criteria
  • pagination
    • pageSize - Number of items per page in the response
    • pageNumber - Current page number in the response
    • totalItems - Total number of items matching the search criteria
    • totalPages - Total number of pages available based on page size

Dependencies

  • QAction API
  • API key credential for authentication

Troubleshooting

  • Ensure the custom object type specified exists in the QAction system to avoid empty or error responses.
  • Verify that the search criteria fields and values are correctly formatted and supported by the API.
  • If pagination is enabled, ensure page size and page number are within valid ranges to avoid out-of-bound errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security implications.

Discussion