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

Action On Notifications

Description

APIs for performing actions on notifications such as ACKNOWLEDGE, UNACKNOWLEDGE,TAKE_OWNERSHIP AND RELEASE_OWNERSHIP.

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
action Required

action to be performed on notifications. Allowed actions values are ACKNOWLEDGE | UNACKNOWLEDGE | TAKE_OWNERSHIP | RELEASE_OWNERSHIP


Request Body

Request Body

ActionRequest of mimetype application/json Required

Request body to pefrom action on notification such as acknowledge, unacknowledge etc.

{
    "auditText": "Acknowledged the notification",
    "deDupKeys": [
        "Name:NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired$Source:INCHARGE-SA-PRES$"
    ],
    "user": "admin"
}
string
auditText Required

audit text to identify the action.


array of string
deDupKeys Required

An array of notifications unique keys.


string
user Required

User who is performing this action

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of ActionResponse of type application/json
{
    "action": "acknowledge",
    "deDupKey": "Name:NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired$Source:INCHARGE-SA-PRES$",
    "errorMessage": "",
    "name": "NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired",
    "samName": "INCHARGE-SA-PRES",
    "status": "OK",
    "user": "admin"
}
string
action Optional

action to be performed on Notification


string
deDupKey Optional

DeDupkey uniquely indentifies the notification across domains.


string
errorMessage Optional

if action failed, cause of failure and exception message for more details


string
name Optional

Notification on which action is performed


string
samName Optional

SAM Name on which action performed


string
status Optional

status of http request , success = 200 ok


string
user Optional

Sam user who is performing this action

Errors

Errors

401

Client must authenticate itself to get the requested response


403

The client does not have access rights to the content; that is, it is Client must authenticate itself to get the requested response


404

The server can not find the requested resource

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"auditText":"Acknowledged the notification","deDupKeys":["Name:NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired$Source:INCHARGE-SA-PRES$"],"user":"admin"}' https://{api_host}tcsa.host.com/tcsa/api/notification-actions/v1/notifications?action=string


Feedback

Was this page helpful?