Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Contract Exclusion Role from the Autotask system using its unique ID. It is useful for workflows that need to fetch and utilize contract exclusion role data, such as automating contract management, auditing roles excluded from contracts, or integrating contract role data into other systems.

Properties

Name Meaning
Exclusion Role ID The unique identifier of the contract exclusion role to retrieve. This is a required input to specify which exclusion role to get.
Add Picklist Labels Determines whether to automatically add human-readable label fields (with suffix '_label') for picklist fields in the response. Labels are not added for empty values.
Add Reference Labels Determines whether to automatically add human-readable label fields (with suffix '_label') for reference fields in the response. Labels are not added for empty values.
Select Columns Names or IDs. Specifies which 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 Determines whether user-defined fields (UDFs) should be brought up to the top level of the returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract exclusion role.
  • name - The name of the contract exclusion role.
  • description - Description or details about the contract exclusion role.
  • field
    • _label - Human-readable labels for picklist or reference fields, added if enabled in input properties.
  • userDefinedFields - Array of user-defined fields related to the contract exclusion role, or flattened to top-level if flattenUdfs is true.

Dependencies

  • Requires an authenticated connection to the Autotask REST API via an API key credential.

Troubleshooting

  • Ensure the Exclusion Role ID provided is valid and exists in the Autotask system; invalid IDs will cause errors or empty responses.
  • If no data is returned, verify that the API credentials have sufficient permissions to access contract exclusion roles.
  • If picklist or reference labels are not appearing, check that the corresponding boolean properties are enabled.
  • Errors related to network or authentication failures indicate issues with the API key or connectivity; verify credentials and network access.

Discussion