[{"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

Start Workflow Execution

Description

Instantiates a workflow run, by using the passed parameters. The workflow run is asynchronous, so the call returns a pointer to a task that can be used to track the workflow run.

Request

Request

URL

URL


post
https://{api_host}/cloudapi/workflows/{workflowId}/executions
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

Definition of WsParameter.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns WsWorkflowExecution of type(s) application/json;version=37.0

Workflow execution instance has been created

{
	"businessState": "string",
	"contentException": "string",
	"currentItemDisplayName": "string",
	"endDate": "string",
	"id": "string",
	"inputParameters": [
		{
			"description": "string",
			"encryptValue": false,
			"name": "string",
			"scope": "local",
			"type": "string",
			"updated": false,
			"value": {
				"inputType": "string"
			}
		}
	],
	"name": "string",
	"outputParameters": [
		{
			"description": "string",
			"encryptValue": false,
			"name": "string",
			"scope": "local",
			"type": "string",
			"updated": false,
			"value": {
				"inputType": "string"
			}
		}
	],
	"relations": {
		"link": [
			{
				"attributes": [
					{
						"displayValue": "string",
						"name": "string",
						"value": "string"
					}
				],
				"href": "string",
				"name": "string",
				"rel": "string",
				"type": "string"
			}
		],
		"start": 0,
		"total": 0
	},
	"startDate": "string",
	"startedBy": "string",
	"state": "canceled"
}
string
businessState Optional

string
contentException Optional

string
currentItemDisplayName Optional

string as date-time
endDate Optional

string
id Optional

array of WsParameter
inputParameters Optional

Definition of WsParameter.


string
name Optional

array of WsParameter
outputParameters Optional

Definition of WsParameter.


relations Optional

Definition of Relations.


string as date-time
startDate Optional

string
startedBy Optional

state Optional

Possible values are: canceledcompletedrunningsuspendedwaitingwaiting-signalfailedinitializing

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}/executions


[{"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?