Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Service Unit records 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, control the number of records returned, and customize the output fields. This is useful for scenarios where detailed and specific data about contract service units is needed, such as reporting, auditing, or integration with other systems.

Properties

Name Meaning
Get All Determines whether to return all matching Contract Service Unit records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of Contract Service Unit 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 query criteria according to the Autotask API specification. This allows for complex and precise filtering of Contract Service Unit records.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix to the output for picklist fields, providing human-readable labels for those fields.
Add Reference Labels If enabled, adds additional fields with '_label' suffix to the output for reference fields, providing human-readable labels for those fields.
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 moved 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 Contract Service Unit record.
  • fieldName - Various fields representing the properties of the Contract Service Unit as returned by the Autotask API, including any selected columns.
  • fieldName_label - Human-readable labels for picklist or reference fields, if 'Add Picklist Labels' or 'Add Reference Labels' options are enabled.
  • userDefinedFields - Array of user-defined fields associated with the Contract Service Unit, unless 'Flatten User-Defined Fields' is enabled.
  • userDefinedFieldName - User-defined fields promoted to top-level properties if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an Autotask API credential (API key or token) to authenticate requests to the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows the Autotask API filter specification.
  • Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API limits being hit. Use 'Max Records' to limit results or enable 'Get All' cautiously.
  • Selecting invalid or unsupported fields in 'Select Columns' may result in errors or incomplete data. Use the 'Get Field Info' and 'Search Filter Build' tools to confirm valid fields.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields support labels.
  • API authentication errors indicate issues with the provided credentials. Verify that the Autotask API credentials are correct and have sufficient permissions.

Links

Discussion