/sequences/{sequenceId}/rank

Place a sequence in the dispatch chain, or take it out. The chain is every ranked sequence of the tenant, active or not, ordered by rank, then by creation time; automatic dispatch tries its active sequences in that order. position is the 1-based place the sequence takes: from 1 to the chain's length when the sequence is ranked, to one more when it is not (to append it). position: null takes it out of the chain, so it runs only when started by hand. Every sequence of the chain is then renumbered 1, 2, 3, … in one write, and each one whose rank changes advances its version; a move that changes no rank writes nothing. The sequence is not checked against the rules of POST /sequences, so a broken one can be taken out. A chain of more than 100 sequences cannot be renumbered in one write and answers 400; take sequences out first (PATCH /sequences/{sequenceId} with rank: null). When another request changed a sequence of the chain meanwhile, the answer is 409 CONCURRENT_UPDATE and nothing is written: list the sequences again and decide anew. The response is the moved sequence as stored, with its summary.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the sequence

Body Params

the place in the dispatch chain, or null

Where to place the sequence in the dispatch chain, or null to take it out.

integer | null
required
1 to 9007199254740991

1-based place in the dispatch chain, the list of every ranked sequence of the tenant, active or not, ordered by rank, then by creation time. 1 is tried first. Valid positions run from 1 to the chain's length after the move: its current length when the sequence is already ranked, one more when it is not (to append it). Every sequence of the chain is renumbered 1, 2, 3, … in that order. null takes the sequence out of the chain, so it runs only when started by hand, and closes the gap it leaves.

Responses

401

unauthorized

403

The role of the API key does not allow this action. The key needs a role with the matching permission, for example full access.

404

sequence not found: no sequence with this ID in the tenant of the key

409

conflict - another request changed a sequence of the chain since it was read (internalCode CONCURRENT_UPDATE). Nothing is written; list the sequences again and decide anew.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json