Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Contract Block from the Autotask system using its unique Block ID. It is useful for workflows that need to fetch contract block data for processing, reporting, or integration purposes. For example, a user can automate the retrieval of contract block details to update internal databases or trigger further actions based on contract block attributes.

Properties

Name Meaning
Block ID The unique identifier of the contract block to retrieve.
Add Picklist Labels Determines whether to automatically add human-readable "_label" fields for picklist fields in the response. Labels are only added if the picklist value is not empty.
Add Reference Labels Determines whether to automatically add human-readable "_label" fields for reference fields in the response. Labels are only added if the reference value is not empty.
Select Columns Names or IDs. Specifies which fields 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 brought to the top level of each returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract block.
  • name - The name of the contract block.
  • description - Description or details about the contract block.
  • userDefinedFields - An array of user-defined fields associated with the contract block, unless flattened.
    _label - Human-readable labels for picklist fields, added if 'Add Picklist Labels' is enabled._label - Human-readable labels for reference fields, added if 'Add Reference Labels' is enabled.

Dependencies

  • Requires an API key credential for Autotask REST API authentication.

Troubleshooting

  • If the Block ID is invalid or not found, the node will throw an error indicating the contract block could not be retrieved. Verify the Block ID is correct.
  • If API authentication fails, ensure the Autotask API credentials are correctly configured and have sufficient permissions.
  • Selecting specific columns that do not exist may result in incomplete data or errors; verify field names or IDs are valid.
  • Enabling flattening of user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Discussion