Task Manager Read Next Tasks By View Spec

Returns TaskInfo data objects based on the specified TaskManagerTaskViewSpec, TaskFilterSpec and TaskInfoFilterSpec parameters.

Returns an empty array when there are no tasks matching the filtering parameters.

Since: vSphere API Release 9.0.0.0

Required privileges: System.View

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/TaskManager/{moId}/ReadNextTasksByViewSpec

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case TaskManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Request Body

ReadNextTasksByViewSpecRequestType of type(s) application/json

Required

"ReadNextTasksByViewSpecRequestType Object"

viewSpec

Required

The view parameters for the tasks query.

filterSpec

Required

The specification for the task query filter.

infoFilterSpec

Optional

The specification for the task info filter.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

TaskInfo data objects matching the filtering parameters.

[
    "TaskInfo Object"
]

array of TaskInfo

Optional

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/TaskManager/{moId}/ReadNextTasksByViewSpec

Availability

Added in vSphere API Release 9.0.0.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST