Get Workflow Presentation Instance

Get Workflow Presentation Instance

Retrieves a specific workflow presentation instance. Presentation instances are removed after the workflow starts. If the presentation instance under requested executionId does not exists, a new presentation instance is created by using the parameters from the workflow execution with the same ID. To retrieve the workflow presentation 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
URI
GET
https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances/{presentationExecutionId}
COPY
Path Parameters
string
workflowId
Required

workflowId

string
presentationExecutionId
Required

presentationExecutionId

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns PresentationExecution of type(s) application/json;version=38.1 
{
    "description": "string",
    "id": "string",
    "name": "string",
    "objectId": "string",
    "parameters": [
        {
            "description": "string",
            "encryptValue": false,
            "name": "string",
            "scope": "string",
            "type": "string",
            "updated": false,
            "value": {
                "inputType": "string"
            }
        }
    ],
    "startDate": "string",
    "startedBy": "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"
                        }
                    ]
                }
            ]
        }
    ],
    "valid": false
}
string
description
Optional

description

string
id
Optional

id

string
name
Optional

name

string
objectId
Optional

objectId

array of WsParameter
parameters
Optional

parameters

string As date-time As date-time
startDate
Optional

startDate

string
startedBy
Optional

startedBy

array of StepInfo
steps
Optional

steps

boolean
valid
Optional

valid


401

The user is not authorized

Operation doesn't return any data structure

403

The user does not have 'read' access rights for that workflow

Operation doesn't return any data structure

404

Cannot find a workflow with the specified ID

Operation doesn't return any data structure

Availability
Deprecated in 36.0
With alternative: see
vRO Forms Overlay API Marked As Internal
On This Page
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