Notification

Notification
Notification

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

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

Trouble ticket ID

string
UserDefined1
Optional

User defined field

string
UserDefined2
Optional

User defined field

string
UserDefined3
Optional

User defined field

string
UserDefined4
Optional

User defined field

string
UserDefined5
Optional

User defined field

string
UserDefined6
Optional

User defined field

string
UserDefined7
Optional

User defined field

string
UserDefined8
Optional

User defined field

string
UserDefined9
Optional

User defined field

string
UserDefined10
Optional

User defined field

string
UserDefined11
Optional

User defined field

string
UserDefined12
Optional

User defined field

string
UserDefined13
Optional

User defined field

string
UserDefined14
Optional

User defined field

string
UserDefined15
Optional

User defined field

string
UserDefined16
Optional

User defined field

string
UserDefined17
Optional

User defined field

string
UserDefined18
Optional

User defined field

string
UserDefined19
Optional

User defined field

string
UserDefined20
Optional

User defined field

boolean
InMaintenance
Optional

Did this event occur during maintenance?

boolean
IsProblem
Optional

A notification is a problem when all of the original event types are 'PROBLEM' or 'UNKNOWN'. There must be at least one 'PROBLEM', i.e. 'UNKNOWN' by itself is not a problem

string
Owner
Optional

The name of the user that is responsible for handling this event

boolean
IsLiveNotification
Optional

Notification is live or historical

number
ProcessedTimeStamp
Optional

Timestamp in epoch milliseconds when the event from the underlying source was processed.

string
InstanceDisplayName
Optional

Display name for the event instance

string
ElementClassName
Optional

The class name of the topology element associated with the event in the repository where this event resides. This may or may not have the same value as ClassName

string
Name
Optional

Name of Event

number
AcknowledgmentTime
Optional

The time in epoch milliseconds, when this Notification was acknowledged. A time of '0' means that the Notification has not been acknowledged

number
LastChangedAt
Optional

Time in epoch milliseconds of last event change

number
LastClearedAt
Optional

Last clear time in epoch milliseconds

number
LastNotifiedAt
Optional

Last notification time in epoch milliseconds

string
InstanceName
Optional

Instance name of the object where this event occurred. This attribute along with ClassName and EventName uniquely identify this event.

string
DeDupKey
Optional

Uniqe key of notification across domains

string
SourceDomainName
Optional

The name(s) of the domain(s)or domainGroups that have originally diagnosed and notified - directly or indirectly - current occurrences of this event. If there are more than one original domain, the attribute lists each separated by a comma. When the notification is cleared, the last clearing domain stays in the value.

number
FirstNotifiedAt
Optional

First event notification time in epoch milliseconds

string
EventState
Optional

The current state of this event. ACTIVE: The event is currently active. WAS_ACTIVE: The event was active, but we lost contact with the event source. INACTIVE: The event is inactive. UNINITIALIZED: The event has not been notified yet; the object does not yet represent a notified event.

integer
Severity
Optional

"An enumerated value that describes the severity of the event from the notifier's point of view: 1 - Critical is used to indicate action is needed NOW and the scope is broad, e.g. an outage to a critical resource. 2 - Major is used to indicate action is needed NOW. 3 - Minor should be used to indicate action is needed, but the situation is not serious at this time. 4 - Unknown indicates that the element is unreachable, disconnected or in an otherwise unknown state. 5 - Normal is used when an event is purely informational."

string
EventName
Optional

Name of the event. This attribute along with ClassName and InstanceName uniquely identify this event.

integer
OccurrenceCount
Optional

The number of occurrences of this event starting from FirstNotifiedAt until LastNotifiedAt

string
SourceInfo
Optional

This table maps an original source to corresponding immediate sources.It also maintains domain groups corresponding to immediate sources.

string
EventType
Optional

Indicates the nature of the event. A MOMENTARY event has no duration. An authentication failure is a good example. A DURABLE event has a period during which the event is active and after which the event is no longer active. An example of a durable event is a link failure

string
EventText
Optional

The textual representation or description of the event

string
ElementName
Optional

The name of the topology element associated with the event in the repository where this event resides. This may or may not have the same value as InstanceName. The string is empty if there is no related element.

string
elementUUID
Optional

Internal notification id

integer
Impact
Optional

A quantification of the impact of this event on the infrastructure and/or business processes. There are no pre-defined semantics to the value of this attribute other than a larger numeric value indicates a larger impact

string
DeviceType
Optional

Type of device on which notifiation occured

boolean
HasCauses
Optional

Does this notification causes other notifiations

array of string
OriginalSources
Optional

OriginalSources

NotificationStates
Optional

NotificationStates

boolean
Active
Optional

Indicates if this event is ACTIVE currently

boolean
Acknowledged
Optional

Indicates if this event has been acknowledged

boolean
IsRoot
Optional

Indicates if this event is a root cause event

string
Category
Optional

Category of this event. The event category represents a broad categorization of the event, e.g. availability vs. performance.

string
EventDisplayName
Optional

Display name for the event Name.

integer
Certainty
Optional

The certainty of this event

string
Source
Optional

The name(s) of the domain(s)or domainGroups that have originally diagnosed and notified - directly or indirectly - current occurrences of this event. If there are more than one original domain, the attribute lists each separated by a comma. When the notification is cleared, the last clearing domain stays in the value.

string
ClassName
Optional

Class name of the object where this event occurred. This attribute along with InstanceName and EventName uniquely identify this event

string
DisplayName
Optional

The string shown in the UI when this Event's name is displayed.

string
SourceSpecific
Optional

This indicates additional information related to the events source

string
ClassDisplayName
Optional

Display name for the event class.

string
PollingState
Optional

State assigned to differentiate, if the event is part of polling batch or subscription

number
PollingID
Optional

ID assigned in case the event is part of polling batch from the underlying source.

boolean
ClearOnAcknowledge
Optional

Indicates if this event should be cleared when it is acknowledged. Set this to TRUE only for events that do not expire nor have sources that generate a clear

string
SourceEventType
Optional

The type(s) of the events(s), i.e. 'PROBLEM', 'EVENT', 'AGGREGATE' in the source domains that have notified current occurrences of this event. If there is more than one domain the attribute lists each separated by a comma, in the same order as SourceDomainName.

string
ToolInfo
Optional

Place holder for data related to other tools

object
tags
Optional

JSON Object or HashMap with flexible key value pairs of type String, that represents the tag names and its corresponding values