Get Notifications

Get Notifications

Returns the list of notifications. By default maximum 10 records from offset 0 are returned in the response. In order to get the more or less number of records user can specify the desired number of records using "size" parameter.

Request
URI
POST
https://{api_host}/tcsa/api/notification-management/v1/notifications
COPY
Request Body

Request body is optional. User needs to provide request body only when filtering, sorting or pagination is required.

NotificationRequest of type(s) application/json
Optional 
{
    "size": 20,
    "from": 0,
    "sort": [
        {
            "order": "desc",
            "fieldName": "Severity"
        }
    ],
    "vsafilter": {
        "condition": "AND",
        "filterlist": [
            "Filter Object"
        ]
    }
}
integer
size
Optional

The size parameter allows you to configure the maximum amount of notifications to be returned. Default is 10.

integer
from
Optional

The from parameter defines the offset from the first result user want to fetch. Default is 0.

array of object
sort
Optional

The Sort object defines on how and which field sorting has to be applied.

object
vsafilter
Optional

The VSAFilter object defines how the filters has to be applied on queries.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NotificationResponse of type(s) application/json 
{
    "Count": 10,
    "Result": [
        {
            "Acknowledged": false,
            "AcknowledgmentTime": 0,
            "Active": true,
            "Category": "Operational",
            "Certainty": 100,
            "ClassDisplayName": "CentralUnitControlPlane",
            "ClassName": "CentralUnitControlPlane",
            "ClearOnAcknowledge": false,
            "DeDupKey": "Name:NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired$Source:INCHARGE-SA-PRES$",
            "DeviceType": "gNodeB",
            "DisplayName": "CentralUnitControlPlane Impaired 100.0%: cucp-50332-65095-bmsed",
            "ElementClassName": "NetworkFunction",
            "ElementName": "gNodeB-service-mavenir",
            "EventDisplayName": "Impaired",
            "EventName": "Impaired",
            "EventState": "ACTIVE",
            "EventText": "Indicates RRC and PDCP-C protocol not working.",
            "EventType": "DURABLE",
            "FirstNotifiedAt": 1660350528000,
            "HasCauses": false,
            "Impact": 0,
            "InMaintenance": false,
            "InstanceDisplayName": "kube-multus-ds-amd64-gv429",
            "InstanceName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2",
            "IsLiveNotification": true,
            "IsProblem": true,
            "IsRoot": false,
            "LastChangedAt": 1660350567000,
            "LastClearedAt": 0,
            "LastNotifiedAt": 1660350528000,
            "Name": "NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired",
            "NotificationStates": [
                {
                    "eventState": "ACTIVE",
                    "eventTimestamp": 1660350567000,
                    "source": "INCHARGE-SA-PRES",
                    "syncId": 1660635420400,
                    "syncTimestamp": 1660635421552
                }
            ],
            "OccurrenceCount": 1,
            "OriginalSources": [
                "string"
            ],
            "Owner": "admin",
            "PollingID": 1662381989790,
            "PollingState": "POLLING",
            "ProcessedTimeStamp": 1660635421552,
            "Severity": 2,
            "Source": "INCHARGE-SA-PRES",
            "SourceDomainName": "INCHARGE-ESM",
            "SourceEventType": "EVENT",
            "SourceInfo": "INCHARGE-SA",
            "SourceSpecific": "primary",
            "ToolInfo": "string",
            "TroubleTicketID": "string",
            "UserDefined1": "string",
            "UserDefined10": "string",
            "UserDefined11": "string",
            "UserDefined12": "string",
            "UserDefined13": "string",
            "UserDefined14": "string",
            "UserDefined15": "string",
            "UserDefined16": "string",
            "UserDefined17": "string",
            "UserDefined18": "string",
            "UserDefined19": "string",
            "UserDefined2": "string",
            "UserDefined20": "string",
            "UserDefined3": "string",
            "UserDefined4": "string",
            "UserDefined5": "string",
            "UserDefined6": "string",
            "UserDefined7": "string",
            "UserDefined8": "string",
            "UserDefined9": "string",
            "elementUUID": "gNodeB-service-mavenir$gNodeB$INCHARGE-SA-PRES",
            "tags": {}
        }
    ]
}
integer
Count
Optional

The total number of notification

array of object
Result
Optional

An array of notfication objects.


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

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/tcsa/api/notification-management/v1/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