Load Execution

Load Execution

Retrieves a specific workflow presentation instance. Presentation instances are removed after the workflow starts. If the presentation instance under requested executionId does not exists, a new presentation instance is created by using the parameters from the workflow execution with the same ID. To retrieve the workflow presentation 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
GET
https://{api_host}/vco/api/workflows/{workflowId}/presentation/instances/{executionId}
COPY
Path Parameters
string
workflowId
Required

workflowId

string
executionId
Required

executionId

string
presentationExecutionId
Required

presentationExecutionId

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

403

The user does not have 'read' access rights for that workflow

Operation doesn't return any data structure

404

Cannot find a workflow with the specified ID

Operation doesn't return any data structure

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