Patch Task

Patch Task

This API enables user to update the existing task.

Request
URI
PATCH
https://{api_host}/tcsa.host.com/tcsa/api/v1/tasks/{id}
COPY
Path Parameters
string
id
Required

The id of task.

Request Body

Request to update task.

TaskPatchRequest of type(s) application/json
Required 
{
    "status": "IN_PROGRESS",
    "end_time": "number",
    "action": "ACKNOWLEDGE",
    "details": "Performing ack operation",
    "entities": [
        {}
    ]
}
string
status
Optional

The current status of task.

Possible values are : IN_PROGRESS, COMPLETED, FAILED,
number
end_time
Optional

The end time of task in epoch millis.

string
action
Optional

The name of the action e.g. ADD_USER, ACKNOWLEDGE or REMEDIATION.

string
details
Optional

The details of performing action.

array of object
entities
Optional

entities

Authentication
This operation uses the following authentication methods.
Responses
204

No content

Operation doesn't return any data structure

400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

On This Page
Task Operations
POST
Create Task
GET
Get All Tasks
GET
Get Task
PATCH
Patch Task