Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Resource 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 resource roles returned. Users can choose to return all matching records or limit the number of results. Additionally, it supports options to include human-readable labels for picklist and reference fields, select specific columns to return, and flatten user-defined fields for easier access. This operation is useful for scenarios where detailed and customized queries on resource roles are needed, such as generating reports, syncing data with other systems, or performing bulk data analysis.

Properties

Name Meaning
Get All Determines whether to return all matching resource role records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of resource 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 resource roles. This allows complex and precise filtering based on field values.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields in the response. Empty values do not get labels.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for reference fields in the response. Empty values do not get labels.
Select Columns Names or IDs. Allows selection of specific fields (columns) to include in the response. If no fields are selected, all fields are returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array, simplifying access.

Output

JSON

  • id - Unique identifier of the resource role record.
  • fieldName - Various fields of the resource role as returned by the Autotask API, depending on selected columns.
  • fieldName_label - Human-readable labels for picklist or reference fields, added if respective options are enabled.
  • userDefinedFields - Array of user-defined fields associated with the resource role, unless flattened to top-level properties.

Dependencies

  • Requires an Autotask API credential with appropriate permissions to access resource role data.
  • Relies on the Autotask REST API endpoint for resource roles.

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 non-existent columns in 'Select Columns' may result in empty or partial data.
  • If labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled and that the fields have valid values.
  • API authentication errors may occur if the Autotask API credentials are missing, expired, or lack necessary permissions.

Links

Discussion