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

{
    "steps": [
        {
            "readOnly": false,
            "elements": [
                {
                    "id": "string",
                    "hidden": false,
                    "display-name": "string",
                    "description": "string",
                    "messages": [
                        {
                            "Summary": "string",
                            "Details": "string",
                            "severity": "string",
                            "code": "string"
                        }
                    ]
                }
            ],
            "id": "string",
            "description": "string",
            "display-name": "string",
            "hidden": false,
            "messages": [
                {
                    "Summary": "string",
                    "Details": "string",
                    "severity": "string",
                    "code": "string"
                }
            ]
        }
    ],
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "attribute": [
                    {
                        "displayValue": "string",
                        "value": "string",
                        "name": "string"
                    }
                ],
                "href": "string",
                "type": "string",
                "rel": "string"
            }
        ]
    },
    "id": "string",
    "name": "string",
    "description": "string",
    "inputParameters": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "outputParameters": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ]
}

array of StepInfo

steps

Optional

steps

string

href

Optional

href

Relations

relations

Optional

relations