Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Exclusion Sets from the Autotask system. It is useful for users who need to fetch a list of contract exclusion sets, which define groups of exclusions related to contracts, for reporting, synchronization, or further processing in workflows. For example, a user might want to get all contract exclusion sets to analyze which roles or billing codes are excluded from certain contracts.

Properties

Name Meaning
Fields Defines which fields of the Contract Exclusion Sets to retrieve and map in the output. Supports custom mapping and selection of specific fields.
Get All Determines whether to return all available 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.
Add Picklist Labels If enabled, adds human-readable label fields for picklist fields in the output, making it easier to understand picklist values.
Add Reference Labels If enabled, adds human-readable label fields for reference fields in the output, improving readability of referenced entities.
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 When enabled, user-defined fields (UDFs) are brought to the top level of each object instead of being nested, simplifying access to these fields.

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 - Additional human-readable labels for picklist or reference fields if enabled.

Dependencies

  • Requires an API key credential for Autotask REST API authentication.

Troubleshooting

  • If no records are returned, verify that the Autotask API credentials are correct and have sufficient permissions to access contract exclusion sets.
  • If the node returns an error about unsupported resource, ensure the resource parameter is set to 'contractExclusionSets'.
  • When selecting specific fields, ensure the field names or IDs are valid; invalid fields may cause errors or missing data.
  • If the maximum records limit is exceeded, reduce the 'Max Records' value or enable 'Get All' to retrieve all records.
  • If picklist or reference labels are missing, check that the corresponding options 'Add Picklist Labels' and 'Add Reference Labels' are enabled.

Discussion