Managing alarms by using REST API

Before you begin

To create and update alarms, you must have the required roles and permissions. For more information, see Roles-and-permissions.

To create a primary alarm by using REST API

To create a secondary alarm by using REST API

To update an alarm by using REST API

To clear alarms by changing the severity by using REST API

Incident Management defines the default alarm severity for each alarm, which is aligned with the TMF642 standard and the Alarm Resource specification. 

After an alarm is triggered, it is defined within six severity levels. These severity levels represent service-affecting conditions ordered from the most severe to the least:

To update the alarm severity by using REST API

You can add a new alarm to an existing incident, or a current alarm can be updated.

Before you begin

Make sure that you have a valid authentication token. For more information, see Access-and-authentication-for-REST-API.

To update the alarm severity in the Postman client

1. Open the Postman REST client.
2. Set the request URL as:
   https://<Innovation Suite server URL>/api/rx/application/record/recordinstance/com.bmc.dsm.netops-extensions%3AAM-Alarm/<Alarm ID>
3. Select as PUT in the operation.
4. Select raw.
5. From the list, select JSON.

6. Enter the JSON input.
   For example, update the following details in the payload to change the severity from Minor to Major:

   Fields	Values needed to change the severity	Description
   Referredtype	alarm	Denotes the targeted entity.
   Id	xyz	Indicates the incident ID that is being updated.
   Severity	major	Indicates the Severity value that is being updated.

   Request body to update the severity

     {
    "id": "AGGG1P27J624TASIRBUNSIRBUNWOA9", //Alarm ID
    "resourceType": "com.bmc.arsys.rx.services.record.domain.RecordInstance",
     "recordDefinitionName": "com.bmc.dsm.netops-extensions:AM-Alarm",
     "fieldInstances": {
      "880004125": {
        "resourceType": "com.bmc.arsys.rx.services.record.domain.FieldInstance",
        "id": 880004125,
        "value": "1LLZ6BS",     // Alarmed Object
      },
         "880004111": {
            "resourceType": "com.bmc.arsys.rx.services.record.domain.FieldInstance",
            "id": 880004111,
            "value": 60     // Perceived Severity
          },
           "880004131": {
            "resourceType": "com.bmc.arsys.rx.services.record.domain.FieldInstance",
            "id": 880004131,
            "value": "2024-01-04T09:49:48Z"     // Alarm Cleared Time
          },
           "880004108": {
            "resourceType": "com.bmc.arsys.rx.services.record.domain.FieldInstance",
            "id": 880004108,
            "value": "Test"     // System ID
          },
           "880004109": {
            "resourceType": "com.bmc.arsys.rx.services.record.domain.FieldInstance",
            "id": 880004109,
            "value": "Test"     // User ID
          }
          
    }
   }

7. Click Send.
   After the alarm is added to the incident, the severity value can be updated manually or by using the API. For more information about changing the alarm severity by using UI, see Managing-incident-requests.

   When you change the alarm severity value in the response body to Cleared and if the work orders and impact records associated with the incident are resolved, the status of the incident automatically changes to Resolved.

   If the alarm severity is updated to any other value by using REST API, the status of the incident automatically changes to In Progress, unless the incident is in Resolved status.