Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple records of Contract Exclusion Set Excluded Work Types from the Autotask REST API using an advanced filtering mechanism. It is useful for users who need to query and extract specific subsets of excluded work types associated with contract exclusion sets, applying complex filters to refine the data returned. For example, a user can fetch all excluded work types that meet certain criteria defined in a JSON filter, optionally limiting the number of records or retrieving all available records.

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 that defines the query criteria according to the Autotask API's advanced query syntax. This allows precise filtering of records based on field values.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the response, enhancing readability.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the response.
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) 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 excluded work type record.
  • contractExclusionSetID - Identifier of the contract exclusion set to which the excluded work type belongs.
  • workTypeID - Identifier of the excluded work type.
  • workType_label - Human-readable label for the excluded work type (if Add Reference Labels is enabled).
  • userDefinedFields - Array of user-defined fields associated with the record, unless flattened.
  • otherFields - Additional fields returned from the API according to selected columns and filters.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Invalid JSON in the Advanced Filter property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • Selecting invalid or non-existent fields in Select Columns may result in errors or missing data.
  • If labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields support labels.
  • Authentication errors may occur if the API key credential is missing or invalid; ensure proper credential configuration.

Links

Discussion