Get Presentation For
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}/vco/api/workflows/{workflowId}/presentation
COPY
Path Parameters
string
workflowId
Required
workflowId
Responses
200
The request is successful
Returns presentation of type(s) application/json
{
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"steps": [
{
"hidden": false,
"display-name": "string",
"elements": [
{
"hidden": false,
"display-name": "string",
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"id": "string"
}
],
"description": "string",
"messages": [
{
"severity": "string",
"Details": "string",
"code": "string",
"Summary": "string"
}
],
"readOnly": false,
"id": "string"
}
],
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
]
}string
name
Optional
name
string
description
Optional
description
string
href
Optional
href
string
id
Optional
id
401
The user is not authorized
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
Workflow Presentation Service Operations
GET
All Presentation
DELETE
Delete Workflow Execution
GET
Get Presentation For
GET
Load Execution
POST
Start Presentation
POST
Update Presentation
PUT
Update Presentation