Start Workflow Execution

• Workflow Run Service

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

ExecutionContext of type(s) application/json

Required

{
    "executionId": "string",
    "parameters": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "profilerOptions": {
        "enabled": false,
        "debuggerEnabled": false,
        "tokenReplayEnabled": false
    }
}

string

executionId

Optional

executionId

array of object

parameters

Optional

parameters

object

profilerOptions

Optional

profilerOptions

Authentication

This operation uses the following authentication methods.

BearerAuth

BasicAuth

Responses

202

Hide Details

The request is successful

Returns WsWorkflowExecution of type(s) application/json

"WsWorkflowExecution Object"

object

relations

Optional

relations

string

id

Optional

id

string

state

Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,

string

name

Optional

name

string

href

Optional

href

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

running-instance-id

Optional

running-instance-id

string

content-exception

Optional

content-exception

string

current-item-display-name

Optional

current-item-display-name

array of object

execution-stack

Optional

execution-stack

array of object

workflowAttributes

Optional

workflowAttributes

string

current-item-for-display

Optional

current-item-for-display

object

statistic

Optional

statistic

array of object

formInputs

Optional

formInputs

400

Hide Details

The request is invalid(validation error)

Returns WsWorkflowExecution of type(s) application/json

"WsWorkflowExecution Object"

object

relations

Optional

relations

string

id

Optional

id

string

state

Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,

string

name

Optional

name

string

href

Optional

href

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

running-instance-id

Optional

running-instance-id

string

content-exception

Optional

content-exception

string

current-item-display-name

Optional

current-item-display-name

array of object

execution-stack

Optional

execution-stack

array of object

workflowAttributes

Optional

workflowAttributes

string

current-item-for-display

Optional

current-item-for-display

object

statistic

Optional

statistic

array of object

formInputs

Optional

formInputs

401

Hide Details

The user is not authorized

Returns WsWorkflowExecution of type(s) application/json

"WsWorkflowExecution Object"

object

relations

Optional

relations

string

id

Optional

id

string

state

Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,

string

name

Optional

name

string

href

Optional

href

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

running-instance-id

Optional

running-instance-id

string

content-exception

Optional

content-exception

string

current-item-display-name

Optional

current-item-display-name

array of object

execution-stack

Optional

execution-stack

array of object

workflowAttributes

Optional

workflowAttributes

string

current-item-for-display

Optional

current-item-for-display

object

statistic

Optional

statistic

array of object

formInputs

Optional

formInputs

404

Hide Details

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

Returns WsWorkflowExecution of type(s) application/json

"WsWorkflowExecution Object"

object

relations

Optional

relations

string

id

Optional

id

string

state

Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,

string

name

Optional

name

string

href

Optional

href

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

running-instance-id

Optional

running-instance-id

string

content-exception

Optional

content-exception

string

current-item-display-name

Optional

current-item-display-name

array of object

execution-stack

Optional

execution-stack

array of object

workflowAttributes

Optional

workflowAttributes

string

current-item-for-display

Optional

current-item-for-display

object

statistic

Optional

statistic

array of object

formInputs

Optional

formInputs

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

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Workflow Run Service Operations

GET

Get All Executions For

POST

Start Workflow Execution

GET

Get User Interaction

POST

Answer User Interaction

DELETE

Cancel User Interaction

GET

Get Workflow Execution

DELETE

Delete Workflow Execution

GET

Export Execution Logs 1

GET

Get Workflow Execution Statistics

GET

Get Workflow Execution State

DELETE

Cancel Workflow Execution

GET

Get Workflow Execution Logs