API Alarm Commands

The PrismUI API can retrieve details about active alarms in your project. The below commands use JSON elements to specify parameters and to send the response information. Each one is appended to the URL for the Runtime it is connecting to.

/api/Alarms/Types

This GET command retrieves a list of available alarm type IDs in the project.

Responses

Code Description
200 The request succeeded and the ID list is returned.
404 Alarms do not exist.

/api/Alarms/Types/{id}

This GET command retrieves the details for a specific alarm type ID.

Parameters

Name Description
id The ID for the alarm type in the project.

Responses

Code Description
200 The request succeeded and the details for the alarm type are returned.
404 This alarm type does not exist.

/api/Alarms/Postings

This GET command retrieves the list of available alarm posting IDs in the project.

Responses

Code Description
200 The request succeeded and the alarm posting ID list is returned.
404 There are no existing alarm postings.

/api/Alarms/Postings/{id}

This GET command retrieves the details for a specified alarm posting ID.

Parameters

Name Description
id The ID for the alarm posting in the project.

Responses

Code Description
200 The request succeeded and the alarm posting details are returned.
404 The alarm posting does not exist.