Dependencies
This documentation is for LiquidPlanner New: next.liquidplanner.com
Use this endpoint to manage dependencies.
https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1/<item id>/dependencies
Support Methods
POST
Add a dependency on a plan item using a POST request by including the following fields in the request body:
"dependencyType": predecessor or successor
"dependencyItemId": LiquidPlanner ID of the dependency item,
"waitDays": the number of wait days
The example below creates a dependency between Task A and Task B such that Task B is a successor of Task A with a waiting period of 5 days after Task A is marked done:
curl --location --request POST 'https://next.liquidplanner.com/api/workspaces/<workspace id/items/v1/<ID of Task A>/dependencies' \
--header 'Authorization: Bearer <API Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"dependencyType": "successor",
"dependencyItemId": <ID of Task B>,
"waitDays": 5
}'
UPDATE
Send a PUT request to update the number of wait days on an existing dependency as shown below.
curl --location --request PUT 'https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1/<item id>/dependencies/<dependency id> \
--header 'Authorization: Bearer <API Token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"waitDays": 1
}'
DELETE
Send a DELETE request to remove an existing dependency on an item by the dependency id.
curl --location --request DELETE 'https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1/<item id>/dependencies/<dependency id> \
--header 'Authorization: Bearer <API Token>' \
--header 'Content-Type: application/json' \
--data-raw ' '
GET
Pull a list of all the dependencies on a specific Item in JSON format.
https://next.liquidplanner.com/api/workspaces/<workspace id>/items/v1/<item id>/dependencies
Sample Response
{
"recordLimit": 500,
"recordCount": 2,
"data": [
{
"id": 57992,
"dependencyType": "successor",
"dependencyItemId": 438312,
"waitDays": 5,
"itemId": 438311,
"dependencyStatus": "active",
"createdAt": "2022-10-10T23:26:02.512168Z",
"updatedAt": "2022-10-10T23:26:04.468804Z",
"createdById": 185,
"updatedById": null
},
{
"id": 57993,
"dependencyType": "predecessor",
"dependencyItemId": 438310,
"waitDays": 5,
"itemId": 438311,
"dependencyStatus": "active",
"createdAt": "2022-10-10T23:27:05.639644Z",
"updatedAt": "2022-10-10T23:27:07.987392Z",
"createdById": 185,
"updatedById": null
}
]
}
Filter Options
API filtering is not available on this endpoint.
Updated about 2 years ago