Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific Resource Role by its ID. It is useful in scenarios where you need to fetch configuration or permission details related to resource roles within Autotask, such as for auditing, reporting, or integration workflows. For example, you can use this node to get the attributes of a resource role to determine access levels or to synchronize role data with another system.

Properties

Name Meaning
Resource Role ID The unique identifier of the resource role to retrieve. This is a required input to specify which resource role's details should be fetched.
Add Picklist Labels A boolean option to automatically add human-readable '_label' fields for picklist fields in the response. This helps in understanding picklist values without needing to decode them manually.
Add Reference Labels A boolean option to automatically add human-readable '_label' fields for reference fields in the response. This makes reference fields easier to interpret.
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 regardless of selection. This helps optimize data retrieval by limiting the response to relevant fields.
Flatten User-Defined Fields When enabled, user-defined fields (UDFs) are brought up to the top level of the returned object instead of being nested inside a 'userDefinedFields' array. This simplifies access to UDFs in the output.

Output

JSON

  • id - The unique identifier of the resource role.
  • name - The name of the resource role.
  • description - A textual description of the resource role.
  • picklistField_label - Human-readable labels for picklist fields, added if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable labels for reference fields, added if 'Add Reference Labels' is enabled.
  • userDefinedFields - An array of user-defined fields associated with the resource role, unless flattened.
  • userDefinedFieldName - When 'Flatten User-Defined Fields' is enabled, UDFs appear as top-level properties with their respective names.

Dependencies

  • Requires an API key credential for Autotask REST API authentication.

Troubleshooting

  • If the node returns an error indicating the resource role ID is invalid or not found, verify that the provided ID exists in Autotask.
  • If no data is returned, check that the API credentials have sufficient permissions to access resource role information.
  • Errors related to picklist or reference labels may occur if the fields do not have associated labels; disabling the label options can help isolate the issue.
  • If user-defined fields are not appearing as expected, verify the 'Flatten User-Defined Fields' option and the structure of the data in Autotask.

Links

Discussion