FRAMES | NO FRAMES Description | Parameters | Examples | Response
Step
URL http://<steps-url>/<stepId>
Supported Operations Can Run  Execute  Mark as Done  Move to Next  Resolve Conflict  Set as Current  Log Comment
Parent Resource Steps
Child Resources Description  File  Comments

Description

Represents a single step in a job workflow.

Parameters

Parameter Details
f Description: The response format. The default response format is html.

Values: html | json

Example Usage

Example 1: URL for step ID 14 of job ID 5 in the "Workflow" service on sampleserver.

http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/workflow/steps/14

JSON Response Syntax

{
  "id": <stepId>,
  "name": "<stepName>",
  "commonId": <commonId>,
  "assignedType": <assignedType>,  // Valid values: 0 (unassigned), 1 (user), 2 (group)
  "assignedTo": "<assignedTo>",
  "async": <true | false>,
  "autoRun": <true | false>,
  "canSkip": <true | false>,
  "canSpawnConcurrency": <true | false>,
  "hasBeenStarted": <true | false>,
  "hasBeenExecuted": <true | false>,
  "selfCheck": <true | false>,
  "statusId": <statusId>,
  "defaultPercentComplete": <percentage>,
  "stepPercentComplete": <percentage>,
  "notificationType": "<notificationName>",  // Added at 10.1
  "stepType": {
    "id": <stepTypeId>,
    "name": "<stepTypeName>",
    "description": "<stepTypeDescription>",
    "program": "<program>",
    "arguments": "<arguments>",
    "executionType": <stepExecutionType>,  // Valid values: 1 (executable), 2 (function), 3 (procedural), 4 (launch URL), 5 (question), 6 (open file)
    "visible": <true | false>,
    "stepDescriptionType": <stepDescriptionType>,  // Valid values: 1 (none), 2 (embedded HTML), 3 (link)
    "stepDescriptionLink": "<stepDescriptionLink>",  // Used only when stepDescriptionType = 3
    "stepIndicatorType": <stepIndicatorType>,  // Valid values: 1 (rounded rectangle), 2 (rectangle), 3 (oval), 4 (diamond), 5 (parallelogram)
    "supportedPlatform": <supportedPlatform>  // Valid values: 0 (desktop), 1 (server), 2 (both)
  }
}

JSON Response Example

{
  "id": 14,
  "name": "QA-QC Data",
  "commonId": 20,
  "assignedType": 2,
  "assignedTo": "QA Team",
  "async": false,
  "autoRun": false,
  "canSkip": false,
  "canSpawnConcurrency": true,
  "hasBeenStarted": true,
  "hasBeenExecuted": true,
  "selfCheck": false,
  "statusId": 2,
  "defaultPercentComplete": 85,
  "stepPercentComplete": 50,
  "notificationType": "QualityCheckComplete",
  "stepType": {
    "id": 6,
    "name": "QA-QC Data",
    "description": "Perform quality assurance checks on the edited features.",
    "program": "JTXDesktopSteps.LaunchArcMap",
    "arguments": "",
    "executionType": 2,
    "visible": false,
    "stepDescriptionType": 3,
    "stepDescriptionLink": "http://myserver/workflow/help/QA_Guidelines.html",
    "stepIndicatorType": 1,
    "supportedPlatform": 0
  }
}