Get Presentation For Interaction

Get Presentation For Interaction

Retrieves the definition of a user interaction presentation. To retrieve the definition of a user interaction presentation, make an HTTP GET request at the URL of the presentation. Pass the workflow and execution IDs as a path variable. To retrieve the user interaction presentation definition localized, add Accept-Language header, with the appropriate locale. In advance, localization resource should be present for the workflow of the user interaction, otherwise it defaults to the standard user interaction presentation definition.

Request
URI
GET
https://{api_host}/vco/api/workflows/{workflowId}/executions/{executionId}/interaction/presentation
COPY
Path Parameters
string
workflowId
Required

workflowId

string
executionId
Required

executionId


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",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ],
    "outputParameters": [
        {
            "scope": "string",
            "name": "string",
            "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

relations
Optional

relations

array of StepInfo
steps
Optional

steps

array of parameter
inputParameters
Optional

inputParameters

array of parameter
outputParameters
Optional

outputParameters


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