Domain concepts
Apply a progress action
Apply the action for real. It cascades through the tree, stops work sessions, and clears daily-plan assignments for nodes that become done.
Call /plan first if you want to show the effect before committing.
POST
Apply a progress action
Authorizations
Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.
Path Parameters
Root of the tree the node belongs to.
Record id.
Body
application/json
- Option 1
- Option 2
- Option 3
A progress action, keyed on type. Send this rather than patching the progress object directly.
complete finishes the remaining quantity. rework sends the node back. put-on-hold and resume-work toggle the hold.
Available options:
complete, rework, put-on-hold, resume-work Response
What the action changed.
The applied effect.