Update many dependencies

PATCH

deliverable

dependencies

bulk

curl --request PATCH \
  --url https://{instance}/api/v2/deliverable/dependencies/bulk \
  --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/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/deliverable/dependencies/bulk"

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)

{
  "values": [
    {
      "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": {}
}

Authorizations

X-API-Key

string

header

required

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

Query Parameters

string

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter

string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json

Every field is optional. Only the fields you send are changed.

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

rootParentId

string<uuid>

Root of the tree both nodes belong to.

fromId

string<uuid>

Node the link runs from, the predecessor.

toId

string<uuid>

Node the link runs to, the successor.

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.

Response

The updated dependencies.

values

object[]

required

Show child attributes

Update many dependencies

curl --request PATCH \
  --url https://{instance}/api/v2/deliverable/dependencies/bulk \
  --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/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/deliverable/dependencies/bulk"

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)

{
  "values": [
    {
      "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": {}
}

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

Query Parameters

Body

Response