logo
Documentation Powered by Redocly

Monitor API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

The monitor service implements all monitor functions for GroupAlarm

Authentication

API_Token

You can generate an API-Token in the permissions-settings of your organization. All requests will be performed in the scope of this organization. Requests regarding users will fail.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

You can generate a Personal Access Token in your profile settings. All requests will be performed as the user who created the token, with permissions as configured in each organization.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

monitor

ListMonitors

Returns all monitors for the given organization

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

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

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

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

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"
}

monitor-data

GetMonitorData

Returns all data for a given monitor

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

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[ items ]

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

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[ items ]

Responses

Request samples

Content type
application/json
{
  • "awaitingResponses": 5,
  • "positiveResponses": 10
}

Response samples

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

SetMonitorDataMeta

Create or overwrites the monitor meta data

path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

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

path Parameters
monitor_id
required
integer

ID of the monitor which data should be updated

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

Responses

Request samples

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

Response samples

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