Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple notification history records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the notification history data precisely. This is useful for auditing, monitoring, or reporting on notification events within Autotask, such as tracking system alerts or user notifications over time.

Properties

Name Meaning
Get All Determines whether to return all matching notification history records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of notification history 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 notification history records. This allows for complex and precise queries based on Autotask's REST API filtering capabilities.
Add Picklist Labels If enabled, the node automatically adds additional fields with '_label' suffix for picklist fields, providing human-readable values for those fields.
Add Reference Labels If enabled, the node automatically adds additional fields with '_label' suffix for reference fields, providing human-readable values for those references.
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 by default. The ID field is always included regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are brought up to the top level of each returned object instead of being nested inside a 'userDefinedFields' array, simplifying access to these fields.

Output

JSON

  • id - Unique identifier of the notification history record.
  • notificationHistory
    • * - Properties of the notification history record as returned by the Autotask API, including fields such as notification type, status, timestamps, and related entity references.
  • *_label - Human-readable labels for picklist and reference fields, added automatically if enabled in the input properties.
  • userDefinedFields
    • * - User-defined fields associated with the notification history record, either nested or flattened to top-level properties depending on the 'Flatten User-Defined Fields' setting.

Dependencies

  • Requires an Autotask API key credential for authentication to access the Autotask REST API.

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property will cause the node to fail. Ensure the JSON string is correctly formatted and contains a valid 'filter' array as per Autotask API documentation.
  • Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API rate limiting. Use 'Max Records' to limit the number of returned records or enable 'Get All' cautiously.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may result in incomplete data or errors. Use the 'Get Field Info' feature to verify field names.
  • If picklist or reference labels are not appearing as expected, verify that the corresponding 'Add Picklist Labels' and 'Add Reference Labels' options are enabled.
  • API authentication errors may occur if the Autotask API key credential is missing, expired, or invalid. Verify credentials in the node settings.

Links

Discussion