POST api/v1/alarms/clear?force={force}

Clears, or optionally force clears, specified alarms for a CygNet alarm service

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Alarm

Request Information

URI Parameters

Name	Description	Type	Additional information
force	(Optional) If value = True, force clears the specified alarms	boolean	Default value is False

Body Parameters

Alarms to clear

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Common Alarm Service (CAS)	string	Required
alarmIds	List of Alarm ID objects	Collection of AlarmIdDTO	Required

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.CAS",
  "alarmIds": [
    {
      "pointTag": "CYGSITE.UIS.00006771:ASH_WL_PRTUBXIN:ASH_WL.PRTUBXIN",
      "alarmRecordVersion": "AlmVer:42866.422995678"
    },
    {
      "pointTag": "CYGSITE.UIS.00006771:ASH_GM_PRTUBXIN:ASH_GM.PRTUBXIN",
      "alarmRecordVersion": "AlmVer:42866.42291234"
    }
  ]
}

Response Information

Resource Description

Lists alarm clearance errors encountered; otherwise returns an empty set

Name	Description	Type	Additional information
alarmClearErrors	List of alarm clearance errors	Collection of AlarmClearError	None

Response Formats

application/json, text/json

Sample:

{
  "alarmClearErrors": [
    {
      "alarmId": {
        "pointTag": "CYGSITE.UIS.00006771:ASH_WL_PRTUBXIN:ASH_WL.PRTUBXIN",
        "alarmRecordVersion": "AlmVer:42866.42295678"
      },
      "error": "AlarmAckError - Point Not Found"
    },
    {
      "alarmId": {
        "pointTag": "CYGSITE.UIS.00006771:ASH_GM_PRTUBXIN:ASH_GM.PRTUBXIN",
        "alarmRecordVersion": "AlmVer:42866.42291234"
      },
      "error": "AlarmAckError - Invalid State Change"
    }
  ]
}