TaskPredecessors

This entity describes a predecessor/successor arrangement between two project schedule items. A predecessor item comes before one or more tasks (successor tasks) in the Project schedule. A successor task is scheduled to begin at the predecessor task's end date plus the number of "lag" days specified. for the predecessor.

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: TaskPredecessors

Entity Path:

/atservicesrest/v1.0/TaskPredecessors
Parent Entity: Tasks
Can Create:
Can Update:
Lag days only
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.
  • Currently, the API does not support project Phases as predecessors.
  • Only lagDays can be updated.
  • The start date of the Successor Task (successorTaskID) will shift based on the Predecessor Task's (predecessorTaskID) end date plus the number of Lag Days (lagDays) where specified.
  • The Predecessor Task and Successor Task must be associated with the same Project.
  • API user can only create, update, delete, and query TaskPredecessor for Tasks allowed by user's security level permissions, including RESTRICTED access to Tasks for users who are assigned to a Task but have no access to Projects.
  • Predecessor and Successor Tasks associated with projects of Type = Baseline are read-only and cannot be created, updated or deleted via the API.

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
id long    
lagDays integer        
predecessorTaskID integer Tasks  
successorTaskID integer Tasks  

Additional resources