[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Create Task

Description

This API enables user to create task.

Request

URL

post

https://{api_host}tcsa.host.com/tcsa/api/v1/tasks

Copy

Request Body

TaskCreateRequest of mimetype application/json Required

Request structure for creating task.

Show optional properties

{
    "action": "ACKNOWLEDGE",
    "notification_ids": [
        "id1",
        "id2"
    ],
    "status": "IN_PROGRESS",
    "type": "NOTIFICATION"
}

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

string

action Required

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

array of string

notification_ids Required

List of notification ids on which the action is performed.

string

status Required

The current status of task.

Possible values are: IN_PROGRESS , COMPLETED , FAILED

string

type Required

Which type of task user wants to create.

Possible values are: NOTIFICATION , REMEDIATION

string

dag_id Optional

dag id, specific to REMEDIATION tasks.

string

details Optional

The details of performing action.

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.

201 Created

Returns TaskCreateResponse of type application/json

string

id Required

Unique id of newly created resource.

Response Headers

string

Location

Provide information about the location of a newly created resource.

Errors

401

Client must authenticate itself to get the requested response

403

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

404

The server can not find the requested resource

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"action":"ACKNOWLEDGE","dag_id":"xxxxxx","details":"Performing ack operation","notification_ids":["id1","id2"],"status":"IN_PROGRESS","type":"NOTIFICATION"}' https://{api_host}tcsa.host.com/tcsa/api/v1/tasks

[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Task Operations

post

Create Task

get

Get All Tasks

get

Get Task

patch

Patch Task

Create Task

Request

URL

Request Body

Authentication

bearerAuth

Response

Response Body

201 Created

Response Headers

Errors

Code Samples

cURL Command

On This Page

Task Operations

Was this page helpful?