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

Description

Retrieves a workflow run for a given workflow.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/workflows/{workflowId}/executions/{executionId}
Copy

Path Parameters

Path Parameters

string
workflowId Required

workflowId


string
executionId Required

executionId


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns WsWorkflowExecution of type(s) application/json;version=36.3

Workflow execution successfully retrived

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

string
name Optional

array of WsParameter
outputParameters Optional

relations Optional

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


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