List Tasks

List Tasks

API code: LIST_TASKS
Pre-authorized role(s): ANONYMOUS
Platform(s): AMAZON | OSIS | CLOUDIAN | ECS

Request
URI
GET
https://apaas-29.eng.vmware.com//api/v1/core/tasks
COPY
Query Parameters
string
order
Optional

The sort spec of the collection. The value is of pattern 'property ASC|DESC'. Only single property order is supported.
Examples:

  • lastModifiedDate DESC
  • name ASC

integer
offset
Optional

The start index of items to return for the current page.

integer
limit
Optional

The max count of items to return for the current page.

string
filter
Optional

The RSQL expression to filter page results based on property comparison.
The logical operations include:

  • Logical AND ';' or 'and'
  • Logical OR ',' or 'or'
The comparison operations include:
  • Equal to '=='
  • Not equal to '!='
  • Less than '=lt=' or '<'
  • Less than or equal to '=le=' or '<='
  • Greater than operator '=gt=' or '>'
  • Greater than or equal to '=ge=' or '>='
  • In '=in='
  • Not in '=out='
The logic operations can be grouped by parentheses:
  • (..)
  • (..);(..)
  • (..),(..)
To know which property supports which filter operators, please refer to the type resource, e.g. /api/v1/types/bucket.
Date property value format must be ISO8601 compliant, e.g. yyyy-MM-ddTHH:mm:ss.SSSZ. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D.
Examples:
  • lastModifiedDate<2018-10-14T02:36:08.262%2D0000
  • foo1=="value1" and foo2>value2
  • foo1=in=(value1,value2);foo2=out=(value3,value4,value5),foo3==value6*value7

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PageTask of type(s) application/json 
{
    "items": [
        {
            "id": "string",
            "vcdId": "string",
            "vcdAssociationId": "string",
            "description": "string",
            "status": "string",
            "resourceType": "string",
            "resourceKey": "string",
            "progress": 0,
            "tenant": "string",
            "owner": "string",
            "startDate": "string",
            "endDate": "string",
            "reason": "string",
            "metadata": {
                "metadata": "string"
            }
        }
    ],
    "pageInfo": {
        "offset": 0,
        "limit": 0,
        "total": 0
    }
}
array of Task
items
Optional

items

PageInfo
pageInfo
Optional

pageInfo


On This Page
Task Management Operations
POST
Cancel Task
GET
Get Task
GET
List Tasks