GET api/v1/alarms/points/{pointTag}

Retrieves alarms for a specified point

CygNet Access Requirements

    CygNet ACS security: BRDGAPI ACCESS 1

    CygNet Bridge API license type: Base

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pointTag

Point tag to retrieve alarms for

 string

Required

Body Parameters

None

Response Information

Resource Description

Lists alarm records for a specified point

NameDescriptionTypeAdditional information
alarmRecord

Alarm record

 AlarmRecordDTO

None

Response Formats

application/json, text/json

Sample: 
{
  "alarmRecord": {
    "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
    }
  }
}