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

Get All Tasks

Description

This API retrieves all the tasks and also provides ability to filter tasks based on filter criteria.

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
dag_id Optional

filters the response based on the property “dag_id”


string
entities.notif_uuid Optional

filters the response based on the nested property “entities.notif_uuid”


string
entities.policy_name Optional

filters the response based on the nested property “entities.policy_name”


integer
limit Optional

Requested number of resources to be provided in response


string
notification_ids Optional

filters the response based on the notification ids. This field can have comma(,) separted values


integer
offset Optional

Requested index for start of resources to be provided in response


string
status Optional

filters the response based on status type

Possible values are: IN_PROGRESSCOMPLETEDFAILED


string
time_range Optional

Get data for last {time_range}. The format for time range is “last-{the int number}-{min/hour/days/week/month}”

time_range example
"last-5-min"

string
type Optional

type of tasks user wants to retreive

Possible values are: NOTIFICATIONREMEDIATION


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of 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


500

Internal server error

Code Samples

Code Samples

cURL Command

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


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

Was this page helpful?