Download OpenAPI specification:Download
The monitor service implements all monitor functions for GroupAlarm
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-TOKEN |
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Personal-Access-Token |
Returns all monitors for the given organization
organization required | integer ID of the organization of which the monitors should be listed |
array of all monitors for the given organization
organization ID is missing or in wrong format
Unexpected database error
[- {
- "configuration": {
- "property1": { },
- "property2": { }
}, - "configurationSplitScreen": {
- "property1": { },
- "property2": { }
}, - "configurationStandby": {
- "property1": { },
- "property2": { }
}, - "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
]
Updates a given monitor with new values
configuration | object (PropertyMap is used as container for additional and arbitrary data in alarms or messages.) Currently supported: "address": "Willy-Brandt-Straße 1, 10557 Berlin" "latitude": 52.5201 "longitude": 13.3688 |
configurationSplitScreen | object (PropertyMap is used as container for additional and arbitrary data in alarms or messages.) Currently supported: "address": "Willy-Brandt-Straße 1, 10557 Berlin" "latitude": 52.5201 "longitude": 13.3688 |
configurationStandby | object (PropertyMap is used as container for additional and arbitrary data in alarms or messages.) Currently supported: "address": "Willy-Brandt-Straße 1, 10557 Berlin" "latitude": 52.5201 "longitude": 13.3688 |
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 |
the edited monitor with new values
monitor in wrong format or missing required field
Unexpected database error
{- "configuration": {
- "property1": { },
- "property2": { }
}, - "configurationSplitScreen": {
- "property1": { },
- "property2": { }
}, - "configurationStandby": {
- "property1": { },
- "property2": { }
}, - "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
{- "configuration": {
- "property1": { },
- "property2": { }
}, - "configurationSplitScreen": {
- "property1": { },
- "property2": { }
}, - "configurationStandby": {
- "property1": { },
- "property2": { }
}, - "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
Creates a new Monitor
configuration | object (PropertyMap is used as container for additional and arbitrary data in alarms or messages.) Currently supported: "address": "Willy-Brandt-Straße 1, 10557 Berlin" "latitude": 52.5201 "longitude": 13.3688 |
configurationSplitScreen | object (PropertyMap is used as container for additional and arbitrary data in alarms or messages.) Currently supported: "address": "Willy-Brandt-Straße 1, 10557 Berlin" "latitude": 52.5201 "longitude": 13.3688 |
configurationStandby | object (PropertyMap is used as container for additional and arbitrary data in alarms or messages.) Currently supported: "address": "Willy-Brandt-Straße 1, 10557 Berlin" "latitude": 52.5201 "longitude": 13.3688 |
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 |
the created monitor with ID
monitor in wrong format or missing required field
Unexpected database error
{- "configuration": {
- "property1": { },
- "property2": { }
}, - "configurationSplitScreen": {
- "property1": { },
- "property2": { }
}, - "configurationStandby": {
- "property1": { },
- "property2": { }
}, - "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
{- "configuration": {
- "property1": { },
- "property2": { }
}, - "configurationSplitScreen": {
- "property1": { },
- "property2": { }
}, - "configurationStandby": {
- "property1": { },
- "property2": { }
}, - "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 |
monitor
monitor ID is missing or in wrong format
Unexpected database error
{- "configuration": {
- "property1": { },
- "property2": { }
}, - "configurationSplitScreen": {
- "property1": { },
- "property2": { }
}, - "configurationStandby": {
- "property1": { },
- "property2": { }
}, - "id": 0,
- "name": "string",
- "organizationID": 0,
- "standbyDelay": 0
}
Deletes the given monitor by ID
monitor_id required | integer The ID of the monitor that should be deleted |
delete monitor
monitor id is missing or in wrong format
Unexpected database error
{- "message": "Eintrag erfolgreich gelöscht"
}
Returns all data for a given monitor
monitor_id required | integer The ID of the monitor |
mobile configurations for passed user
owner ID is missing or in wrong format
Unexpected database error
{- "alarmData": {
- "property1": { },
- "property2": { }
}, - "alarmDataList": {
- "property1": { },
- "property2": { }
}, - "incidentLog": {
- "property1": { },
- "property2": { }
}, - "metaData": {
- "property1": { },
- "property2": { }
}
}
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> |
geo | object |
message | string |
negativeResponses | integer |
positiveResponses | integer |
units | Array of objects |
response message
required parameter missing or in wrong format
Unexpected database error
{- "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> |
geo | object |
message | string |
negativeResponses | integer |
positiveResponses | integer |
units | Array of objects |
response message
required parameter missing or in wrong format
Unexpected database error
{- "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 |
pagers | object |
tables | object |
response message
required parameter missing or in wrong format
Unexpected database error
{- "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 |
pagers | object |
tables | object |
response message
required parameter missing or in wrong format
Unexpected database error
{- "pagers":