Ack Notifications

Ack Notifications

This API is used for acknowledge multiple notifications.

Request
URI
POST
https://{api_host}/tcsa/api/notification-management/v1/ack-notifications
COPY
Request Body
MultiselectNotificationRequest of type(s) application/json
Required 
{
    "ids": [
        "Name:NOTIFICATION-Router_qa-Vpls4_DiscoveryError$Source:INCHARGE-SA-PRES$",
        "Name:NOTIFICATION-Router_dev-Vpls7_Unresponsive$Source:INCHARGE-SA-PRES$"
    ],
    "audit_text": "acknowledge"
}
array of string
ids
Optional

Notification Ids on which action to be performed

string
audit-text
Optional

Audit text to be added for the action

Authentication
This operation uses the following authentication methods.
Responses
202

Task Id to get status of the request

Returns MultiselectNotificationResponse of type(s) application/json 
{
    "href": "/tcsa/api/v1/tasks/Ay2poYYBJZK7mTHo85kO",
    "id": "Ay2poYYBJZK7mTHo85kO",
    "type": "NOTIFICATION",
    "status": "IN_PROGRESS",
    "start_time": "1677749514934",
    "end_time": "1677749514944",
    "action": "AUDIT_LOG",
    "details": "verified",
    "user_name": "admin",
    "entities": [],
    "notification_ids": [
        "Name:NOTIFICATION-Router_qa-Vpls4_DiscoveryError$Source:INCHARGE-SA-PRES$",
        "Name:1111NOTIFICATION-Router_dev-Vpls7_Unresponsive$Source:INCHARGE-SA-PRES$"
    ],
    "dag_id": "dag_id"
}
string
id
Optional

Task Id to fetch the status of the action

string
href
Optional

url to get task details

string
type
Optional

on which object task is created

string
status
Optional

task status COMPLETE or IN_PROGRESS

string
action
Optional

describes the action

string
details
Optional

details of the action

string
user_name
Optional

loged in user who performed action

array of object
entities
Optional

entities

string
start_time
Optional

task created time

string
end_time
Optional

task completed time

array of string
notification_ids
Optional

notification_ids

string
dag_id
Optional

dag id


400

Invalid Request sent by the user

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/tcsa/api/notification-management/v1/ack-notifications
On This Page
Notification Operations
POST
Get Notifications
POST
Get Notification Summary
POST
Get Max Severity For Devices
POST
Get Notification History
POST
Get Causes
POST
Get Caused By
POST
Get Audit Trail
POST
Action On Notifications
POST
Get Server Tools
POST
Perform Server Tools Actions
POST
Get Distinct Values Of Notification Property
POST
Export Notifications
POST
Notification Count
POST
Threshold List
POST
Add Audit Logs
POST
Ack Notifications
POST
Unack Notifications
POST
Take Ownership
POST
Release Ownership