GET HistoricalAlarms

Returns historical alarms.

Relative URL

rest/HistoricalAlarms?PointName={PointName}&StartDate={StartDate}&EndDate={EndDate}

Parameters

PointName (required) -The name of the point (alarm server) from which to retrieve the historical alarms

Default Value: None

Example Value: awx:Alarms/@ICONICS.AlarmSvr.1.Server

StartDate (optional) -The start time of the window for which to retrieve the data in the format: YYYY-MM-ddThh:mm:ss. The special value of 'now' (without quotes) can be used to pass the current date and time. A negative offset can also be provided using the format: now - hh:mm:ss

Default Value: 1 day back from the value of EndDate.

Example Value: 2015-01-01T00:00:00

EndDate (optional) - The end time of the window for which to retrieve the data in the format: YYYY-MM-ddThh:mm:ss. The special value of 'now' (without quotes) can be used to pass the current date and time. A negative offset can also be provided using the format: now - hh:mm:ss

Default Value: The current date and time at the moment of the call.

Example Value: 2015-01-31T00:00:00

Example Result

An array containing multiple objects, each one representing an alarm. The returned columns can be customized via the EventFields parameter (POST only).

[ { "EventType": "OpcAEType", "EventClass": 2, "SourceName": "@ICONICS.AlarmSvr.1\\Arm Torque.Limit.Condition", "Time": "2015-07-28T14:36:04.178Z", "ReceiveTime": "2015-08-24T19:49:59.025936Z", "Message": "Arm Torque is High", "Severity": 500, "AckRequired": true, "ActiveTime": "2015-07-28T14:36:04.178Z", "ActorId": "", "ChangeMask": 49, "ConditionName": "Limit", "NewState": 3, "OriginalSource": "Arm Torque", "Retain": null, "StatusCode": 0, "SubConditionName": "HI", "Category": 3, "CategoryName": null, "AttributeCount": null, "ServerNode": null, "Attribute1": "60", "Attribute2": null, "Attribute3": null, "Attribute4": "Plant Area A", "Attribute5": null, "Attribute6": null, "Attribute7": "60", "Attribute8": null, "Attribute9": null, "Attribute10": null, "Attribute11": null, "Attribute12": null, "Attribute13": null, "Attribute14": null, "Attribute15": null, "Attribute16": null, "Attribute17": null, "Attribute18": null, "Attribute19": null, "Attribute20": null, "CV": "60", "AckComment": null, "Area": "Plant Area A", "LimitExceeded": "60", "NewValue": null, "Comment": null, "Node": null, "PreviousValue": null, "NameOfParameter": null }, { "EventType": "OpcAEType", "EventClass": 2, "SourceName": "@ICONICS.AlarmSvr.1\\Coolant Level.Limit.Condition", "Time": "2015-07-28T14:36:03.241Z", "ReceiveTime": "2015-08-24T19:49:59.0339353Z", "Message": "Coolant level is low. Possible leak?", "Severity": 600, "AckRequired": true, "ActiveTime": "2015-07-28T14:36:03.241Z", "ActorId": "", "ChangeMask": 48, "ConditionName": "Limit", "NewState": 3, "OriginalSource": "Coolant Level", "Retain": null, "StatusCode": 0, "SubConditionName": "LO", "Category": 3, "CategoryName": null, "AttributeCount": null, "ServerNode": null, "Attribute1": "51", "Attribute2": null, "Attribute3": null, "Attribute4": "Plant Area B", "Attribute5": null, "Attribute6": null, "Attribute7": "90", "Attribute8": null, "Attribute9": null, "Attribute10": null, "Attribute11": null, "Attribute12": null, "Attribute13": null, "Attribute14": null, "Attribute15": null, "Attribute16": null, "Attribute17": null, "Attribute18": null, "Attribute19": null, "Attribute20": null, "CV": "51", "AckComment": null, "Area": "Plant Area B", "LimitExceeded": "90", "NewValue": null, "Comment": null, "Node": null, "PreviousValue": null, "NameOfParameter": null } ]