Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Service records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the services returned. Users can choose to return all matching records or limit the number of records returned. Additionally, it supports options to include human-readable labels for picklist and reference fields, select specific columns to return, and flatten user-defined fields for easier access. This operation is useful for scenarios where detailed and customized retrieval of service data is needed, such as generating reports, syncing service data with other systems, or performing bulk data analysis.

Properties

Name Meaning
Get All Determines whether to return all matching service records or limit the results to a maximum number.
Max Records Specifies the maximum number of service records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the service records returned. This allows complex and precise querying.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable values for picklist fields in the returned data.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable values for reference fields in the returned data.
Select Columns Names or IDs. Allows selection of specific fields (columns) 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 brought up to the top level of each returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the service record.
  • fieldName - Various service fields as specified by the selected columns or all fields if none selected.
  • fieldName_label - Human-readable labels for picklist or reference fields if the respective options are enabled.
  • userDefinedFields - Array of user-defined fields if flattening is disabled; otherwise, UDFs appear as top-level properties.

Dependencies

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

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property can cause query failures. Ensure the JSON is well-formed and follows Autotask API query criteria syntax.
  • Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API limits being hit.
  • Selecting invalid or non-existent columns in 'Select Columns' may result in errors or missing data.
  • If picklist or reference labels are not appearing, verify that the respective options are enabled and that the fields actually have label data.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion