Start Interaction Presentation

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

parameter

Responses
200

The request is successful

Returns execution of type(s) application/json 
{
    "valid": false,
    "name": "string",
    "description": "string",
    "start-date": "string",
    "href": "string",
    "id": "string",
    "started-by": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    },
    "object-id": "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"
        }
    ],
    "parameters": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ]
}
boolean
valid
Optional

valid

string
name
Optional

name

string
description
Optional

description

string As date-time As date-time
start-date
Optional

start-date

string
href
Optional

href

string
id
Optional

id

string
started-by
Optional

started-by

Relations
relations
Optional

relations

string
object-id
Optional

object-id

array of StepInfo
steps
Optional

steps

array of parameter
parameters
Optional

parameters


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

On This Page
Workflow User Interaction Presentation Service Operations
GET
All Interaction Presentations
DELETE
Delete Workflow Execution
GET
Get Presentation For Interaction
GET
Load Execution
POST
Start Interaction Presentation
POST
Update Presentation
PUT
Update Presentation