Domain concepts
Preview a progress action
Work out what a progress action would do without writing anything. Use it before a destructive action such as rework so you can show the consequences first.
POST
Preview 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 would change.
The planned effect. Nothing has been written.