Alarm Controller Facade

get
Authorizations
Path parameters
alarmIdstringRequired
Responses
200

OK

*/*
Responseone of
all ofOptional
or
all ofOptional
or
all ofOptional
get
/api/alarms/{alarmId}
GET /api/alarms/{alarmId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-10-31T22:41:48.915Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-10-31T22:41:48.915Z",
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "lowValue": 1,
  "highValue": 1,
  "setPointValue": 1,
  "lowLowValue": 1,
  "deadband": 1,
  "highHighValue": 1,
  "variableId": "text",
  "deviationPercentage": 1
}
put
Authorizations
Path parameters
alarmIdstringRequired
Body
one ofOptional
all ofOptional
or
all ofOptional
or
all ofOptional
Responses
204

No Content

No content
put
/api/alarms/{alarmId}
PUT /api/alarms/{alarmId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "lowValue": 1,
  "highValue": 1,
  "setPointValue": 1,
  "lowLowValue": 1,
  "deadband": 1,
  "highHighValue": 1,
  "variableId": "text",
  "deviationPercentage": 1
}
No content
delete
Authorizations
Path parameters
alarmIdstringRequired
Responses
204

No Content

No content
delete
/api/alarms/{alarmId}
DELETE /api/alarms/{alarmId} HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
get
Authorizations
Responses
200

OK

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

[
  {
    "creationDate": "2025-10-31T22:41:48.915Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-10-31T22:41:48.915Z",
    "id": "text",
    "name": "text",
    "offTimeVariableId": "text",
    "groupId": "text",
    "delay": 1,
    "projectId": "text",
    "isActive": true,
    "part": "text",
    "dsc": "text",
    "onTimeVariableId": "text",
    "alarmType": "text",
    "type": "text",
    "lowValue": 1,
    "highValue": 1,
    "setPointValue": 1,
    "lowLowValue": 1,
    "deadband": 1,
    "highHighValue": 1,
    "variableId": "text",
    "deviationPercentage": 1
  }
]
post
Authorizations
Body
one ofOptional
all ofOptional
or
all ofOptional
or
all ofOptional
Responses
200

OK

*/*
Responseone of
all ofOptional
or
all ofOptional
or
all ofOptional
post
/api/alarms
POST /api/alarms HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "lowValue": 1,
  "highValue": 1,
  "setPointValue": 1,
  "lowLowValue": 1,
  "deadband": 1,
  "highHighValue": 1,
  "variableId": "text",
  "deviationPercentage": 1
}
{
  "creationDate": "2025-10-31T22:41:48.915Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-10-31T22:41:48.915Z",
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "lowValue": 1,
  "highValue": 1,
  "setPointValue": 1,
  "lowLowValue": 1,
  "deadband": 1,
  "highHighValue": 1,
  "variableId": "text",
  "deviationPercentage": 1
}
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200

OK

*/*
Responseobject
post
/api/alarms/import
POST /api/alarms/import HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
post
Authorizations
Query parameters
Body
dscInstringOptional
nameInstringOptional
partstringOptional
projectIdstringRequired
groupIdstringOptional
Responses
200

OK

*/*
post
/api/alarms/filter/pages
POST /api/alarms/filter/pages?pageable=[object+Object] HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "dscIn": "text",
  "nameIn": "text",
  "part": "text",
  "projectId": "text",
  "groupId": "text"
}
{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "creationDate": "2025-10-31T22:41:48.915Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-10-31T22:41:48.915Z",
      "id": "text",
      "name": "text",
      "offTimeVariableId": "text",
      "groupId": "text",
      "delay": 1,
      "projectId": "text",
      "isActive": true,
      "part": "text",
      "dsc": "text",
      "onTimeVariableId": "text",
      "alarmType": "text",
      "type": "text",
      "lowValue": 1,
      "highValue": 1,
      "setPointValue": 1,
      "lowLowValue": 1,
      "deadband": 1,
      "highHighValue": 1,
      "variableId": "text",
      "deviationPercentage": 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
}
get
Authorizations
Path parameters
alarmIdstringRequired
Responses
200

OK

*/*
Responsestring · enumPossible values:
get
/api/alarms/{alarmId}/status
GET /api/alarms/{alarmId}/status HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

Active
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/alarms/status/by-project
GET /api/alarms/status/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Active"
}
get
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200

OK

*/*
Responsestring · enumPossible values:
get
/api/alarms/status/by-project-and-name
GET /api/alarms/status/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

