Object lifecycle flows
The states records move through — draft, approved, end-of-life, whatever the workspace defines — and who may move them. Objects created while a flow is active start in its initial state.
List flows
Beta — this operation may change on 30 days notice. See versioning.
Returns the workspace's object lifecycle flows, each with its states. At most one is active at a time.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsm_activesort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List flows › Responses
Success
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's states, in display order.
Create a flow
Beta — this operation may change on 30 days notice. See versioning.
Defines the states objects move through and who may move them. New objects start in the initial state. Answers 409 while an active flow exists — update or delete that one instead.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Create a flow › Responses
Created
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's states, in display order.
Get a flow
Beta — this operation may change on 30 days notice. See versioning.
Returns the flow with its states, its transitions, and the roles each transition requires.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a flow › Responses
Success
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's states, in display order.
Update a flow
Beta — this operation may change on 30 days notice. See versioning.
Replaces the flow's states and transitions. Objects already sitting in a state the new definition drops keep that value until something moves them.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a flow › Responses
Success
sm_idsm_activesm_createdsm_updatedsm_object_criteriaThe moves the machine allows. roles and users are alternatives — holding one of the roles or being one of the users is enough — and naming neither leaves the move open to anyone who can write the record.
sm_metadataThe flow's states, in display order.
Delete a flow
Beta — this operation may change on 30 days notice. See versioning.
Stops objects being governed. Records keep the state they are in.
Requires the module-objects license feature. Without it the request is refused with 403 license_required — see plans and modules.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a flow › Responses
Success. No content.