Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Configuration Item Category User-Defined Field (UDF) Associations from the Autotask REST API using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the results, making it suitable for scenarios where precise data extraction is needed from configuration item category UDF associations. For example, a user can fetch all UDF associations matching specific conditions or attributes, with options to limit the number of records or retrieve all matching entries.

Properties

Name Meaning
Get All Determines whether to return all matching records or limit the results to a specified maximum number.
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 with Autotask API query criteria to filter the results according to complex conditions.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the output, enhancing readability.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the output.
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 Determines whether user-defined fields (UDFs) should be brought up to the top level of each object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the Configuration Item Category UDF Association.
  • userDefinedFields - Array containing user-defined fields associated with the category, unless flattened.
  • fieldName - Name of the user-defined field.
  • fieldValue - Value of the user-defined field.
  • picklistField_label - Human-readable label for picklist fields, if 'Add Picklist Labels' is enabled.
  • referenceField_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 correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
  • Requesting too many records without setting 'Get All' to true may result in incomplete data. Adjust 'Max Records' or enable 'Get All' to retrieve all data.
  • Selecting invalid or non-existent fields in 'Select Columns' may cause errors or missing data in the response.
  • If picklist or reference labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields contain values.
  • API rate limits or authentication errors may occur if the API key is invalid or lacks necessary permissions.

Links

Discussion