Update Task

Update Task

Restart a subtask. Can be applied on a checkpoint only. If state of the task is other then completed, then the restart from the checkpoint is not possible

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

ID of the task

Query Parameters
string
action
Required

The update to be performed on the task - resume

string
checkpointId
Optional

The update to be performed on the task - resume

Request Body
Array of object of type(s) application/json
Optional 
[
    {}
]
Responses
200

Checkpoint ID for the subtask to restart.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


401

Unauthorized access

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


404

Checkpoint doesn't exist

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


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