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

Get Events

get

/api/event/Events

Gets the events that match the specified parameters. If no parameters are specified, all events are returned. Oracle recommends using filtering and pagination parameters to limit the results.

Request

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 list of events that match the specified parameters.
Show Source
Nested Schema : metaData
Type: array
The metadata associated with the method.
Show Source
Nested Schema : eventEventsReadData
Type: object
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
  • The non-human entity that caused a change to be made.
    Example: SQL Tool: Acknowledge
  • The entity or user that caused the change to be made.
    Example: admin
  • The number of times this event has happened (deduplicated).
    Example: 1963
  • Customer can be set to a value when needed.
    Example:
  • Customer.rules will set this to Unknown if not previously set.
    Example: Unknown
  • 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"}
  • 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 for which the event occurred (LastReported - FirstReported)
    Example: 24417000.000
  • 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
  • The event category. Allowed values are:
    • Resolution
    • Problem
    • Discrete
    Example: Problem
  • The event ID specified for individual read operations.
    Example: 57341
  • The event key.
    Example: Standard Threshold-router1.example.com-Device Down-Device
  • The type of event. For example, linkUpDown for a linkDown trap.
    Example: Device Down
  • 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
  • The timestamp when the event was first reported.
    Example: 2022-10-31 10:40:00.000
  • An object containing a longitude and latitude denoting a geographic location related to the event.
    Example: {"type": "Point", "coordinates": [0.0, 0.0]}
  • 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]]}
  • The IPv4 or IPv6 address of the Device associated with this Event
    Example: 100.77.1.4
  • The timestamp when the event was last changed.
    Example: 2023-08-10 01:10:00.000
  • The timestamp when the event was last reported.
    Example: 2023-08-10 01:10:00.000
  • Name, Address, or something similar associated with the Event. Observability Analytics uses this if it is set.
    Example:
  • 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
  • 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
  • The original severity when the event was first created.
    Example: 5
  • 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
  • Used by applications to know whether the event is being processed as a root cause of another event or not.
    Example: 0
  • Used by applications to know whether the event was caused by another event or not.
    Example: 0
  • 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
  • The SLM applications will set this to the name of the SLM Service if a violation is detected.
    Example:
  • Flag to indicate a provided service has been impacted. Allowed values:
    • 0: Not service impacting
    • 1: Service impacting
    Example: 0
  • 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
  • The shard ID of the database to query. If no value is specified, the default is 1.
    Example: 1
  • Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.
    Example: Unknown
  • 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
  • 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
  • The event summary.
    Example: Device Down with availability 0.00% == 0%
  • A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = opened
    Example: 0
  • 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:
  • Can be set to the Device Zone that the device is in.
    Example: 5
Nested Schema : eventEventsReadMetaData
Type: object
Show Source
Nested Schema : columns
Type: array
Show Source
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
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