Dependencies
Update a dependency
Change one dependency. Only the fields you send are touched.
PATCH
/
deliverable
/
dependencies
/
{id}
Update a dependency
curl --request PATCH \
--url https://{instance}/api/v2/deliverable/dependencies/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"type": "fs",
"rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lagTimeSec": 0,
"isArchived": false,
"archivedAt": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'fs',
rootParentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fromId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
toId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lagTimeSec: 0,
isArchived: false,
archivedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://{instance}/api/v2/deliverable/dependencies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/deliverable/dependencies/{id}"
payload = {
"type": "fs",
"rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lagTimeSec": 0,
"isArchived": False,
"archivedAt": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "fs",
"rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lagTimeSec": 0,
"isArchived": false,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}Authorizations
Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.
Path Parameters
Record id.
Body
application/json
Every field is optional. Only the fields you send are changed.
Link type: fs finish-to-start, ff finish-to-finish, sf start-to-finish, ss start-to-start.
Available options:
fs, ff, sf, ss Root of the tree both nodes belong to.
Node the link runs from, the predecessor.
Node the link runs to, the successor.
Lag between the two nodes, in seconds. Negative values lead.
Archived links no longer affect scheduling.
When the link was archived.
Response
The updated dependency.
A scheduling link between two deliverables in the same tree. Creating or changing one re-rolls the downstream node's dates.
Show child attributes
Show child attributes
⌘I
Update a dependency
curl --request PATCH \
--url https://{instance}/api/v2/deliverable/dependencies/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"type": "fs",
"rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lagTimeSec": 0,
"isArchived": false,
"archivedAt": "2023-11-07T05:31:56Z"
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'fs',
rootParentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
fromId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
toId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lagTimeSec: 0,
isArchived: false,
archivedAt: '2023-11-07T05:31:56Z'
})
};
fetch('https://{instance}/api/v2/deliverable/dependencies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/deliverable/dependencies/{id}"
payload = {
"type": "fs",
"rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lagTimeSec": 0,
"isArchived": False,
"archivedAt": "2023-11-07T05:31:56Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "fs",
"rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lagTimeSec": 0,
"isArchived": false,
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}