Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Exclusion Role records from the Autotask system. It is useful for scenarios where you need to fetch a list of contract exclusion roles, for example, to analyze or process roles that are excluded from certain contracts. Practical applications include generating reports, syncing data with other systems, or filtering contracts based on exclusion roles.

Properties

Name Meaning
Fields Defines which fields of the Contract Exclusion Role resource to map and include in the output. It supports defining fields manually or using auto-mapping features.
Get All Determines whether to return all available Contract Exclusion Role records or limit the number of records returned.
Max Records Specifies the maximum number of Contract Exclusion Role records to return when 'Get All' is set to false. The value must be between 1 and 500.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields in the output.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels 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 Role record.
  • name - Name of the Contract Exclusion Role.
  • description - Description of the Contract Exclusion Role.
  • userDefinedFields - Array of user-defined fields associated with the Contract Exclusion Role, unless flattened.
    _label - Human-readable labels for picklist or reference fields, added if enabled.

Dependencies

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

Troubleshooting

  • If no records are returned, verify that the resource and operation parameters are correctly set to 'contractExclusionRoles' and 'getMany'.
  • Ensure the API credentials are valid and have sufficient permissions to read Contract Exclusion Role data.
  • If the node returns an error about unsupported resource, confirm that the resource name is correctly spelled and supported by the node.
  • When selecting specific fields, ensure the field names or IDs are valid; otherwise, the API may reject the request or return incomplete data.
  • If the maximum records limit is exceeded, reduce the 'Max Records' value or enable 'Get All' to fetch all records.

Discussion