Monitor API specification (0a5236da6fd4a939879f68b248c8877fc2ff2276)

Download OpenAPI specification:Download

The monitor service implements all monitor functions for GroupAlarm

monitor

ListMonitors

Returns all monitors for the given organization

Authorizations:
API-TOKENPersonal-Access-Token
query Parameters
organization
required
integer

ID of the organization of which the monitors should be listed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

EditMonitor

Updates a given monitor with new values

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "configuration": null,
  • "configurationSplitScreen": null,
  • "configurationStandby": null,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "standbyDelay": 0
}

Response samples

Content type
application/json
{
  • "configuration": null,
  • "configurationSplitScreen": null,
  • "configurationStandby": null,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "standbyDelay": 0
}

CreateMonitor

Creates a new Monitor

Authorizations:
API-TOKENPersonal-Access-Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "configuration": null,
  • "configurationSplitScreen": null,
  • "configurationStandby": null,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "standbyDelay": 0
}

Response samples

Content type
application/json
{
  • "configuration": null,
  • "configurationSplitScreen": null,
  • "configurationStandby": null,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "standbyDelay": 0
}

GetMonitor

Returns the Monitor for the given Monitor-ID

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the Monitor that should be fetched

Responses

Response samples

Content type
application/json
{
  • "configuration": null,
  • "configurationSplitScreen": null,
  • "configurationStandby": null,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "standbyDelay": 0
}

DeleteMonitor

Deletes the given monitor by ID

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

The ID of the monitor that should be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "Eintrag erfolgreich gelöscht"
}

SSEMonitor

Endpoint for monitor update Events

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the Monitor that should be fetched

Responses

display

checks if a quickcode exists.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
quickcode
required
string

Responses

Sets a display configuration.

Authorizations:
API-TOKENPersonal-Access-Token
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

Content type
application/json
{
  • "alias": "string",
  • "config": {
    },
  • "monitorID": 0
}

Sets a display configuration.

Authorizations:
API-TOKENPersonal-Access-Token
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

Content type
application/json
{
  • "alias": "string",
  • "config": {
    }
}

Gets a display configuration.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
uuid
required
string

currently active uuid for the display

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "creationTime": null,
  • "monitorToken": {
    }
}

Sets a display configuration.

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
uuid
required
string

Responses

GetDisplaysForMonitor

Gets a list of displays by a specified monitor

Authorizations:
API-TOKENPersonal-Access-Token
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

Content type
application/json
{
  • "displays": [
    ],
  • "totalDisplays": 0
}

CreateUUID

Returns a UUID and a quickcode to setup a display

Authorizations:
API-TOKENPersonal-Access-Token

Responses

Response samples

Content type
application/json
{
  • "quickcode": "string",
  • "uuid": "string"
}

monitor-data

GetMonitorData

Returns all data for a given monitor

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

The ID of the monitor

Responses

Response samples

Content type
application/json
{
  • "activeAlarmsData": null,
  • "alarmData": null,
  • "alarmDataList": null,
  • "childrenData": null,
  • "incidentLog": null,
  • "metaData": null
}

SetMonitorDataAlarming

Create or overwrites the monitor alarming data

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
required
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

Content type
application/json
{
  • "awaitingResponses": 20,
  • "event": "Brand in der Goethestraße",
  • "geo": {
    },
  • "message": "Großbrand in der Goethestraße 5",
  • "negativeResponses": 1,
  • "positiveResponses": 2,
  • "units": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Eintrag erfolgreich gespeichert"
}

PatchMonitorDataAlarming

Patches one or more field from the monitor alarming data

Authorizations:
API-TOKENPersonal-Access-Token
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

Content type
application/json
{
  • "awaitingResponses": 0,
  • "event": "string",
  • "eventEndDate": "2019-08-24T14:15:22Z",
  • "eventId": 0,
  • "eventStartDate": "2019-08-24T14:15:22Z",
  • "geo": {
    },
  • "message": "string",
  • "negativeResponses": 0,
  • "positiveResponses": 0,
  • "units": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Eintrag erfolgreich gespeichert"
}

SetMonitorDataMeta

Create or overwrites the monitor meta data

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
required
latestAlarms
Array of strings
object
object

Responses

Request samples

Content type
application/json
{
  • "latestAlarms": [
    ],
  • "pagers": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Eintrag erfolgreich gespeichert"
}

PatchMonitorDataMeta

Patches one or more field from the monitor meta data

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

Request Body schema: application/json
required
latestAlarms
Array of strings
object
object

Responses

Request samples

Content type
application/json
{
  • "pagers": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Eintrag erfolgreich gespeichert"
}

gong

GetGong

Returns the Gong for the given Monitor-ID

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the Monitor

Responses

Response samples

Content type
application/json
{
  • "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:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

ID of the Monitor

Request Body schema: application/json
required
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

Content type
application/json
{
  • "gongDelay": 0,
  • "isGongEnabled": true,
  • "monitorID": 0,
  • "selectedGong": "string",
  • "selectedVoice": "string",
  • "ttsCount": 0,
  • "ttsPause": 0,
  • "ttsTextTemplate": "string",
  • "voicePitch": 0.1,
  • "voiceRate": 0.1
}

Response samples

Content type
application/json
{
  • "gongDelay": 0,
  • "isGongEnabled": true,
  • "monitorID": 0,
  • "selectedGong": "string",
  • "selectedVoice": "string",
  • "ttsCount": 0,
  • "ttsPause": 0,
  • "ttsTextTemplate": "string",
  • "voicePitch": 0.1,
  • "voiceRate": 0.1
}

DeleteGong

Deletes the gong for the given monitor ID

Authorizations:
API-TOKENPersonal-Access-Token
path Parameters
monitor_id
required
integer

The ID of the monitor

Responses

Response samples

Content type
application/json
{
  • "message": "Eintrag erfolgreich gelöscht"
}