Actions389
- Contract Actions
- Ticket History Actions
- Ticket Note Webhook Actions
- Ticket Note Actions
- Ticket Webhook Actions
- Time Entry Actions
- Resource Actions
- Role Actions
- Resource Role Actions
- Search Filter Actions
- Service Actions
- Skill Actions
- Service Call Actions
- Survey Results Actions
- Survey Actions
- Ticket Actions
- Opportunity Actions
- Notification History Actions
- Invoice Actions
- Product Actions
- Product Vendor Actions
- Project Actions
- Project Charge Actions
- Project Phase Actions
- Project Task Actions
- Project Note Actions
- Contract Retainer Actions
- Contract Service Actions
- Contract Service Adjustment Actions
- Contract Service Bundle Actions
- Contract Service Bundle Unit Actions
- Contract Service Bundle Adjustment Actions
- Contract Ticket Purchase Actions
- Contract Service Unit Actions
- Domain Registrar Actions
- Holiday Actions
- Holiday Set Actions
- Contract Exclusion Billing Code Actions
- Contract Rate Actions
- Contract Exclusion Role Actions
- Contract Exclusion Sets Actions
- Contract Exclusion Set Excluded Role Actions
- Contract Exclusion Set Excluded Work Type Actions
- Contract Milestone Actions
- Contract Note Actions
- Contract Role Costs Actions
- Contact Groups Actions
- Contact Actions
- Contact Webhook Actions
- Contact Group Contacts Actions
- Contract Block Hour Factor Actions
- Contract Block Actions
- Contract Billing Rule Actions
- Contract Charge Actions
- Configuration Item Category Actions
- Configuration Item Category UDF Association Actions
- Configuration Item DNS Record Actions
- Configuration Item Note Actions
- Configuration Item Related Item Actions
- Configuration Item SSL Subject Alternative Name Actions
- Configuration Item Type Actions
- Configuration Item Webhook Actions
- Company Alert Actions
- Company Actions
- Billing Code Actions
- Company Location Actions
- Company Note Actions
- Company Webhook Actions
- Configuration Item Actions
- Configuration Item Billing Product Association Actions
Overview
This node operation retrieves multiple Contract Exclusion 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 precisely. This is useful for scenarios where you need to extract specific contract exclusion roles based on detailed conditions, such as filtering by role attributes or related contract data. For example, you might want to get all exclusion roles that match certain billing criteria or are linked to specific contracts.
Properties
| Name | Meaning |
|---|---|
| Get All | Determines whether to return all matching Contract Exclusion Role records or limit the number of results. |
| Max Records | Specifies the maximum number of Contract Exclusion Role 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 that defines the Autotask API query criteria to filter Contract Exclusion Roles. This allows for complex and precise filtering based on field values. |
| Add Picklist Labels | If enabled, adds human-readable '_label' fields for picklist fields in the output, making it easier to understand picklist values. |
| Add Reference Labels | If enabled, adds human-readable '_label' fields for reference fields in the output, improving readability of referenced entities. |
| 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 returned object instead of being nested inside a userDefinedFields array. |
Output
JSON
id- Unique identifier of the Contract Exclusion Role record.fieldName- Various fields of the Contract Exclusion Role as returned by the Autotask API, depending on selected columns.picklistField_label- Human-readable labels for picklist fields, if 'Add Picklist Labels' is enabled.referenceField_label- Human-readable labels for reference fields, if 'Add Reference Labels' is enabled.userDefinedFields- User-defined fields nested or flattened depending on 'Flatten User-Defined Fields' setting.
Dependencies
- Requires an Autotask API key credential for authentication to access the Autotask REST API.
Troubleshooting
- Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
- Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API limits. Use 'Max Records' to limit results or enable 'Get All' cautiously.
- Selecting invalid or unsupported fields in 'Select Columns' may cause errors. Use 'Get Field Info' or API docs to confirm valid field names.
- If picklist or reference labels are not appearing, verify that the corresponding fields have values and that the label options are enabled.
- API authentication errors may occur if the Autotask API key credential is missing or invalid. Verify credentials in node settings.
Links
- Autotask API Basic Query Calls - Official Autotask API documentation describing how to construct filter queries for advanced data retrieval.