steps
List the steps of a flow
/api/v1/flows/{flow_id}/steps
The steps of one version, in order, each with its navigation buttons.
version=draft is reserved to who may edit the flow; it adds faults, what the editor flags on a step. A flow that was never published answers 409 not_published for its published version.
key
Required scope: read
Path parameters
-
flow_idinteger · requiredId of the flow.
Query parameters
-
versionstring · optionalpublished(default) ordraft. The draft is only readable by who may edit the flow.
Response
200
FlowSteps
-
flowFlowThe flow.
13 fields
-
idintegerId, unique among the objects of its type.
-
typestringAlways
flow. -
namestringIts name.
-
rolestring or nullRole of the account on it:
owner,editororreader;nullwhen it holds none of its own. -
online_statusstringonline: open to its readers.offline: closed.pending_online/pending_offline: inside a binder that is not online, hence closed; the setting is recorded and applies when the parent goes online. -
parent_idinteger or nullId of the binder that holds it;
nullat the root of a space. -
organisation_idinteger or nullId of the organisation whose space it lives in;
nullin a personal space. -
ownerOwnerThe account that owns it.
2 fields
-
idintegerId of the account.
-
namestringIts name, or its address when it has none.
-
-
created_atdate-timeWhen it was created.
-
updated_atdate-timeWhen it was last changed.
-
is_publishedbooleanWhether a published version exists.
-
published_atdate-time or nullWhen it was last published;
nullwhen it never was. -
has_unpublished_changesboolean or nullWhether the draft differs from the published version.
nullfor who may not edit the flow.
-
-
versionstringThe version the steps belong to.
-
stepsarray of StepThe steps, in order.
13 fields
-
idintegerId of the step. The draft and the published version of a flow carry different ids.
-
referencestringShort name of the step, unique in its version: what buttons point at.
-
orderintegerRank in the flow, from 1.
-
titlestringTitle. Empty for a reader when the author hid it.
-
contentstringText, as HTML. Empty for a reader when the author hid it.
-
image_urlstring or nullWhere to download the image, with the same credential;
nullwithout image, or when the author hid it from readers. -
image_fitstring or nullcontainshows the whole image,coverfills its frame.null: never chosen, shown ascontain. -
updated_atdate-timeWhen it was last changed.
-
display_titleboolean or nullWhether readers see the title. Only given to who may edit.
-
display_contentboolean or nullWhether readers see the text. Only given to who may edit.
-
display_imageboolean or nullWhether readers see the image. Only given to who may edit.
-
buttonsarray of Button or nullIts navigation buttons, in order.
6 fields
-
idintegerId of the button.
-
labelstringWhat the button says.
-
target_step_idinteger or nullId of the step it leads to;
nullwhen it ends the flow, or when its target was deleted. -
target_referencestringReference of the step it leads to, kept after that step is deleted; empty when it ends the flow.
-
ends_procedurebooleanWhether it ends the flow.
-
target_missingbooleanWhether it points at a step that was deleted. A draft cannot be published while one remains.
-
-
faultsarray of string or nullDraft only, what the editor flags:
missing_target(a button points at a deleted step; blocks publishing) orunreachable(no button of another step leads here).
-
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
404
Nothing with that id, or nothing the account may open.
-
422
A value is missing or malformed.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.