Task

Describes the task object.

Properties

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_PROGRESS , COMPLETED , FAILED

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: NOTIFICATION , REMEDIATION , COLLECTOR

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.

JSON Example

Show optional properties

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

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

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

telco-cloud-service-assurance

Returned By

Get All Tasks
Get Task

Task

Properties

JSON Example

Returned By

Was this page helpful?