Read Task Properties

Get information about the specified task

Request

URI

GET

https://nsxmanager.your.domain/api/v1/tasks/{task-id}

COPY

Path Parameters

string

task-id

Required

ID of task to read

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns TaskProperties of type(s) application/json

This response body class contains all of the following: Resource , InlineTaskProperties1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "status": "string",
    "async_response_available": false,
    "description": "string",
    "start_time": 0,
    "cancelable": false,
    "request_method": "string",
    "user": "string",
    "progress": 0,
    "message": "string",
    "request_uri": "string",
    "id": "string",
    "end_time": 0
}

303

See other

Returns TaskProperties of type(s) application/json

This response body class contains all of the following: Resource , InlineTaskProperties1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "status": "string",
    "async_response_available": false,
    "description": "string",
    "start_time": 0,
    "cancelable": false,
    "request_method": "string",
    "user": "string",
    "progress": 0,
    "message": "string",
    "request_uri": "string",
    "id": "string",
    "end_time": 0
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure