Fired Alarm Controller

get
Authorizations
Responses
200
OK
*/*
Responsestring
get
GET /api/alarms/fired-alarms/configs HTTP/1.1
Host: inscada.cloud
Accept: */*
text
put
Authorizations
Body
stringOptional
Responses
200
OK
put
PUT /api/alarms/fired-alarms/configs HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

post
Authorizations
Body
forcedOffBystringOptional
commentstringOptional
forcedOffbooleanOptional
offValueBnumber · doubleOptional
projectIdstringOptional
partstringOptional
firedAlarmTypestringOptional
offValuenumber · doubleOptional
offTimestring · date-timeOptional
namestringOptional
groupstringOptional
projectstringOptional
groupIdstringOptional
onValuenumber · doubleOptional
acknowledgerstringOptional
dscstringOptional
alarmIdstringOptional
statusstringOptional
onTimestring · date-timeOptional
acknowledgeTimestring · date-timeOptional
statusValueinteger · int32Optional
onValueBnumber · doubleOptional
acknowledgeTimeInMsinteger · int64Optional
offTimeInMsinteger · int64Optional
onTimeInMsinteger · int64Optional
Responses
204
No Content
post
POST /api/alarms/fired-alarms/force-off HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 485

{
  "forcedOffBy": "text",
  "comment": "text",
  "forcedOff": true,
  "offValueB": 1,
  "projectId": "text",
  "part": "text",
  "firedAlarmType": "text",
  "offValue": 1,
  "offTime": "2025-07-05T18:53:05.477Z",
  "name": "text",
  "group": "text",
  "project": "text",
  "groupId": "text",
  "onValue": 1,
  "acknowledger": "text",
  "dsc": "text",
  "alarmId": "text",
  "status": "text",
  "onTime": "2025-07-05T18:53:05.477Z",
  "acknowledgeTime": "2025-07-05T18:53:05.477Z",
  "statusValue": 1,
  "onValueB": 1,
  "acknowledgeTimeInMs": 1,
  "offTimeInMs": 1,
  "onTimeInMs": 1
}

No content

post
Authorizations
Body
forcedOffBystringOptional
commentstringOptional
forcedOffbooleanOptional
offValueBnumber · doubleOptional
projectIdstringOptional
partstringOptional
firedAlarmTypestringOptional
offValuenumber · doubleOptional
offTimestring · date-timeOptional
namestringOptional
groupstringOptional
projectstringOptional
groupIdstringOptional
onValuenumber · doubleOptional
acknowledgerstringOptional
dscstringOptional
alarmIdstringOptional
statusstringOptional
onTimestring · date-timeOptional
acknowledgeTimestring · date-timeOptional
statusValueinteger · int32Optional
onValueBnumber · doubleOptional
acknowledgeTimeInMsinteger · int64Optional
offTimeInMsinteger · int64Optional
onTimeInMsinteger · int64Optional
Responses
204
No Content
post
POST /api/alarms/fired-alarms/comment HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 485

{
  "forcedOffBy": "text",
  "comment": "text",
  "forcedOff": true,
  "offValueB": 1,
  "projectId": "text",
  "part": "text",
  "firedAlarmType": "text",
  "offValue": 1,
  "offTime": "2025-07-05T18:53:05.477Z",
  "name": "text",
  "group": "text",
  "project": "text",
  "groupId": "text",
  "onValue": 1,
  "acknowledger": "text",
  "dsc": "text",
  "alarmId": "text",
  "status": "text",
  "onTime": "2025-07-05T18:53:05.477Z",
  "acknowledgeTime": "2025-07-05T18:53:05.477Z",
  "statusValue": 1,
  "onValueB": 1,
  "acknowledgeTimeInMs": 1,
  "offTimeInMs": 1,
  "onTimeInMs": 1
}

No content

post
Authorizations
Body
forcedOffBystringOptional
commentstringOptional
forcedOffbooleanOptional
offValueBnumber · doubleOptional
projectIdstringOptional
partstringOptional
firedAlarmTypestringOptional
offValuenumber · doubleOptional
offTimestring · date-timeOptional
namestringOptional
groupstringOptional
projectstringOptional
groupIdstringOptional
onValuenumber · doubleOptional
acknowledgerstringOptional
dscstringOptional
alarmIdstringOptional
statusstringOptional
onTimestring · date-timeOptional
acknowledgeTimestring · date-timeOptional
statusValueinteger · int32Optional
onValueBnumber · doubleOptional
acknowledgeTimeInMsinteger · int64Optional
offTimeInMsinteger · int64Optional
onTimeInMsinteger · int64Optional
Responses
204
No Content
post
POST /api/alarms/fired-alarms/acknowledge HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 485

