Get Task | VMware Horizon Server API

Get Task

Note: CPA need not be initialized for the pod for invoking this API. All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_VIEW	Caller should have permission to this privilege, to perform this operation.

Request

URI

GET

https://{api_host}//localhost/rest/federation/v1/cpa/tasks/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns TaskInfo of type(s) */*

{
    "category": "POD_FEDERATION_CATEGORY",
    "id": "a219420d-4799-4517-8f78-39c74c7c4efc",
    "percentage_complete": 80,
    "result": {
        "message": "PodFederation initialization completed.",
        "message_id": "POD_FEDERATION_INIT_SUCCESS.",
        "result_code": "SUCCESS"
    },
    "status": "COMPLETED",
    "type": "POD_FEDERATION_INITIALIZING"
}

string

category

Optional

The category of the task.

POD_FEDERATION_CATEGORY: Category for PodFederation related tasks.

string

Optional

Unique ID representing the task.

integer As int32 As int32

percentage_complete

Optional

The amount of task completed, in percentage.

TaskResult

result

Optional

result

string

status

Optional

The state of the task.

RUNNING: The task is currently running.
WAITING: The task is currently waiting to execute.
COMPLETED: The task execution has completed.
FAILED: The task execution has failed.
PAUSED: The task execution has been paused.
CANCELLED: The task execution has been cancelled.

Possible values are : RUNNING, WAITING, COMPLETED, FAILED, PAUSED, CANCELLED,

string

type

Optional

The type of the task.

POD_FEDERATION_INITIALIZING: Task performing PodFederation initialize operation.
POD_FEDERATION_UNINITIALIZING: Task performing PodFederation uninitialize operation.
POD_FEDERATION_JOINING: Task performing PodFederation join operation.
POD_FEDERATION_UNJOINING: Task performing PodFederation unjoin operation.

Possible values are : POD_FEDERATION_INITIALIZING, POD_FEDERATION_UNINITIALIZING, POD_FEDERATION_JOINING, POD_FEDERATION_UNJOINING,

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page

Description