Upsert a dependency

PUT

deliverable

dependencies

{id}

Upsert a dependency

curl --request PUT \
  --url https://{instance}/api/v2/deliverable/dependencies/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "fs",
  "lagTimeSec": 0,
  "isArchived": false,
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rootParentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    fromId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    toId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'fs',
    lagTimeSec: 0,
    isArchived: false,
    archivedAt: '2023-11-07T05:31:56Z',
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '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 = {
    "rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "fs",
    "lagTimeSec": 0,
    "isArchived": False,
    "archivedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(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

X-API-Key

string

header

required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Path Parameters

string<uuid>

required

Record id.

Query Parameters

update

string[]

required

Columns to overwrite when the row already exists. Repeat the parameter for each column: a single comma-separated value is read as one column name and fails at the database. Without the parameter the request is rejected with 400.

Body

application/json

rootParentId

string<uuid>

required

Root of the tree both nodes belong to.

fromId

string<uuid>

required

Node the link runs from, the predecessor.

toId

string<uuid>

required

Node the link runs to, the successor.

string<uuid>

Unique id. Generated on create unless you supply one.

type

enum<string>

default:fs

Link type: fs finish-to-start, ff finish-to-finish, sf start-to-finish, ss start-to-start.

Available options:

fs,

ff,

sf,

ss

lagTimeSec

integer

default:0

Lag between the two nodes, in seconds. Negative values lead.

isArchived

boolean

default:false

Archived links no longer affect scheduling.

archivedAt

string<date-time> | null

When the link was archived.

createdAt

string<date-time>

When the record was created.

updatedAt

string<date-time>

When the record last changed.

Response

The upserted dependency.

value

object

required

A scheduling link between two deliverables in the same tree. Creating or changing one re-rolls the downstream node's dates.

Show child attributes

Upsert a dependency

curl --request PUT \
  --url https://{instance}/api/v2/deliverable/dependencies/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "fs",
  "lagTimeSec": 0,
  "isArchived": false,
  "archivedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rootParentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    fromId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    toId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'fs',
    lagTimeSec: 0,
    isArchived: false,
    archivedAt: '2023-11-07T05:31:56Z',
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '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 = {
    "rootParentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fromId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "toId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "fs",
    "lagTimeSec": 0,
    "isArchived": False,
    "archivedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(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": {}
}

Overview

Projects

Stages

Deliverables

Work sessions

Dependencies

Documents

Custom properties

QC

People (Workers)

Timesheets

Codes

Roles

Users

Domain concepts

Items

Item vendors

Inventory stock

Inventory transactions

Inventory allocations

BOM lines

Production outputs

Units of measure

Vendors

Locations

Deliveries

Delivery lines

Trucks

Contacts

Project contacts

Teams

Shifts

Departments (shops)

Authorizations

Path Parameters

Query Parameters

Body

Response