Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node operation retrieves multiple Configuration Item Related Items from the Autotask system using an advanced filter query. It is useful for users who need to fetch a customized list of related configuration items based on complex criteria, such as filtering by specific fields or conditions. For example, a user can query all related items linked to a particular configuration item category or status, applying detailed filters to narrow down results.

Properties

Name Meaning
Get All Determines whether to return all matching results or limit the number of records returned.
Max Records Specifies the maximum number of 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 to filter the related items.
Add Picklist Labels Whether to automatically add human-readable '_label' fields for picklist fields in the output. Empty values will not have labels added.
Add Reference Labels Whether to automatically add human-readable '_label' fields for reference fields in the output. Empty values will not have labels added.
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 When enabled, user-defined fields (UDFs) are moved to the top level of each object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the configuration item related item.
  • fieldName - Various fields representing the properties of the related item as returned by the Autotask API, including any selected columns.
  • picklistField_label - Human-readable labels for picklist fields if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable labels for reference fields if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields unless 'Flatten User-Defined Fields' is enabled, in which case these fields appear at the top level.

Dependencies

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

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
  • Requesting more than 500 records when 'Get All' is false and 'Max Records' exceeds 500 will result in an error. Limit 'Max Records' to 500 or enable 'Get All' to retrieve all records.
  • If no records are returned, verify that the filter criteria in 'Advanced Filter' correctly match existing related items.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size; disable if not needed to improve performance.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Links

Discussion