Active
get
Authorizations
Query parameters
alarmIdsstring[]Required
Responses
200

OK

*/*
get
/api/alarms/status/by-alarm-ids
GET /api/alarms/status/by-alarm-ids?alarmIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Active"
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
Responsestring[]
get
/api/alarms/parts-by-project
GET /api/alarms/parts-by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  "text"
]
get
Authorizations
Query parameters
Responses
200

OK

*/*
get
/api/alarms/pages
GET /api/alarms/pages?arg0=[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": [
    {
      "creationDate": "2025-10-31T22:41:48.915Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-10-31T22:41:48.915Z",
      "id": "text",
      "name": "text",
      "offTimeVariableId": "text",
      "groupId": "text",
      "delay": 1,
      "projectId": "text",
      "isActive": true,
      "part": "text",
      "dsc": "text",
      "onTimeVariableId": "text",
      "alarmType": "text",
      "type": "text",
      "lowValue": 1,
      "highValue": 1,
      "setPointValue": 1,
      "lowLowValue": 1,
      "deadband": 1,
      "highHighValue": 1,
      "variableId": "text",
      "deviationPercentage": 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
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/alarms/pages/by-project
GET /api/alarms/pages/by-project?projectId=text&pageable=[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": [
    {
      "creationDate": "2025-10-31T22:41:48.915Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-10-31T22:41:48.915Z",
      "id": "text",
      "name": "text",
      "offTimeVariableId": "text",
      "groupId": "text",
      "delay": 1,
      "projectId": "text",
      "isActive": true,
      "part": "text",
      "dsc": "text",
      "onTimeVariableId": "text",
      "alarmType": "text",
      "type": "text",
      "lowValue": 1,
      "highValue": 1,
      "setPointValue": 1,
      "lowLowValue": 1,
      "deadband": 1,
      "highHighValue": 1,
      "variableId": "text",
      "deviationPercentage": 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
}
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200

OK

*/*
Responseobject
get
/api/alarms/export
GET /api/alarms/export HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/alarms/by-project
GET /api/alarms/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-10-31T22:41:48.915Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-10-31T22:41:48.915Z",
    "id": "text",
    "name": "text",
    "offTimeVariableId": "text",
    "groupId": "text",
    "delay": 1,
    "projectId": "text",
    "isActive": true,
    "part": "text",
    "dsc": "text",
    "onTimeVariableId": "text",
    "alarmType": "text",
    "type": "text",
    "lowValue": 1,
    "highValue": 1,
    "setPointValue": 1,
    "lowLowValue": 1,
    "deadband": 1,
    "highHighValue": 1,
    "variableId": "text",
    "deviationPercentage": 1
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
alarmNamestringRequired
Responses
200

OK

*/*
Responseone of
all ofOptional
or
all ofOptional
or
all ofOptional
get
/api/alarms/by-project-and-name
GET /api/alarms/by-project-and-name?projectId=text&alarmName=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

{
  "creationDate": "2025-10-31T22:41:48.915Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-10-31T22:41:48.915Z",
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "lowValue": 1,
  "highValue": 1,
  "setPointValue": 1,
  "lowLowValue": 1,
  "deadband": 1,
  "highHighValue": 1,
  "variableId": "text",
  "deviationPercentage": 1
}
get
Authorizations
Query parameters
projectIdstringRequired
groupNamestringRequired
Responses
200

OK

*/*
get
/api/alarms/by-project-and-group
GET /api/alarms/by-project-and-group?projectId=text&groupName=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

[
  {
    "creationDate": "2025-10-31T22:41:48.915Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-10-31T22:41:48.915Z",
    "id": "text",
    "name": "text",
    "offTimeVariableId": "text",
    "groupId": "text",
    "delay": 1,
    "projectId": "text",
    "isActive": true,
    "part": "text",
    "dsc": "text",
    "onTimeVariableId": "text",
    "alarmType": "text",
    "type": "text",
    "lowValue": 1,
    "highValue": 1,
    "setPointValue": 1,
    "lowLowValue": 1,
    "deadband": 1,
    "highHighValue": 1,
    "variableId": "text",
    "deviationPercentage": 1
  }
]
delete
Authorizations
Query parameters
alarmIdsstring[]Required
Responses
204

No Content

No content
delete
/api/alarms/multi/by-ids
DELETE /api/alarms/multi/by-ids?alarmIds=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
PreviousAnalog Alarm ControllerNextAlarm Group Controller

Last updated