Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific Contract Exclusion Set by its ID. It is useful for users who need to fetch and utilize contract exclusion set data within their workflows, such as for contract management, auditing, or integration with other systems. For example, a user can get a contract exclusion set's details to verify which roles or billing codes are excluded from a contract, or to synchronize contract exclusion data with an external database.

Properties

Name Meaning
Contract Exclusion Set ID The unique identifier of the contract exclusion set to retrieve.
Add Picklist Labels Determines whether to automatically add human-readable "_label" fields for picklist fields in the response, enhancing readability by showing labels instead of raw values.
Add Reference Labels Determines whether to automatically add human-readable "_label" fields for reference fields in the response, providing clearer context for 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 regardless of selection.
Flatten User-Defined Fields When enabled, user-defined fields (UDFs) are brought to the top level of each object in the response instead of being nested inside a userDefinedFields array, simplifying access to these fields.

Output

JSON

  • id - The unique identifier of the contract exclusion set.
  • name - The name of the contract exclusion set.
  • description - Description or notes about 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 Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • If the node returns an error indicating the contract exclusion set ID is invalid or not found, verify that the provided ID exists and is correct.
  • If no data is returned, check that the API credentials have sufficient permissions to access contract exclusion sets.
  • Errors related to picklist or reference labels may occur if the API response does not include expected metadata; try disabling label additions to isolate the issue.
  • If user-defined fields are not appearing as expected, verify the 'Flatten User-Defined Fields' setting and the structure of the data returned by the API.

Links

Discussion