Get Causes

Get Causes

Get causes operation lists the impacted notification caused by the requested notification.

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

Request body contains parameters to get list of notification that are causes by requested notification.

RootCauseRequest 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-Router_dev-MPLSp8_Down$Source:INCHARGE-SA-PRES$",
    "size": 100,
    "from": 0,
    "sort": [
        {
            "order": "desc",
            "fieldName": "Severity"
        }
    ],
    "vsafilter": {
        "condition": "AND",
        "filterlist": [
            "Filter Object"
        ]
    },
    "isLive": false
}
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.

boolean
isLive
Optional

Setting value to true returns the root causes for live notification, setting value to "false "will return root causes for historical notification. Default is true

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns CausesResponse of type(s) application/json 
{
    "Count": 1,
    "Result": [
        {
            "UserDefined8": "",
            "TroubleTicketID": "",
            "UserDefined9": "",
            "UserDefined6": "",
            "Owner": "admin",
            "UserDefined7": "",
            "InMaintenance": false,
            "SourceInfo": "INCHARGE-SA",
            "IsProblem": false,
            "EventType": "DURABLE",
            "IsLiveNotification": true,
            "ProcessedTimeStamp": 1662450274959,
            "UserDefined1": "",
            "InstanceDisplayName": "kube-multus-ds-amd64-gv429",
            "UserDefined4": "",
            "UserDefined5": "",
            "UserDefined2": "",
            "ElementClassName": "NetworkFunction",
            "Name": "NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired",
            "UserDefined3": "",
            "PollingID": 1662449173275,
            "EventText": "The Function is Impaired",
            "ElementName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2",
            "LastChangedAt": 1662439219000,
            "elementUUID": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "Impact": 0,
            "deviceType": "NetworkFunction",
            "UserDefined19": "",
            "UserDefined18": "",
            "UserDefined17": "",
            "UserDefined16": "",
            "HasCauses": false,
            "UserDefined15": "",
            "UserDefined14": "",
            "UserDefined13": "",
            "OriginalSources": [],
            "NotificationStates": [
                {
                    "syncTimestamp": 1662450274959,
                    "source": "INCHARGE-SA-PRES",
                    "eventState": "ACTIVE",
                    "eventTimestamp": 1662439219000,
                    "syncId": 1662449173275
                }
            ],
            "tags": {
                "location": "",
                "customer": ""
            },
            "InstanceName": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2",
            "DeDupKey": "Name:NOTIFICATION-NetworkFunction_NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2_Impaired$Source:INCHARGE-SA-PRES$",
            "Active": true,
            "LastNotifiedAt": 1660934292000,
            "SourceDomainName": "INCHARGE-ESM",
            "UserDefined20": "",
            "Acknowledged": true,
            "IsRoot": false,
            "Category": "Operational",
            "EventDisplayName": "Impaired",
            "Certainty": 100,
            "elementUUID_PM": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$",
            "Source": "INCHARGE-SA-PRES",
            "UserDefined12": "",
            "ClassName": "NetworkFunction",
            "DisplayName": "NetworkFunction Impaired 100.0%: kube-multus-ds-amd64-gv429",
            "instanceUUID": "NetworkFunction-ebf940d1-9166-4e3b-bb17-c6b8d200bdc2$NetworkFunction$INCHARGE-SA-PRES",
            "UserDefined11": "",
            "UserDefined10": "",
            "FirstNotifiedAt": 1660934292000,
            "EventState": "ACTIVE",
            "Severity": 2,
            "EventName": "Impaired",
            "SourceSpecific": "primary",
            "ClassDisplayName": "NetworkFunction",
            "OccurrenceCount": 2,
            "PollingState": "POLLING",
            "ClearOnAcknowledge": false,
            "SourceEventType": "EVENT"
        }
    ]
}
integer
Count
Optional

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