Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Milestone 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 milestones returned. Users can choose to return all matching records or limit the number of records returned. Additionally, it supports options to include human-readable labels for picklist and reference fields, select specific columns to return, and flatten user-defined fields for easier access. This operation is useful for scenarios where detailed and customized retrieval of contract milestone data is needed, such as reporting, data synchronization, or integration workflows.

Properties

Name Meaning
Get All Determines whether to return all matching contract milestone records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contract milestone records to return when 'Get All' is set to false. The value must be between 1 and 500.
Advanced Filter A JSON string containing a 'filter' array that defines the query criteria according to the Autotask API's advanced query syntax. This filter controls which contract milestones are retrieved.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields in the returned data.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for reference fields in the returned data.
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 contract milestone.
  • name - Name of the contract milestone.
  • description - Description of the contract milestone.
  • startDate - Start date of the milestone.
  • endDate - End date of the milestone.
  • status - Status of the milestone, possibly with an additional '_label' field if picklist labels are enabled.
  • referenceField_label - Human-readable label for a reference field if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields unless 'Flatten User-Defined Fields' is enabled, in which case UDFs appear as top-level properties.

Dependencies

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

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting too many records without pagination or limits may lead to timeouts or API rate limiting.
  • Selecting non-existent fields in 'Select Columns' may result in errors or missing data.
  • If picklist or reference labels are enabled but no labels appear, verify that the fields actually have associated labels and that the API supports label retrieval for those fields.
  • Authentication errors may occur if the API key credential is missing, expired, or invalid.

Links

Discussion