Update an Event
put
/api/event/Events/{id}
Updates the properties of the event that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The event ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DisableConversions: integer
Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.Example:
0
-
ShardID: integer
Shard to query (defaults to 1)Example:
1
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated 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 updated event.
-
metaData: array
eventEventsReadByIDMetaData
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventEventsReadByIDMetaData
Type:
Show Source
array
Example:
[
{
"EventID":"7948575",
"Node":"pg-micgent4-453200.ua3.gbucdsint02phx.oraclevcn.com",
"EventType":"Device Down",
"Summary":"Device Down with availability 0.00% == 0%",
"Count":"20012",
"FirstReported":"2023-08-11 03:05:00.000",
"LastReported":"2023-10-19 05:45:00.000",
"LastChanged":"2023-10-19 05:45:00.000",
"EventKey":"Standard Threshold-pg-micgent4-453200.ua3.gbucdsint02phx.oraclevcn.com-Device Down-Device",
"EventCategory":"Problem",
"Ack":"0",
"Action":"",
"Actor":"",
"Customer":"",
"Department":"Unknown",
"Details":"{\"ThresholdName\":\"Device Down\",\"Time\":\"1691741100\",\"InstanceName\":\"Device\",\"ThresholdTimeRange\":\"900\",\"ThresholdTypeName\":\"Standard Threshold\",\"ThresholdSeverity\":\"5\",\"MetricValue\":0,\"ThresholdOperator\":\"==\",\"DeviceName\":\"pg-micgent4-453200.ua3.gbucdsint02phx.oraclevcn.com\",\"ThresholdType\":\"1\",\"ThresholdMessage\":\"Performance threshold violation: Device Down\",\"Measurement\":\"metrictype_Latency\",\"ThresholdValue\":\"0\"}",
"DeviceType":"Unknown",
"Duration":"5971200.000",
"EscalationFlag":"0",
"ExpireTime":"0",
"GeoPath":"{\"type\": \"LineString\", \"coordinates\": [[0.0, 0.0], [0.0, 0.0]]}",
"GeoLocation":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}",
"IPAddress":"100.77.220.51",
"Location":"",
"Method":"StandardThresholdEngined",
"OrigSeverity":"5",
"OwnerName":"",
"RootCauseFlag":"0",
"RootCauseID":"0",
"Score":"0",
"Service":"",
"ServiceImpact":"0",
"Severity":"5",
"SubDeviceType":"Unknown",
"SubMethod":"Standard Threshold",
"SubNode":"Device",
"TicketFlag":"0",
"TicketID":"",
"ZoneID":"3",
"ShardID":"1"
},
{
"EventID":{
"displayName":"EventID <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"numberfield\"}"
},
"Node":{
"displayName":"Device",
"editor":"{\"xtype\":\"textfield\"}"
},
"EventType":{
"displayName":"Event Type",
"editor":"{\"xtype\":\"textfield\"}"
},
"Summary":{
"displayName":"Event Text",
"editor":"{\"xtype\":\"textfield\"}"
},
"Count":{
"displayName":"Count <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"numberfield\"}"
},
"FirstReported":{
"displayName":"First Occurred <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"timedatefield\"}"
},
"LastReported":{
"displayName":"Last Occurred <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"timedatefield\"}"
},
"LastChanged":{
"displayName":"Last Changed <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"timedatefield\"}"
},
"EventKey":{
"displayName":"EventKey <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"textfield\"}"
},
"EventCategory":{
"displayName":"EventCategory",
"editor":"{\"xtype\":\"eventcategorycombo\"}"
},
"Ack":{
"displayName":"Ack",
"editor":"{\"xtype\":\"textfield\"}"
},
"Action":{
"displayName":"Action <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"textfield\"}"
},
"Actor":{
"displayName":"Actor <img src=\"./resources/assure1/images/icons/fugue/lock-small.png\"/>",
"editor":"{\"xtype\":\"textfield\"}"
},
"Customer":{
"displayName":"Customer",
"editor":"{\"xtype\":\"textfield\"}"
},
"Department":{
"displayName":"Department",
"editor":"{\"xtype\":\"textfield\"}"
},
"Details":{
"displayName":"Details",
"editor":"{\"xtype\":\"textfield\"}"
},
"DeviceType":{
"displayName":"DeviceType",
"editor":"{\"xtype\":\"textfield\"}"
},
"Duration":{
"displayName":"Duration",
"editor":"{\"xtype\":\"textfield\"}"
},
"EscalationFlag":{
"displayName":"EscalationFlag",
"editor":"{\"xtype\":\"textfield\"}"
},
"ExpireTime":{
"displayName":"ExpireTime",
"editor":"{\"xtype\":\"textfield\"}"
},
"GeoPath":{
"displayName":"GeoPath",
"editor":"{\"xtype\":\"textfield\"}"
},
"GeoLocation":{
"displayName":"GeoLocation",
"editor":"{\"xtype\":\"textfield\"}"
},
"IPAddress":{
"displayName":"IPAddress",
"editor":"{\"xtype\":\"textfield\"}"
},
"Location":{
"displayName":"Location",
"editor":"{\"xtype\":\"textfield\"}"
},
"Method":{
"displayName":"Method",
"editor":"{\"xtype\":\"textfield\"}"
},
"OrigSeverity":{
"displayName":"OrigSeverity",
"editor":"{\"xtype\":\"textfield\"}"
},
"OwnerName":{
"displayName":"OwnerName",
"editor":"{\"xtype\":\"textfield\"}"
},
"RootCauseFlag":{
"displayName":"RootCauseFlag",
"editor":"{\"xtype\":\"textfield\"}"
},
"RootCauseID":{
"displayName":"RootCauseID",
"editor":"{\"xtype\":\"textfield\"}"
},
"Score":{
"displayName":"Score",
"editor":"{\"xtype\":\"textfield\"}"
},
"Service":{
"displayName":"Service",
"editor":"{\"xtype\":\"textfield\"}"
},
"ServiceImpact":{
"displayName":"ServiceImpact",
"editor":"{\"xtype\":\"textfield\"}"
},
"Severity":{
"displayName":"Severity",
"editor":"{\"xtype\":\"severitycombo\"}"
},
"SubDeviceType":{
"displayName":"SubDeviceType",
"editor":"{\"xtype\":\"textfield\"}"
},
"SubMethod":{
"displayName":"SubMethod",
"editor":"{\"xtype\":\"textfield\"}"
},
"SubNode":{
"displayName":"SubNode",
"editor":"{\"xtype\":\"textfield\"}"
},
"TicketFlag":{
"displayName":"TicketFlag",
"editor":"{\"xtype\":\"textfield\"}"
},
"TicketID":{
"displayName":"TicketID",
"editor":"{\"xtype\":\"textfield\"}"
},
"ZoneID":{
"displayName":"ZoneID",
"editor":"{\"xtype\":\"textfield\"}"
},
"ShardID":{
"displayName":"ShardID",
"editor":"{\"xtype\":\"numberfield\"}"
}
}
]
Nested Schema : eventEventsReadByID
Type:
Show Source
object
-
Ack:
Ack
-
Action:
Action
-
Actor:
Actor
-
Count:
Count
-
Customer:
Customer
-
Department:
Department
-
Details:
Details
-
DeviceType:
DeviceType
-
Duration:
Duration
-
EscalationFlag:
EscalationFlag
-
EventCategory:
EventCategory
-
EventCategoryHasConversion: integer
Event Category had conversionExample:
1
-
EventCategoryRaw: integer
Event categoryExample:
2
-
EventID:
EventID
-
EventKey:
EventKey
-
EventType:
EventType
-
ExpireTime:
ExpireTime
-
FirstReported:
FirstReported
-
GeoLocation: object
GeoLocation
An object containing a longitude and latitude denoting a geographic location related to the event.
-
GeoPath: object
GeoPath
An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.
-
IPAddress:
IPAddress
-
LastChanged:
LastChanged
-
LastReported:
LastReported
-
Location:
Location
-
Method:
Method
-
Node:
Node
-
OrigSeverity:
OrigSeverity
-
OwnerName:
OwnerName
-
RootCauseFlag:
RootCauseFlag
-
RootCauseID:
RootCauseID
-
Score:
Score
-
Service:
Service
-
ServiceImpact:
ServiceImpact
-
Severity:
Severity
-
ShardID:
ShardID
-
SubDeviceType:
SubDeviceType
-
SubMethod:
SubMethod
-
SubNode:
SubNode
-
Summary:
Summary
-
TicketFlag:
TicketFlag
-
TicketID:
TicketID
-
ZoneID:
ZoneID
Nested Schema : Ack
Match All
Show Source
-
integer
Indicates if the event has been flagged as acknowledged. Events will be displayed differently based on Ack. - 0 -> N0 - 1 -> YesExample:
1
Example:
0
Nested Schema : Action
Match All
Show Source
-
string
Action is an indication for a non-human entity that caused a change to be made.Example:
SQL Tool: Acknowledge
Example:
Nested Schema : Actor
Match All
Show Source
-
string
Actor is an indication of the entity that caused the change to be made.Example:
admin
Example:
Nested Schema : Count
Match All
Show Source
-
integer
The number of times this Event has happened (deduplicated)Example:
1963
Example:
23428
Nested Schema : Customer
Match All
Show Source
-
string
Customer can be set to a value when neededExample:
Example:
Nested Schema : Department
Match All
Show Source
-
string
Customer.rules will set this to Unknown if not previously set.Example:
Unknown
Example:
Unknown
Nested Schema : Details
Match All
Show Source
-
string
Details of the event (a JSON text)Example:
{"ThresholdName":"Device Down","Time":"1667230800","InstanceName":"Device","ThresholdTimeRange":900,"ThresholdTypeName":"Standard Threshold","ThresholdSeverity":5,"MetricValue":0,"ThresholdOperator":"==","DeviceName":"router.example.com","ThresholdType":"1","ThresholdMessage":"Performance threshold violation: Device Down","Measurement":"metrictype_Latency","ThresholdValue":"0"}
Example:
{"ThresholdName":"Device Down","Time":"1691741100","InstanceName":"Device","ThresholdTimeRange":"900","ThresholdTypeName":"Standard Threshold","ThresholdSeverity":"5","MetricValue":0,"ThresholdOperator":"==","DeviceName":"pg-micgent4-453200.ua3.gbucdsint02phx.oraclevcn.com","ThresholdType":"1","ThresholdMessage":"Performance threshold violation: Device Down","Measurement":"metrictype_Latency","ThresholdValue":"0"}
Nested Schema : DeviceType
Match All
Show Source
-
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
Example:
Unknown
Nested Schema : Duration
Match All
Show Source
-
number
Duration for which the event occurred (LastReported - FirstReported)Example:
24417000.000
Example:
7009800.000
Nested Schema : EscalationFlag
Match All
Show Source
-
integer
If an event should be escalated or not. ??? 0 = no ??? 1 = should be escalated ??? 2 = has been escalatedExample:
0
Example:
0
Nested Schema : EventCategory
Match All
Show Source
-
string
Event Category - 1 -> Resolution - 2 -> Problem - 3 -> DiscreteExample:
Problem
Example:
Problem
Nested Schema : EventID
Match All
Show Source
-
integer
Event ID specified for individual read operationsExample:
57341
Example:
7948575
Nested Schema : EventKey
Match All
Show Source
-
string
Event KeyExample:
Standard Threshold-router1.example.com-Device Down-Device
Example:
Standard Threshold-pg-453200.example.com-Device Down-Device
Nested Schema : EventType
Match All
Show Source
-
string
Type of the Event (ex. linkUpDown for a linkDown trap)Example:
Device Down
Example:
Problem
Nested Schema : ExpireTime
Match All
Show Source
-
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
Example:
0
Nested Schema : FirstReported
Match All
Show Source
-
string
Timestamp when event was first reportedExample:
2022-10-31 10:40:00.000
Example:
2023-08-11 03:05:00.000
Nested Schema : GeoLocation
Type:
object
An object containing a longitude and latitude denoting a geographic location related to the event.
Show Source
-
coordinates:
Example:
[ 0, 0 ]
-
type:
Example:
Point
Nested Schema : GeoPath
Type:
object
An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.
Show Source
-
coordinates:
Example:
[ [ 0, 0 ], [ 0, 0 ] ]
-
type:
Example:
LineString
Nested Schema : IPAddress
Match All
Show Source
-
string
The IPv4 or IPv6 address of the Device associated with this EventExample:
100.77.1.4
Example:
100.77.220.51
Nested Schema : LastChanged
Match All
Show Source
-
string
Timestamp when event was last changedExample:
2023-08-10 01:10:00.000
Example:
2023-10-31 06:15:00.000
Nested Schema : LastReported
Match All
Show Source
-
string
Timestamp when event was last reportedExample:
2023-08-10 01:10:00.000
Example:
2023-10-31 06:15:00.000
Nested Schema : Location
Match All
Show Source
-
string
Name, Address, or something similar associated with the Event. Event Analytics will use this if it is set.Example:
Example:
Nested Schema : Method
Match All
Show Source
-
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
Example:
StandardThresholdEngined
Nested Schema : Node
Match All
Show Source
-
string
The name of the device where the event happened (usually the DNS name of the device associated with the event)Example:
router1.example.com
Example:
pg-micgent4-453200.ua3.gbucdsint02phx.oraclevcn.com
Nested Schema : OrigSeverity
Match All
Show Source
-
integer
The original severity when the event was first created.Example:
5
Example:
5
Nested Schema : OwnerName
Match All
Show Source
-
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
Example:
Nested Schema : RootCauseFlag
Match All
Show Source
-
integer
Used by applications to know whether the event is being processed as a root cause of another event or not.Example:
0
Example:
0
Nested Schema : RootCauseID
Match All
Show Source
-
integer
Used by applications to know whether the event was caused by another event or not.Example:
0
Example:
0
Nested Schema : Score
Match All
Show Source
-
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
Example:
0
Nested Schema : Service
Match All
Show Source
-
string
The SLM applications will set this to the name of the SLM Service if a violation is detected.Example:
Example:
Nested Schema : ServiceImpact
Match All
Show Source
-
integer
Flag to indicate a provided service has been impacted. Allowed values: - 0 = Not service impacting - 1 = Service impactingExample:
0
Example:
0
Nested Schema : Severity
Match All
Show Source
-
string
Must be a value between 0 - 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
Example:
5
Nested Schema : ShardID
Match All
Show Source
-
integer
Shard to query (defaults to 1)Example:
1
Example:
1
Nested Schema : SubDeviceType
Match All
Show Source
-
string
Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.Example:
Unknown
Example:
Unknown
Nested Schema : SubMethod
Match All
Show Source
-
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
Example:
Standard Threshold
Nested Schema : SubNode
Match All
Show Source
-
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
Example:
Device
Nested Schema : Summary
Match All
Show Source
-
string
Event descriptionExample:
Device Down with availability 0.00% == 0%
Example:
Device Down with availability 0.00% == 0%
Nested Schema : TicketFlag
Match All
Show Source
-
integer
A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = openedExample:
0
Example:
0
Nested Schema : TicketID
Match All
Show Source
-
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:
Example:
Nested Schema : ZoneID
Match All
Show Source
-
integer
Can be set to the Device Zone that the device is in.Example:
5
Example:
3
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
Nested Schema : items
Type:
object