Bulk Poll

Bulk Poll

This request returns the tasks that are specified in the body. Use this API for efficient task polling. Note: The specified tasks are filtered - which is not considered critical. The task execution continues as normal.

Request
URI
POST
https://{api_host}//tasks/poll
COPY
Query Parameters
string
site
Optional

Optional site to retrieve the task from. Could be a remote site or the local one.

site example 
site1
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body

List of task UUIDs

Array of string of type(s) application/json
Optional 
[
    "03275f31-92eb-49dc-b4cc-41d7ddc8f00f"
]
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TasksPollResponse of type(s) application/json;charset=UTF-8 
{
    "propertyNames": [
        "string"
    ],
    "values": [
        "start"
    ]
}
array of string
propertyNames
Optional

A list of property names.

array
values
Optional

A list of values.


400

The returned error codes include (but are not limited to): BadUserInput

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


401

The returned error codes include (but are not limited to): NotAuthenticated, RemoteAuthenticationFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


404

The returned error codes include (but are not limited to): SiteNotFound, TaskNotFound

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Tasks Operations
POST
Bulk Poll
GET
Get One
GET
Query Tasks