Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Company Alert 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 alerts, control the number of records returned, and customize the output fields. This is useful for scenarios where detailed and specific alert data is needed, such as monitoring company notifications, automating alert processing, or integrating alert data into other workflows.

Properties

Name Meaning
Get All Determines whether to return all matching Company Alert records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of Company Alert 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 query criteria according to the Autotask API specification. This allows for complex and precise filtering of Company Alert records.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix to the output for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional fields with '_label' suffix to the output for reference fields, providing human-readable values.
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.
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.

Output

JSON

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

Dependencies

  • Requires an Autotask API key credential for authentication.
  • Relies on the Autotask REST API endpoint for Company Alerts.

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property will cause query errors. Ensure the JSON is well-formed and follows the Autotask API filter structure.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • Selecting invalid or non-existent fields in 'Select Columns' may result in incomplete or error responses.
  • If picklist or reference labels are enabled but no labels appear, verify that the fields actually have associated labels and that the API supports them.
  • Authentication errors may occur if the API key credential is missing, invalid, or expired.

Links

Discussion