Bulk Poll

Bulk Poll

Requests the tasks that were specified in the body. This API should be used for efficient task polling. Note that the given task will be filtered - tasks that belong to another user won't be retrieved.

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
Accept
Optional

Accept

string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body

List of task ids.

Array of string of type(s) application/json
Optional 
[
    {}
]
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TasksPollResponse of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "propertyNames": [
        "string"
    ],
    "values": [
        [
            {}
        ]
    ]
}
array of string
propertyNames
Optional

propertyNames

array
values
Optional

values


400

Returned error codes include (but are not limited to):

  • BadUserInput
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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

Returned error codes include (but are not limited to):

  • NotAuthenticated
  • RemoteAuthenticationFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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

Returned error codes include (but are not limited to):

  • SiteNotFound
  • TaskNotFound
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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

Returned error codes include (but are not limited to):

  • GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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