[{"label":"Latest (v37.0)","version":"latest"},{"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

Description

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

Request

URL

URL


get
https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances/{presentationExecutionId}
Copy

Path Parameters

Path Parameters

string
workflowId Required

workflowId


string
presentationExecutionId Required

presentationExecutionId


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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": [
		{}
	],
	"valid": false
}
string
description Optional

string
id Optional

string
name Optional

string
objectId Optional

array of WsParameter
parameters Optional

string as date-time
startDate Optional

string
startedBy Optional

array of StepInfo
steps Optional

boolean
valid Optional
Errors

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

Code Samples

cURL Command

curl https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances/{presentationExecutionId}


[{"label":"Latest (v37.0)","version":"latest"},{"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
Feedback

Was this page helpful?