Execute Steps (Operation)

URL	`http://<steps-url>/execute`
Parent Resource	Steps

Description

Executes the specified steps in order.

The possible values for the executionResult response property and their meanings are as follows:

1 : The step executed successfully
2 : Dependent on a step in another job
3 : Dependent on a stage in another job
4 : Dependent on a status in another job
5 : Blocked by an active job hold
6 : Dependent on a previous step in this job's workflow
7 : The step was marked as complete
8 : The step is assigned to another user
9 : The step is assigned to another group
10 : The job is assigned to another user/group
11 : The job is closed
12 : The step is configured for a different platform (desktop vs. server)
13 : Invalid step
14 : Dependent on another job
15 : The step is not the current workflow step

Parameters

Parameter	Details
f	Description: The response format. The default response format is html. Values: html \| json
user	Required Description: The username of the client.
auto	Description: Whether to automatically execute as many steps as possible, based on the workflow configuration. The default is `false`, meaning only execute the specified steps. Values: true \| false
steps	Required Description: The current steps to execute. This list is a comma delimited list of step IDs.

Example Usage

Example 1: URL for executing only steps 12 and 13 on job ID 5 in the "Workflow" service on sampleserver.

http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/workflow/steps/execute?user=cjones&steps=12,13

Example 2: URL for auto-executing steps on job ID 5 in the "Workflow" service on sampleserver.

http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/workflow/steps/execute?user=cjones&steps=12,13&auto=true

JSON Response Syntax

{
  "executeInfo": [
    {
      "hasReturnCode": <true | false>,
      "returnCode": <returnCode1>,
      "threwError": <true | false>,
      "errorCode": <errorCode1>,
      "errorDescription": "<errorDescription1>",
      "jobId": <jobId>,
      "stepId": <stepId1>,
      "executionResult": <executionResult1>,
      "hasConflicts": <true | false>,
      "conflicts": {
        "jobId": <jobId>,
        "stepId": <stepId1>,
        "spawnsConcurrency": <true | false>,
        "options": [
          {
            "returnCode": <returnCode1>,
            "steps": [
              { "id": <stepId11>, "name": "<stepName11>" },
              { "id": <stepId12>, "name": "<stepName12>" },
              ...
            ]
          },
          {
            "returnCode": <returnCode2>,
            "steps": [
              { "id": <stepId21>, "name": "<stepName21>" },
              { "id": <stepId22>, "name": "<stepName22>" },
              ...
            ]
          },
          ...
        ]
      }
    },
    {
      "hasReturnCode": <true | false>,
      "returnCode": <returnCode2>,
      "threwError": <true | false>,
      "errorCode": <errorCode2>,
      "errorDescription": "<errorDescription2>",
      "jobId": <jobId>,
      "stepId": <stepId2>,
      "executionResult": <executionResult2>,
      "hasConflicts": <true | false>,
      "conflicts": {
        ...
      }
    },
    ...
  ]
}

JSON Response Example

{
  "executeInfo": [
    {
      "hasReturnCode": true,
      "returnCode": 1,
      "threwError": false,
      "errorCode": 0,
      "errorDescription": "",
      "jobId": 5,
      "stepId": 12,
      "executionResult": 1,
      "hasConflicts": false,
      "conflicts": null
    },
    {
      "hasReturnCode": true,
      "returnCode": 2,
      "threwError": false,
      "errorCode": 0,
      "errorDescription": "",
      "jobId": 5,
      "stepId": 13,
      "executionResult": 1,
      "hasConflicts": true,
      "conflicts": {
        "jobId": 5,
        "stepId": 13,
        "spawnsConcurrency": false,
        "options": [
          {
            "returnCode": 2,
            "steps": [
              { "id": 18, "name": "Publish Edits" },
              { "id": 21, "name": "Make Additional Edits" }
            ]
          }
        ]
      }
    }
  ]
}