Autotask icon

Autotask

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

Actions524

Contract Exclusion Role → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple Contract Exclusion Role records from the Autotask PSA system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the results according to their needs. This operation is useful for scenarios where users need to fetch a customized list of contract exclusion roles based on specific conditions, such as filtering by role attributes or related contract details.

Use Case Examples

  1. Fetch all contract exclusion roles that meet certain criteria defined in an advanced JSON filter.
  2. Retrieve a limited number of contract exclusion roles with specific attributes for reporting or integration purposes.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit.
Max Records Maximum number of records to return when 'Get All' is false. Range is 1 to 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the contract exclusion roles.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable 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.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object for easier access.

Output

JSON

  • id - Unique identifier of the contract exclusion role.
  • name - Name of the contract exclusion role.
  • description - Description of the contract exclusion role.
  • userDefinedFields - User-defined fields associated with the contract exclusion role, optionally flattened to top-level properties.
  • _label - Human-readable labels for picklist and reference fields, if enabled.

Dependencies

  • Autotask PSA REST API
  • API authentication credentials

Troubleshooting

  • Ensure the advanced filter JSON is correctly formatted and follows the Autotask API query criteria syntax.
  • Verify API credentials and permissions to access contract exclusion roles.
  • If no results are returned, check the filter criteria to ensure they match existing data.
  • Errors related to rate limits may occur; ensure proper handling or retry logic is implemented.

Links

Discussion