Autotask icon

Autotask

Consume Autotask REST API

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific Contract Service by its Service ID. It is useful for workflows that need to fetch contract service data for further processing, reporting, or integration with other systems. For example, a user can get contract service details to verify service terms, billing information, or service status within an automated business process.

Properties

Name Meaning
Service ID The unique identifier of the contract service to retrieve.
Add Picklist Labels Determines whether to add human-readable '_label' fields for picklist fields in the response, enhancing readability by including descriptive labels alongside raw values.
Add Reference Labels Determines whether to add human-readable '_label' fields for reference fields in the response, providing descriptive labels for referenced entities.
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) are promoted to top-level properties in the output object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract service.
  • name - The name of the contract service.
  • description - Description or details about the contract service.
  • picklistField_label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields associated with the contract service, unless flattened.
  • userDefinedFieldName - User-defined fields promoted to top-level properties if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • If the Service ID is invalid or does not exist, the node may return an error or empty result. Verify the Service ID is correct.
  • If API authentication fails, ensure the API key credential is correctly configured and has sufficient permissions.
  • Selecting specific columns that do not exist may result in incomplete data or errors; verify field names or IDs are valid.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' without corresponding data may result in missing label fields; this is expected behavior.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields; use with caution.

Discussion