Create Task

Create Task

This API enables user to create task.

Request
URI
POST
https://{api_host}/tcsa/api/v1/tasks
COPY
Request Body

Request structure for creating task.

TaskCreateRequest of type(s) application/json
Required

Show optional properties

{
    "type": "NOTIFICATION",
    "status": "IN_PROGRESS",
    "action": "ACKNOWLEDGE",
    "notification_ids": [
        {}
    ]
}
{
    "type": "NOTIFICATION",
    "status": "IN_PROGRESS",
    "action": "ACKNOWLEDGE",
    "details": "Performing ack operation",
    "notification_ids": [
        "id1",
        "id2"
    ],
    "dag_id": "xxxxxx",
    "entities": [
        {}
    ]
}
string
type
Required

Which type of task user wants to create.

Possible values are : NOTIFICATION, REMEDIATION, ESCALATION,
string
status
Required

The current status of task.

Possible values are : IN_PROGRESS, COMPLETED, FAILED,
string
action
Required

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

string
details
Optional

The details of performing action.

array of string
notification_ids
Required

List of notification ids on which the action is performed.

string
dag_id
Optional

dag id, specific to REMEDIATION tasks.

array of object
entities
Optional

This field contains the details specific to the Task type (NOTIFICATION/REMEDIATION)

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns TaskCreateResponse of type(s) application/json 
"TaskCreateResponse Object"
string
id
Required

Unique id of newly created resource.

Response Headers

string
Location

Provide information about the location of a newly created resource.


401

Client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

The client does not have access rights to the content; that is, it is Client must authenticate itself to get the requested response

Operation doesn't return any data structure

404

The server can not find the requested resource

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"type:"string","status:"string","action:"string","user_name":"{}","notification_ids":["string"]}' https://{api_host}/tcsa/api/v1/tasks
On This Page
Task Operations
POST
Create Task
GET
Get All Tasks
PATCH
Patch Task
GET
Get Task