Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Configuration Item Categories from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the categories returned. This is useful for scenarios where precise data extraction is needed, such as reporting, data synchronization, or integration workflows that require specific subsets of configuration item categories based on custom conditions.

Properties

Name Meaning
Get All Determines whether to return all matching Configuration Item Categories or limit the results to a specified maximum number.
Max Records Specifies the maximum number of Configuration Item Categories 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 Item Categories. This allows for complex and precise filtering based on field values.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values alongside the raw data.
Add Reference Labels If enabled, adds additional fields with '_label' suffix for reference fields to provide human-readable values alongside the raw data.
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 regardless of selection.
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, simplifying access to these fields.

Output

JSON

  • id - Unique identifier of the Configuration Item Category.
  • name - Name of the Configuration Item Category.
  • description - Description of the Configuration Item Category.
  • userDefinedFields - Array of user-defined fields associated with the Configuration Item Category, unless flattened.
    _label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled._label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.

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 well-formed and follows Autotask API filter syntax.
  • Requesting too many records without 'Get All' enabled may result in incomplete data. Use 'Get All' or increase 'Max Records' appropriately.
  • If no records are returned, verify that the filter criteria correctly match existing Configuration Item Categories.
  • API rate limits may cause errors; consider adding delays or reducing request frequency.
  • Incorrect field names in 'Select Columns' or filter criteria can cause errors; use 'Get Field Info' to confirm exact field names.

Links

Discussion