Update Workflow Presentation Instance

Update Workflow Presentation Instance

Update a specific workflow presentation instance. 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. If the parameter's 'updated' flag is set to true, the dependent field values are recalculated.

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

workflowId

string
presentationExecutionId
Required

presentationExecutionId

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"
            }
        }
    ]
}
array of WsParameter
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=36.3 
{
    "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

array of WsParameter
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


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

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

Operation doesn't return any data structure

404

Cannot find a workflow or presentation instance with specified ID

Operation doesn't return any data structure

Availability
Deprecated in 36.0
With alternative: see
vRO Forms Overlay API Marked As Internal
On This Page
Vro Workflow Presentation Operations
DELETE
Delete Workflow Presenation Instance
GET
Get All Workflow Presentation Instances
GET
Get Workflow Presentation
GET
Get Workflow Presentation Instance
POST
Start Workflow Presentation
PUT
Update Workflow Presentation Instance