Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Configuration Items from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter Configuration Items according to their needs. This is useful for scenarios where you need to extract specific Configuration Items based on detailed conditions, such as retrieving all items matching certain attributes or statuses. For example, an IT service manager could use this to get all Configuration Items of a particular category or with specific custom field values.

Properties

Name Meaning
Get All Determines whether to return all matching Configuration Items or limit the number of results.
Max Records Specifies the maximum number of Configuration Items 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 Configuration Items. This allows for complex and precise queries.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional fields with '_label' suffix for reference fields to provide 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 Configuration Item object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the Configuration Item.
  • name - Name of the Configuration Item.
  • categoryId - Identifier of the Configuration Item's category.
  • category_label - Human-readable label for the Configuration Item's category (if Add Reference Labels is enabled).
  • picklistField_label - Human-readable label for any picklist field included in the response (if Add Picklist Labels is enabled).
    userDefinedFields - User-defined fields nested inside the userDefinedFields array, unless Flatten User-Defined Fields is enabled. - User-defined fields promoted to top-level properties if Flatten User-Defined Fields 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 the node to fail. Ensure the JSON string is correctly formatted and contains a 'filter' array as per Autotask API documentation.
  • Requesting too many records without enabling 'Get All' or setting a very high 'Max Records' may lead to performance issues or API limits.
  • If no results are returned, verify that the filter criteria in the Advanced Filter are correct and match existing Configuration Items.
  • Enabling Add Picklist Labels or Add Reference Labels when the fields do not have corresponding labels will result in no additional label fields being added.
  • If user-defined fields are not appearing as expected, check the Flatten User-Defined Fields setting to control their nesting.

Links

Discussion