[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

Get Task

Description

This API retrieves the specific tasks using id.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

The id of task.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Task of type application/json

No content

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

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


number
start_time Required

The start time of task in epoch millis.


string
status Required

The current status of task.

Possible values are: IN_PROGRESSCOMPLETEDFAILED


number
end_time Required

The end time of task in epoch millis.


array of object
entities Required

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


string
id Required

Unique identifier for task.


array of string
notification_ids Required

List of notification ids on which the action is performed.


string
type Required

Which type of task user wants to create.

Possible values are: NOTIFICATIONREMEDIATIONCOLLECTOR


string
user_name Required

The name of the user


string
dag_id Optional

This field is specific to remediation task. dag_id represent dag_id created for airflow pipeline.


string
details Optional

The details of performing action.

Errors

Errors

401

User authentication failed


403

Access to the requested resource/operation is forbidden


404

Cannot find requested resource


500

Internal server error

Code Samples

Code Samples

cURL Command

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


[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Feedback

Was this page helpful?