Create an Event
post
/api/event/Events
Creates a new event. If it is a duplicate event, the Count, Severity, LastReported, EventCategory, and Summary fields of the existing event are updated rather than creating another event. This endpoint does not support custom deduplication.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ShardID: integer
The shard ID of the database to query. If no value is specified, the default is 1.Example:
1
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
object
The response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new event.
-
metaData: array
metaData
The metadata associated with the method.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventEventsReadData
Type:
Show Source
object
-
Ack: integer
Whether the event has been acknowledged (1) or not (0). Events will be displayed differently based on whether or not they have been acknowledged.Example:
1
-
Action: string
The non-human entity that caused a change to be made.Example:
SQL Tool: Acknowledge
-
Actor: string
The entity or user that caused the change to be made.Example:
admin
-
Count: integer
The number of times this event has happened (deduplicated).Example:
1963
-
Customer: string
Customer can be set to a value when needed.Example:
-
Department: string
Customer.rules will set this to Unknown if not previously set.Example:
Unknown
-
Details: string
Details of the event in JSON format.Example:
{"ThresholdName":"Device Down","Time":"1667230800","InstanceName":"Device","ThresholdTimeRange":900,"ThresholdTypeName":"StandardThreshold","ThresholdSeverity":5,"MetricValue":0,"ThresholdOperator":"==","DeviceName":"router.example.com","ThresholdType":"1","ThresholdMessage":"Performance threshold violation: Device Down","Measurement":"metrictype_Latency","ThresholdValue":"0"}
-
DeviceType: string
Device Type is used as a general category for the event. Customer.rules will set this to Unknown if not previously set.Example:
Unknown
-
Duration: number
Duration for which the event occurred (LastReported - FirstReported)Example:
24417000.000
-
EscalationFlag: integer
Whether the event should or has been escalated. Can be:
- 0: Should not be escalated.
- 1: Should be escalated.
- 2: Has been escalated.
Example:0
-
EventCategory: string
The event category. Allowed values are:
- Resolution
- Problem
- Discrete
Example:Problem
-
EventID: integer
The event ID specified for individual read operations.Example:
57341
-
EventKey: string
The event key.Example:
Standard Threshold-router1.example.com-Device Down-Device
-
EventType: string
The type of event. For example, linkUpDown for a linkDown trap.Example:
Device Down
-
ExpireTime: integer
Time at which the event expired (Number of seconds after LastChanged for this Event to become eligible-to-be-deleted, which is done by the mechanization DeleteExpired)Example:
0
-
FirstReported: string
The timestamp when the event was first reported.Example:
2022-10-31 10:40:00.000
-
GeoLocation: string
An object containing a longitude and latitude denoting a geographic location related to the event.Example:
{"type": "Point", "coordinates": [0.0, 0.0]}
-
GeoPath: string
An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.Example:
{"type": "LineString", "coordinates": [[0.0, 0.0], [0.0, 0.0]]}
-
IPAddress: string
The IPv4 or IPv6 address of the Device associated with this EventExample:
100.77.1.4
-
LastChanged: string
The timestamp when the event was last changed.Example:
2023-08-10 01:10:00.000
-
LastReported: string
The timestamp when the event was last reported.Example:
2023-08-10 01:10:00.000
-
Location: string
Name, Address, or something similar associated with the Event. Observability Analytics uses this if it is set.Example:
-
Method: string
Protocol of how the event was received/retrieved. The binary will set a default value (Trapd, Syslogd, for example), but can be update in rules, if needed.Example:
StandardThresholdEngined
-
Node: string
The name of the device where the event happened. This is usually the DNS name of the device associated with the event.Example:
router1.example.com
-
OrigSeverity: integer
The original severity when the event was first created.Example:
5
-
OwnerName: string
The name of the currently-responsible person. Some event Tools (for example, "Acknowledge", "Delete", and "Take Ownership") set this to the username that executed the tool; "UnAcknowledge" sets it to 0.Example:
admin
-
RootCauseFlag: integer
Used by applications to know whether the event is being processed as a root cause of another event or not.Example:
0
-
RootCauseID: integer
Used by applications to know whether the event was caused by another event or not.Example:
0
-
Score: integer
If a Priority value is set on a device, this field can be set to the event Severity * Priority to increase the number. Event Filters can be configured to show the hi-score Events first, or other processing may utilize this value.Example:
0
-
Service: string
The SLM applications will set this to the name of the SLM Service if a violation is detected.Example:
-
ServiceImpact: integer
Flag to indicate a provided service has been impacted. Allowed values:
- 0: Not service impacting
- 1: Service impacting
Example:0
-
Severity: string
Must be a value between 0 and 5. The event will change colors in the Event List based on the severity. Allowed Values: - 0 => Normal - 1 => Unknown - 2 => Info - 3 => Minor - 4 => Major - 5 => CriticalExample:
Critical
-
ShardID: integer
The shard ID of the database to query. If no value is specified, the default is 1.Example:
1
-
SubDeviceType: string
Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.Example:
Unknown
-
SubMethod: string
Usually set in rules to the specific processing that was done on the event, for example, the MIB that defines the trap, or the string "watchdog", or "Unknown".Example:
Standard Threshold
-
SubNode: string
The Instance of the Event, for example, the ifIndex value of a linkUp trap. Mechanization CorrelateProblemResolutions requires that this is the same for correlating eventsExample:
Device
-
Summary: string
The event summary.Example:
Device Down with availability 0.00% == 0%
-
TicketFlag: integer
A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = openedExample:
0
-
TicketID: integer
The Ticket ID associated with this Event in the external system. Should be populated by the process done to open the ticket in the external system.Example:
-
ZoneID: integer
Can be set to the Device Zone that the device is in.Example:
5
Nested Schema : eventEventsReadMetaData
Type:
Show Source
object
-
columns: array
columns
-
fields: array
fields
fields within the data object (Events)
-
root: string
rootExample:
data
-
severity: object
severity
Object containing number of all type of severities
Nested Schema : columns
Type:
Show Source
array
Example:
[
{
"text":"<div class=\"fa fa-link\"></div>",
"tooltip":"Indicates correlated symptom events",
"dataIndex":"RootCauseFlag",
"align":"left",
"filter":false,
"sortable":false,
"hidden":false,
"menuDisabled":true,
"width":34
},
{
"header":"EventID",
"dataIndex":"EventID",
"align":"left",
"filter":"int",
"hidden":true,
"width":100
},
{
"header":"ShardID",
"dataIndex":"ShardID",
"align":"left",
"filter":"int",
"hidden":true,
"width":60
},
{
"header":"Device",
"dataIndex":"Node",
"align":"left",
"filter":"string",
"hidden":false,
"width":300
},
{
"header":"Event Type",
"dataIndex":"EventType",
"align":"left",
"filter":"string",
"hidden":false,
"width":200
},
{
"header":"Event Text",
"dataIndex":"Summary",
"align":"left",
"filter":"string",
"hidden":false,
"flex":1,
"minWidth":100
},
{
"header":"Count",
"dataIndex":"Count",
"align":"center",
"filter":"int",
"hidden":false,
"width":70
},
{
"header":"First Occurred",
"dataIndex":"FirstReported",
"align":"center",
"filter":"datetime",
"hidden":false,
"width":190
},
{
"header":"Last Occurred",
"dataIndex":"LastReported",
"align":"center",
"filter":"datetime",
"hidden":false,
"width":190
},
{
"header":"Last Changed",
"dataIndex":"LastChanged",
"align":"center",
"filter":"datetime",
"hidden":true,
"width":120
},
{
"header":"EventKey",
"dataIndex":"EventKey",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"EventCategory",
"dataIndex":"EventCategory",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Ack",
"dataIndex":"Ack",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Action",
"dataIndex":"Action",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Actor",
"dataIndex":"Actor",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Customer",
"dataIndex":"Customer",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Department",
"dataIndex":"Department",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Details",
"dataIndex":"Details",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"DeviceType",
"dataIndex":"DeviceType",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Duration",
"dataIndex":"Duration",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"EscalationFlag",
"dataIndex":"EscalationFlag",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"ExpireTime",
"dataIndex":"ExpireTime",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"GeoPath",
"dataIndex":"GeoPath",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"GeoLocation",
"dataIndex":"GeoLocation",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"IPAddress",
"dataIndex":"IPAddress",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Location",
"dataIndex":"Location",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Method",
"dataIndex":"Method",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"OrigSeverity",
"dataIndex":"OrigSeverity",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"OwnerName",
"dataIndex":"OwnerName",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"RootCauseFlag",
"dataIndex":"RootCauseFlag",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"RootCauseID",
"dataIndex":"RootCauseID",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Score",
"dataIndex":"Score",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Service",
"dataIndex":"Service",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"ServiceImpact",
"dataIndex":"ServiceImpact",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"Severity",
"dataIndex":"Severity",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"SubDeviceType",
"dataIndex":"SubDeviceType",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"SubMethod",
"dataIndex":"SubMethod",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"SubNode",
"dataIndex":"SubNode",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"TicketFlag",
"dataIndex":"TicketFlag",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"TicketID",
"dataIndex":"TicketID",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
},
{
"header":"ZoneID",
"dataIndex":"ZoneID",
"align":"left",
"filter":"string",
"hidden":true,
"width":120
}
]
Nested Schema : fields
Type:
array
fields within the data object (Events)
Show Source
Example:
[
"EventID",
"ShardID",
"Node",
"EventType",
"Summary",
"Count",
"FirstReported",
"LastReported",
"LastChanged",
"EventKey",
"EventCategory",
"Ack",
"Action",
"Actor",
"Customer",
"Department",
"Details",
"DeviceType",
"Duration",
"EscalationFlag",
"ExpireTime",
"GeoPath",
"GeoLocation",
"IPAddress",
"Location",
"Method",
"OrigSeverity",
"OwnerName",
"RootCauseFlag",
"RootCauseID",
"Score",
"Service",
"ServiceImpact",
"Severity",
"SubDeviceType",
"SubMethod",
"SubNode",
"TicketFlag",
"TicketID",
"ZoneID"
]
Nested Schema : severity
Type:
object
Object containing number of all type of severities
Example:
{
"normal":11,
"unknown":1,
"info":1,
"minor":1620,
"major":809,
"critical":165,
"all":2607,
"sum":130887185
}
Nested Schema : items
Type:
object
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.