POST api/v1/alarms

Retrieves alarms for a CygNet alarm service, optionally within a specified date range

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Alarms to request

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Common Alarm Service (CAS)	string	Required
start	(Optional) Date and time to begin retrieving alarms	date	None
end	(Optional) Date and time to finish retrieving alarms	date	None

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.CAS",
  "start": "2023-04-06T13:19:00.903251-07:00",
  "end": "2023-04-07T13:19:00.903251-07:00"
}

Response Information

Resource Description

Lists alarm records present in the specified CygNet alarm service

Name	Description	Type	Additional information
alarmRecords	List of alarm records	Collection of AlarmRecordDTO	None

Response Formats

application/json, text/json

Sample:

{
  "alarmRecords": [
    {
      "isSuppressed": false,
      "pointTag": "CYG0101.UIS.00004794:ANTIER_RD_SYCSSTTN:ANTIER_RD.SYCSSTTN",
      "alarmRecordVersion": "AlmVer:43484.77233671",
      "highestAlarmPrioritySinceAck": 0,
      "highestAlarmPriority": 0,
      "alarmPriorityCategory": 0,
      "alarmPriority": 0,
      "alarmCategory": "COMM",
      "pointState": null,
      "alarmCondition": null,
      "alarmPriorityCategoryDescription": null,
      "isHidden": false,
      "isAcknowledged": false,
      "isSet": false,
      "reportedTimestamp": "2018-10-11T09:17:53-07:00",
      "pointValue": {
        "timestamp": "2018-10-11T09:17:47-07:00",
        "value": "1100.851486875",
        "alternateValue": "2.73935883993975",
        "status": [
          "Initialized",
          "Updated"
        ],
        "userStatus": [
          "PointScheme1",
          "ExternalValue"
        ],
        "externalStatus": 192
      }
    },
    {
      "isSuppressed": false,
      "pointTag": "CYG0101.UIS.00004804:ANTIER_WL_POACTSDV:ANTIER_WL.POACTSDV",
      "alarmRecordVersion": "AlmVer:42866.42313628",
      "highestAlarmPrioritySinceAck": 0,
      "highestAlarmPriority": 99,
      "alarmPriorityCategory": 0,
      "alarmPriority": 0,
      "alarmCategory": "GC",
      "pointState": null,
      "alarmCondition": null,
      "alarmPriorityCategoryDescription": null,
      "isHidden": false,
      "isAcknowledged": true,
      "isSet": false,
      "reportedTimestamp": "2018-10-11T09:17:53-07:00",
      "pointValue": {
        "timestamp": "2018-10-11T09:17:47-07:00",
        "value": "1100.851486875",
        "alternateValue": "2.73935883993975",
        "status": [
          "Initialized",
          "Updated"
        ],
        "userStatus": [
          "PointScheme1",
          "ExternalValue"
        ],
        "externalStatus": 192
      }
    }
  ]
}