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

Start Workflow Presentation

Description

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

Request

URL

URL


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

Path Parameters

Path Parameters

string
workflowId Required

workflowId


Request Body

Request Body

ExecutionContext of type(s) application/json Required

executionContext

{
	"parameters": [
		{
			"description": "string",
			"encryptValue": false,
			"name": "string",
			"scope": "local",
			"type": "string",
			"updated": false,
			"value": {
				"inputType": "string"
			}
		}
	]
}
array of WsParameter
parameters Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created 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

400

The request is invalid(validation error)


401

The user is not authorized


403

Forbidden


404

Cannot find a workflow with the specified ID or the user does not have ‘read’ access rights for that workflow

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"parameters":[{"description":"string","encryptValue":false,"name":"string","scope":"local","type":"string","updated":false,"value":{"inputType":"string"}}]}' https://{api_host}/cloudapi/workflows/{workflowId}/presentation/instances


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