List Tasks

List Tasks

List all tasks with optional filtering.

Request
URI
GET
https://vmc.vmware.com/vmc/api/orgs/{org}/tasks
COPY
Path Parameters
string
org
Required

Organization identifier

Query Parameters
string
$filter
Optional

Filter expression

Binary Operators: 'eq', 'ne', 'lt', 'gt', 'le', 'ge', 'mul', 'div', 'mod', 'sub', 'add' Unary Operators: 'not', '-' (minus) String Operators: 'startswith', 'endswith', 'length', 'contains', 'tolower', 'toupper',

Nested attributes are composed using '.'

Dates must be formatted as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss[.SSS]Z

Strings should enclosed in single quotes, escape single quote with two single quotes

The special literal 'created' will be mapped to the time the resource was first created.

Examples:

  • $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e)
  • $filter=(created eq 2016-08-09)
  • $filter=(created gt 2016-08-09) and (sddc.status eq 'READY')

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns Array of Task of type(s) application/json
[
    {
        "updated": "string",
        "user_id": "string",
        "updated_by_user_id": "string",
        "created": "string",
        "version": 5,
        "updated_by_user_name": "string",
        "user_name": "string",
        "id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
        "status": "string",
        "localized_error_message": "string",
        "resource_id": "string",
        "parent_task_id": "string",
        "task_version": "string",
        "correlation_id": "string",
        "start_resource_entity_version": 0,
        "customer_error_message": "string",
        "sub_status": "string",
        "task_type": "string",
        "start_time": "string",
        "task_progress_phases": [
            {
                "id": "string",
                "name": "string",
                "progress_percent": 0
            }
        ],
        "error_message": "string",
        "org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
        "end_resource_entity_version": 5,
        "service_errors": [
            {
                "default_message": "string",
                "original_service": "string",
                "localized_message": "string",
                "original_service_error_code": "string"
            }
        ],
        "org_type": "string",
        "estimated_remaining_minutes": 4,
        "progress_percent": 75,
        "phase_in_progress": "string",
        "resource_type": "string",
        "end_time": "string"
    }
]

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure