Start Workflow Execution Deprecated
DescriptionInstantiates 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
URLURL
Path Parameters
Path Parameters
workflowId
Request Body
{
"parameters": [
{
"description": "string",
"encryptValue": false,
"name": "string",
"scope": "local",
"type": "string",
"updated": false,
"value": {
"inputType": "string"
}
}
]
}
Authentication
Response
Response BodyResponse Body
201 Created
Workflow execution instance has been created
{
"businessState": "string",
"contentException": "string",
"currentItemDisplayName": "string",
"endDate": "string",
"id": "string",
"inputParameters": [
{
"description": "string",
"encryptValue": false,
"name": "string",
"scope": "local",
"type": "string",
"updated": false,
"value": {
"inputType": "string"
}
}
],
"name": "string",
"outputParameters": [
{
"description": "string",
"encryptValue": false,
"name": "string",
"scope": "local",
"type": "string",
"updated": false,
"value": {
"inputType": "string"
}
}
],
"relations": {
"link": [
{
"attributes": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"name": "string",
"rel": "string",
"type": "string"
}
],
"start": 0,
"total": 0
},
"startDate": "string",
"startedBy": "string",
"state": "canceled"
}
Possible values are: canceled , completed , running , suspended , waiting , waiting-signal , failed , initializing
Errors
The request is invalid(validation error)
The user is not authorized
Forbidden
Cannot find a workflow with the specified ID or the user does not have ‘read’ access rights for that workflow
Code Samples
cURL Command
Availability
With alternative: vRO Forms Overlay API Marked As Internal
