Query Task List

Query Task List

The response code corresponds to the task list being successfully retrieved, and not to the asynchoronous operations themselves. The status of the asynchronous operation(s) can be viewed in the response body.

Tasks are per cell and remain in memory till the respective appliance node is rebooted. This means that tasks that were triggered prior to reboot are lost upon reboot.

Request
URI
GET
https://{api_host}/api/1.0.0/tasks
COPY
Query Parameters
string
filter
Optional

query filter. values may be "status==running", "status==failed", or "status==stopped"

string
sortAsc
Optional

sortAsc=field means to sort on field in ascending order. values may be "startedAt" or "stoppedAt"

string
sortDesc
Optional

sortDesc=field means to sort on field in descending order. values may be "startedAt" or "stoppedAt"

integer
page
Optional
Constraints: minimum: 1 default: 1

The number of pages to skip before starting to collect the result set. page sequence starts at 1.

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 100 default: 20

The number of items that may be returned in a page.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TaskList of type(s) application/json 
{
    "resultTotal": 0,
    "pageCount": 0,
    "pageSize": 0,
    "listOfTasks": [
        {
            "id": "string",
            "result": {
                "message": "string",
                "result": [
                    "string"
                ]
            },
            "startedAt": "string",
            "status": "string",
            "stoppedAt": "string",
            "url": "string"
        }
    ]
}
integer As int32 As int32
resultTotal
Optional

How many results there are in total (i.e., considering all pages).

integer As int32 As int32
pageCount
Optional

How many pages there are in total.

integer As int32 As int32
pageSize
Optional

Result count for page that was fetched.

array of object
listOfTasks
Optional

List of Task objects.


400

400 BAD REQUEST

Operation doesn't return any data structure

404

404 NOT FOUND

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/1.0.0/tasks
Availability
Added in 36
On This Page
Task List Operations
GET
Query Task List