Start Workflow Execution

Start Workflow Execution

Instantiates a workflow run, by using the passed parameters. The workflow run is asynchronous, so the call returns a pointer to a task that can be used to track the workflow run.

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

workflowId

Request Body
ExecutionContext of type(s) application/json
Optional 
{
    "parameters": [
        {
            "description": "string",
            "encryptValue": false,
            "name": "string",
            "scope": "string",
            "type": "string",
            "updated": false,
            "value": {
                "inputType": "string"
            }
        }
    ]
}
array of WsParameter
parameters
Optional

parameters

Authentication
This operation uses the following authentication methods.
Responses
201

Workflow execution instance has been created

Returns WsWorkflowExecution of type(s) application/json;version=39.0 
{
    "businessState": "string",
    "contentException": "string",
    "currentItemDisplayName": "string",
    "endDate": "string",
    "id": "string",
    "inputParameters": [
        {
            "description": "string",
            "encryptValue": false,
            "name": "string",
            "scope": "string",
            "type": "string",
            "updated": false,
            "value": {
                "inputType": "string"
            }
        }
    ],
    "name": "string",
    "outputParameters": [
        {
            "description": "string",
            "encryptValue": false,
            "name": "string",
            "scope": "string",
            "type": "string",
            "updated": false,
            "value": {
                "inputType": "string"
            }
        }
    ],
    "relations": {
        "total": 0,
        "link": [
            {
                "attributes": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "rel": "string",
                "type": "string",
                "name": "string"
            }
        ],
        "start": 0
    },
    "startDate": "string",
    "startedBy": "string",
    "state": "string"
}
string
businessState
Optional

businessState

string
contentException
Optional

contentException

string
currentItemDisplayName
Optional

currentItemDisplayName

string As date-time As date-time
endDate
Optional

endDate

string
id
Optional

id

array of WsParameter
inputParameters
Optional

inputParameters

string
name
Optional

name

array of WsParameter
outputParameters
Optional

outputParameters

Relations
relations
Optional

Definition of Relations.

string As date-time As date-time
startDate
Optional

startDate

string
startedBy
Optional

startedBy

ExecutionState
state
Optional

state

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

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

403

Forbidden

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

Availability
Added in 30.0
Deprecated in 36.0
With alternative: see
vRO Forms Overlay API Marked As Internal
Removed in 39.0
On This Page
Vro Workflow Execution Operations
DELETE
Cancel Workflow Execution
DELETE
Delete Workflow Execution
GET
Get All Workflow Executions
GET
Get Parameter Types
GET
Get Supportedconstraints
GET
Get Supported Decorators
GET
Get Supported Presentation Elements
GET
Get Workflow Execution
GET
Get Workflow Execution State
POST
Start Workflow Execution