Monitor API specification (e0ce7aa22823f24b1a2cb07e97ba36c6fa10da23)
Download OpenAPI specification:Download
The monitor service implements all monitor functions for GroupAlarm
ListMonitors
Returns all monitors for the given organization
Authorizations:
query Parameters
| organization required | integer ID of the organization of which the monitors should be listed |
Responses
Response samples
- 200
- 400
- 500
[- {
- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
]EditMonitor
Updates a given monitor with new values
Authorizations:
Request Body schema: application/jsonrequired
| configuration | any The configuration of the Monitor |
| configurationSplitScreen | any Split-Screen configuration of the monitor which can be used to display multiple alarms at once |
| configurationStandby | any Standby configuration of the monitor which will be displayed if there is no open event after StandbyDelay is over |
| id | integer <int64> The internal ID of the Monitor |
| name | string The name of the Monitor that is displayed in the UI |
| organizationID | integer <int64> The organization the Monitor is part of |
| standbyDelay | integer <int64> Timeout after which ConfigurationStandby will be displayed on the monitor |
Responses
Request samples
- Payload
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}Response samples
- 200
- 400
- 500
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}CreateMonitor
Creates a new Monitor
Authorizations:
Request Body schema: application/jsonrequired
| configuration | any The configuration of the Monitor |
| configurationSplitScreen | any Split-Screen configuration of the monitor which can be used to display multiple alarms at once |
| configurationStandby | any Standby configuration of the monitor which will be displayed if there is no open event after StandbyDelay is over |
| id | integer <int64> The internal ID of the Monitor |
| name | string The name of the Monitor that is displayed in the UI |
| organizationID | integer <int64> The organization the Monitor is part of |
| standbyDelay | integer <int64> Timeout after which ConfigurationStandby will be displayed on the monitor |
Responses
Request samples
- Payload
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}Response samples
- 201
- 400
- 500
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}GetMonitor
Returns the Monitor for the given Monitor-ID
Authorizations:
path Parameters
| monitor_id required | integer ID of the Monitor that should be fetched |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}Sets a display configuration.
Authorizations:
path Parameters
| quickcode required | string |
Request Body schema: application/json
| alias | string |
object (DisplayConfig) DisplayConfig contains the information for the display settings | |
| monitorID | integer <int64> |
Responses
Request samples
- Payload
{- "alias": "string",
- "config": {
- "language": "string",
- "theme": "string",
- "viewMode": "string"
}, - "monitorID": 0
}Sets a display configuration.
Authorizations:
path Parameters
| uuid required | string |
Request Body schema: application/json
| alias | string |
object (DisplayConfig) DisplayConfig contains the information for the display settings |
Responses
Request samples
- Payload
{- "alias": "string",
- "config": {
- "language": "string",
- "theme": "string",
- "viewMode": "string"
}
}Gets a display configuration.
Authorizations:
path Parameters
| uuid required | string currently active uuid for the display |
Responses
Response samples
- 200
- 500
{- "config": {
- "language": "string",
- "theme": "string",
- "viewMode": "string"
}, - "creationTime": null,
- "monitorToken": {
- "hasChildOrganizationsAccess": true,
- "id": 0,
- "monitorID": 0,
- "name": "string",
- "token": "string"
}
}GetDisplaysForMonitor
Gets a list of displays by a specified monitor
Authorizations:
query Parameters
| monitor_id required | integer |
| limit | integer Default: 10 max. amount of entries in list |
| offset | integer Default: 0 amount of entries to skip |
| all | string if this parameter is set to "true", then return all entries |
Responses
Response samples
- 200
{- "displays": [
- {
- "alias": "string",
- "configuration": {
- "language": "string",
- "theme": "string",
- "viewMode": "string"
}, - "initialConfiguratorID": 0,
- "ipAddress": "string",
- "latestConfiguratorID": 0,
- "timeOfCreation": null,
- "timeOfInitialConfiguration": null,
- "timeOfLatestConfiguration": null,
- "timeOfLatestView": null,
- "userAgent": "string",
- "uuid": "string"
}
], - "totalDisplays": 0
}GetMonitorData
Returns all data for a given monitor
Authorizations:
path Parameters
| monitor_id required | integer The ID of the monitor |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "activeAlarmsData": null,
- "alarmData": null,
- "alarmDataList": null,
- "childrenData": null,
- "incidentLog": null,
- "metaData": null
}SetMonitorDataAlarming
Create or overwrites the monitor alarming data
Authorizations:
path Parameters
| monitor_id required | integer ID of the monitor which data should be updated |
Request Body schema: application/jsonrequired
| awaitingResponses | integer |
| event | string |
| eventEndDate | string <date-time> |
| eventId | integer |
| eventStartDate | string <date-time> |
object | |
| message | string |
| negativeResponses | integer |
| positiveResponses | integer |
Array of objects |
Responses
Request samples
- Payload
{- "awaitingResponses": 20,
- "event": "Brand in der Goethestraße",
- "geo": {
- "address": "Goethestraße 5, 52064 Aachen, Deutschland",
- "latitude": 50.77664,
- "longitude": 6.08342
}, - "message": "Großbrand in der Goethestraße 5",
- "negativeResponses": 1,
- "positiveResponses": 2,
- "units": [
- {
- "feedback": [
- {
- "feedback": 1,
- "label": {
- "color": "#ffffff",
- "name": "AGT"
}, - "name": "Hans Peter",
- "position": "AGT"
}, - {
- "feedback": 1,
- "label": {
- "color": "#ffffff",
- "name": "AGT"
}, - "name": "Karl Blau",
- "position": "AGT"
}, - {
- "feedback": 2,
- "label": {
- "color": "#000000",
- "name": "Helfer"
}, - "name": "Jörg Schwarz",
- "position": "Helfer"
}
], - "name": "Einheit 1"
}
]
}Response samples
- 200
- 400
- 500
{- "message": "Eintrag erfolgreich gespeichert"
}PatchMonitorDataAlarming
Patches one or more field from the monitor alarming data
Authorizations:
path Parameters
| monitor_id required | integer ID of the monitor which data should be updated |
Request Body schema: application/json
| awaitingResponses | integer |
| event | string |
| eventEndDate | string <date-time> |
| eventId | integer |
| eventStartDate | string <date-time> |
object | |
| message | string |
| negativeResponses | integer |
| positiveResponses | integer |
Array of objects |
Responses
Request samples
- Payload
{- "awaitingResponses": 0,
- "event": "string",
- "eventEndDate": "2019-08-24T14:15:22Z",
- "eventId": 0,
- "eventStartDate": "2019-08-24T14:15:22Z",
- "geo": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "message": "string",
- "negativeResponses": 0,
- "positiveResponses": 0,
- "units": [
- {
- "feedback": [
- {
- "feedback": 0,
- "label": {
- "color": "string",
- "name": "string"
}, - "name": "string",
- "position": "string"
}
], - "name": "string"
}
]
}Response samples
- 200
- 400
- 500
{- "message": "Eintrag erfolgreich gespeichert"
}SetMonitorDataMeta
Create or overwrites the monitor meta data
Authorizations:
path Parameters
| monitor_id required | integer ID of the monitor which data should be updated |
Request Body schema: application/jsonrequired
| latestAlarms | Array of strings |
object | |
object |
Responses
Request samples
- Payload
{- "latestAlarms": [
- "Brand in Aachen",
- "Unfall auf der Autobahn A4"
], - "pagers": {
- "activePager": 10,
- "inactivePager": 0
}
}Response samples
- 200
- 400
- 500
{- "message": "Eintrag erfolgreich gespeichert"
}PatchMonitorDataMeta
Patches one or more field from the monitor meta data
Authorizations:
path Parameters
| monitor_id required | integer ID of the monitor which data should be updated |
Request Body schema: application/jsonrequired
| latestAlarms | Array of strings |
object | |
object |
Responses
Request samples
- Payload
{- "pagers": {
- "activePager": 5
}
}Response samples
- 200
- 400
- 500
{- "message": "Eintrag erfolgreich gespeichert"
}GetGong
Returns the Gong for the given Monitor-ID
Authorizations:
path Parameters
| monitor_id required | integer ID of the Monitor |
Responses
Response samples
- 200
- 400
- 404
- 500
{- "gongDelay": 0,
- "isGongEnabled": true,
- "monitorID": 0,
- "selectedGong": "string",
- "selectedVoice": "string",
- "ttsCount": 0,
- "ttsPause": 0,
- "ttsTextTemplate": "string",
- "voicePitch": 0.1,
- "voiceRate": 0.1
}UpsertGong
Creates a new gong or updates an existing one with new values
Authorizations:
path Parameters
| monitor_id required | integer ID of the Monitor |
Request Body schema: application/jsonrequired
| gongDelay | integer <int64> Delay after which the first Gong starts |
| isGongEnabled | boolean Is the Gong in general enabled |
| monitorID | integer <int64> |
| selectedGong | string Name of the selected gong audio file |
| selectedVoice | string Name of the selected voice |
| ttsCount | integer <int64> How often the Gong and TTS should be repeated by the monitor |
| ttsPause | integer <int64> Time between the last and coming Gong |
| ttsTextTemplate | string The text with variables as defined in the monitor settings for later TTS transformation |
| voicePitch | number <double> Pitch of the voice |
| voiceRate | number <double> Rate of the voice |
Responses
Request samples
- Payload
{- "gongDelay": 0,
- "isGongEnabled": true,
- "monitorID": 0,
- "selectedGong": "string",
- "selectedVoice": "string",
- "ttsCount": 0,
- "ttsPause": 0,
- "ttsTextTemplate": "string",
- "voicePitch": 0.1,
- "voiceRate": 0.1
}Response samples
- 200
- 400
- 500
{- "gongDelay": 0,
- "isGongEnabled": true,
- "monitorID": 0,
- "selectedGong": "string",
- "selectedVoice": "string",
- "ttsCount": 0,
- "ttsPause": 0,
- "ttsTextTemplate": "string",
- "voicePitch": 0.1,
- "voiceRate": 0.1
}