Download OpenAPI specification:Download
The monitor service implements all monitor functions for GroupAlarm
Returns all monitors for the given organization
organization required | integer ID of the organization of which the monitors should be listed |
[- {
- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
]
Updates a given monitor with new values
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 |
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
Creates a new Monitor
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 |
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
Returns the Monitor for the given Monitor-ID
monitor_id required | integer ID of the Monitor that should be fetched |
{- "configuration": null,
- "configurationSplitScreen": null,
- "configurationStandby": null,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
Returns all data for a given monitor
monitor_id required | integer The ID of the monitor |
{- "activeAlarmsData": null,
- "alarmData": null,
- "alarmDataList": null,
- "childrenData": null,
- "incidentLog": null,
- "metaData": null
}
Create or overwrites the monitor alarming data
monitor_id required | integer ID of the monitor which data should be updated |
awaitingResponses | integer |
event | string |
eventEndDate | string <date-time> |
eventId | integer |
eventStartDate | string <date-time> |
object | |
message | string |
negativeResponses | integer |
positiveResponses | integer |
Array of objects[ items ] |
{- "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": null,
- "name": "AGT"
}, - "name": "Hans Peter",
- "position": "AGT"
}, - {
- "feedback": 1,
- "label": {
- "color": null,
- "name": "AGT"
}, - "name": "Karl Blau",
- "position": "AGT"
}, - {
- "feedback": 2,
- "label": {
- "color": null,
- "name": "Helfer"
}, - "name": "Jörg Schwarz",
- "position": "Helfer"
}
], - "name": "Einheit 1"
}
]
}
{- "message": "Eintrag erfolgreich gespeichert"
}
Patches one or more field from the monitor alarming data
monitor_id required | integer ID of the monitor which data should be updated |
awaitingResponses | integer |
event | string |
eventEndDate | string <date-time> |
eventId | integer |
eventStartDate | string <date-time> |
object | |
message | string |
negativeResponses | integer |
positiveResponses | integer |
Array of objects[ items ] |
{- "awaitingResponses": 5,
- "positiveResponses": 10
}
{- "message": "Eintrag erfolgreich gespeichert"
}
Create or overwrites the monitor meta data
monitor_id required | integer ID of the monitor which data should be updated |
latestAlarms | Array of strings |
object | |
object |
{- "latestAlarms": [
- "Brand in Aachen",
- "Unfall auf der Autobahn A4"
], - "pagers": {
- "activePager": 10,
- "inactivePager": 0
}
}
{- "message": "Eintrag erfolgreich gespeichert"
}
Patches one or more field from the monitor meta data
monitor_id required | integer ID of the monitor which data should be updated |
latestAlarms | Array of strings |
object | |
object |
{- "pagers": {
- "activePager": 5
}
}
{- "message": "Eintrag erfolgreich gespeichert"
}