Workflow

URL	`http://<job-url>/workflow`
Supported Operations	Recreate Workflow
Parent Resource	Job
Child Resources	Steps

Description

Represents the workflow structure of a job. The workflow information can be represented either as an image of the workflow diagram, or as a JSON description of the workflow model (steps, paths, and annotations).

Parameters

Parameter	Details
f	Description: The response format. The default response format is html. Values: html \| json \| image

Example Usage

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

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

Example 2: URL for the workflow image of job ID 5 in the "Workflow" service on sampleserver.

http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/workflow?f=image

Example 3: URL for the JSON workflow specification of job ID 5 in the "Workflow" service on sampleserver.

http://sampleserver/arcgis/rest/services/Workflow/WMServer/jobs/5/workflow?f=json

JSON Response Syntax

{
  "workflow": {
    "steps": [
      {
        "stepId": <stepId>,
        "stepType": <stepExecutionType>,  // Valid values: 1 (executable), 2 (function), 3 (procedural), 4 (launch URL), 5 (question), 6 (open file)
        "shape": <shapeType>,  // Valid values: 1 (rounded rectangle), 2 (rectangle), 3 (oval), 4 (diamond), 5 (parallelogram)
        "label": "<stepLabel>",
        "width": <pixelWidth>,
        "height": <pixelHeight>,
        "fillColor": [ <red>, <green>, <blue>, <alpha> ],
        "outlineColor": [ <red>, <green>, <blue>, <alpha> ],
        "labelColor": [ <red>, <green>, <blue>, <alpha> ],
        "coordinates": [ [ <xCenterCoordinate>, <yCenterCoordinate> ] ]
      },
      ...
    ],
    "paths": [
      {
        "sourceStepId": <sourceStepId>,
        "destStepId": <destinationStepId>,
        "numLabels": <numberOfLabels>,
        "label": "<pathLabel>",
        "labelX": <xLabelCoordinate>,
        "labelY": <yLabelCoordinate>,
        "lineColor": [ <red>, <green>, <blue>, <alpha> ],
        "labelColor": [ <red>, <green>, <blue>, <alpha> ],
        "coordinates": [ [ <xCoordinate1>, <yCoordinate1> ], [ <xCoordinate2>, <yCoordinate2> ], ... ],
        "pathObject": {
          "isDefault": <true | false>,
          "numReturnValues": <numberOfReturnValues>,
          "returnValue0": <returnValue0>,
          "returnValue1": <returnValue1>,
          ...
        }
      },
      ...
    ],
    "annotations": [
      {
        "label": "<annotationLabel>",
        "width": <pixelWidth>,
        "height": <pixelHeight>,
        "fillColor": [ <red>, <green>, <blue>, <alpha> ],
        "outlineColor": [ <red>, <green>, <blue>, <alpha> ],
        "labelColor": [ <red>, <green>, <blue>, <alpha> ],
        "coordinates": [ [ <xCenterCoordinate>, <yCenterCoordinate> ] ]
      },
      ...
    ]
  }
}

JSON Response Example

{
  "workflow": {
    "steps": [
      {
        "stepId": 14,
        "stepType": 2,
        "shape": 1,
        "label": "QA-QC Data",
        "width": 100,
        "height": 50,
        "fillColor": [ 128, 255, 255, 255 ],
        "outlineColor": [ 0, 0, 0, 255; ],
        "labelColor": [ 0, 0, 0, 255 ],
        "coordinates": [ [ 250, 300 ] ]
      }
    ],
    "paths": [
      {
        "sourceStepId": 14,
        "destStepId": 16,
        "numLabels": 1,
        "label": "Success",
        "labelX": 210,
        "labelY": 360,
        "lineColor": [ 0, 0, 0, 255 ],
        "labelColor": [ 128, 128, 128, 255 ],
        "coordinates": [ [ 250, 345 ] ],
        "pathObject": {
          "isDefault": false,
          "numReturnValues": 1,
          "returnValue0": 2
        }
      }
    ],
    "annotations": [
      {
        "label": "Status: Working",
        "width": 150,
        "height": 40,
        "fillColor": [ 230, 230, 255, 255 ],
        "outlineColor": [ 64, 64, 64, 255 ],
        "labelColor": [ 0, 0, 0, 255 ],
        "coordinates": [ [ 175, 120 ] ]
      }
    ]
  }
}