page[size]
: The requested number of responses per pagination pagepage[afterCursor]
: The cursor to requests responses after this id, when paginating forwardpage[beforeCursor]
: The cursor to request responses prior to this id, when paginating in reverse.links
section with self
, next
, and previous
as appropriate.uuid
that already exist on the system will be updated (subject to the update_mode
parameter below).update_mode
(Optional): One of the following values that determine whether existing Flows are updated with the submitted definition. (most_recent
is the default.) If an update would be rejected due to existing Flows under most_recent
or never
, the system must respond with 409 Conflict
.always
: Always update existing Flows with the same uuid
s.most_recent
: Update existing Flows when the last_modified
value is more recent than the system has already.never
: Never update existing Flows if they already exist on the system.type
of containers
. It shall contain, within the attributes
parameter, the JSON structure of the Container.uuid
of the Container and each Flow can be omitted (or null) if the client wants the receiving system to assign a new UUID for these. If a uuid
is provided for Flows, the client must ensure that the UUID conforms to the JSON API specification requirements for client-generated IDs:uuid
s; a Container is used only for encapsulation of Flows during data exchange and can be temporary. It is the uuid
of individual Flows that determines Flow identity. An individual Flow can be submitted and/or updated as part of one or more different Containers.204 No Content
response mechanism to report acceptance to clients without sending back long documents.data
array includes the list of flows. Implementations may decide what summary information they want to publish in the attributes
for each package.with_flows
(array): An array of Flow UUIDs to request to be assembled, along with dependent resources, into a Container.vendor_metadata
.type
of run_requests
. It shall contain, within the attributes
parameter, the following information:flow
(uuid)contacts
(array of contacts, optional)urn
to reach them at. (URNs for telephone numbers may omit the "tel:" prefix.) Contacts optionally have a set of current properties
, a preferred_mode
, and a preferred_language
. (Systems may impose limits for the number of contacts supported in one run request.)groups
(array of group identifiers, optional)contacts
or groups
shall be provided. (Systems may impose limits for the number of groups supported in one run request.)default_mode
(string)preferred_mode
.default_language
(string)preferred_language
.delay_until
(date-time, optional)vendor_metadata
(object, optional)vendor_metadata
to avoid collisions. Suggested namespaces use reverse domain name notation, with periods replaced by underscores (e.g.: A vendor with domain https://my.example-flow-server.com would place entries within vendor_metadata.com_example-flow-server_my
).204 No Content
response mechanism to report acceptance to clients without sending back long documents.filter[flow]
: Only include run requests for the Flow given by the specified uuid
.filter[start-timestamp]
: Only show run requests that were posted after this timestamp (exclusive). (This is a timestamp in the format of RFC 3339, section 5.6, date-time
.)filter[end-timestamp]
: Only show run requests that were recorded before and on this timestamp (inclusive). (This is a timestamp in the format of RFC 3339, section 5.6, date-time
.)type
of the resource must be run_requests
.status
of run_requests
shall be one of:SCHEDULED
: The request is delayed and scheduled for the future according to the delay_until
parameter.IN_PROGRESS
: The system is currently executing Flow runs for this request.COMPLETED
: The system has finished executing Flow runs for this request.contacts
and their initial properties may be omitted from the response.type
of the resource must be run_requests
.status
of run_requests
shall be one of:SCHEDULED
: The request is delayed and scheduled for the future according to the delay_until
parameter.IN_PROGRESS
: The system is currently executing Flow runs for this request.COMPLETED
: The system has finished executing Flow runs for this request.contacts
and their initial properties may be omitted from the response.