Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

The 'Get Many (Advanced)' operation for the 'Ticket History' resource in the Autotask node allows users to retrieve multiple ticket history records using advanced filtering criteria. This operation is beneficial when you need to query ticket history data with complex conditions beyond simple filters, such as combining multiple criteria in a JSON filter array. For example, you can fetch all ticket history entries related to specific ticket statuses or date ranges by constructing an appropriate JSON filter. It supports returning all matching records or limiting the number of results, and can enhance the output with human-readable labels for picklist and reference fields.

Properties

Name Meaning
Get All Determines whether to return all matching ticket history records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of ticket history 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 filtering ticket history records. This allows complex queries using the Autotask REST API filtering syntax.
Add Picklist Labels If enabled, adds additional '_label' fields to the output for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional '_label' fields to the output for reference fields, showing human-readable values.
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.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the ticket history record.
  • fieldName - Name of the field that was changed in the ticket history.
  • oldValue - Previous value of the field before the change.
  • newValue - New value of the field after the change.
  • changeDate - Date and time when the change was made.
  • changedBy - Reference to the user or entity who made the change.
  • _label - Additional human-readable labels for picklist or reference fields if enabled.
  • userDefinedFields - Array of user-defined fields related to the ticket history record, unless flattened.

Dependencies

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

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property will cause the operation to fail. Ensure the JSON string is correctly formatted and follows the Autotask API filter syntax.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • If no records are returned, verify that the filter criteria match existing ticket history data.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size and processing time.
  • Incorrect field names in 'Select Columns' or 'Advanced Filter' may cause errors or empty results; use 'Get Field Info' to confirm exact field names.

Links

Discussion