[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Get Tasks By Entity ID

Description

Get scheduled tasks by entity id

Request

URL

get

https://cloud.vmwarehorizon.com/portal/v1/task/entity/{id}

Copy

Path Parameters

string

id Required

Query Parameters

string

org_id Optional

org_id

string

page Optional

Page number to retrieve.

string

size Optional

Size of each page.

array of string

sort Optional

Ascending/Descending. Format is property,{asc|desc} and default is ascending.

Parameter Serialization Style: form Explode:true

string

type Optional

type

Possible values are: ENTITLEMENT_UNASSIGN_TASK , ENTITLEMENT_CREATE_SYNC_TASK , ENTITLEMENT_PATCH_SYNC_TASK , POOL_PATCH_SYNC_TASK , POOL_DELETE_TASK

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

200 OK

Returns PageTask of type */*

{
	"content": [
		{
			"createdAt": "string",
			"entityId": "string",
			"errorResponse": {
				"errors": [
					{
						"cause": "ErrorDetail Object",
						"code": "string",
						"detail": "string",
						"domain": "string",
						"message": "string",
						"parameters": {
							"key": "string"
						},
						"severity": "string",
						"timestampInUtc": "string"
					}
				],
				"resource": "string",
				"status": 0,
				"traceId": "string"
			},
			"id": "string",
			"location": "string",
			"orgId": "string",
			"sendNotification": false,
			"status": "ERROR",
			"taskDetails": {},
			"taskType": "ENTITLEMENT_CREATE_SYNC_TASK",
			"updatedAt": "string"
		}
	],
	"empty": false,
	"first": false,
	"last": false,
	"number": 0,
	"numberOfElements": 0,
	"pageable": {
		"offset": 0,
		"pageNumber": 0,
		"pageSize": 0,
		"paged": false,
		"sort": {
			"empty": false,
			"sorted": false,
			"unsorted": false
		},
		"unpaged": false
	},
	"size": 0,
	"sort": {
		"empty": false,
		"sorted": false,
		"unsorted": false
	},
	"totalElements": 0,
	"totalPages": 0
}

array of Task

content Optional

boolean

empty Optional

boolean

first Optional

boolean

last Optional

integer as int32

number Optional

integer as int32

numberOfElements Optional

Pageable

pageable Optional

integer as int32

size Optional

Sort

sort Optional

integer as int64

totalElements Optional

integer as int32

totalPages Optional

Errors

ErrorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

404

Not found

ErrorResponse

412

Precondition Failed

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v1/task/entity/{id}

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Portal Operations

get

Get Tasks By Entity ID

Get Tasks By Entity ID

Request

URL

Path Parameters

Query Parameters

Authentication

Bearer

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Portal Operations

Was this page helpful?