Start Interaction Presentation

Creates a new instance of a workflow user interaction presentation by using the passed parameters. To create a new instance of a workflow user interaction presentation, make an HTTP GET request at the URL that contains the instances of that workflow user interaction presentation. Presentation fields are populated with input parameter values and are validated. If there are any validation errors, they are collected and attached to each field. The presentation is marked as invalid. In order the returned workflow user interaction presentation to be 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 user interaction presentation.

Request

URI

POST

https://{api_host}/vco/api/workflows/{workflowId}/executions/{executionId}/interaction/presentation/instances

COPY

Path Parameters

string

workflowId

Required

workflowId

string

executionId

Required

executionId

Request Body

execution-context of type(s) application/json

Optional

{
    "executionId": "string",
    "parameter": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "profilerOptions": {
        "enabled": false,
        "debuggerEnabled": false
    }
}

string

executionId

Optional

executionId

array of parameter

parameter

Optional

parameter

WsProfilerOptions

profilerOptions

Optional

profilerOptions

Responses

200

The request is successful

Returns execution 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"
                }
            ]
        }
    ],
    "parameters": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "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",
    "object-id": "string",
    "valid": false,
    "start-date": "string",
    "started-by": "string"
}

array of StepInfo

steps

Optional

steps

array of parameter

parameters

Optional

parameters

string

href

Optional

href