Alarm Group Controller

get
Authorizations
Path parameters
groupIdstringRequired
Responses
200

OK

*/*
get
/api/alarms/groups/{groupId}
GET /api/alarms/groups/{groupId} 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",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}
put
Authorizations
Path parameters
groupIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
priorityinteger · int32 · min: 1 · max: 255Required
onAckColorstring · max: 7Optional
namestring · max: 100Required
scanTimeInMillisinteger · int32 · min: 100Required
printerPortinteger · int32Optional
offAckColorstring · max: 7Optional
offNoAckColorstring · max: 7Optional
onNoAckColorstring · max: 7Optional
onScriptIdstringOptional
printWhenOnbooleanOptional
printWhenOffbooleanOptional
ackScriptIdstringOptional
hiddenOnMonitorbooleanOptional
printWhenAckbooleanOptional
printerIpstring · max: 15Optional
projectIdstringOptional
dscstring · max: 255Optional
offScriptIdstringOptional
ownerstringOptional
Responses
204

No Content

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

{
  "id": "text",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}
No content
delete
Authorizations
Path parameters
groupIdstringRequired
Responses
204

No Content

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

No content
get
Authorizations
Responses
200

OK

*/*
get
/api/alarms/groups
GET /api/alarms/groups 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",
    "priority": 1,
    "onAckColor": "text",
    "name": "text",
    "scanTimeInMillis": 1,
    "printerPort": 1,
    "offAckColor": "text",
    "offNoAckColor": "text",
    "onNoAckColor": "text",
    "onScriptId": "text",
    "printWhenOn": true,
    "printWhenOff": true,
    "ackScriptId": "text",
    "hiddenOnMonitor": true,
    "printWhenAck": true,
    "printerIp": "text",
    "projectId": "text",
    "dsc": "text",
    "offScriptId": "text",
    "owner": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
priorityinteger · int32 · min: 1 · max: 255Required
onAckColorstring · max: 7Optional
namestring · max: 100Required
scanTimeInMillisinteger · int32 · min: 100Required
printerPortinteger · int32Optional
offAckColorstring · max: 7Optional
offNoAckColorstring · max: 7Optional
onNoAckColorstring · max: 7Optional
onScriptIdstringOptional
printWhenOnbooleanOptional
printWhenOffbooleanOptional
ackScriptIdstringOptional
hiddenOnMonitorbooleanOptional
printWhenAckbooleanOptional
printerIpstring · max: 15Optional
projectIdstringOptional
dscstring · max: 255Optional
offScriptIdstringOptional
ownerstringOptional
Responses
200

OK

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

{
  "id": "text",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}
{
  "creationDate": "2025-10-31T22:41:48.915Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-10-31T22:41:48.915Z",
  "id": "text",
  "priority": 1,
  "onAckColor": "text",
  "name": "text",
  "scanTimeInMillis": 1,
  "printerPort": 1,
  "offAckColor": "text",
  "offNoAckColor": "text",
  "onNoAckColor": "text",
  "onScriptId": "text",
  "printWhenOn": true,
  "printWhenOff": true,
  "ackScriptId": "text",
  "hiddenOnMonitor": true,
  "printWhenAck": true,
  "printerIp": "text",
  "projectId": "text",
  "dsc": "text",
  "offScriptId": "text",
  "owner": "text"
}
post
Authorizations
Path parameters
groupIdstringRequired
Responses
204

No Content

No content
post
/api/alarms/groups/{groupId}/deactivate
POST /api/alarms/groups/{groupId}/deactivate HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Path parameters
groupIdstringRequired
Responses
204

No Content

No content
post
/api/alarms/groups/{groupId}/activate
POST /api/alarms/groups/{groupId}/activate HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200

OK

*/*
Responseobject
post
/api/alarms/groups/import
POST /api/alarms/groups/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
projectIdstringRequired
Responses
204

No Content

No content
post
/api/alarms/groups/deactivate/by-project
POST /api/alarms/groups/deactivate/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204

No Content

No content
post
/api/alarms/groups/deactivate/by-project-and-name
POST /api/alarms/groups/deactivate/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204

No Content

No content
post
/api/alarms/groups/activate/by-project
POST /api/alarms/groups/activate/by-project?projectId=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204

No Content

No content
post
/api/alarms/groups/activate/by-project-and-name
POST /api/alarms/groups/activate/by-project-and-name?projectId=text&name=text HTTP/1.1
Host: inscada.cloud
X-Space: YOUR_API_KEY
Accept: */*

No content
get
Authorizations
Path parameters
alarmGroupIdstringRequired
Responses
200

OK

*/*
Responsestring · enumPossible values:
get
/api/alarms/groups/{alarmGroupId}/status
GET /api/alarms/groups/{alarmGroupId}/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/groups/status/by-project
GET /api/alarms/groups/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/groups/status/by-project-and-name
GET /api/alarms/groups/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
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200

OK

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

{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200

OK

*/*
get
/api/alarms/groups/by-project
GET /api/alarms/groups/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",
    "priority": 1,
    "onAckColor": "text",
    "name": "text",
    "scanTimeInMillis": 1,
    "printerPort": 1,
    "offAckColor": "text",
    "offNoAckColor": "text",
    "onNoAckColor": "text",
    "onScriptId": "text",
    "printWhenOn": true,
    "printWhenOff": true,
    "ackScriptId": "text",
    "hiddenOnMonitor": true,
    "printWhenAck": true,
    "printerIp": "text",
    "projectId": "text",
    "dsc": "text",
    "offScriptId": "text",
    "owner": "text"
  }
]
delete
Authorizations
Query parameters
groupIdsstring[]Required
Responses
204

No Content

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

No content
PreviousAlarm Controller FacadeNextFired Alarm Controller

Last updated