Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node operation retrieves multiple Contract Service Bundle records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query contract service bundles with complex conditions, such as filtering by specific fields or combinations of fields, and control the number of records returned. For example, a user can fetch all contract service bundles that meet certain status or date criteria, or limit the results to a maximum number for reporting or integration purposes.

Properties

Name Meaning
Get All Determines whether to return all matching contract service bundle records or limit the number of results.
Max Records Specifies the maximum number of contract service bundle records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter contract service bundles. This allows complex queries using Autotask's filtering syntax.
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 brought to the top level of each returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract service bundle record.
  • fieldName - Various fields of the contract service bundle as returned by the Autotask API, depending on selected columns.
  • fieldName_label - Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields if 'Flatten User-Defined Fields' is disabled.
  • userDefinedFieldName - User-defined fields promoted to top-level properties if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an Autotask API key credential for authentication.
  • Relies on the Autotask REST API endpoint for contract service bundles.

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' to retrieve all matching records if needed.
  • Selecting invalid or unsupported fields in 'Select Columns' may cause errors. Use 'Get Field Info' or API documentation to confirm valid field names.
  • If picklist or reference labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields have valid values.
  • API rate limits or authentication errors may occur if the API key is invalid or overused. Check credentials and API usage limits.

Links

Discussion