assignStep

1
/{orgId}/{itemId}/jobs/{jobId}/{stepId}

Update the assignment of the current step in a job based on the current user's Workflow Manager assignment privileges. Updating a step assignment creates a new job progress document for it with the new assignment and a notification is sent to apps listening to it. The different privileges provide different levels of access for changing assignments.

If you have more than one privilege, you get access based on your highest privilege level. Jobs can be unassigned and unassigned jobs can be assigned to users or groups as per the privilege level.

A step can be assigned without specifying the stepId and instead currentStep can be used to denote the current step.

The assignment is not updated in the following cases:

• If the step is not the current step on the job.
• If the job is closed.
• If the step is currently running.
• If the group is not associated with Workflow Manager role.
• If the group is a private group that the current user is not associated with.
• If a value is not provided for user or group.
• If the value provided for user or group doesn't exist.
• If the job does not have a diagram associated with it.

Query parameters

Body parameters

Supported content types: application/json

Type: AssignmentBody

Assignment values to be applied to the step

Path parameters

Response status

Examples

Request

1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobs/{jobId}/{stepId} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"assignedTo":"string","assignedType":"Unassigned"}'

Response

1
2
3
{
  "success": true
}