Custom Alarm Controller

get
Authorizations
Path parameters
alarmIdstringRequired
Responses
200
OK
*/*
Responseall of
get
GET /api/custom-alarms/{alarmId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T18:42:37.443Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:42:37.443Z",
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "condition": "text"
}
put
Authorizations
Path parameters
alarmIdstringRequired
Body
all ofOptional
Responses
204
No Content
put
PUT /api/custom-alarms/{alarmId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "condition": "text"
}
No content
delete
Authorizations
Path parameters
alarmIdstringRequired
Responses
204
No Content
delete
DELETE /api/custom-alarms/{alarmId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Responses
200
OK
*/*
Responseall of[]
get
GET /api/custom-alarms HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:42:37.443Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:42:37.443Z",
    "id": "text",
    "name": "text",
    "offTimeVariableId": "text",
    "groupId": "text",
    "delay": 1,
    "projectId": "text",
    "isActive": true,
    "part": "text",
    "dsc": "text",
    "onTimeVariableId": "text",
    "alarmType": "text",
    "type": "text",
    "condition": "text"
  }
]
post
Authorizations
Body
all ofOptional
Responses
200
OK
*/*
Responseall of
post
POST /api/custom-alarms HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "condition": "text"
}
{
  "creationDate": "2025-07-05T18:42:37.443Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:42:37.443Z",
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "condition": "text"
}
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
post
POST /api/custom-alarms/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
post
Authorizations
Query parameters
Body
dscInstringOptional
nameInstringOptional
partstringOptional
projectIdstringRequired
groupIdstringOptional
Responses
200
OK
*/*
post
POST /api/custom-alarms/filter/pages HTTP/1.1
Host: inscada.cloud
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-07-05T18:42:37.443Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T18:42:37.443Z",
      "id": "text",
      "name": "text",
      "offTimeVariableId": "text",
      "groupId": "text",
      "delay": 1,
      "projectId": "text",
      "isActive": true,
      "part": "text",
      "dsc": "text",
      "onTimeVariableId": "text",
      "alarmType": "text",
      "type": "text",
      "condition": "text"
    }
  ],
  "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
GET /api/custom-alarms/{alarmId}/status HTTP/1.1
Host: inscada.cloud
Accept: */*

Active
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/custom-alarms/status/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Active"
}
get
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
200
OK
*/*
Responsestring · enumPossible values:
get
GET /api/custom-alarms/status/by-project-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*

Active
get
Authorizations
Query parameters
alarmIdsstring[]Required
Responses
200
OK
*/*
get
GET /api/custom-alarms/status/by-alarm-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Active"
}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
Responsestring[]
get
GET /api/custom-alarms/parts-by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  "text"
]
get
Authorizations
Query parameters
Responses
200
OK
*/*
get
GET /api/custom-alarms/pages HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "creationDate": "2025-07-05T18:42:37.443Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T18:42:37.443Z",
      "id": "text",
      "name": "text",
      "offTimeVariableId": "text",
      "groupId": "text",
      "delay": 1,
      "projectId": "text",
      "isActive": true,
      "part": "text",
      "dsc": "text",
      "onTimeVariableId": "text",
      "alarmType": "text",
      "type": "text",
      "condition": "text"
    }
  ],
  "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
GET /api/custom-alarms/pages/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true,
  "size": 1,
  "content": [
    {
      "creationDate": "2025-07-05T18:42:37.443Z",
      "lastModifiedBy": "text",
      "createdBy": "text",
      "lastModifiedDate": "2025-07-05T18:42:37.443Z",
      "id": "text",
      "name": "text",
      "offTimeVariableId": "text",
      "groupId": "text",
      "delay": 1,
      "projectId": "text",
      "isActive": true,
      "part": "text",
      "dsc": "text",
      "onTimeVariableId": "text",
      "alarmType": "text",
      "type": "text",
      "condition": "text"
    }
  ],
  "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
GET /api/custom-alarms/export HTTP/1.1
Host: inscada.cloud
Accept: */*

{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
Responseall of[]
get
GET /api/custom-alarms/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:42:37.443Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:42:37.443Z",
    "id": "text",
    "name": "text",
    "offTimeVariableId": "text",
    "groupId": "text",
    "delay": 1,
    "projectId": "text",
    "isActive": true,
    "part": "text",
    "dsc": "text",
    "onTimeVariableId": "text",
    "alarmType": "text",
    "type": "text",
    "condition": "text"
  }
]
get
Authorizations
Query parameters
projectIdstringRequired
alarmNamestringRequired
Responses
200
OK
*/*
Responseall of
get
GET /api/custom-alarms/by-project-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T18:42:37.443Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:42:37.443Z",
  "id": "text",
  "name": "text",
  "offTimeVariableId": "text",
  "groupId": "text",
  "delay": 1,
  "projectId": "text",
  "isActive": true,
  "part": "text",
  "dsc": "text",
  "onTimeVariableId": "text",
  "alarmType": "text",
  "type": "text",
  "condition": "text"
}
get
Authorizations
Query parameters
projectIdstringRequired
groupNamestringRequired
Responses
200
OK
*/*
Responseall of[]
get
GET /api/custom-alarms/by-project-and-group HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:42:37.443Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:42:37.443Z",
    "id": "text",
    "name": "text",
    "offTimeVariableId": "text",
    "groupId": "text",
    "delay": 1,
    "projectId": "text",
    "isActive": true,
    "part": "text",
    "dsc": "text",
    "onTimeVariableId": "text",
    "alarmType": "text",
    "type": "text",
    "condition": "text"
  }
]
delete
Authorizations
Query parameters
alarmIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/custom-alarms/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
PreviousCustom Influx Db Datasource ControllerNextBroadcast Controller