Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Project Phase records from the Autotask system using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter the project phases returned. This is useful for scenarios where you need to extract specific project phase data based on detailed conditions, such as phases within certain projects, with particular statuses, or matching custom user-defined fields. For example, a project manager could use this to get all active phases for projects in a specific department or with deadlines within a date range.

Properties

Name Meaning
Get All Determines whether to return all matching project phase records or limit the number of results.
Max Records Specifies the maximum number of project phase 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 project phases. Users should construct this JSON using Autotask API documentation and tools like 'Get Field Info' and 'Search Filter Build'.
Add Picklist Labels If enabled, adds additional '_label' fields to the output for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels If enabled, adds '_label' fields for reference fields to provide human-readable values.
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 project phase.
  • name - Name of the project phase.
  • status - Status of the project phase.
  • startDate - Start date of the project phase.
  • endDate - End date of the project phase.
  • userDefinedFields - Array of user-defined fields related to the project phase, unless flattened.
  • _label - Additional human-readable labels for picklist and reference fields if enabled.

Dependencies

  • Requires an Autotask API key credential for authentication.
  • Relies on Autotask REST API to fetch project phase data.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON is well-formed and follows Autotask API filter syntax.
  • Requesting too many records without 'Get All' enabled may result in incomplete data. Use 'Get All' to retrieve all matching records if needed.
  • Selecting fields that do not exist or are misspelled in 'Select Columns' may cause errors or missing data.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields support labels.
  • API rate limits from Autotask may cause errors; consider adding delays or handling retries.

Links

Discussion