Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_Events

# GET Events

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
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.

## Resource URL

/webacs/api/v1/data/Events

Since : 1.2

## 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).
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 | eventFoundAt |
long | eventId | Event Id.
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.
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 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://192.168.116.207/webacs/api/v1/data/Events/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/Events/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="eventsDTO_$$_javassist_5202">
            <eventsDTO id="15" displayName="String value">
                <correlated>15</correlated>
                <description>String value</description>
                <deviceName>String value</deviceName>
                <eventFoundAt>2013-07-02T18:07:43.859-07:00</eventFoundAt>
                <eventId>2</eventId>
                <severity>CRITICAL</severity>
                <source>String value</source>
                <timeStamp>2013-07-02T18:07:43.859-07:00</timeStamp>
            </eventsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

https://192.168.116.207/webacs/api/v1/data/Events/42.json

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/Events\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "eventsDTO_$$_javassist_5202",
          "eventsDTO" : {
            "@id" : "15",
            "@displayName" : "String value",
            "correlated" : 15,
            "description" : "String value",
            "deviceName" : "String value",
            "eventFoundAt" : "2013-07-02T18 : 07 : 43.861-07 : 00",
            "eventId" : 2,
            "severity" : "CRITICAL",
            "source" : "String value",
            "timeStamp" : "2013-07-02T18 : 07 : 43.861-07 : 00"
          }
        }
      }
    }