Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Exclusion Set Excluded Role records from the Autotask REST API using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the results, control the number of records returned, and customize the output by including human-readable labels for picklist and reference fields. This operation is useful for scenarios where detailed and specific data about excluded roles in contract exclusion sets is needed, such as auditing, reporting, or integration with other systems.

Properties

Name Meaning
Get All Determines whether to return all matching records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array with Autotask API query criteria to filter the records returned.
Add Picklist Labels Indicates whether to automatically add '_label' fields for picklist fields to provide human-readable values.
Add Reference Labels Indicates whether to automatically add '_label' fields for reference fields to provide human-readable values.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If none are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are brought to the top level of each object instead of being nested.

Output

JSON

  • id - Unique identifier of the Contract Exclusion Set Excluded Role record.
  • fieldName - Various fields representing the properties of the excluded role as returned by the Autotask API.
  • picklistField_label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.
  • userDefinedFields
    • * - User-defined fields nested or flattened depending on the 'Flatten User-Defined Fields' setting.

Dependencies

  • Requires an Autotask API credential (API key or token) to authenticate requests to the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and follows Autotask API query criteria.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • If no records are returned, verify that the filter criteria match existing data.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may increase response size and processing time.
  • Incorrect field names in 'Select Columns' or filter criteria may cause errors or empty results; use 'Get Field Info' to confirm exact field names.

Links

Discussion