Get Notification History

Returns the previous records and the occurrence of notification.

Request

URI

POST

https://{api_host}/tcsa/api/notification-management/v1/notifications/history

COPY

Request Body

The Request body contains parameters to perform filtering, sorting and pagination on reponse.

NotificationHistoryRequest of type(s) application/json

Required

Show optional properties

{
    "deDupKey": "Name:NOTIFICATION-KubernetesWorker_KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42_Down$Source:INCHARGE-SA-PRES$"
}

{
    "deDupKey": "Name:NOTIFICATION-KubernetesWorker_KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42_Down$Source:INCHARGE-SA-PRES$",
    "size": 100,
    "from": 0,
    "sort": [
        {
            "order": "desc",
            "fieldName": "Severity"
        }
    ],
    "vsafilter": {
        "condition": "AND",
        "filterlist": [
            "Filter Object"
        ]
    }
}

string

deDupKey

Required

DeDupkey uniquely indentifies the notification across domains.

integer As int32 As int32

size

Optional

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

integer As int32 As int32

from

Optional

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

array of object

sort

Optional

The Sort object defines, on which field sorting has to be apply and what will be the sorting order (ASC/DESC).

object

vsafilter

Optional

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

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns HistoryResponse of type(s) application/json

{
    "Count": 1,
    "Result": [
        {
            "UserDefined8": "",
            "TroubleTicketID": "",
            "UserDefined9": "",
            "UserDefined6": "",
            "Owner": "",
            "UserDefined7": "",
            "InMaintenance": false,
            "SourceInfo": "INCHARGE-SA",
            "IsProblem": true,
            "EventType": "DURABLE",
            "IsLiveNotification": true,
            "ProcessedTimeStamp": 1662382231244,
            "UserDefined1": "",
            "InstanceDisplayName": "kube-metaswitch-np1-76ddcc547d-5pp6k",
            "UserDefined4": "",
            "UserDefined5": "",
            "UserDefined2": "",
            "ElementClassName": "KubernetesWorker",
            "Name": "NOTIFICATION-KubernetesWorker_KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42_Down",
            "UserDefined3": "",
            "LastModified": null,
            "PollingID": 1662381989790,
            "EventText": "Indicates that root cause is failed system.",
            "ElementName": "KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42",
            "LastChangedAt": 1661231881000,
            "LastClearedAt": null,
            "elementUUID": "KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42$KubernetesWorker$INCHARGE-SA-PRES",
            "Impact": 0,
            "deviceType": "KubernetesWorker",
            "UserDefined19": "",
            "UserDefined18": "",
            "UserDefined17": "",
            "UserDefined16": "",
            "HasCauses": true,
            "UserDefined15": "",
            "UserDefined14": "",
            "UserDefined13": "",
            "OriginalSources": [],
            "NotificationStates": [
                {
                    "syncTimestamp": 1662382231244,
                    "eventState": "ACTIVE",
                    "source": "INCHARGE-SA-PRES",
                    "eventTimestamp": 1661231881000,
                    "syncId": 1662381989790
                }
            ],
            "tags": {
                "location": "",
                "customer": ""
            },
            "InstanceName": "KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42",
            "DeDupKey": "Name:NOTIFICATION-KubernetesWorker_KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42_Down$Source:INCHARGE-SA-PRES$@1661231881000",
            "Active": true,
            "ToolInfo": null,
            "AcknowledgmentTime": null,
            "LastNotifiedAt": 1660934327000,
            "State": null,
            "SourceDomainName": "INCHARGE-ESM",
            "UserDefined20": "",
            "Acknowledged": false,
            "IsRoot": true,
            "Category": "Availability",
            "EventDisplayName": "Down",
            "Certainty": 100,
            "elementUUID_PM": "KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42$KubernetesWorker$",
            "Source": "INCHARGE-SA-PRES",
            "UserDefined12": "",
            "ClassName": "KubernetesWorker",
            "DisplayName": "KubernetesWorker Down 100.0%: kube-metaswitch-np1-76ddcc547d-5pp6k",
            "instanceUUID": "KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42$KubernetesWorker$INCHARGE-SA-PRES",
            "UserDefined11": "",
            "UserDefined10": "https://10.62.72.35/ui/index.action#/inventory/all/96105fd2-1a74-46b6-ac8f-e869609e8d42/summary",
            "FirstNotifiedAt": 1660934327000,
            "EventState": "ACTIVE",
            "Severity": 1,
            "EventName": "Down",
            "SourceSpecific": "primary",
            "ClassDisplayName": "KubernetesWorker",
            "OccurrenceCount": 2,
            "PollingState": "POLLING",
            "ClearOnAcknowledge": false,
            "SourceEventType": "PROBLEM"
        }
    ]
}

integer

Count

Optional

total number of notification

array of object

Result

Optional

Notification object can also have enriched custom fields, apart from the standard fields.

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 '{"deDupKey:"string"}' https://{api_host}/tcsa/api/notification-management/v1/notifications/history

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Notification Operations

POST

Get Notifications

POST