Query Alarm Categories

Query and list the alarm categories.
The results include all alarm main categories, sub-categories, and their descriptions.

Interface URI

/fault/alarmCategory

Access Method

HTTP

GET

Parameters

Query parameters
total	Whether or not the total number of alarm categories is returned Boolean type. The default setting is false. If the value is set to true, the total number of alarm categories is returned

Returned Result

Status codes

• 200 (OK): Success.

Message body

<list>
  <alarmCategory>
    <id>1</id>
    <baseClass>1</baseClass>
    <subClass>1</subClass>
    <baseDesc>Other Alarms</baseDesc>
    <subDesc>Other Alarms</subDesc>
  </alarmCategory>
  <alarmCategory>
    <id>2</id>
    <baseClass>2</baseClass>
    <subClass>1</subClass>
    <baseDesc>Device Alarm</baseDesc>
    <subDesc>Device Availability Alarm/subDesc>
  </alarmCategory>
  <alarmCategory>
    <id>3</id>
    <baseClass>2</baseClass>
    <subClass>2</subClass>
    <baseDesc>Device Alarm</baseDesc>
    <subDesc>Interface\Link Status Alarm</subDesc>
  </alarmCategory>
  ...
</list>

Elements

alarmCategory sub-elements
id	Alarm category ID, which uniquely identifies an alarm category. Long integer type.
baseClass	Alarm main category. Long integer type.
baseDesc	Main category description. String type.
subClass	Alarm sub-category. Long integer type.
subDesc	Sub-category description. String type.

Example

Query and list all alarm categories.

Request

GET http://host:8080/imcrs/fault/alarmCategory
accept: application/xml
...
        

Response

HTTP/1.1 200 OK
Content-Type: application/xml
...
 
<list>
  <alarmCategory>
    <id>2</id>
    <baseClass>2</baseClass>
    <subClass>1</subClass>
    <baseDesc>Device alarm</baseDesc>
    <subDesc>Device reachability alarm</subDesc>
  </alarmCategory>
  ...
</list>