Start Workflow Execution

Start Workflow Execution

Creates a new instance of a workflow's run, by using the passed parameters. The workflow run is an asynchronous, so the call does not return a response body.

Request
URI
POST
https://{api_host}/vco/api/workflows/{workflowId}/executions
COPY
Path Parameters
string
workflowId
Required

workflowId

Request Body
execution-context of type(s) application/json
Optional 
{
    "executionId": "string",
    "parameter": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "profilerOptions": {
        "enabled": false,
        "debuggerEnabled": false
    }
}
Responses
200

successful operation

Returns workflow-execution of type(s) application/json 
"workflow-execution Object"
string
href
Optional

href

object
relations
Optional

relations

string
id
Optional

id

string
state
Optional

state

Possible values are : CANCELED, COMPLETED, RUNNING, SUSPENDED, WAITING, STATE_WAITING_ON_SIGNAL, FAILED, INITIALIZING,
array of object
inputParameters
Optional

inputParameters

array of object
outputParameters
Optional

outputParameters

string As date-time As date-time
start-date
Optional

start-date

string As date-time As date-time
end-date
Optional

end-date

string
business-state
Optional

business-state

string
started-by
Optional

started-by

string
name
Optional

name

string
content-exception
Optional

content-exception

string
current-item-display-name
Optional

current-item-display-name

array of object
workflow-item
Optional

workflow-item

array of object
workflowAttributes
Optional

workflowAttributes

string
current-item-for-display
Optional

current-item-for-display

object
statistic
Optional

statistic


202

The request is successful

Operation doesn't return any data structure

400

The request is invalid(validation error)

Operation doesn't return any data structure

401

The user is not authorized

Operation doesn't return any data structure

404

Cannot find a workflow with the specified ID or the user does not have 'read' access rights for that workflow

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/vco/api/workflows/{workflowId}/executions
On This Page
Workflow Run Service Operations
GET
Get All Executions For
POST
Start Workflow Execution
GET
Get Workflow Execution
DELETE
Delete Workflow Execution
GET
Get User Interaction
POST
Answer User Interaction
GET
Get Workflow Execution Logs
GET
Get Workflow Execution State
DELETE
Cancel Workflow Execution
GET
Get Workflow Execution Statistics
GET
Get Workflow Execution Syslogs