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.

ApiKeyAuth

Responses

200

The request is successful

Returns PresentationExecution of type(s) application/json;version=39.0

{
    "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

Optional

string

name

Optional

name

string

objectId