[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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

PageOfTask

Represents a page of elements of a single type


Properties

array of Task
elements Optional

The list of elements included in this page


pageMetadata Optional

Pageable elements pagination metadata information

JSON Example

{
	"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,
			"localizableDescriptionPack": {
				"arguments": [
					"string"
				],
				"component": "string",
				"message": "string",
				"messageKey": "string"
			},
			"name": "string",
			"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
			"resources": [
				{
					"fqdn": "sfo-vc01.rainpole.io",
					"name": "string",
					"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
					"sans": [
						"sfo-vc01.rainpole.io"
					],
					"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
				}
			],
			"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
			"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": "sfo-vc01.rainpole.io",
							"name": "string",
							"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
							"sans": [
								"sfo-vc01.rainpole.io"
							],
							"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSX_MANAGER, NSXT_MANAGER, VRA, VRLI, VROPS, VRSLCM, VXRAIL_MANAGER"
						}
					],
					"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, NOT_APPLICABLE",
					"subTasks": "SubTask Object",
					"type": "string"
				}
			],
			"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
		}
	],
	"pageMetadata": {
		"pageNumber": 0,
		"pageSize": 0,
		"totalElements": 0,
		"totalPages": 0
	}
}
[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"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
Returned By

Get Tasks

Feedback

Was this page helpful?