[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get Tasks

Description

Get the Tasks

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/tasks
Copy

Query Parameters

Query Parameters

integer
completedAfter Optional

A time based filter to get tasks which are completed after the given timestamp. A task is completed if its status is ‘Successsful’ or ‘Failed’. Time is in milliseconds.


integer
limit Optional

The number of elements to be returned in the result


string
resourceId Optional

resourceId


string
resourceType Optional

resourceType


string
taskStatus Optional

taskStatus


string
taskType Optional

taskType


Response

Response

Response Body

Response Body

200 OK returns PageOfTask of type(s) application/json

Returns the list of tasks.

{
	"elements": [
		{
			"completionTimestamp": "string",
			"creationTimestamp": "string",
			"errors": [
				{
					"arguments": [
						"string"
					],
					"causes": [
						{
							"message": "string",
							"type": "string"
						}
					],
					"context": {
						"key": "string"
					},
					"errorCode": "string",
					"errorType": "string",
					"message": "string",
					"nestedErrors": "Error Object",
					"referenceToken": "string",
					"remediationMessage": "string"
				}
			],
			"id": "string",
			"isCancellable": false,
			"name": "string",
			"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
			"resources": [
				{
					"fqdn": "string",
					"name": "string",
					"resourceId": "string",
					"sans": [
						"string"
					],
					"type": "string"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
			"subTasks": [
				{
					"completionTimestamp": "string",
					"creationTimestamp": "string",
					"description": "string",
					"errors": [
						{
							"arguments": [
								"string"
							],
							"causes": [
								{
									"message": "string",
									"type": "string"
								}
							],
							"context": {
								"key": "string"
							},
							"errorCode": "string",
							"errorType": "string",
							"message": "string",
							"nestedErrors": "Error Object",
							"referenceToken": "string",
							"remediationMessage": "string"
						}
					],
					"name": "string",
					"resources": [
						{
							"fqdn": "string",
							"name": "string",
							"resourceId": "string",
							"sans": [
								"string"
							],
							"type": "string"
						}
					],
					"stages": [
						{
							"completionTimestamp": "string",
							"creationTimestamp": "string",
							"description": "string",
							"errors": [
								{
									"arguments": [
										"string"
									],
									"causes": [
										{
											"message": "string",
											"type": "string"
										}
									],
									"context": {
										"key": "string"
									},
									"errorCode": "string",
									"errorType": "string",
									"message": "string",
									"nestedErrors": "Error Object",
									"referenceToken": "string",
									"remediationMessage": "string"
								}
							],
							"name": "string",
							"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
							"type": "string"
						}
					],
					"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
					"subTasks": "SubTask Object",
					"type": "string"
				}
			],
			"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
array of Task
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information

Errors

Errors

500

Unexpected error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/tasks


[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?