Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET_Alarms

# GET Alarms

- Jump To

### Resource Information

Rate Limiting? | Yes
Sorting? | Yes
Paging? | Yes
Filtering? | Yes
Response Formats | xml json
HTTP Methods | GET

Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred.

## Resource URL

/webacs/api/v1/data/Alarms

Since : 1.2

## Response Parameters

Type | Attribute Name | Description
--- | --- | ---
boolean | acknowledgementStatus | Indicates whether the Alarm has been acknowledged.
Date | alarmFoundAt |
long | alarmId | A calculated opaque value that is used by the event handling implementation logic to identify the alarm and that serves as an identifier (sometimes known as a "business key"). In most cases, the specific alarm ID is an identifier for the entity that caused the alarm (known as the "alarm source" and available in the "source" attribute) augmented by a distinguishing value (or values) to facilitate unique identifying value for this specific alarm. The distinguishing values can be, but are not limited to, the specific types of the alarm.
Annotation[] | annotations | This nested field contains corrective message annotations. These are notes added to the alarm by the operator.
Type | Attribute Name | Description
--- | --- | ---
Date | creationTimestamp | Specifies the time the note was created.
String | creatorId | Specifies the name or user id of the creator of this note.
String | noteText | Note content added by operator.
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).
String | deviceName | Represents the entity for which the event/alarm is reported.
Date | lastUpdatedAt | Reflects the time when the Alarm was last modified.
String | message | Contains the Event/Alarm description as free text.
String | nttyaddrss7_address | Used to associate AP alarms with their controller.
String | owner | Specifies the name or ID of the person assigned to handle this alarm. If value is set to NULL, no owner is assigned.
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 when this alarm was created. This is the same as the time of the event that resulted in the creation of this alarm (attribute Event.notificationTimestamp).
String | wirelessSpecificAlarmId | Id used for associating Unified AP alarms with their Unified AP.

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/Alarms/42

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <queryResponse rootUrl="/webacs/data" requestUrl="https://192.168.116.207/webacs/api/v1/data/Alarms/42" responseType="getEntity">
        <entity url="/webacs/data/className/15" type="className" dtoType="alarmsDTO_$$_javassist_5208">
            <alarmsDTO id="15" displayName="String value">
                <acknowledgementStatus>true</acknowledgementStatus>
                <alarmFoundAt>2013-07-02T18:07:44.376-07:00</alarmFoundAt>
                <alarmId>2</alarmId>
                <annotations>
                    <annotation>
                        <creationTimestamp>2013-07-02T18:07:44.379-07:00</creationTimestamp>
                        <creatorId>String value</creatorId>
                        <noteText>String value</noteText>
                    </annotation>
                </annotations>
                <deviceName>String value</deviceName>
                <lastUpdatedAt>2013-07-02T18:07:44.381-07:00</lastUpdatedAt>
                <message>String value</message>
                <nttyaddrss7_address>String value</nttyaddrss7_address>
                <owner>String value</owner>
                <severity>CRITICAL</severity>
                <source>String value</source>
                <timeStamp>2013-07-02T18:07:44.381-07:00</timeStamp>
                <wirelessSpecificAlarmId>String value</wirelessSpecificAlarmId>
            </alarmsDTO>
        </entity>
    </queryResponse>

## Sample JSON Payload

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

    {
      "queryResponse" : {
        "@rootUrl" : "\/webacs\/data",
        "@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/data\/Alarms\/42",
        "@responseType" : "getEntity",
        "entity" : {
          "@url" : "\/webacs\/data\/className\/15",
          "@type" : "className",
          "@dtoType" : "alarmsDTO_$$_javassist_5208",
          "alarmsDTO" : {
            "@id" : "15",
            "@displayName" : "String value",
            "acknowledgementStatus" : true,
            "alarmFoundAt" : "2013-07-02T18 : 07 : 44.382-07 : 00",
            "alarmId" : 2,
            "annotations" : {
              "annotation" : {
                "creationTimestamp" : "2013-07-02T18 : 07 : 44.384-07 : 00",
                "creatorId" : "String value",
                "noteText" : "String value"
              }
            },
            "deviceName" : "String value",
            "lastUpdatedAt" : "2013-07-02T18 : 07 : 44.386-07 : 00",
            "message" : "String value",
            "nttyaddrss7_address" : "String value",
            "owner" : "String value",
            "severity" : "CRITICAL",
            "source" : "String value",
            "timeStamp" : "2013-07-02T18 : 07 : 44.387-07 : 00",
            "wirelessSpecificAlarmId" : "String value"
          }
        }
      }
    }