Autotask icon

Autotask

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

Actions524

Contract Exclusion Set Excluded Role → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple records of Contract Exclusion Set Excluded Roles from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to query and extract detailed data about excluded roles within contract exclusion sets, applying complex filters to refine the results. For example, a user might want to fetch all excluded roles that meet specific conditions defined in a JSON filter to analyze contract exclusions comprehensively.

Use Case Examples

  1. Retrieve all Contract Exclusion Set Excluded Roles with a specific attribute using an advanced JSON filter.
  2. Fetch a limited number of Contract Exclusion Set Excluded Roles records 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 not returning all (range 1-500).
Advanced Filter A JSON string containing a "filter" array with Autotask API query criteria to specify complex filtering conditions for the query.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values (no labels added for empty values).
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values (no labels 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 - Unique identifier of the Contract Exclusion Set Excluded Role record.
  • name - Name or label of the excluded role (if applicable).
  • otherProperties - Additional properties of the Contract Exclusion Set Excluded Role as returned by the Autotask API, including any user-defined fields if flattening is enabled.

Dependencies

  • Autotask PSA REST API

Troubleshooting

  • Ensure the Autotask API credentials are correctly configured and have sufficient permissions to access Contract Exclusion Set Excluded Role data.
  • Verify the JSON syntax and structure of the Advanced Filter to avoid query errors.
  • If no results are returned, check the filter criteria to ensure they match existing records.
  • Be aware of API rate limits; the node attempts to initialize a rate tracker to handle this, but excessive requests may still be throttled.

Links

Discussion