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

Get Meta Events

get

/api/event/MetaEvents/

Gets the meta-events that match the specified parameters. If no parameters are specified, all meta-events are returned.

Request

Query Parameters
  • 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 meta-events that match the specified parameters.
Show Source
Nested Schema : eventMetaEventsRead
Type: object
Show Source
  • Indicates if the event has been flagged as acknowledged. Events will be displayed differently based on Ack. - 0 -> N0 - 1 -> Yes
    Example: 0
  • Action is an indication for a non-human entity that caused a change to be made.
    Example: $ACTION
  • Actor is an indication of the entity that caused the change to be made.
    Example: $ACTOR
  • The number of times this Event has happened (deduplicated)
    Example: 1
  • Customer.rules will set this to Unknown if not previously set.
    Example:
  • Description of Meta Event
    Example: Default Service Event
  • Details of the event (a JSON text)
    Example: {}
  • Device Type is used as a general category for the event. Customer.rules will set this to Unknown if not previously set.
    Example: Service
  • Example:
  • Example:
  • If an event should be escalated or not. ??? 0 = no ??? 1 = should be escalated ??? 2 = has been escalated
    Example:
  • Example:
  • Event Category - 1 -> Resolution - 2 -> Problem - 3 -> Discrete
    Example: $STATE
  • Event Key
    Example: Service_$SERVICENAME
  • Event type.
    Example: Event SLM
  • 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: 3600
  • Timestamp when event was first reported
    Example: $TIMESTAMP
  • Example: $IPADDRESS
  • Timestamp when event was last changed
    Example: $TIMESTAMP
  • Timestamp when event was last reported
    Example: $TIMESTAMP
  • Name, Address, or something similar associated with the Event. Observability Analytics uses this if it is set.
    Example:
  • Meta Event ID specified for individual CRUD operations for Assure1.EventMetaEvents
    Example: 1
  • Meta Event Name
    Example: Default Service Event
  • 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: EventSLM
  • The name of the device where the event happened (usually the DNS name of the device associated with the event)
    Example: $SERVICENAME
  • The original severity when the event was first created.
    Example: $SEVERITY
  • 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:
  • The SLM applications will set this to the name of the SLM Service if a violation is detected.
    Example: $SERVICENAME
  • Flag to indicate a provided service has been impacted. Allowed values: - 0 = Not service impacting - 1 = Service impacting
    Example: $SERVICEIMPACT
  • 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 => Critical
    Example: $SEVERITY
  • Example:
  • Example:
  • Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.
    Example: Event Service
  • 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: $SERVICENAME
  • 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: $SERVICEID
  • Event description summary.
    Example: Service $STATE_TEXT ($VALUE $OPERATOR $THRESHOLD)
  • A flag for the ticket state of this event. - 0 = no ticket - 1 = ticket to be created - 2 = processing - 3 = opened
    Example:
  • 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:

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