Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Contract Exclusion Sets → Get

AI-generated

Overview

This node operation retrieves details of a specific Contract Exclusion Set from the Autotask PSA system using its ID. It is useful for scenarios where you need to fetch and review the configuration or details of contract exclusion sets, which define roles or work types excluded from contracts. For example, it can be used to get the exclusion set information to validate contract rules or to integrate contract data into other systems.

Use Case Examples

  1. Retrieve a contract exclusion set by its ID to display its details in a dashboard.
  2. Fetch contract exclusion set data to synchronize with an external contract management system.

Properties

Name Meaning
Contract Exclusion Set ID The ID of the contract exclusion set to operate on, required to specify which exclusion set to retrieve.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values (no labels will be added for empty values).
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values (no labels will be added for empty values).
Select Columns Names or IDs. Choose which fields to include in the response. If no fields are selected, all fields will be returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object, making UDFs accessible as top-level properties instead of nested in the userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract exclusion set.
  • name - The name of the contract exclusion set.
  • description - Description or details about the contract exclusion set.
  • excludedRoles - List of roles excluded by this contract exclusion set.
  • excludedWorkTypes - List of work types excluded by this contract exclusion set.
  • userDefinedFields - Custom user-defined fields related to the contract exclusion set, if any.

Dependencies

  • An API key credential for Autotask PSA REST API

Troubleshooting

  • Ensure the Contract Exclusion Set ID is correct and exists in the Autotask system to avoid 'not found' errors.
  • Check API credentials and permissions if the node fails to authenticate or access the resource.
  • If no data is returned, verify that the selected columns include the necessary fields or leave it empty to fetch all fields.
  • Enable 'Add Picklist Labels' and 'Add Reference Labels' to get human-readable values if the raw data is not clear.

Links

Discussion