1. REST API for Unified Assurance Core
  2. Tasks
  3. Events
  4. Events

Get an Event by ID

get

/api/event/Events/{id}

Gets the event that matches the specified ID and query parameters.

Request

Path Parameters
Query Parameters
  • The beginning of the date range in the format yyyy-mm-dd.
  • The end of the date range in the format yyyy-mm-dd.
  • Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.
  • The ID of the display used to determine the columns selected.
    Example:
    1
  • The filter group of the filter. This parameter is required when FilterType is set to FilterId or MetaTag, otherwise it is optional.
  • The type of filter. Possible values are:
    • FilterID
    • DeviceName
    • MetaTag
    • TEL
    The default value is TEL (Transient Event List).
  • The value of the filter. You can use a filter ID, a device name, metadata with the MetaType FilterGroupID, or an SQL where clause.
  • This parameter indicates the way the event field values are sorted. The allowed values are frequency and alphanumeric values.
  • Read severities only and prevent returning events. The default value is 0.
  • The shard ID to query. Default value is 1.
    Example:
    1
  • The fields to filter the results by. You cannot filter by fields that contain a state.
    This parameter's value uses the following JSON format:
    { "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
    If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • Default Value: LIKE
      Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
      The filter operation to use.
      Example: eq
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • The field and direction to sort results by. You cannot sort by fields that contain a state.
    This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The properties of the specified event.
Show Source
Nested Schema : eventEventsReadByIDMetaData
Type: array
Show Source
Example:
[
    {
        "EventID":"7948575",
        "Node":"example.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-example.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\":\"example.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: object
Show Source
Nested Schema : Ack
Match All
Show Source
  • 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
Example:
0
Nested Schema : Action
Match All
Show Source
  • The non-human entity that caused a change to be made.
    Example: SQL Tool: Acknowledge
Example:
Nested Schema : Actor
Match All
Show Source
  • The entity or user that caused the change to be made.
    Example: admin
Example:
Nested Schema : Count
Match All
Show Source
  • The number of times this event has happened (deduplicated).
    Example: 1963
Example:
23428
Nested Schema : Customer
Match All
Show Source
  • Customer can be set to a value when needed.
    Example:
Example:
Nested Schema : Department
Match All
Show Source
  • Customer.rules will set this to Unknown if not previously set.
    Example: Unknown
Example:
Unknown
Nested Schema : Details
Match All
Show Source
  • 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"}
Example:
{"ThresholdName":"Device Down","Time":"1691741100","InstanceName":"Device","ThresholdTimeRange":"900","ThresholdTypeName":"Standard Threshold","ThresholdSeverity":"5","MetricValue":0,"ThresholdOperator":"==","DeviceName":"example.com","ThresholdType":"1","ThresholdMessage":"Performance threshold violation: Device Down","Measurement":"metrictype_Latency","ThresholdValue":"0"}
Nested Schema : DeviceType
Match All
Show Source
  • 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
  • Duration for which the event occurred (LastReported - FirstReported)
    Example: 24417000.000
Example:
7009800.000
Nested Schema : EscalationFlag
Match All
Show Source
  • 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
Example:
0
Nested Schema : EventCategory
Match All
Show Source
  • The event category. Allowed values are:
    • Resolution
    • Problem
    • Discrete
    Example: Problem
Example:
Problem
Nested Schema : EventID
Match All
Show Source
  • The event ID specified for individual read operations.
    Example: 57341
Example:
7948575
Nested Schema : EventKey
Match All
Show Source
  • The event key.
    Example: 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
  • The type of event. For example, linkUpDown for a linkDown trap.
    Example: Device Down
Example:
Problem
Nested Schema : ExpireTime
Match All
Show Source
  • 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
  • The timestamp when the event was first reported.
    Example: 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
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
Nested Schema : IPAddress
Match All
Show Source
  • The IPv4 or IPv6 address of the Device associated with this Event
    Example: 100.77.1.4
Example:
100.77.220.51
Nested Schema : LastChanged
Match All
Show Source
  • The timestamp when the event was last changed.
    Example: 2023-08-10 01:10:00.000
Example:
2023-10-31 06:15:00.000
Nested Schema : LastReported
Match All
Show Source
  • The timestamp when the event was last reported.
    Example: 2023-08-10 01:10:00.000
Example:
2023-10-31 06:15:00.000
Nested Schema : Location
Match All
Show Source
  • Name, Address, or something similar associated with the Event. Observability Analytics uses this if it is set.
    Example:
Example:
Nested Schema : Method
Match All
Show Source
  • 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
  • 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
Example:
example.com
Nested Schema : OrigSeverity
Match All
Show Source
  • The original severity when the event was first created.
    Example: 5
Example:
5
Nested Schema : OwnerName
Match All
Show Source
  • 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
  • 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
  • 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
  • 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
  • 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
  • Flag to indicate a provided service has been impacted. Allowed values:
    • 0: Not service impacting
    • 1: Service impacting
    Example: 0
Example:
0
Nested Schema : Severity
Match All
Show Source
  • 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 => Critical
    Example: Critical
Example:
5
Nested Schema : ShardID
Match All
Show Source
  • The shard ID of the database to query. If no value is specified, the default is 1.
    Example: 1
Example:
1
Nested Schema : SubDeviceType
Match All
Show Source
  • 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
  • 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
  • The Instance of the Event, for example, the ifIndex value of a linkUp trap. Mechanization CorrelateProblemResolutions requires that this is the same for correlating events
    Example: Device
Example:
Device
Nested Schema : Summary
Match All
Show Source
  • The event summary.
    Example: Device Down with availability 0.00% == 0%
Example:
Device Down with availability 0.00% == 0%
Nested Schema : TicketFlag
Match All
Show Source
  • A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = opened
    Example: 0
Example:
0
Nested Schema : TicketID
Match All
Show Source
  • 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
  • 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
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top