Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Exclusion Sets 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 according to their needs. This is useful for scenarios where you need to extract specific subsets of contract exclusion sets based on detailed conditions, such as filtering by certain attributes or relationships. For example, a user might want to get all contract exclusion sets that exclude specific roles or billing codes, or that meet custom criteria defined in the advanced filter.

Properties

Name Meaning
Get All Determines whether to return all matching contract exclusion sets or limit the number of results.
Max Records Specifies the maximum number of contract exclusion sets 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 the contract exclusion sets. This allows for complex and precise querying.
Add Picklist Labels If enabled, adds human-readable '_label' fields for picklist fields in the output, making the data easier to understand.
Add Reference Labels If enabled, adds 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 If enabled, user-defined fields (UDFs) are brought to the top level of each object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract exclusion set.
  • name - Name of the contract exclusion set.
  • description - Description of the contract exclusion set.
  • excludedRoles - List of roles excluded by this contract exclusion set.
  • excludedBillingCodes - List of billing codes excluded by this contract exclusion set.
  • userDefinedFields - Array of user-defined fields associated with the contract exclusion set, unless flattened.
  • _label - Human-readable labels for picklist and reference fields if enabled.

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 errors. Ensure the JSON string is well-formed and follows the Autotask API query criteria format.
  • If no results are returned, verify that the filter criteria match existing contract exclusion sets.
  • Setting 'Max Records' outside the allowed range (1-500) will cause validation errors.
  • If picklist or reference labels are not appearing, ensure the corresponding options are enabled and that the fields have non-empty values.
  • API rate limits or authentication errors may occur if the API key is invalid or lacks necessary permissions.

Links

Discussion