Update assignments

Bulk update the status of a workflow's task assignments. criteria selects the candidate assignments within the workflow; selection picks the assignments within that set (provide ids, or explicitly set include to false to update every candidate; an empty selection is rejected). Setting the status to 6 (Done) or 8 (Unable to Complete) closes the assignments and moves each person on to the connected next task, or removes them from the workflow when there is none; reason/comments are recorded as a note on each person.

Required permission: Full Write Workflows

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

The id of the workflow.

Body Params

The status to set and the assignments to apply it to

status
object | null
required

The status to set, by id: 4 = Not Started, 5 = In Progress, 6 = Done, 7 = Reassign, 8 = Unable to Complete.

string | null

Why the assignments are being marked unable to complete; required when status is 8. Recorded as a note on each person.

string | null

Optional comments recorded as a note on each person when the assignments are completed (status 6).

criteria
object | null

Filters selecting the candidate assignments within the workflow; the same filters as /api/workflows/assignments.

selection
object | null

The assignments the update applies to, within the candidate set.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

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