Get Task

Get Task

Get the details of a specified task.

Request
URI
GET
https://{api_host}/https://{{host}}:{{port}}/api/v5/task/{taskId}
COPY
Path Parameters
integer
taskId
Required

ID of the task

Responses
200

Details of requested tasks.

Returns Task of type(s) */* 
{
    "id": 0,
    "taskType": "string",
    "subTasks": {
        "subTasks": {
            "canBeRestarted": false,
            "name": "string",
            "status": "string",
            "message": {},
            "nextSubTasks": {
                "nextSubTasks": "string"
            },
            "ignoreStatus": false,
            "checkpointId": 0,
            "checkpointFK": 0,
            "snapshots": {
                "snapshots": "string"
            }
        }
    },
    "totalSnapshots": [
        "string"
    ],
    "uid": "string",
    "metaProps": {
        "metaProps": {}
    },
    "taskRef": 0,
    "message": {},
    "automatic": false,
    "status": "string",
    "environmentId": "string",
    "nextTaskId": 0,
    "taskName": "string",
    "next_tasks": [
        0
    ]
}
integer As int64 As int64
id
Optional

The task ID.

string
taskType
Optional

The type of the task.

Possible values are : ENVIRONMENT_DEPLOY, ENVIRONMENT_IMPORT, ENVIRONMENT_VALIDATE, ENVIRONMENT_DELETE, UPGRADE, UPGRADE_VALIDATE, CERTIFICATE_UPDATE, NODE_ADD, NODE_UPDATE, NODE_REDEPLOY, NODE_DELETE, NODE_POWER, ALL_NODES_UPDATE, DATACENTER_REGISTER, DATACENTER_VALIDATE, DATACENTER_UPDATE, DATACENTER_DELETE, DATACENTER_DISCOVER, PRODUCT_DISCOVER, PRODUCT_DELETE, INTEGRATION_ADD, INTEGRATION_UPDATE, INTEGRATION_DELETE, VCPLCM_SUPPORT,
object
subTasks
Optional

The sub tasks executed as part of this task.

array of string
totalSnapshots
Optional

totalSnapshots

string
uid
Optional

uid

object
metaProps
Optional

metaProps

integer As int64 As int64
taskRef
Optional

taskRef

object
message
Optional

The task's result message - empty if successful, in case of error the sub task and failure messages are returned.

boolean
automatic
Optional

automatic

string
status
Optional

The task's status based on the status of all sub tasks.

Possible values are : NOT_STARTED, IN_PROGRESS, SUCCESS, ERROR, CANCELLED, MANUAL, MANDATORY, DEFAULT,
string
environmentId
Optional

The environment ID of the environment that this task is defined for.

integer As int64 As int64
nextTaskId
Optional

nextTaskId

string
taskName
Optional

The task's name.

array of integer
next_tasks
Optional

The list of tasks waiting for this task to finish.


401

Unauthorized access

Returns Task of type(s) */* 
{
    "id": 0,
    "taskType": "string",
    "subTasks": {
        "subTasks": {
            "canBeRestarted": false,
            "name": "string",
            "status": "string",
            "message": {},
            "nextSubTasks": {
                "nextSubTasks": "string"
            },
            "ignoreStatus": false,
            "checkpointId": 0,
            "checkpointFK": 0,
            "snapshots": {
                "snapshots": "string"
            }
        }
    },
    "totalSnapshots": [
        "string"
    ],
    "uid": "string",
    "metaProps": {
        "metaProps": {}
    },
    "taskRef": 0,
    "message": {},
    "automatic": false,
    "status": "string",
    "environmentId": "string",
    "nextTaskId": 0,
    "taskName": "string",
    "next_tasks": [
        0
    ]
}
integer As int64 As int64
id
Optional

The task ID.

string
taskType
Optional

The type of the task.

Possible values are : ENVIRONMENT_DEPLOY, ENVIRONMENT_IMPORT, ENVIRONMENT_VALIDATE, ENVIRONMENT_DELETE, UPGRADE, UPGRADE_VALIDATE, CERTIFICATE_UPDATE, NODE_ADD, NODE_UPDATE, NODE_REDEPLOY, NODE_DELETE, NODE_POWER, ALL_NODES_UPDATE, DATACENTER_REGISTER, DATACENTER_VALIDATE, DATACENTER_UPDATE, DATACENTER_DELETE, DATACENTER_DISCOVER, PRODUCT_DISCOVER, PRODUCT_DELETE, INTEGRATION_ADD, INTEGRATION_UPDATE, INTEGRATION_DELETE, VCPLCM_SUPPORT,
object
subTasks
Optional

The sub tasks executed as part of this task.

array of string
totalSnapshots
Optional

totalSnapshots

string
uid
Optional

uid

object
metaProps
Optional

metaProps

integer As int64 As int64
taskRef
Optional

taskRef

object
message
Optional

The task's result message - empty if successful, in case of error the sub task and failure messages are returned.

boolean
automatic
Optional

automatic

string
status
Optional

The task's status based on the status of all sub tasks.

Possible values are : NOT_STARTED, IN_PROGRESS, SUCCESS, ERROR, CANCELLED, MANUAL, MANDATORY, DEFAULT,
string
environmentId
Optional

The environment ID of the environment that this task is defined for.

integer As int64 As int64
nextTaskId
Optional

nextTaskId

string
taskName
Optional

The task's name.

array of integer
next_tasks
Optional

The list of tasks waiting for this task to finish.


On This Page
Task Operations
GET
Get Task
GET
Get Task Request
GET
Get Tasks
POST
Restart Task
PUT
Update Task