Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET Events

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Represents a "normalized" record of an occurrence reported by the network (or any system capable of notifying of such an occurrence); it could be a syslog, SNMP trap, or any other such type. The term "normalized" denotes a single format abstracted over all types of reported events, regardless of source and structure.

Since Product Version: 1.2

Resource URL

/webacs/api/v1/data/Events

Response Parameters

Type Attribute Name Description

EventAlarmCategoryEnum

category

Specifies the major category for the Alarm/Event. Categories are major functionality areas for events. For example, the wireless network management application categorizes events by the type of network element or entity that can emit them (access point, wireless LAN controller, port). A different application can introduce a different set of categories. Binding the list of categories for a particular implementation is represented as a "Lookup" datatype for the values (as opposed to an immutable enumeration type).

String

chassisId

Chassis ID

EventTypeEnum

condition

Specifies a type of occurrence/event within a category. Different applications can introduce different sets of types. Binding the list of types for a particular implementation is represented as a "Lookup" enumeration datatype for the values (as opposed to an immutable enumeration type).

Long

correlated

String

description

Contains the Event/Alarm description as free text.

String

deviceName

Date

deviceTimestamp

Specifies the device clock time when this event occured.

Date

eventFoundAt

long

eventId

Event Id.

String

instanceUuid

This is a uuid for this instance.

AlarmSeverityEnum

severity

Specifies the Event/Alarm severity.

Allowed values:

  • CRITICAL
  • MAJOR
  • MINOR
  • WARNING
  • CLEARED
  • INFORMATION

String

source

Represents the entity for which the event/alarm is reported. This is not necessarily the reporting entity; in many cases, the notification is sent by an entity reporting an occurrence on another entity. Note that this is an opaque reference type that MIGHT be a reference to a known entity (that is, an instance in the model), but it might also be a reference to an entity that is not represented in the system.

String

srcObjectBusinessKey

Event Source Object Business Key

int

srcObjectClassId

Event Source Object Class ID

String

srcObjectDisplayName

Event Source Object Display Name

long

srcObjectId

Event Source Object ID

Date

timeStamp

Specifies the time the event occurred. If this time is not available (because the raw notification did not carry this information), the timestamp specifies the time this record was created.

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Payload

https://172.25.123.114/webacs/api/v1/data/Events/15

<?xml version="1.0" ?>
<queryResponse type="Events" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/Events/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="eventsDTO" type="Events" url="https://172.25.123.114/webacs/api/v1/data/Events/15">
    <eventsDTO displayName="String value" id="15" uuid="String value">
      <chassisId>String value</chassisId>
      <correlated>15</correlated>
      <description>String value</description>
      <deviceName>String value</deviceName>
      <deviceTimestamp>2020-07-28T20:28:14.233Z</deviceTimestamp>
      <eventFoundAt>2020-07-28T20:28:14.233Z</eventFoundAt>
      <eventId>2</eventId>
      <severity>CRITICAL</severity>
      <source>String value</source>
      <srcObjectBusinessKey>String value</srcObjectBusinessKey>
      <srcObjectClassId>1</srcObjectClassId>
      <srcObjectDisplayName>String value</srcObjectDisplayName>
      <srcObjectId>2</srcObjectId>
      <timeStamp>2020-07-28T20:28:14.234Z</timeStamp>
    </eventsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/Events/15.json

{
  "queryResponse" : {
    "@type" : "Events",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Events\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "eventsDTO",
      "@type" : "Events",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Events\/15",
      "eventsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "chassisId" : "String value",
        "correlated" : 15,
        "description" : "String value",
        "deviceName" : "String value",
        "deviceTimestamp" : "2020-07-28T20 : 28 : 14.233Z",
        "eventFoundAt" : "2020-07-28T20 : 28 : 14.233Z",
        "eventId" : 2,
        "severity" : "CRITICAL",
        "source" : "String value",
        "srcObjectBusinessKey" : "String value",
        "srcObjectClassId" : 1,
        "srcObjectDisplayName" : "String value",
        "srcObjectId" : 2,
        "timeStamp" : "2020-07-28T20 : 28 : 14.234Z"
      }
    }
  }
}