FRAMES | NO FRAMES Description | Parameters | Examples | Response
Mark Step as Done (Operation)
URL http://<step-url>/markAsDone
Parent Resource Step

Description

Marks the current step of a job workflow as completed.

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

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.

Example Usage

Example 1: URL for marking step 12 as complete on job ID 5 in the "Workflow" service on sampleserver.

http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/workflow/steps/12/markAsDone?user=cjones

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
    }
  ]
}