Fired Alarm Controller | Version 2022

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Responses

200

OK

*/*

Responsestring

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/fired-alarms/configs

GET /api/alarms/fired-alarms/configs HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

text

put

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Body

stringOptional

Responses

200

OK

No content

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

put

/api/alarms/fired-alarms/configs

PUT /api/alarms/fired-alarms/configs HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/fired-alarms/force-off

POST /api/alarms/fired-alarms/force-off HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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-11-22T23:41:24.665Z",
  "name": "text",
  "group": "text",
  "project": "text",
  "groupId": "text",
  "onValue": 1,
  "acknowledger": "text",
  "dsc": "text",
  "alarmId": "text",
  "status": "text",
  "onTime": "2025-11-22T23:41:24.665Z",
  "acknowledgeTime": "2025-11-22T23:41:24.665Z",
  "statusValue": 1,
  "onValueB": 1,
  "acknowledgeTimeInMs": 1,
  "offTimeInMs": 1,
  "onTimeInMs": 1
}

No content

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/fired-alarms/comment

POST /api/alarms/fired-alarms/comment HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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-11-22T23:41:24.665Z",
  "name": "text",
  "group": "text",
  "project": "text",
  "groupId": "text",
  "onValue": 1,
  "acknowledger": "text",
  "dsc": "text",
  "alarmId": "text",
  "status": "text",
  "onTime": "2025-11-22T23:41:24.665Z",
  "acknowledgeTime": "2025-11-22T23:41:24.665Z",
  "statusValue": 1,
  "onValueB": 1,
  "acknowledgeTimeInMs": 1,
  "offTimeInMs": 1,
  "onTimeInMs": 1
}

No content

post

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

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

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

post

/api/alarms/fired-alarms/acknowledge

POST /api/alarms/fired-alarms/acknowledge HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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-11-22T23:41:24.665Z",
  "name": "text",
  "group": "text",
  "project": "text",
  "groupId": "text",
  "onValue": 1,
  "acknowledger": "text",
  "dsc": "text",
  "alarmId": "text",
  "status": "text",
  "onTime": "2025-11-22T23:41:24.665Z",
  "acknowledgeTime": "2025-11-22T23:41:24.665Z",
  "statusValue": 1,
  "onValueB": 1,
  "acknowledgeTimeInMs": 1,
  "offTimeInMs": 1,
  "onTimeInMs": 1
}

No content

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

countinteger · int32Required

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/fired-alarms

GET /api/alarms/fired-alarms?count=1 HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "forcedOffBy": "text",
    "comment": "text",
    "forcedOff": true,
    "offValueB": 1,
    "projectId": "text",
    "part": "text",
    "firedAlarmType": "text",
    "offValue": 1,
    "offTime": "2025-11-22T23:41:24.665Z",
    "name": "text",
    "group": "text",
    "project": "text",
    "groupId": "text",
    "onValue": 1,
    "acknowledger": "text",
    "dsc": "text",
    "alarmId": "text",
    "status": "text",
    "onTime": "2025-11-22T23:41:24.665Z",
    "acknowledgeTime": "2025-11-22T23:41:24.665Z",
    "statusValue": 1,
    "onValueB": 1,
    "acknowledgeTimeInMs": 1,
    "offTimeInMs": 1,
    "onTimeInMs": 1
  }
]

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

projectIdstringRequired

countinteger · int32Required

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/fired-alarms/monitor

GET /api/alarms/fired-alarms/monitor?projectId=text&count=1 HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "forcedOffBy": "text",
    "comment": "text",
    "forcedOff": true,
    "offValueB": 1,
    "projectId": "text",
    "part": "text",
    "firedAlarmType": "text",
    "offValue": 1,
    "offTime": "2025-11-22T23:41:24.665Z",
    "name": "text",
    "group": "text",
    "project": "text",
    "groupId": "text",
    "onValue": 1,
    "acknowledger": "text",
    "dsc": "text",
    "alarmId": "text",
    "status": "text",
    "onTime": "2025-11-22T23:41:24.665Z",
    "acknowledgeTime": "2025-11-22T23:41:24.665Z",
    "statusValue": 1,
    "onValueB": 1,
    "acknowledgeTimeInMs": 1,
    "offTimeInMs": 1,
    "onTimeInMs": 1
  }
]

get

Authorizations

ins_access_tokenstringRequired

Access token provided as a cookie named 'ins_access_token'. This token is obtained after successful login and is valid for x minutes. It can be refreshed using the ins_refresh_token cookie at the /refresh endpoint.

X-SpacestringRequired

Required active space header

Query parameters

Responses

200

OK

*/*

400

Bad Request

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

500

Internal Server Error

*/*

get

/api/alarms/fired-alarms/filter/pages

GET /api/alarms/fired-alarms/filter/pages?arg0=[object+Object]&arg1=[object+Object] HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
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-11-22T23:41:24.665Z",
      "name": "text",
      "group": "text",
      "project": "text",
      "groupId": "text",
      "onValue": 1,
      "acknowledger": "text",
      "dsc": "text",
      "alarmId": "text",
      "status": "text",
      "onTime": "2025-11-22T23:41:24.665Z",
      "acknowledgeTime": "2025-11-22T23:41:24.665Z",
      "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
}