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

Get Causes

Description

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

Request

Request

URL

URL


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

Request Body

Request Body

RootCauseRequest of mimetype application/json Required

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

{
    "deDupKey": "Name:NOTIFICATION-Router_dev-MPLSp8_Down$Source:INCHARGE-SA-PRES$"
}
string
deDupKey Required

DeDupkey uniquely indentifies the notification across domains.


integer as int32
from Optional

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


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”


integer as int32
size Optional

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


array of Sort
sort Optional

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


vsafilter Optional

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

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

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

total number of notification


array of Notification
Result Optional

An array of notfication objects.

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 '{"deDupKey":"Name:NOTIFICATION-Router_dev-MPLSp8_Down$Source:INCHARGE-SA-PRES$","from":0,"isLive":false,"size":100}' https://{api_host}tcsa.host.com/tcsa/api/notification-management/v1/notifications/causes


Feedback

Was this page helpful?