Update many work sessions

PATCH

deliverable

work-sessions

bulk

curl --request PATCH \
  --url https://{instance}/api/v2/deliverable/work-sessions/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isEdited": false,
  "lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shiftWorkHours": {
    "startTime": "08:00",
    "endTime": "17:00",
    "breaks": [
      {
        "startTime": "12:00",
        "durationInSec": 1800
      }
    ],
    "timezone": "America/New_York"
  },
  "externalSource": "<string>",
  "externalSync": "synced",
  "metadata": {
    "costCode": "WELD-100",
    "unionCode": "LOCAL-7"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deliverableId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    shopId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    isEdited: false,
    lastUpdatedBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    shiftWorkHours: {
      startTime: '08:00',
      endTime: '17:00',
      breaks: [{startTime: '12:00', durationInSec: 1800}],
      timezone: 'America/New_York'
    },
    externalSource: '<string>',
    externalSync: 'synced',
    metadata: {costCode: 'WELD-100', unionCode: 'LOCAL-7'}
  })
};

fetch('https://{instance}/api/v2/deliverable/work-sessions/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/deliverable/work-sessions/bulk"

payload = {
    "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isEdited": False,
    "lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shiftWorkHours": {
        "startTime": "08:00",
        "endTime": "17:00",
        "breaks": [
            {
                "startTime": "12:00",
                "durationInSec": 1800
            }
        ],
        "timezone": "America/New_York"
    },
    "externalSource": "<string>",
    "externalSync": "synced",
    "metadata": {
        "costCode": "WELD-100",
        "unionCode": "LOCAL-7"
    }
}
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",
      "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "isEdited": false,
      "lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shiftWorkHours": {
        "startTime": "08:00",
        "endTime": "17:00",
        "breaks": [
          {
            "startTime": "12:00",
            "durationInSec": 1800
          }
        ],
        "timezone": "America/New_York"
      },
      "breakTimeInSec": 123,
      "externalSource": "<string>",
      "externalSync": "synced",
      "metadata": {
        "costCode": "WELD-100",
        "unionCode": "LOCAL-7"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "rawStart": "2023-11-07T05:31:56Z",
      "rawEnd": "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.

deliverableId

string<uuid>

Deliverable the time was logged against.

workerId

string<uuid>

Person who did the work.

shopId

string<uuid>

Department the session belongs to.

startDate

string<date-time>

When the session started, in UTC.

endDate

string<date-time> | null

When the session ended, in UTC. null means it is still open.

isEdited

boolean

default:false

true when someone has edited the session by hand.

lastUpdatedBy

string<uuid> | null

Who last changed the session.

shiftWorkHours

object | null

The shift the record was worked against. Break times are local wall-clock, not UTC.

Show child attributes

externalSource

string | null

System the session came from, for example quickbase.

externalSync

string

default:not synced

Sync state for the external system.

Example:

"synced"

metadata

object

Free-form key-value store. No key is guaranteed to be present, and a missing key is not the same as a null one. See the resource guide for which paths populate costCode and unionCode.

Example:

{
  "costCode": "WELD-100",
  "unionCode": "LOCAL-7"
}

Response

The updated work sessions.

values

object[]

required

Show child attributes

Update many work sessions

curl --request PATCH \
  --url https://{instance}/api/v2/deliverable/work-sessions/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isEdited": false,
  "lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shiftWorkHours": {
    "startTime": "08:00",
    "endTime": "17:00",
    "breaks": [
      {
        "startTime": "12:00",
        "durationInSec": 1800
      }
    ],
    "timezone": "America/New_York"
  },
  "externalSource": "<string>",
  "externalSync": "synced",
  "metadata": {
    "costCode": "WELD-100",
    "unionCode": "LOCAL-7"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deliverableId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    workerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    shopId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    isEdited: false,
    lastUpdatedBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    shiftWorkHours: {
      startTime: '08:00',
      endTime: '17:00',
      breaks: [{startTime: '12:00', durationInSec: 1800}],
      timezone: 'America/New_York'
    },
    externalSource: '<string>',
    externalSync: 'synced',
    metadata: {costCode: 'WELD-100', unionCode: 'LOCAL-7'}
  })
};

fetch('https://{instance}/api/v2/deliverable/work-sessions/bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/deliverable/work-sessions/bulk"

payload = {
    "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isEdited": False,
    "lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shiftWorkHours": {
        "startTime": "08:00",
        "endTime": "17:00",
        "breaks": [
            {
                "startTime": "12:00",
                "durationInSec": 1800
            }
        ],
        "timezone": "America/New_York"
    },
    "externalSource": "<string>",
    "externalSync": "synced",
    "metadata": {
        "costCode": "WELD-100",
        "unionCode": "LOCAL-7"
    }
}
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",
      "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "isEdited": false,
      "lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shiftWorkHours": {
        "startTime": "08:00",
        "endTime": "17:00",
        "breaks": [
          {
            "startTime": "12:00",
            "durationInSec": 1800
          }
        ],
        "timezone": "America/New_York"
      },
      "breakTimeInSec": 123,
      "externalSource": "<string>",
      "externalSync": "synced",
      "metadata": {
        "costCode": "WELD-100",
        "unionCode": "LOCAL-7"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "rawStart": "2023-11-07T05:31:56Z",
      "rawEnd": "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