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

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

The request is successful

Returns Presentation of type(s) application/json;version=39.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

Optional

string

vroId

Optional

vroId

array of WsParameter

inputParameters