Skip to main content
POST
Create a deliverable with validation

Authorizations

X-API-Key
string
header
required

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

Body

application/json
type
enum<string>
required

Concept to create.

Available options:
order,
route,
overhead,
template-phase,
phase,
component,
stage,
step,
qcstep
name
string
required

Node name.

parentId
string<uuid> | null

Node to nest under. Leave it off for a root.

rootParentId
string<uuid> | null

Root of the tree.

identifier
string

Your own identifier. Generated when you leave it out.

quantity
integer
default:1

How many of this node the work covers.

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.

costCode
string | null

Cost code.

originTemplateId
string<uuid> | null

Route or template to build this node from. Setting it applies that structure underneath.

data
object

Per-concept fields. Which keys are required depends on type: an order needs projectId, an overhead needs category, a qcstep needs qcTemplateId. A stage node needs stageId unless a department can be resolved, in which case the station is found or created for you.

Response

The created node.

A deliverable as the concepts layer returns it: the node's own fields plus its resolved concept context.

id
string<uuid>

Node id.

identifier
string

Human-readable id.

name
string

Node name.

type
enum<string>

Concept this node represents.

Available options:
order,
route,
overhead,
template-phase,
phase,
component,
stage,
step,
qcstep
parentId
string<uuid> | null

Node directly above this one.

rootParentId
string<uuid> | null

Root of the tree.

quantity
integer

How many of this node the work covers.

cycleTimeSec
integer

Cycle time per unit, in seconds.

durationSec
integer

Total duration, in seconds.

peopleNum
integer

How many people the node is planned for.

costCode
string | null

Cost code.

data
object

Per-concept fields for this type.

computed
object

Values BuildingSwell derives from the tree on every read. All read-only: anything you send here is ignored.