Apama 10.3 | Apama Documentation | Connecting Apama Applications to External Components | Standard Connectivity Plug-ins | The Cumulocity IoT Transport Connectivity Plug-in | Using alarms | Querying for alarms
Querying for alarms
To search for an alarm or a collection of alarms, send the com.apama.cumulocity.FindAlarm event to Cumulocity IoT, with a unique reqId to the com.apama.cumulocity.FindAlarm.CHANNEL channel.
The transport will then respond with zero or more com.apama.cumulocity.FindAlarmResponse events and then one com.apama.cumulocity.FindAlarmResponseAck event on the com.apama.cumulocity.FindAlarmResponse.CHANNEL channel.
integer reqId := integer.getUnique();
com.apama.cumulocity.FindAlarm request := new com.apama.cumulocity.FindAlarm;
request.reqId := reqId;
// Filter based on alarms type
request.params.add("type", "c8y_UnavailabilityAlarm");
// Send request to find available alarms
send request to com.apama.cumulocity.FindAlarm.CHANNEL;
// Subscribe to com.apama.cumulocity.FindAlarmResponse.CHANNEL to listen
// for responses
// Listen for responses based on reqId
on all com.apama.cumulocity.FindAlarmResponse(reqId=reqId) as response
// Avoid listener leaks by terminating the listener on completion of the request
and not com.apama.cumulocity.FindAlarmResponseAck(reqId=reqId)
log "Received Alarm " + response.toString() at INFO;
// Listen for com.apama.cumulocity.FindAlarmResponseAck,
// this indicates that all responses have been received
on com.apama.cumulocity.FindAlarmResponseAck(reqId=reqId) as requestCompleted
log "Received all Alarm(s) for request " +
requestCompleted.reqId.toString() at INFO;
// Request is completed and we can unsubscribe from this channel
Supported query parameters
You can provide the following query parameters with the request:
Search for an alarm based on alarmId. When searching for an alarm based on Id, all the query parameters listed below are ignored.
Search for alarms based on the device identifier or asset identifier of the source.
Search for alarms based on the status. The status can be any of ACTIVE, ACKNOWLEDGED or CLEARED.
Search for alarms based on the severity. The severity can be any of CRITICAL, MAJOR, MINOR or WARNING.
Search for alarms based on the type.
Search for alarms from a start date. The date and time is provided as seconds since the epoch.
Search for alarms within a time range. This is to be used in combination with fromDate. The date and time is provided as seconds since the epoch.
A boolean parameter used for filtering, based on the resolved state.
Along with the above parameters, you can also provide other query parameters (such as pageSize) to be forwarded with the request to Cumulocity IoT.

Copyright © 2013-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.