/workflow/stop
POST
Stops instructions
Parameters in the POST body schema
Name | Type | Description | Example | Default |
---|---|---|---|---|
controllerId |
required, string | Controller ID | myController | |
workflowId |
required, object | Workflow ID specified by its path and optional version | {
"path": "/path/to/workflow",
"versionId": "c79caab4-4e72-4818-bae7-902f1037d8b6"
} |
|
path |
required, string | Field in workflowId to specify the path of a workflow |
||
versionId |
optional, string | Field in workflowId to specify the version of a workflow |
||
positions |
optional, array[array or string] | Positions of the Workflow instructions The position can also be specified by the label of the instruction. |
[[1]] or ["myJob"] | |
auditLog |
optional, object | Object that contains comment , timeSpent and ticketLink . |
{ "comment": "Operational requirement!", "timeSpent": 2 } |
|
comment |
optional, string | Field in auditLog to comment this action, e.g. the reason. |
||
timeSpent |
optional, integer | Field in auditLog to enter the time spent in minutes. |
||
ticketLink |
optional, string | Field in auditLog to enter a link to a corresponding ticket. |
Request