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 Role records from the Autotask system. It is useful for scenarios where you need to fetch a list of roles, for example, to display user roles, manage permissions, or synchronize role data with other systems. The operation supports fetching all roles or limiting the number of records returned, and allows customization of which fields to include in the output, including user-defined fields and labels for picklist and reference fields.
Properties
| Name | Meaning |
|---|---|
| Fields | Defines which fields of the Role resource to retrieve and map in the output. Supports defining fields manually or using auto-mapping features. |
| Get All | Boolean flag to determine whether to return all Role records or limit the results. |
| Max Records | Specifies the maximum number of Role records to return when 'Get All' is false. The value must be between 1 and 500. |
| Add Picklist Labels | Whether to add human-readable '_label' fields for picklist fields in the Role data. Labels are only added for non-empty values. |
| Add Reference Labels | Whether to add human-readable '_label' fields for reference fields in the Role data. Labels are only added for non-empty values. |
| Select Columns Names or IDs. | Allows selecting specific fields (columns) to include in the response by choosing from a list or specifying IDs via expressions. If no fields are selected, all fields are returned. The ID field is always included. |
| Flatten User-Defined Fields | When enabled, user-defined fields (UDFs) are brought to the top level of each Role object instead of being nested inside a userDefinedFields array. |
Output
JSON
id- Unique identifier of the Role record.name- Name of the Role.description- Description of the Role.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- Array of user-defined fields associated with the Role, unless 'Flatten User-Defined Fields' is enabled.userDefinedFieldName- User-defined fields brought to the top level if 'Flatten User-Defined Fields' is enabled.
Dependencies
- Requires an API key credential for Autotask REST API authentication.
Troubleshooting
- If no roles are returned, verify that the API credentials are correct and have sufficient permissions.
- If the node returns an error about unsupported resource, ensure the 'Resource' parameter is set to 'Role'.
- If the output is missing expected fields, check the 'Fields' and 'Select Columns' settings to ensure the desired fields are included.
- If the node times out or returns partial data, consider enabling 'Get All' or increasing the 'Max Records' limit within allowed bounds.
- Errors related to picklist or reference labels may occur if those fields are not present or the labels are not available; try disabling 'Add Picklist Labels' or 'Add Reference Labels' to troubleshoot.