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 Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/data/Alarms
Response Parameters
acknowledgementStatus
boolean
|
Indicates whether the Alarm has been acknowledged.
|
alarmFoundAt
Date
|
Reflects the time when the Alarm was found.
|
alarmId
long
|
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.
|
annotations
Annotation[]
|
This nested field contains corrective message annotations. These are notes added to the alarm by the operator.
|
creationTimestamp
Date
|
Specifies the time the note was created.
|
creatorId
String
|
Specifies the name or user id of the creator of this note.
|
noteText
String
|
Note content added by operator.
|
|
category
EventAlarmCategoryEnum
|
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).
|
condition
EventTypeEnum
|
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).
|
deviceName
String
|
Represents the entity for which the event/alarm is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this alarm was created.
|
lastUpdatedAt
Date
|
Reflects the time when the Alarm was last modified.
|
message
String
|
Contains the Event/Alarm description as free text.
|
nttyaddrss7_address
String
|
Used to associate AP alarms with their controller.
|
owner
String
|
Specifies the name or ID of the person assigned to handle this alarm. If value is set to NULL, no owner is assigned.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
CRITICAL
MAJOR
MINOR
WARNING
CLEARED
INFORMATION
|
source
String
|
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.
|
timeStamp
Date
|
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).
|
wirelessSpecificAlarmId
String
|
Reports the MAC address of a rogue AP when a rogue AP is detected. Reports the wireless MAC address of an access point for all other alarms raised by an access point. Reports the controller IP address for alarms reported by a controller.
|
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://localhost/webacs/api/v1/data/Alarms/15
<?xml version="1.0" ?>
<queryResponse type="Alarms" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/Alarms/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="alarmsDTO" type="Alarms" url="https://localhost/webacs/api/v1/data/Alarms/15">
<alarmsDTO displayName="String value" id="15" uuid="String value">
<acknowledgementStatus>true</acknowledgementStatus>
<alarmFoundAt>2017-11-22T16:16:10.663Z</alarmFoundAt>
<alarmId>2</alarmId>
<annotations>
<annotation>
<creationTimestamp>2017-11-22T16:16:10.670Z</creationTimestamp>
<creatorId>String value</creatorId>
<noteText>String value</noteText>
</annotation>
</annotations>
<deviceName>String value</deviceName>
<deviceTimestamp>2017-11-22T16:16:10.675Z</deviceTimestamp>
<lastUpdatedAt>2017-11-22T16:16:10.675Z</lastUpdatedAt>
<message>String value</message>
<nttyaddrss7_address>String value</nttyaddrss7_address>
<owner>String value</owner>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2017-11-22T16:16:10.676Z</timeStamp>
<wirelessSpecificAlarmId>String value</wirelessSpecificAlarmId>
</alarmsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/Alarms/15.json
{
"queryResponse" : {
"@type" : "Alarms",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Alarms\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "alarmsDTO",
"@type" : "Alarms",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/Alarms\/15",
"alarmsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"acknowledgementStatus" : true,
"alarmFoundAt" : "2017-11-22T16 : 16 : 10.663Z",
"alarmId" : 2,
"annotations" : {
"annotation" : {
"creationTimestamp" : "2017-11-22T16 : 16 : 10.670Z",
"creatorId" : "String value",
"noteText" : "String value"
}
},
"deviceName" : "String value",
"deviceTimestamp" : "2017-11-22T16 : 16 : 10.675Z",
"lastUpdatedAt" : "2017-11-22T16 : 16 : 10.675Z",
"message" : "String value",
"nttyaddrss7_address" : "String value",
"owner" : "String value",
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : "2017-11-22T16 : 16 : 10.676Z",
"wirelessSpecificAlarmId" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/data/Alarms
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
acknowledgementStatus
boolean
|
Indicates whether the Alarm has been acknowledged.
|
alarmFoundAt
Date
|
Reflects the time when the Alarm was found.
|
alarmId
long
|
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.
|
annotations
Annotation[]
|
This nested field contains corrective message annotations. These are notes added to the alarm by the operator.
|
creationTimestamp
Date
|
Specifies the time the note was created.
|
creatorId
String
|
Specifies the name or user id of the creator of this note.
|
noteText
String
|
Note content added by operator.
|
|
category
EventAlarmCategoryEnum
|
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).
|
condition
EventTypeEnum
|
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).
|
deviceName
String
|
Represents the entity for which the event/alarm is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this alarm was created.
|
lastUpdatedAt
Date
|
Reflects the time when the Alarm was last modified.
|
message
String
|
Contains the Event/Alarm description as free text.
|
nttyaddrss7_address
String
|
Used to associate AP alarms with their controller.
|
owner
String
|
Specifies the name or ID of the person assigned to handle this alarm. If value is set to NULL, no owner is assigned.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
CRITICAL
MAJOR
MINOR
WARNING
CLEARED
INFORMATION
|
source
String
|
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.
|
timeStamp
Date
|
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).
|
wirelessSpecificAlarmId
String
|
Reports the MAC address of a rogue AP when a rogue AP is detected. Reports the wireless MAC address of an access point for all other alarms raised by an access point. Reports the controller IP address for alarms reported by a controller.
|
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://localhost/webacs/api/v2/data/Alarms/15
<?xml version="1.0" ?>
<queryResponse type="Alarms" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/Alarms/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="alarmsDTO" type="Alarms" url="https://localhost/webacs/api/v2/data/Alarms/15">
<alarmsDTO displayName="String value" id="15" uuid="String value">
<acknowledgementStatus>true</acknowledgementStatus>
<alarmFoundAt>2017-11-22T16:16:10.694Z</alarmFoundAt>
<alarmId>2</alarmId>
<annotations>
<annotation>
<creationTimestamp>2017-11-22T16:16:10.700Z</creationTimestamp>
<creatorId>String value</creatorId>
<noteText>String value</noteText>
</annotation>
</annotations>
<deviceName>String value</deviceName>
<deviceTimestamp>2017-11-22T16:16:10.706Z</deviceTimestamp>
<lastUpdatedAt>2017-11-22T16:16:10.707Z</lastUpdatedAt>
<message>String value</message>
<nttyaddrss7_address>String value</nttyaddrss7_address>
<owner>String value</owner>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2017-11-22T16:16:10.707Z</timeStamp>
<wirelessSpecificAlarmId>String value</wirelessSpecificAlarmId>
</alarmsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/Alarms/15.json
{
"queryResponse" : {
"@type" : "Alarms",
"@requestUrl" : "https://localhost/webacs/api/v2/data/Alarms/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "alarmsDTO",
"@type" : "Alarms",
"@url" : "https://localhost/webacs/api/v2/data/Alarms/15",
"alarmsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"acknowledgementStatus" : true,
"alarmFoundAt" : 1511367370694,
"alarmId" : 2,
"annotations" : {
"annotation" : [ {
"creationTimestamp" : 1511367370700,
"creatorId" : "String value",
"noteText" : "String value"
} ]
},
"deviceName" : "String value",
"deviceTimestamp" : 1511367370706,
"lastUpdatedAt" : 1511367370707,
"message" : "String value",
"nttyaddrss7_address" : "String value",
"owner" : "String value",
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : 1511367370707,
"wirelessSpecificAlarmId" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/data/Alarms
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
acknowledgementStatus
boolean
|
Indicates whether the Alarm has been acknowledged.
|
alarmFoundAt
Date
|
Reflects the time when the Alarm was found.
|
alarmId
long
|
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.
|
annotations
Annotation[]
|
This nested field contains corrective message annotations. These are notes added to the alarm by the operator.
|
creationTimestamp
Date
|
Specifies the time the note was created.
|
creatorId
String
|
Specifies the name or user id of the creator of this note.
|
noteText
String
|
Note content added by operator.
|
|
category
EventAlarmCategoryEnum
|
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).
|
condition
EventTypeEnum
|
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).
|
deviceName
String
|
Represents the entity for which the event/alarm is reported.
|
deviceTimestamp
Date
|
Specifies the device clock time when this alarm was created.
|
lastUpdatedAt
Date
|
Reflects the time when the Alarm was last modified.
|
message
String
|
Contains the Event/Alarm description as free text.
|
nttyaddrss7_address
String
|
Used to associate AP alarms with their controller.
|
owner
String
|
Specifies the name or ID of the person assigned to handle this alarm. If value is set to NULL, no owner is assigned.
|
severity
AlarmSeverityEnum
|
Specifies the Event/Alarm severity.
Allowed values:
CRITICAL
MAJOR
MINOR
WARNING
CLEARED
INFORMATION
|
source
String
|
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.
|
timeStamp
Date
|
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).
|
wirelessSpecificAlarmId
String
|
Reports the MAC address of a rogue AP when a rogue AP is detected. Reports the wireless MAC address of an access point for all other alarms raised by an access point. Reports the controller IP address for alarms reported by a controller.
|
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://localhost/webacs/api/v3/data/Alarms/15
<?xml version="1.0" ?>
<queryResponse type="Alarms" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/Alarms/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="alarmsDTO" type="Alarms" url="https://localhost/webacs/api/v3/data/Alarms/15">
<alarmsDTO displayName="String value" id="15" uuid="String value">
<acknowledgementStatus>true</acknowledgementStatus>
<alarmFoundAt>2017-11-22T16:16:10.720Z</alarmFoundAt>
<alarmId>2</alarmId>
<annotations>
<annotation>
<creationTimestamp>2017-11-22T16:16:10.732Z</creationTimestamp>
<creatorId>String value</creatorId>
<noteText>String value</noteText>
</annotation>
</annotations>
<deviceName>String value</deviceName>
<deviceTimestamp>2017-11-22T16:16:10.736Z</deviceTimestamp>
<lastUpdatedAt>2017-11-22T16:16:10.736Z</lastUpdatedAt>
<message>String value</message>
<nttyaddrss7_address>String value</nttyaddrss7_address>
<owner>String value</owner>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>2017-11-22T16:16:10.737Z</timeStamp>
<wirelessSpecificAlarmId>String value</wirelessSpecificAlarmId>
</alarmsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/Alarms/15.json
{
"queryResponse" : {
"@type" : "Alarms",
"@requestUrl" : "https://localhost/webacs/api/v3/data/Alarms/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "alarmsDTO",
"@type" : "Alarms",
"@url" : "https://localhost/webacs/api/v3/data/Alarms/15",
"alarmsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"acknowledgementStatus" : true,
"alarmFoundAt" : "2017-11-22T16:16:10.720Z",
"alarmId" : 2,
"annotations" : {
"annotation" : [ {
"creationTimestamp" : "2017-11-22T16:16:10.732Z",
"creatorId" : "String value",
"noteText" : "String value"
} ]
},
"deviceName" : "String value",
"deviceTimestamp" : "2017-11-22T16:16:10.736Z",
"lastUpdatedAt" : "2017-11-22T16:16:10.736Z",
"message" : "String value",
"nttyaddrss7_address" : "String value",
"owner" : "String value",
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : "2017-11-22T16:16:10.737Z",
"wirelessSpecificAlarmId" : "String value"
}
} ]
}
}