Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves a specific Configuration Item Related Item from the Autotask system by its unique Related Item ID. It is useful for scenarios where you need to fetch detailed information about a related item linked to a configuration item, such as for auditing, reporting, or integration purposes. For example, you might use this node to get details about a related hardware or software component associated with a configuration item in your IT asset management workflow.

Properties

Name Meaning
Related Item ID The unique identifier of the related item to retrieve.
Add Picklist Labels Determines whether to automatically add human-readable '_label' fields for picklist fields in the response, enhancing readability by showing labels instead of raw values.
Add Reference Labels Determines whether to automatically add human-readable '_label' fields for reference fields in the response, making reference data easier to understand.
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 regardless of selection.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) should be moved to the top level of the returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the related item.
    fields - Various fields of the related item as specified by the selected columns or all fields if none selected._label - Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' options are enabled.
  • userDefinedFields - Array of user-defined fields associated with the related item, unless flattened to top-level properties.

Dependencies

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

Troubleshooting

  • If the Related Item ID is invalid or does not exist, the node will throw an error indicating the item was not found. Verify the ID is correct.
  • If API authentication fails, ensure the Autotask API key credential is correctly configured and has sufficient permissions.
  • Selecting invalid or non-existent columns in 'Select Columns' may result in incomplete or empty data fields.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' when the fields have empty values will not add label fields, which is expected behavior.
  • If user-defined fields are not appearing as expected, check the 'Flatten User-Defined Fields' option to control their structure in the output.

Discussion