{
  "forcedOffBy": "text",
  "comment": "text",
  "forcedOff": true,
  "offValueB": 1,
  "projectId": "text",
  "part": "text",
  "firedAlarmType": "text",
  "offValue": 1,
  "offTime": "2025-07-05T18:53:05.477Z",
  "name": "text",
  "group": "text",
  "project": "text",
  "groupId": "text",
  "onValue": 1,
  "acknowledger": "text",
  "dsc": "text",
  "alarmId": "text",
  "status": "text",
  "onTime": "2025-07-05T18:53:05.477Z",
  "acknowledgeTime": "2025-07-05T18:53:05.477Z",
  "statusValue": 1,
  "onValueB": 1,
  "acknowledgeTimeInMs": 1,
  "offTimeInMs": 1,
  "onTimeInMs": 1
}

No content

get
Authorizations
Query parameters
countinteger · int32Required
Responses
200
OK
*/*
get
GET /api/alarms/fired-alarms HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "forcedOffBy": "text",
    "comment": "text",
    "forcedOff": true,
    "offValueB": 1,
    "projectId": "text",
    "part": "text",
    "firedAlarmType": "text",
    "offValue": 1,
    "offTime": "2025-07-05T18:53:05.477Z",
    "name": "text",
    "group": "text",
    "project": "text",
    "groupId": "text",
    "onValue": 1,
    "acknowledger": "text",
    "dsc": "text",
    "alarmId": "text",
    "status": "text",
    "onTime": "2025-07-05T18:53:05.477Z",
    "acknowledgeTime": "2025-07-05T18:53:05.477Z",
    "statusValue": 1,
    "onValueB": 1,
    "acknowledgeTimeInMs": 1,
    "offTimeInMs": 1,
    "onTimeInMs": 1
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
countinteger · int32Required
Responses
200
OK
*/*
get
GET /api/alarms/fired-alarms/monitor HTTP/1.1
Host: inscada.cloud
Accept: */*
[
  {
    "forcedOffBy": "text",
    "comment": "text",
    "forcedOff": true,
    "offValueB": 1,
    "projectId": "text",
    "part": "text",
    "firedAlarmType": "text",
    "offValue": 1,
    "offTime": "2025-07-05T18:53:05.477Z",
    "name": "text",
    "group": "text",
    "project": "text",
    "groupId": "text",
    "onValue": 1,
    "acknowledger": "text",
    "dsc": "text",
    "alarmId": "text",
    "status": "text",
    "onTime": "2025-07-05T18:53:05.477Z",
    "acknowledgeTime": "2025-07-05T18:53:05.477Z",
    "statusValue": 1,
    "onValueB": 1,
    "acknowledgeTimeInMs": 1,
    "offTimeInMs": 1,
    "onTimeInMs": 1
  }
]
get
Authorizations
Query parameters
Responses
200
OK
*/*
get
GET /api/alarms/fired-alarms/filter/pages HTTP/1.1
Host: inscada.cloud
Accept: */*
{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "forcedOffBy": "text",
      "comment": "text",
      "forcedOff": true,
      "offValueB": 1,
      "projectId": "text",
      "part": "text",
      "firedAlarmType": "text",
      "offValue": 1,
      "offTime": "2025-07-05T18:53:05.477Z",
      "name": "text",
      "group": "text",
      "project": "text",
      "groupId": "text",
      "onValue": 1,
      "acknowledger": "text",
      "dsc": "text",
      "alarmId": "text",
      "status": "text",
      "onTime": "2025-07-05T18:53:05.477Z",
      "acknowledgeTime": "2025-07-05T18:53:05.477Z",
      "statusValue": 1,
      "onValueB": 1,
      "acknowledgeTimeInMs": 1,
      "offTimeInMs": 1,
      "onTimeInMs": 1
    }
  ],
  "number": 1,
  "sort": [
    {
      "direction": "text",
      "nullHandling": "text",
      "ascending": true,
      "property": "text",
      "ignoreCase": true
    }
  ],
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "sort": [
      {
        "direction": "text",
        "nullHandling": "text",
        "ascending": true,
        "property": "text",
        "ignoreCase": true
      }
    ],
    "pageNumber": 1,
    "unpaged": true,
    "paged": true,
    "pageSize": 1
  },
  "empty": true
}