POST api/v1/alarms/points

Retrieves alarms for a list of points

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Name	Description	Type	Additional information
pointTags	List of point tags	Collection of string	Required

Request Formats

application/json, text/json

Sample:

{
  "pointTags": [
    "CYGSITE.UIS.00005074:BRADY_GM_ANNPE:BRADY_GM.ANNPE",
    "CYGSITE.UIS::BRADY_GM.ANNON"
  ]
}

Response Information

Resource Description

Lists alarm records for the specified points

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
      }
    }
  ]
}