Action On Notifications

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

Request

URI

POST

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

COPY

Query Parameters

string

action

Required

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

Possible values are : ACKNOWLEDGE, UNACKNOWLEDGE, TAKE_OWNERSHIP, RELEASE_OWNERSHIP,

Request Body

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

ActionRequest of type(s) application/json

Required

Show optional properties

{
    "auditText": "Acknowledged the notification",
    "deDupKeys": [
        {}
    ],
    "user": "admin"
}

{
    "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

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns Array of ActionResponse of type(s) application/json

[
    {
        "name": "NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired",
        "samName": "INCHARGE-SA-PRES",
        "user": "admin",
        "errorMessage": "string",
        "deDupKey": "Name:NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired$Source:INCHARGE-SA-PRES$",
        "action": "acknowledge",
        "status": "OK"
    }
]

401

Client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

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

Operation doesn't return any data structure

404

The server can not find the requested resource

Operation doesn't return any data structure

On This Page

Description

Request