[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Get Workflow Presentation Instance Deprecated
DescriptionRetrieves 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
URLURL
https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances/{presentationExecutionId}
Path Parameters
Path Parameters
string
workflowId
Required
workflowId
string
presentationExecutionId
Required
presentationExecutionId
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PresentationExecution
of type(s) application/json;version=36.3
The request is successful
{
"description": "string",
"id": "string",
"name": "string",
"objectId": "string",
"parameters": [
{
"description": "string",
"encryptValue": false,
"name": "string",
"scope": "local",
"type": "string",
"updated": false,
"value": {
"inputType": "string"
}
}
],
"startDate": "string",
"startedBy": "string",
"steps": [
{
"description": "string",
"displayName": "string",
"elementType": "string",
"elements": [
{
"description": "string",
"displayName": "string",
"elementType": "string",
"hidden": false,
"id": "string",
"messages": [
{
"code": "string",
"details": "string",
"severity": "INFO",
"summary": "string"
}
]
}
],
"hidden": false,
"id": "string",
"messages": [
{
"code": "string",
"details": "string",
"severity": "INFO",
"summary": "string"
}
],
"readOnly": false
}
],
"valid": false
}
string
description
Optional
string
id
Optional
string
name
Optional
string
objectId
Optional
string as date-time
startDate
Optional
string
startedBy
Optional
boolean
valid
Optional
Errors
401
The user is not authorized
403
The user does not have ‘read’ access rights for that workflow
404
Cannot find a workflow with the specified ID
Code Samples
cURL Command
curl https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances/{presentationExecutionId}
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Deprecated in 36.0
With alternative: vRO Forms Overlay API Marked As Internal
With alternative: vRO Forms Overlay API Marked As Internal
