Phases

This entity describes an Autotask project Phase. Phases allow users to break projects into sub-groups of project tasks. They can be a sub-phase to a Parent phase. Users manage phases through the Project's Schedule view in the Projects module.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: Phases

Entity Path:

/atservicesrest/v1.0/Phases
Parent Entity: Projects
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

General

  • If Autotask receives a create, update, or delete request for this entity and its corresponding module is unavailable, the API will return the error message, "The logged in Resource does not have the adequate permissions to update this entity type." For more information about installed modules, refer to our Modules article.
  • Phases associated with projects of Type = Baseline are read-only and cannot be created, updated or deleted via the API.
  • On update, projectID cannot be changed. An error will be returned.
  • To maintain consistency with the Autotask UI, Phase.endDateTime ignores any time component passed in. A time value of midnight will be applied to any Phase end date provided. End date can be the same day as Start date.

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
createDate datetime      
creatorResourceID integer   Resources  
description string (8000)        
dueDate datetime        
estimatedHours decimal      
externalID string (50)        
id long    
isScheduled boolean      
lastActivityDateTime datetime      
parentPhaseID integer     Phases  
phaseNumber string (50)      
projectID integer Projects  
startDate datetime        
title string (255)      

Additional resources