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",
"profilerOptions": {
"debuggerEnabled": false,
"enabled": false
},
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
]
}string
executionId
Optional
executionId
Responses
200
successful operation
Returns workflow-execution of type(s) application/json
{
"statistic": {
"total-time": 0,
"token-blocked": 0,
"token-system": 0,
"token-user": 0,
"token-wait": 0,
"activities": [
{
"total-time": 0,
"number-of-executions": 0,
"max-time": 0,
"activities": [
"activity-statistics Object"
],
"number-of-transitions": 0,
"id": "string"
}
],
"plugins": [
{
"total-time": 0,
"number-of-executions": 0,
"details": [
{
"value": 0,
"key": "string"
}
],
"plugin-name": "string"
}
],
"number-of-transitions": 0,
"total-number-of-transitions": 0,
"id": "string",
"token-size": 0
},
"start-date": "string",
"workflow-item": [
{
"displayName": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"name": "string",
"workflowDisplayName": "string",
"href": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}
],
"started-by": "string",
"content-exception": "string",
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"workflowAttributes": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"current-item-display-name": "string",
"end-date": "string",
"name": "string",
"href": "string",
"id": "string",
"state": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"current-item-for-display": "string",
"business-state": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
]
}string As date-time As date-time
start-date
Optional
start-date
string
started-by
Optional
started-by
string
content-exception
Optional
content-exception
string
current-item-display-name
Optional
current-item-display-name
string As date-time As date-time
end-date
Optional
end-date
string
name
Optional
name
string
href
Optional
href
string
id
Optional
id
string
state
Optional
state
Possible values are : CANCELED, COMPLETED, RUNNING, SUSPENDED, WAITING, STATE_WAITING_ON_SIGNAL, FAILED, INITIALIZING,
string
current-item-for-display
Optional
current-item-for-display
string
business-state
Optional
business-state
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
On This Page
Workflow Run Service Operations
POST
Answer User Interaction
DELETE
Cancel Workflow Execution
DELETE
Delete Workflow Execution
GET
Get All Executions For
GET
Get User Interaction
GET
Get Workflow Execution
GET
Get Workflow Execution Logs
GET
Get Workflow Execution State
GET
Get Workflow Execution Statistics
GET
Get Workflow Execution Syslogs
POST
Start Workflow Execution