Skip to main content
PATCH
Update many deliverables

Authorizations

X-API-Key
string
header
required

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

Query Parameters

search
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.

identifier
string

Human-readable id, unique within your organization. Generated for you when you leave it out.

name
string

Display name.

isArchived
boolean
default:false

Archived records are hidden from list results unless you ask for them. Set this to archive or restore the record.

archivedAt
string<date-time> | null

When the record was archived. Set automatically when isArchived flips to true, and cleared on restore.

type
enum<string>

Which concept this node represents.

Available options:
order,
route,
overhead,
template-phase,
phase,
component,
stage,
step,
qcstep,
group
quantity
integer
default:1

How many of this node the work covers.

parentId
string<uuid> | null

Node directly above this one.

rootParentId
string<uuid> | null

Root of this node's tree. A root node points at itself.

originTemplateId
string<uuid> | null

Route or template this node was built from.

cycleTimeSec
integer
default:0

Cycle time per unit, in seconds.

durationSec
integer
default:0

Total duration, in seconds.

peopleNum
integer
default:1

How many people the node is planned for.

data
object

Per-concept fields. Which keys apply depends on type: a stage node needs stageId, an order needs projectId, and so on. See the domain concepts guide for the full table.

Example:
costCode
string | null

Cost code. Trimmed on write, and an empty string is rejected: send a non-empty string or null.

Stored as a plain string. It is not validated against the cost code list, and renaming an entry in that list does not change this value.

Response

The updated deliverables.

values
object[]
required