Phase

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

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.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: Phase
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 field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
CreateDate Phase Creation Date datetime      
CreatorResourceID Phase Creator integer   Resource  
Description Phase Description string (8000)        
DueDate Phase End Date datetime        
EstimatedHours Phase Estimated Hours double      
ExternalID Phase External ID string (50)        
id Phase ID long    
LastActivityDateTime Phase Last Activity Date datetime      
ParentPhaseID Parent Phase integer     Phase  
PhaseNumber Phase Number string (50)      
ProjectID Project integer Project  
Scheduled Is Scheduled boolean      
StartDate Phase Start Date datetime        
Title Phase Title string (255)