assignStep

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

Update the assignment of the current step on a job

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

NameTypeRequired

token

string

Body parameters

Supported content types: application/json

NameTypeRequiredDescription

Assignment values to be applied to the step

body

Assignment values to be applied to the step

Path parameters

NameTypeRequired

jobId

string

stepId

string

orgId

string

itemId

string

Examples

Request

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

Response

StatusMeaningDescriptionSchema

200

OK

success

Success

400

Bad Request

error

WorkflowJsonExceptionDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close