GET/projects/api/v2/projects/{id}/predecessors.json
Retrieve all Task Predecessors/Dependencies on a given Project
NOTE: This is a V2 endpoint. These endpoints can be used but are subject to change.
Returns Predecessors tasks of tasks within the project specified by ID in the URL. A task which has predecessors cannot be completed unless they are first, so they are essentially blocking a task.
- includeDependencies and onlyDependencies are mutually exclusive query options. By default predecessors within the project are returned, but using these switches dependencies of this project can be included or exclusively returned. These switches will only impact the response where a project has dependency/predecessor links with other projects.
Path Params
- Name
id- Type
- integer
- required
- Description
ID of the Project to query
Query Params
- Name
includeDependencies- Type
- boolean
- Description
- Default
false
- Name
onlyDependencies- Type
- boolean
- Description
- Default
false
- Name
onlyBasicFields- Type
- boolean
- Description
When true, means a reduced set of fields are returned.
- Default
false
- Name
onlyActionable- Type
- boolean
- Description
When true, only return results for active projects, tasklists and tasks
- Default
false
- Name
dataSet- Type
- string
- Description
Relates to the type of data you want returned.
- ?dataSet=all: returns the full task objects for each dependancy on the call.
- ?dataSet=basic: returns only the task dependancy ids for the call
- Default
none
- Name
page- Type
- string
- Description
- Name
pageSize- Type
- string
- Description
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 Response
200 Response
application/json
{
"STATUS": "OK",
"tasks": [
{
"depTaskId": 1,
"id": 2,
"name": "Task One",
"status": "Closed",
"type": "start",
"parentTaskId": 0,
"projectType": "normal"
}
]
}