Start Workflow Presentation Deprecated
DescriptionCreates a new instance of the presentation of a workflow, by using the passed parameters. To create a new instance of a workflow presentation, make an HTTP GET request at the URL that contains the instances of the workflow presentation. Presentation’s fields are populated with input parameter values and are validated. If there are any validation errors, they are collected and attached to each field. The presentation is marked as invalid. In order the returned workflow presentation to be localized, add Accept-Language header, with the appropriate locale. In advance, localization resource should be present for the workflow, otherwise it defaults to the standard workflow presentation.
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
200 OK
The request is successful
{
"description": "string",
"id": "string",
"name": "string",
"objectId": "string",
"parameters": [
{
"description": "string",
"encryptValue": false,
"name": "string",
"scope": "local",
"type": "string",
"updated": false,
"value": {
"inputType": "string"
}
}
],
"startDate": "string",
"startedBy": "string",
"steps": [
{
"description": "string",
"displayName": "string",
"elementType": "string",
"elements": [
{
"description": "string",
"displayName": "string",
"elementType": "string",
"hidden": false,
"id": "string",
"messages": [
{
"code": "string",
"details": "string",
"severity": "INFO",
"summary": "string"
}
]
}
],
"hidden": false,
"id": "string",
"messages": [
{
"code": "string",
"details": "string",
"severity": "INFO",
"summary": "string"
}
],
"readOnly": false
}
],
"valid": false
}
201 Created
Created
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
