Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific Role entity by its ID. It is useful for workflows that need to fetch role details for access control, reporting, or integration purposes. For example, you can use it to get the properties of a role to assign permissions or to display role information in a dashboard.

Properties

Name Meaning
Role ID The unique identifier of the role to retrieve.
Add Picklist Labels Determines whether to add human-readable '_label' fields for picklist fields in the response, enhancing readability.
Add Reference Labels Determines whether to add human-readable '_label' fields for reference fields in the response.
Select Columns Names or IDs. Specifies which fields to include in the response. If none are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are promoted to top-level properties instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the role.
  • name - The 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 - User-defined fields nested inside userDefinedFields array or flattened to top-level if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • If the Role ID is invalid or not found, the node will throw an error indicating the role could not be retrieved. Verify the Role ID is correct.
  • If API authentication fails, ensure the API key credential is correctly configured and has sufficient permissions.
  • If no fields are returned, check the 'Select Columns' property to ensure desired fields are selected or leave it empty to retrieve all fields.
  • If picklist or reference labels are missing, verify that the corresponding 'Add Picklist Labels' and 'Add Reference Labels' options are enabled.

Discussion