Get Workflow Presentation
Retrieves the definition of a workflow presentation. To retrieve the workflow presentation definition 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 definition.
Request
URI
GET
https://{api_host}/cloudapi/workflows/{workflowId}/presentation
COPY
Path Parameters
string
workflowId
Required
workflowId
Responses
200
The request is successful
Returns Presentation of type(s) application/json;version=38.0
{
"description": "string",
"id": "string",
"vroId": "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"
}
}
],
"steps": [
{
"elementType": "string",
"description": "string",
"displayName": "string",
"hidden": false,
"id": "string",
"messages": [
{
"code": "string",
"details": "string",
"severity": "string",
"summary": "string"
}
],
"readOnly": false,
"elements": [
{
"elementType": "string",
"description": "string",
"displayName": "string",
"hidden": false,
"id": "string",
"messages": [
{
"code": "string",
"details": "string",
"severity": "string",
"summary": "string"
}
]
}
]
}
]
}
string
description
Optional
description
string
id
Optional
id
string
vroId
Optional
vroId
string
name
Optional
name
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
Deprecated in 36.0
With alternative: see
vRO Forms Overlay API Marked As Internal
Vro Workflow Presentation Operations
DELETE
Delete Workflow Presenation Instance
GET
Get All Workflow Presentation Instances
GET
Get Workflow Presentation
GET
Get Workflow Presentation Instance
POST
Start Workflow Presentation
PUT
Update Workflow Presentation Instance