Alarm Group Controller
get
Authorizations
Path parameters
groupIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups/{groupId} HTTP/1.1
Host: inscada.cloud
Accept: */*
{
"creationDate": "2025-07-05T19:13:27.122Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:13:27.122Z",
"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
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
put
PUT /api/alarms/groups/{groupId} HTTP/1.1
Host: inscada.cloud
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
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/alarms/groups/{groupId} HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:13:27.122Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:13:27.122Z",
"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
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups HTTP/1.1
Host: inscada.cloud
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-07-05T19:13:27.122Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:13:27.122Z",
"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
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/{groupId}/deactivate HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
post
Authorizations
Path parameters
groupIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/{groupId}/activate HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"file": "binary"
}
{}
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/deactivate/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/deactivate/by-project-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/activate/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
post
Authorizations
Query parameters
projectIdstringRequired
namestringRequired
Responses
204
No Content
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
post
POST /api/alarms/groups/activate/by-project-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*
No content
get
Authorizations
Path parameters
alarmGroupIdstringRequired
Responses
200
OK
*/*
Responsestring · enumPossible values:
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups/{alarmGroupId}/status HTTP/1.1
Host: inscada.cloud
Accept: */*
Active
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups/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:
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups/status/by-project-and-name HTTP/1.1
Host: inscada.cloud
Accept: */*
Active
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault:
false
Responses
200
OK
*/*
Responseobject
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups/export HTTP/1.1
Host: inscada.cloud
Accept: */*
{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
get
GET /api/alarms/groups/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*
[
{
"creationDate": "2025-07-05T19:13:27.122Z",
"lastModifiedBy": "text",
"createdBy": "text",
"lastModifiedDate": "2025-07-05T19:13:27.122Z",
"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
400
Bad Request
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
500
Internal Server Error
*/*
delete
DELETE /api/alarms/groups/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*
No content