system.alarm.queryJournal(startDate, endDate, journalName, priority, state, path, source, displaypath, all_properties, any_properties, defined, includeData, includeSystem, isSystem)
Date startDate - The start of the time range to query. Defaults to 8 hours previous to now if omitted. Time range is inclusive.
Date endDate - The end of the time range to query. Defaults to "now" if omitted.
String journalName - The journal name to query.
String priority - A list of possible priorities to match. Priorities can be specified by name or number, with the values: Diagnostic(0), Low(1), Medium(2), High(3), Critical(4).
String state - A list of the event state types to match. Valid values are "ClearUnacked", "ClearAcked", "ActiveUnacked", and "ActiveAcked".
String path - A list of possible source paths to search at. The wildcard "*" may be used.
String source - A list of possible source paths to search at. The wildcard "*" may be used.
String displaypath - A list of display paths to search at. Display paths are separated by "/", and if a path ends in "/*", everything below that path will be searched as well.
Object all_properties - A set of property conditions, all of which must be met for the condition to pass. This parameter is a list of tuples, in the form ("propName", "condition", value). Valid condition values: "=","!=","<","<=",">",">=". Only the first two conditions may be used for string values.
Object any_properties - A set of property conditions, any of which will cause the overall the condition to pass. This parameter is a list of tuples, in the form ("propName", "condition", value). Valid condition values: "=","!=","<","<=",">",">=". Only the first two conditions may be used for string values.
String defined - A list of string property names, all of which must be present on an event for it to pass.
Boolean includeData - Whether or not event data should be included in the return. If this parameter is false, and if there are no conditions specified on associated data, the properties table will not be queried.
Boolean includeSystem - Specifies whether system events are included in the return.
Boolean isSystem - Specifies whether the returned event must or must not be a system event.
AlarmQueryResult - The AlarmQueryResult object is functionally a list of AlarmEvent objects. The AlarmQueryResult object has a built-in getDataset() function that will return a Standard Dataset containing the Event Id (UUID of the alarm), Source Path, Display Path, Event Time, State (as an integer), and Priority (as an integer).
Additionally, each AlarmEvent inside of the AlarmQueryResult object has several built-in methods to extract alarm information. More details on these methods can be found on the Alarm Event Properties Reference page.
Each item in the resulting list is a separate alarm event: an alarm becoming active is one item, while the same alarm becoming acknowledged is a separate item. This differs from system.alarm.queryStatus() which groups each event into a single item.
Gateway, Vision Client, Perspective Session