Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Role records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter roles according to their needs. This is useful for scenarios where you need to extract a customized list of roles based on specific attributes or conditions, such as roles with certain permissions or roles created within a date range. For example, a user can fetch all roles assigned to a particular department or with a specific status by defining the appropriate filter JSON.

Properties

Name Meaning
Get All Determines whether to return all matching Role records or limit the number of 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.
Advanced Filter A required JSON string containing a 'filter' array that defines the Autotask API query criteria to filter Role records. This allows complex and precise filtering based on Role fields.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional fields with '_label' suffix for reference fields to provide human-readable values.
Select Columns Names or IDs. Allows selection of specific Role 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 moved 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.
  • userDefinedFields - Array of user-defined fields associated with the Role, unless flattened.
    _label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled._label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.

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 well-formed and follows Autotask API filter syntax.
  • Requesting too many records without pagination or limits may lead to timeouts or API rate limiting.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may result in incomplete or error responses.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields support labels.
  • API authentication errors may occur if the API key credential is missing, expired, or invalid.

Links

Discussion