Alarms
URI Definition
Method | URI and Fields | ||||||||||||||||||||||||||||||||||||||||||||
GET | /iap/alarms | ||||||||||||||||||||||||||||||||||||||||||||
Returns all alarms that the current user is permitted to get, unless a filter is specified. Response
Query ParametersThe following query parameters can be used with this endpoint.
Example
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/count | |||||||||||||||||||||||||||||||||||||||||||||
Returns either the count of active alarms that the current user is permitted to get, or returns the count of active alarms at the current moment (AlarmState.ACTIVE). Query ParametersThe following query parameters can be used with this endpoint.
Example
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/definitions | |||||||||||||||||||||||||||||||||||||||||||||
Returns all alarm definitions that the current user is permitted to get. Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/definitions/{id} | |||||||||||||||||||||||||||||||||||||||||||||
Returns the alarm definition for the specified ID. Throws a ServiceRuntimeException if the specified alarm definition was not found. PropertiesThe following property is used with this endpoint.
Success ResponseUpdated alarm definition. Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/definitions/{id}/subscribers | |||||||||||||||||||||||||||||||||||||||||||||
Updates the list of subscribers for the specified alarm definition. PropertiesThe following property is used with this endpoint.
Success ResponseUpdated alarm definition. Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/dev/count | |||||||||||||||||||||||||||||||||||||||||||||
Returns the count of active alarms for the provided device IDs, or for all accessible devices if the list of provided IDs is null or empty. PropertiesThe following property is used with this endpoint.
Query ParameterThe following query parameter can be used with this endpoint.
Success Response:List of pairs with the device ID and count of currently active alarms. Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/dev/count/{deviceId} | |||||||||||||||||||||||||||||||||||||||||||||
Returns the number (count) of active alarms for devices using skipping non-communicating logic. PropertiesThe following property is used with this endpoint.
Response
Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/device/{deviceId} | |||||||||||||||||||||||||||||||||||||||||||||
Returns all alarms related to the specified device, including the cleared alarms. PropertiesThe following property is used with this endpoint.
Query ParametersThe following query parameters can be used with this endpoint.
Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/export | |||||||||||||||||||||||||||||||||||||||||||||
Exports alarms with the specified date range in CSV or PDF format. Response code is 200 in case of success, or some error code otherwise. Query ParametersThe following query parameters can be used with this endpoint.
Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/ids | |||||||||||||||||||||||||||||||||||||||||||||
Returns all alarm IDs that the current user is permitted to get, unless a filter is specified. Query ParametersThe following query parameters can be used with this endpoint.
Example
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/types | |||||||||||||||||||||||||||||||||||||||||||||
Returns all default alarm types. Example
| |||||||||||||||||||||||||||||||||||||||||||||
PUT | /iap/alarms/clear | ||||||||||||||||||||||||||||||||||||||||||||
Changes the state to INACTIVE_OPERATOR for the specified alarms. Alarms are specified in the payload as an array of alarm IDs. Response code is 200 in case of success, or some error code otherwise. Parameters:
Example:
| |||||||||||||||||||||||||||||||||||||||||||||
/iap/alarms/devs | |||||||||||||||||||||||||||||||||||||||||||||
Returns all alarms related to the specified devices, including the cleared ones. A successful request returns a collection of device IDs with their alarms. Parameters:
Query Parameters
|