Start Workflow Presentation

Start Workflow Presentation

Creates a new instance of the presentation of a workflow, by using the passed parameters. To create a new instance of a workflow presentation, make an HTTP GET request at the URL that contains the instances of the workflow presentation. Presentation's 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 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 presentation.

Request
URI
POST
https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances
COPY
Path Parameters
string
workflowId
Required

workflowId


Request Body
ExecutionContext of type(s) application/json
Optional
{
    "parameters": [
        {
            "description": "string",
            "encryptValue": false,
            "name": "string",
            "scope": "string",
            "type": "string",
            "updated": false,
            "value": {
                "inputType": "string"
            }
        }
    ]
}
parameters
Optional

parameters

Authentication
This operation uses the following authentication methods.
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
id
Optional

id

string
name
Optional

name

string
objectId
Optional

objectId

parameters
Optional

parameters

string As date-time As date-time
startDate
Optional

startDate

string
startedBy
Optional

startedBy

array of StepInfo
steps
Optional

steps

boolean
valid
Optional

valid


201

Created

Operation doesn't return any data structure

400

The request is invalid(validation error)

Operation doesn't return any data structure

401

The user is not authorized

Operation doesn't return any data structure

403

Forbidden

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