Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

The node operation 'Get Many (Advanced)' for the 'Contract Ticket Purchase' resource allows users to retrieve multiple contract ticket purchase records from the Autotask system using advanced filtering criteria. This operation is beneficial when users need to query contract ticket purchases with complex conditions beyond simple filters, enabling precise data extraction for reporting, analysis, or integration purposes. For example, a user can fetch all contract ticket purchases that meet specific status, date ranges, or custom field criteria by providing a JSON filter array according to Autotask API query syntax.

Properties

Name Meaning
Get All Determines whether to return all matching contract ticket purchase records or limit the number of results.
Max Records Specifies the maximum number of contract ticket purchase records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the Autotask API query criteria for selecting contract ticket purchase records. This allows complex and precise filtering based on field values.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the output, enhancing readability by showing label values instead of raw codes.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the output, providing descriptive labels for referenced entities.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are promoted to top-level properties in each returned object instead of being nested inside a 'userDefinedFields' array, simplifying access to these fields.

Output

JSON

  • id - Unique identifier of the contract ticket purchase record.
  • fieldName - Various fields of the contract ticket purchase record as specified by the selected columns or all fields if none selected.
  • picklistField
    • _label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled.
  • referenceField
    • _label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields if 'Flatten User-Defined Fields' is false; otherwise, UDFs appear as top-level properties.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Ensure the 'Advanced Filter' JSON string is correctly formatted and follows Autotask API query syntax; invalid JSON or incorrect filter structure will cause errors.
  • If no records are returned, verify that the filter criteria match existing contract ticket purchase records in Autotask.
  • When selecting specific columns, ensure the field names or IDs are valid for the 'Contract Ticket Purchase' resource; invalid fields may cause incomplete or failed responses.
  • If the node fails with authentication errors, confirm that the Autotask API credentials are correctly configured and have sufficient permissions.

Links

Discussion