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

Ack Notifications

Description

This API is used for acknowledge multiple notifications.

Request

Request

URL

URL


post
https://{api_host}tcsa.host.com/tcsa/api/notification-management/v1/ack-notifications
Copy

Request Body

Request Body

MultiselectNotificationRequest of mimetype application/json Required
{
	"audit_text": "acknowledge",
	"ids": [
		"Name:NOTIFICATION-Router_qa-Vpls4_DiscoveryError$Source:INCHARGE-SA-PRES$",
		"Name:NOTIFICATION-Router_dev-Vpls7_Unresponsive$Source:INCHARGE-SA-PRES$"
	]
}
string
audit-text Optional

Audit text to be added for the action


array of string
ids Optional

Notification Ids on which action to be performed

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns MultiselectNotificationResponse of type application/json

Task Id to get status of the request

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

describes the action


string
dag_id Optional

dag id


string
details Optional

details of the action


string
end_time Optional

task completed time


array of object
entities Optional

string
href Optional

url to get task details


string
id Optional

Task Id to fetch the status of the action


array of string
notification_ids Optional

string
start_time Optional

task created time


string
status Optional

task status COMPLETE or IN_PROGRESS


string
type Optional

on which object task is created


string
user_name Optional

loged in user who performed action

Errors

Errors

400

Invalid Request sent by the user


500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"audit_text":"acknowledge","ids":["Name:NOTIFICATION-Router_qa-Vpls4_DiscoveryError$Source:INCHARGE-SA-PRES$","Name:NOTIFICATION-Router_dev-Vpls7_Unresponsive$Source:INCHARGE-SA-PRES$"]}' https://{api_host}tcsa.host.com/tcsa/api/notification-management/v1/ack-notifications


Feedback

Was this page helpful?