Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Survey records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query surveys with complex conditions beyond simple filters, allowing precise data extraction. For example, a user can fetch all surveys matching specific criteria such as date ranges, status, or custom fields, and control the number of records returned.

Properties

Name Meaning
Get All Determines whether to return all matching survey records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of survey 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 with Autotask API query criteria to perform complex filtering of surveys.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the survey data.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the survey data.
Select Columns Names or IDs. Allows selection of specific survey 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 Determines whether user-defined fields (UDFs) are promoted to top-level properties in each survey object instead of being nested.

Output

JSON

  • id - Unique identifier of the survey record.
  • fieldName - Various survey fields as specified by the selected columns or all fields if none selected.
  • fieldName_label - Human-readable labels for picklist or reference fields if enabled.
  • userDefinedFields - Array of user-defined fields associated with the survey, unless flattened.
  • userDefinedFieldName - User-defined fields promoted to top-level properties if flattenUdfs is enabled.

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 errors. Ensure the JSON string is well-formed and follows Autotask API query criteria format.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • Selecting invalid or non-existent field names in 'Select Columns' may result in incomplete or empty data.
  • If picklist or reference labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields have non-empty values.
  • Authentication errors may occur if the Autotask API key credential is missing or invalid.

Links

Discussion