Executing a Workflow as a Job

This operation executes a workflow as a job.

More Details

Path Parameters

workflowname string required

Query Parameters

outputOnly boolean

application/json

Request Body

Workflow_StartWorkflow object
outputFormat string
options object
inputs object
Input1 string
Input2 integer
Input3 string
client object
clientName string

Responses

application/json

Schema
Example (from schema)
Executing a Workflow as a Job - This request executes a workflow named " Demo - New Machine Request" The workflow uses four workflow level inputs.

Schema

sessionId string
message string
processStepId integer
dialogType integer
jobId integer
iconType integer
html boolean
workflow object
workflowName string
workflowId integer
commCell object
_type_ integer
commCellName string
newName string
GUID string
commCellId integer
csGUID string
flags object
client object
hostName string
clientId integer
clientName string
_type_ integer
commCellName string
commCellId integer
clientGUID string
properties object

{
  "sessionId": "string",
  "message": "string",
  "processStepId": 0,
  "dialogType": 0,
  "jobId": 0,
  "iconType": 0,
  "html": true,
  "workflow": {
    "workflowName": "string",
    "workflowId": 0
  },
  "commCell": {
    "_type_": 0,
    "commCellName": "string",
    "newName": "string",
    "GUID": "string",
    "commCellId": 0,
    "csGUID": "string",
    "flags": {}
  },
  "client": {
    "hostName": "string",
    "clientId": 0,
    "clientName": "string",
    "_type_": 0,
    "commCellName": "string",
    "commCellId": 0,
    "clientGUID": "string"
  },
  "properties": {}
}

{
  "sessionId": "c72a4d37-0b96-4947-8e2b-f7a093bd4dca",
  "message": "<html>Your new machine request has been submitted for approval<br></html>",
  "processStepId": 1333,
  "dialogType": 0,
  "jobId": 287,
  "iconType": 0,
  "html": false,
  "workflow": {
    "workflowName": "Demo - New Machine Request",
    "workflowId": 14
  },
  "commCell": {
    "_type_": 1,
    "commCellName": "firewalltestcs",
    "newName": "",
    "GUID": "",
    "commCellId": 2,
    "csGUID": "",
    "flags": {}
  },
  "client": {
    "hostName": "FirewallTestCS.test.com",
    "clientId": 2,
    "clientName": "firewalltestcs",
    "_type_": 3,
    "commCellName": "firewalltestcs",
    "commCellId": 2,
    "clientGUID": "3D2BECB0-B5AB-4911-BF0E-E956174D752A"
  },
  "properties": {}
}

Executing a Workflow as a Job​

Executing a Workflow as a Job