logo
API docs by Redocly

Alarming API specification (3846dc5a16bdc5122b040a42126787f9bbb62155)

Download OpenAPI specification:Download

The alarming service is used to configure and manage alarms.

alarm

CreateAlarm

Creates an alarm for an event and calculate required user for a notification

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
alarmResourceTemplateID
integer <int64>

Contains the ID of a resource template which will replace the values of this alarm with the configured values of the template

object (AlarmCreationResources contains an alarm's alarmed scenarios, units, labels and / or users.)

At least one of those arrays must contain data, otherwise the alarm can not be started.

alarmTemplateID
integer <int64>

Alarm message template ID given ID is used to replace alarm's message text while creating a new alarm either this or Message have to be set

creatorID
integer <int64>

id of the creator resource

creatorName
string

name of the creator resource

creatorType
string

type of the creator resource (user|api-token|tag)

object (EscalationModeConfiguration is used to configure all required parameters for an alarm in escalation-mode.)
eventExternalID
string

ExternalID of the event defined by the user

eventID
integer <int64>

id of an existing event

eventName
string

Name of an event; if event name is passed, a new event will be created with the passed name

message
string

Alarm message text either this or AlarmTemplateID have to be set

mode
string

Alarm mode (strict|best-effort|escalation)

optionalContent
any

optional content (e.g. coordinates)

organizationID
required
integer <int64>

ID of the organization to create the alarm in

scenarioID
integer <int64>

id of the alarmed scenario

DEPRECATED: this property is deprecated and will be removed soon, please use alarmResources instead

scheduledEndTime
any

Scheduled time for closing the Event

startTime
any

Start time for this alarm. Uses the current time if not set.

Responses

Request samples

Content type
application/json
{
  • "alarmResourceTemplateID": 0,
  • "alarmResources": {
    },
  • "alarmTemplateID": 0,
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "escalationModeConfiguration": {
    },
  • "eventExternalID": "string",
  • "eventID": 0,
  • "eventName": "string",
  • "message": "string",
  • "mode": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "scenarioID": 0,
  • "scheduledEndTime": null,
  • "startTime": null
}

Response samples

Content type
application/json
{
  • "alarmResources": {
    },
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "endDate": null,
  • "escalationModeConfiguration": {
    },
  • "event": {
    },
  • "feedback": [
    ],
  • "feedbackPercentage": {
    },
  • "id": 1,
  • "message": "string",
  • "mode": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "startDate": null,
  • "strength": {
    },
  • "success": true
}

PreviewAlarm

Returns a preview of a planned alarm using the given resources

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
alarmResourceTemplateID
integer <int64>

Contains the ID of a resource template which will replace the values of this alarm with the configured values of the template

object (AlarmCreationResources contains an alarm's alarmed scenarios, units, labels and / or users.)

At least one of those arrays must contain data, otherwise the alarm can not be started.

alarmTemplateID
integer <int64>

Alarm message template ID given ID is used to replace alarm's message text while creating a new alarm either this or Message have to be set

creatorID
integer <int64>

id of the creator resource

creatorName
string

name of the creator resource

creatorType
string

type of the creator resource (user|api-token|tag)

object (EscalationModeConfiguration is used to configure all required parameters for an alarm in escalation-mode.)
eventExternalID
string

ExternalID of the event defined by the user

eventID
integer <int64>

id of an existing event

eventName
string

Name of an event; if event name is passed, a new event will be created with the passed name

message
string

Alarm message text either this or AlarmTemplateID have to be set

mode
string

Alarm mode (strict|best-effort|escalation)

optionalContent
any

optional content (e.g. coordinates)

organizationID
required
integer <int64>

ID of the organization to create the alarm in

scenarioID
integer <int64>

id of the alarmed scenario

DEPRECATED: this property is deprecated and will be removed soon, please use alarmResources instead

scheduledEndTime
any

Scheduled time for closing the Event

startTime
any

Start time for this alarm. Uses the current time if not set.

Responses

Request samples

Content type
application/json
{
  • "alarmResourceTemplateID": 0,
  • "alarmResources": {
    },
  • "alarmTemplateID": 0,
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "escalationModeConfiguration": {
    },
  • "eventExternalID": "string",
  • "eventID": 0,
  • "eventName": "string",
  • "message": "string",
  • "mode": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "scenarioID": 0,
  • "scheduledEndTime": null,
  • "startTime": null
}

Response samples

Content type
application/json
{
  • "alarmResources": {
    },
  • "plan": [
    ],
  • "positionsFulfilled": true
}

GetAlarm

Returns an alarm payload for requested alarm id

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
alarmID
required
integer
query Parameters
update_for_user
boolean

optional parameter to update alarm with data for querying user (e.g. replaced variables in message)

Responses

Response samples

Content type
application/json
{
  • "alarmResources": {
    },
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "endDate": null,
  • "escalationModeConfiguration": {
    },
  • "event": {
    },
  • "feedback": [
    ],
  • "feedbackPercentage": {
    },
  • "id": 1,
  • "message": "string",
  • "mode": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "startDate": null,
  • "strength": {
    },
  • "success": true
}

CloseAlarm

Closes the alarm with the passed alarm id

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
alarmID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

GetAlarms

Returns all alarms for an organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of organization

type
string
Enum: "all" "own"

should all or only own alarms be returned

limit
integer [ 1 .. 50 ]
Default: 10

limits alarm list output to passed amount.

offset
integer
Default: 0

defines the offset for pagination

event
integer

id of an event, to get all alarms for this event

Responses

Response samples

Content type
application/json
{
  • "alarms": [
    ],
  • "strength": {
    },
  • "totalAlarms": 0
}

GetUsersAlarms

Returns all alarms the current user has been alarmed in from all organizations they are a member of

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
limit
integer [ 1 .. 50 ]
Default: 10

amount of entries in paginated list

offset
integer >= 0
Default: 0

amount of skipped entries in paginated list

Responses

Response samples

Content type
application/json
{
  • "alarms": [
    ],
  • "strength": {
    },
  • "totalAlarms": 0
}

GetAlarmsInUsersOrganizations

Returns all alarms from all organizations the current user is a member of

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
limit
integer [ 1 .. 50 ]
Default: 10

amount of entries in paginated list

offset
integer >= 0
Default: 0

amount of skipped entries in paginated list

Responses

Response samples

Content type
application/json
{
  • "alarms": [
    ],
  • "strength": {
    },
  • "totalAlarms": 0
}

alarm-template

CreateResourceTemplate

Creates an alarm template with the passed parameters

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

the resource template struct

allUsers
boolean
eventName
string
id
integer <int64>
initialEscalationStage
integer <int64>
Array of objects (AlarmResourceTemplateLabel)
message
string
mode
string
name
string
optionalContent
any
organizationID
integer <int64>
organizationName
string
scenarios
Array of integers <int64> [ items <int64 > ]
shiftEscalationID
integer <int64>
units
Array of integers <int64> [ items <int64 > ]
users
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "allUsers": true,
  • "eventName": "string",
  • "id": 0,
  • "initialEscalationStage": 0,
  • "labels": [
    ],
  • "message": "string",
  • "mode": "string",
  • "name": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "organizationName": "string",
  • "scenarios": [
    ],
  • "shiftEscalationID": 0,
  • "units": [
    ],
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "allUsers": true,
  • "eventName": "string",
  • "id": 0,
  • "initialEscalationStage": 0,
  • "labels": [
    ],
  • "message": "string",
  • "mode": "string",
  • "name": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "organizationName": "string",
  • "scenarios": [
    ],
  • "shiftEscalationID": 0,
  • "units": [
    ],
  • "users": [
    ]
}

GetResourceTemplate

Returns a specific alarm resource template

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the alarm resource template

query Parameters
organization_id
integer

Optional id of the requesting organization. This is required if you try to fetch a shared template from a different organization.

Responses

Response samples

Content type
application/json
{
  • "allUsers": true,
  • "eventName": "string",
  • "id": 0,
  • "initialEscalationStage": 0,
  • "labels": [
    ],
  • "message": "string",
  • "mode": "string",
  • "name": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "organizationName": "string",
  • "scenarios": [
    ],
  • "shiftEscalationID": 0,
  • "units": [
    ],
  • "users": [
    ]
}

UpdateResourceTemplate

Updates an alarm template with the passed parameters

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the alarm resource template

Request Body schema: application/json
required

the resource template struct

allUsers
boolean
eventName
string
id
integer <int64>
initialEscalationStage
integer <int64>
Array of objects (AlarmResourceTemplateLabel)
message
string
mode
string
name
string
optionalContent
any
organizationID
integer <int64>
organizationName
string
scenarios
Array of integers <int64> [ items <int64 > ]
shiftEscalationID
integer <int64>
units
Array of integers <int64> [ items <int64 > ]
users
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "allUsers": true,
  • "eventName": "string",
  • "id": 0,
  • "initialEscalationStage": 0,
  • "labels": [
    ],
  • "message": "string",
  • "mode": "string",
  • "name": "string",
  • "optionalContent": null,
  • "organizationID": 0,
  • "organizationName": "string",
  • "scenarios": [
    ],
  • "shiftEscalationID": 0,
  • "units": [
    ],
  • "users": [
    ]
}

DeleteResourceTemplate

Deletes the alarm resource template with the passed template id

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the alarm resource template

Responses

GetPaginatedResourceTemplates

Returns a paginated list of alarm resource templates for the queried organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

id of the alarm template

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

limit
integer [ 1 .. 50 ]
Default: 10

limits alarm list output to passed amount.

offset
integer
Default: 0

defines the offset for pagination

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ],
  • "total": 0
}

CreateAlarmTemplate

Creates an alarm template with the passed parameters

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

template payload

id
integer <int64>
message
string
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "name": "string",
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "name": "string",
  • "organizationID": 0
}

GetAlarmTemplate

Returns a specific alarm template for passed template id

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the template

query Parameters
organization_id
required
integer

id of organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UpdateAlarmTemplate

Updates an alarm template with the passed parameters

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the alarm template

Request Body schema: application/json
required

template payload

id
integer <int64>
message
string
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "name": "string",
  • "organizationID": 0
}

DeleteAlarmTemplate

Updates an alarm template with the passed parameters

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of the alarm template

Responses

GetAlarmTemplates

Returns all alarm templates for passed organization id

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

id of organization

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer
Default: 0

amount of entries to skip

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

search
string

query to filter template list by a name

Responses

Response samples

Content type
application/json
{
  • "templates": [
    ],
  • "total": 0
}

alarm-template-sharing

Forfeits access to a shared alarm resource template.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

required data for key forfeiture

organizationID
integer <int64>
templateID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "templateID": 0
}

Redeems an existing sharing key for the given organization.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

required data for key redemption

key
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "organizationID": 0
}

Creates a new sharing key for the given template.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
templateID
required
integer

id of the alarm resource template

Request Body schema: application/json
required

required data for key creation

name
string
templateID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "templateID": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "organizationID": 0,
  • "redeemedOrganizationIDs": [
    ],
  • "templateID": 0
}

Refreshes an existing sharing key for the given template.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
templateID
required
integer

id of the alarm resource template

keyID
required
integer

id of the alarm resource template sharing key

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "name": "string",
  • "organizationID": 0,
  • "redeemedOrganizationIDs": [
    ],
  • "templateID": 0
}

Deletes an existing sharing key for the given template, which automatically revokes all previously granted accesses.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
templateID
required
integer

id of the alarm resource template

keyID
required
integer

id of the alarm resource template sharing key

Responses

Returns a list of sharing keys associated with the given template.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
templateID
required
integer

id of the alarm resource template

Responses

Response samples

Content type
application/json
[
  • {
    }
]

alarm-settings

GetSettings

Gets the configured organization alarm settings

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "alarmDispatchedUsers": true,
  • "hideFeedback": true,
  • "hideGeolocation": true,
  • "messengerAddTimeoutedUsersToEventRoom": true,
  • "messengerCreateRoomForEvent": true,
  • "messengerDeleteEventRoomAfterMinutes": 0
}

UpsertSettings

Creates or updates the alarm settings for the passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required
alarmDispatchedUsers
boolean
hideFeedback
boolean
hideGeolocation
boolean
messengerAddTimeoutedUsersToEventRoom
boolean
messengerCreateRoomForEvent
boolean
messengerDeleteEventRoomAfterMinutes
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "alarmDispatchedUsers": true,
  • "hideFeedback": true,
  • "hideGeolocation": true,
  • "messengerAddTimeoutedUsersToEventRoom": true,
  • "messengerCreateRoomForEvent": true,
  • "messengerDeleteEventRoomAfterMinutes": 0
}

event

SearchEvent

Searches an event with the passed externalID or name

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

ID of an organization

name
string

searchable name of an event

externalID
string

searchable externalID of an event

filter
string
Enum: "open" "closed" "archived"

makes the search consider only events that are either open, closed or archived

Responses

Response samples

Content type
application/json
{
  • "abort": {
    },
  • "archived": true,
  • "endDate": null,
  • "externalID": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledEndtime": null,
  • "startDate": null
}

CreateEvent

Creates an event with the passed event payload

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
externalID
string
name
string
organizationID
integer <int64>
scheduledEndtime
any
startDate
any

Responses

Request samples

Content type
application/json
{
  • "externalID": "string",
  • "name": "string",
  • "organizationID": 0,
  • "scheduledEndtime": null,
  • "startDate": null
}

Response samples

Content type
application/json
{
  • "abort": {
    },
  • "archived": true,
  • "endDate": null,
  • "externalID": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledEndtime": null,
  • "startDate": null
}

GetEvent

Gets an event with the passed event ID

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
eventID
required
integer

Responses

Response samples

Content type
application/json
{
  • "abort": {
    },
  • "archived": true,
  • "endDate": null,
  • "externalID": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "scheduledEndtime": null,
  • "startDate": null
}

CloseEvent

Closes an event with the passed event ID while also closing all associated alarms

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
eventID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "event 1 was successfully closed"
}

GetEvents

Returns paginated events of a passed organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

ID of an organization

type
string
Enum: "all" "own"

show all or only events with my own feedback

filter
string
Enum: "open" "closed" "archived"

filter the events of the organization

limit
integer

max. amount of entries in list

offset
integer

amount of entries to skip

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "totalEvents": 0
}

GetOpenEvents

Returns all open events of a passed organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

ID of an organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

abort

AbortEvent

Aborts an event with the passed event ID or external ID

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
externalID
string

External ID of an event

organizationID
integer

ID of the organization that contains the queried event. This parameter is required if searching with an externalID

Request Body schema: application/json
required

Event abort details

creatorID
integer <int64>
creatorName
string
creatorType
string
eventID
integer <int64>
message
string
organizationID
integer <int64>
time
any

Responses

Request samples

Content type
application/json
{
  • "creatorID": 0,
  • "creatorName": "string",
  • "creatorType": "string",
  • "eventID": 0,
  • "message": "string",
  • "organizationID": 0,
  • "time": null
}

archive

ArchiveEvent

Archives an already closed event

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
eventID
required
integer

ID of a closed event

Responses

UnarchiveEvent

Un-Archives an event

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
eventID
required
integer

ID of a closed event

Responses

geofences

Returns a paginated list of geofences for the current user or the given organization.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
integer

optional organization id, returns all geofences for the organization if set

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of geofences in paginated list

offset
integer
Default: 0

skipped geofences in paginated list

Responses

Response samples

Content type
application/json
{
  • "geofences": [
    ],
  • "total": 0
}

Creates a new geofence for an organization.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
color
required
string

identifying color of the geofence

latitude
required
number <double> [ -90 .. 90 ]

latitude in degrees defining the location of the geofence

longitude
required
number <double> [ -180 .. 180 ]

longitude in degrees defining the location of the geofence

name
required
string

identifying name of the geofence

organizationID
required
integer <int64>

unique identifier of the organization that manages the geofence

radius
required
number <double> [ 100 .. 10000 ]

radius in meters around the location of the geofence

Responses

Request samples

Content type
application/json
{
  • "color": "string",
  • "latitude": -90,
  • "longitude": -180,
  • "name": "string",
  • "organizationID": 0,
  • "radius": 100
}

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "id": 0,
  • "latitude": -90,
  • "longitude": -180,
  • "name": "string",
  • "organizationID": 0,
  • "radius": 100
}

Returns a specific geofence.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

unique identifier of the geofence

Responses

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "id": 0,
  • "latitude": -90,
  • "longitude": -180,
  • "name": "string",
  • "organizationID": 0,
  • "radius": 100
}

Updates an existing geofence for an organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

unique identifier of the geofence

Request Body schema: application/json
required
color
required
string

identifying color of the geofence

latitude
required
number <double> [ -90 .. 90 ]

latitude in degrees defining the location of the geofence

longitude
required
number <double> [ -180 .. 180 ]

longitude in degrees defining the location of the geofence

name
required
string

identifying name of the geofence

organizationID
required
integer <int64>

unique identifier of the organization that manages the geofence

radius
required
number <double> [ 100 .. 10000 ]

radius in meters around the location of the geofence

Responses

Request samples

Content type
application/json
{
  • "color": "string",
  • "latitude": -90,
  • "longitude": -180,
  • "name": "string",
  • "organizationID": 0,
  • "radius": 100
}

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "id": 0,
  • "latitude": -90,
  • "longitude": -180,
  • "name": "string",
  • "organizationID": 0,
  • "radius": 100
}

Deletes an existing geofence for an organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

unique identifier of the geofence

Responses

labels

CreateLabel

Creates a new label with the passed label payload parameters

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

label payload

assignees
Array of integers <int64> [ items <int64 > ]

assigned user for this label, users who have paused this label will not be in this field

color
required
string

hex color code

description
string

description for this labels

id
integer <int64>

id for this label

name
required
string

name of this label

organizationID
required
integer <int64>

organization id for this label

pauseableUsers
Array of integers <int64> [ items <int64 > ]

users who have been assigned to this label and can pause or reactivate it

priority
integer <int64>

priority of this label

object (SmartLabelConfiguration)

SmartLabelConfiguration contains the configuration for smart labels

substitute
object (Label describes a label payload) Recursive

This is used for the interaction with alarms

Responses

Request samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pauseableUsers": [
    ],
  • "priority": 0,
  • "smartLabelConfiguration": {
    },
  • "substitute": { }
}

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pauseableUsers": [
    ],
  • "priority": 0,
  • "smartLabelConfiguration": {
    },
  • "substitute": { }
}

GetOrganizationsWithLabels

Get paginated organizations along with all labels assigned for user with the passed JWT token

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
limit
integer

max. amount of entries in list

offset
integer

amount of entries to skip

Responses

Response samples

Content type
application/json
{
  • "organizationsWithLabels": [
    ],
  • "totalOrganizations": 0
}

GetLabel

Returns a specific label with passed ID

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer

Responses

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pauseableUsers": [
    ],
  • "priority": 0,
  • "smartLabelConfiguration": {
    },
  • "substitute": { }
}

UpdateLabel

Updates a specific label by a passed label ID and a label payload

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer
Request Body schema: application/json
required
assignees
Array of integers <int64> [ items <int64 > ]

assigned user for this label, users who have paused this label will not be in this field

color
required
string

hex color code

description
string

description for this labels

id
integer <int64>

id for this label

name
required
string

name of this label

organizationID
required
integer <int64>

organization id for this label

pauseableUsers
Array of integers <int64> [ items <int64 > ]

users who have been assigned to this label and can pause or reactivate it

priority
integer <int64>

priority of this label

object (SmartLabelConfiguration)

SmartLabelConfiguration contains the configuration for smart labels

substitute
object (Label describes a label payload) Recursive

This is used for the interaction with alarms

Responses

Request samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pauseableUsers": [
    ],
  • "priority": 0,
  • "smartLabelConfiguration": {
    },
  • "substitute": { }
}

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "color": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pauseableUsers": [
    ],
  • "priority": 0,
  • "smartLabelConfiguration": {
    },
  • "substitute": { }
}

DeleteLabel

Deletes the label with passed ID

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "label 1 successfully deleted"
}

AssignLabel

Assigns a user to a label

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer
userID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "successfully assigned label"
}

UnassignLabel

Unassigns a user from a label

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer
userID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "label 1 successfully deleted"
}

PauseLabel

Pauses a label for the current user, if it is pauseable

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "label 1 successfully paused"
}

UnpauseLabel

Unpauses a label for the current user

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
labelID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "label 1 successfully unpaused"
}

Returns an array of all labels of the queried organization

When given a user-id, output is limited to the user's labels. When given limit and offset parameters, output is limited to those values.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of an organization

user
integer

id of an user, e.g. for user label assignment

type
string
Enum: "normal" "smart" "all"

type of labels to return, defaults to normal labels

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer
Default: 0

amount of entries to skip

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

search
string

query to filter label list by a name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetLabelsCSV

Get all labels for queried organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

id of an organization

query Parameters
type
string
Enum: "normal" "smart" "all"

type of labels to return, defaults to normal labels

Responses

ImportLabels

Imports multiple labels for the passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

id of an organization

Responses

strength

GetStrength Deprecated

Get label to strength configuration for passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organization
required
integer

id of an organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UpsertStrength

Creates a new or changes an existing strength configuration for passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organization
required
integer

id of an organization

Request Body schema: application/json

user-rank assignment payload

required
Array of objects (RankLabels)

Responses

Request samples

Content type
application/json
{
  • "configs": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

GetStrengthConfiguration

Get the strength rank and names configuration for this organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organization
required
integer

id of an organization

Responses

Response samples

Content type
application/json
{
  • "names": {
    },
  • "ranks": [
    ]
}

UpsertStrengthConfiguration

Inserts or updates a rank name configuration for the passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organization
required
integer

id of an organization

Request Body schema: application/json
required

rank names configuration payload

general
string
officer
string
soldier
string

Responses

Request samples

Content type
application/json
{
  • "general": "string",
  • "officer": "string",
  • "soldier": "string"
}

GetUserRanks

Get all assigned ranks for every user of the passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organization
required
integer

id of an organization

Responses

AssignUserRank

Assing a rank to passed user

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organization
required
integer

id of an organization

Request Body schema: application/json

user-rank assignment payload

rank
required
string

rank value

userID
required
integer <int64>

userID

Responses

Request samples

Content type
application/json
{
  • "rank": "string",
  • "userID": 0
}

Response samples

Content type
application/json
{
  • "message": "success"
}

report

GetReport

Download a complete report for the given alarm as pdf file

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
alarmID
required
integer

id of alarm to create a report for

query Parameters
type
required
string

which type of report is requested ("dispatch", "report")

Responses

scenario

CreateScenario

Creates a scenario with the passed parameters of a scenario payload

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

scenario payload

description
required
string

user given description for this scenario

instructionCatalogID
integer <int64>

possible id of an instruction catalog

isLocked
boolean

IsLocked describes if the Scenario is locked for deletion or not

name
required
string

user given name for this scenario

organizationID
required
integer <int64>

assigned organization by an ID

sendPosition
required
boolean

send position to users after alarm is closed

object (ScenarioCreationTagConfiguration)

ScenarioCreationTagConfiguration contains details about the tag configuration of a scenario while creating it

units
required
Array of integers <int64> [ items <int64 > ]

all units by their ID in an array

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "instructionCatalogID": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "sendPosition": true,
  • "tags": {
    },
  • "units": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

GetScenario

Returns a specific scenario payload for a scenario with passed ID

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
scenarioID
required
integer

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "instructionCatalogID": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "sendPosition": true,
  • "tags": {
    },
  • "units": [
    ]
}

UpdateScenario

Updates an existing scenario with passed scenario ID and scenario payload

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
scenarioID
required
integer
Request Body schema: application/json
required
description
required
string

user given description for this scenario

instructionCatalogID
integer <int64>

possible id of an instruction catalog

isLocked
boolean

IsLocked describes if the Scenario is locked for deletion or not

name
required
string

user given name for this scenario

organizationID
required
integer <int64>

assigned organization by an ID

sendPosition
required
boolean

send position to users after alarm is closed

object (ScenarioCreationTagConfiguration)

ScenarioCreationTagConfiguration contains details about the tag configuration of a scenario while creating it

units
required
Array of integers <int64> [ items <int64 > ]

all units by their ID in an array

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "instructionCatalogID": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "sendPosition": true,
  • "tags": {
    },
  • "units": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "instructionCatalogID": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "sendPosition": true,
  • "tags": {
    },
  • "units": [
    ]
}

DeleteScenario

Deletes an existing scenario with passed scenario ID

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
scenarioID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "successfully deleted scenario"
}

GetScenarios

Returns all scenarios in the organization with the passed ID

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organizationID
required
integer
limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer
Default: 0

amount of entries to skip

search
string

query to filter scenario list by a name

Responses

Response samples

Content type
application/json
{
  • "scenarios": [
    ],
  • "total": 0
}

schedules

GetSchedules

Get all shift schedules for queried organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of an organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateSchedule

Create a new shift schedule

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
active
boolean
id
integer <int64>
name
string
organizationID
integer <int64>
Array of objects (Shift)

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "shifts": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "shifts": [
    ]
}

GetSchedule

Get a single shift schedule

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a shift schedule

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "shifts": [
    ]
}

UpdateSchedule

Update an existing shift schedule

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a shift schedule

Request Body schema: application/json
required
active
boolean
id
integer <int64>
name
string
organizationID
integer <int64>
Array of objects (Shift)

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "shifts": [
    ]
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "shifts": [
    ]
}

DeleteSchedule

Delete an existing shift schedule

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a shift schedule

Responses

escalations

Returns a shift escalation history for a specific alarm.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of an alarm

Responses

Response samples

Content type
application/json
{
  • "alarmID": 0,
  • "items": [
    ],
  • "organizationID": 0,
  • "shiftEscalationName": "string"
}

Returns a paginated list of all shift escalations for the queried organization.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of an organization

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer >= 0
Default: 0

amount of entries to skip

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ],
  • "total": 0
}

Creates a new shift escalation.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
name
string
organizationID
integer <int64>
secondsUntilNextStage
Array of integers <int64> [ items <int64 > ]

SecondsUntilNextStage is the time in seconds between two ShiftSchedule stages. Required for alarms in full-escalation mode. If n = amount of given shift schedules, the amount of entries in SecondsUntilNextStage needs to be n-1.

shiftScheduleIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organizationID": 0,
  • "secondsUntilNextStage": [
    ],
  • "shiftScheduleIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "secondsUntilNextStage": [
    ],
  • "stages": [
    ]
}

Returns a single shift escalation.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a shift escalation

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "secondsUntilNextStage": [
    ],
  • "stages": [
    ]
}

Updates an existing shift escalation.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a shift escalation

Request Body schema: application/json
required
name
string
organizationID
integer <int64>
secondsUntilNextStage
Array of integers <int64> [ items <int64 > ]

SecondsUntilNextStage is the time in seconds between two ShiftSchedule stages. Required for alarms in full-escalation mode. If n = amount of given shift schedules, the amount of entries in SecondsUntilNextStage needs to be n-1.

shiftScheduleIDs
Array of integers <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "organizationID": 0,
  • "secondsUntilNextStage": [
    ],
  • "shiftScheduleIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "secondsUntilNextStage": [
    ],
  • "stages": [
    ]
}

Deletes an existing shift escalation.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a shift escalation

Responses

shift

ActiveUsers

Returns a list of all users currently active in a shift for the given organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

AnyActive

Returns if any shift is currently active for the given organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "active": true
}

shift-groups

CreateShiftGroup

Creates a new shift group

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

configuration of a shift group

assignees
Array of integers <int64> [ items <int64 > ]
id
integer <int64>
labels
Array of integers <int64> [ items <int64 > ]
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assignees": [
    ],
  • "id": 0,
  • "labels": [
    ],
  • "name": "string",
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "id": 0,
  • "labels": [
    ],
  • "name": "string",
  • "organizationID": 0
}

GetShiftGroup

Returns a specific shift group with the passed id

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
groupID
required
integer

id of a shift group

Responses

Response samples

Content type
application/json
{
  • "assignees": [
    ],
  • "id": 0,
  • "labels": [
    ],
  • "name": "string",
  • "organizationID": 0
}

UpdateShiftGroup

Updates a shift group

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
groupID
required
integer

id of a shift group

Request Body schema: application/json
required

configuration of a shift group

assignees
Array of integers <int64> [ items <int64 > ]
id
integer <int64>
labels
Array of integers <int64> [ items <int64 > ]
name
string
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "assignees": [
    ],
  • "id": 0,
  • "labels": [
    ],
  • "name": "string",
  • "organizationID": 0
}

DeleteShiftGroup

Removes a shift group

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
groupID
required
integer

id of a shift group

Responses

AssignShiftGroup

Assigns a user to a shift group

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
groupID
required
integer
userID
required
integer

Responses

UnassignShiftGroup

Unassigns a user from a shift group

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
groupID
required
integer
userID
required
integer

Responses

GetShiftGroups

Returns all configured shift groups for the given organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organizationID
required
integer

id of the organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

tags

TriggerHistory

Get a history of all manually triggered tags

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of an organization

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer
Default: 0

amount of entries to skip

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateOverwrittenAlarmMessage

Get a history of all manually triggered tags

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

payload of a configured overwritten alarm message for a specific tagID

id
integer <int64>
message
string
organizationID
integer <int64>
tagID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "organizationID": 0,
  • "tagID": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "organizationID": 0,
  • "tagID": 0
}

DeleteOverwrittenAlarmMessage

Delete an overwritten alarm message for this tag in this organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

id of the organization

tagID
required
integer

id of the tag

Responses

ListTags

Get all tags of the given organization and its parent organizations

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of an organization

owned
boolean

lists only tags owned by the organization if set to true, otherwise all usable tags are returned

limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer
Default: 0

amount of entries to skip

all
boolean
Default: false
search
string

search for tags by name

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateTag

Create a new tag

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
allowed_organizations
Array of integers <int64> [ items <int64 > ]
color
string
date_create
any
date_edit
any
description
string
id
integer <int64>
name
string
organization
any
organization_id
integer <int64>
protected
boolean
object (TagScenarios)

TagScenarios is used to contain a list of scenarios triggered by or triggering a certain tag

Responses

Request samples

Content type
application/json
{
  • "allowed_organizations": [
    ],
  • "color": "string",
  • "date_create": null,
  • "date_edit": null,
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organization": null,
  • "organization_id": 0,
  • "protected": true,
  • "scenarios": {
    }
}

Response samples

Content type
application/json
{
  • "allowed_organizations": [
    ],
  • "color": "string",
  • "date_create": null,
  • "date_edit": null,
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organization": null,
  • "organization_id": 0,
  • "protected": true,
  • "scenarios": {
    }
}

GetTag

Get a certain tag by its id

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a tag

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UpdateTag

Updates an existing tag

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a tag

Request Body schema: application/json
required
allowed_organizations
Array of integers <int64> [ items <int64 > ]
color
string
date_create
any
date_edit
any
description
string
id
integer <int64>
name
string
organization
any
organization_id
integer <int64>
protected
boolean
object (TagScenarios)

TagScenarios is used to contain a list of scenarios triggered by or triggering a certain tag

Responses

Request samples

Content type
application/json
{
  • "allowed_organizations": [
    ],
  • "color": "string",
  • "date_create": null,
  • "date_edit": null,
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organization": null,
  • "organization_id": 0,
  • "protected": true,
  • "scenarios": {
    }
}

Response samples

Content type
application/json
{
  • "allowed_organizations": [
    ],
  • "color": "string",
  • "date_create": null,
  • "date_edit": null,
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organization": null,
  • "organization_id": 0,
  • "protected": true,
  • "scenarios": {
    }
}

DeleteTag

Deletes an existing tag

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer

id of a tag

Responses

TriggerTag

Trigger a certain Tag by it's ID

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
id
required
integer
Request Body schema: application/json
required
eventExternalID
string
eventName
string
message
string
optionalContent
any
textTemplateID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "eventExternalID": "string",
  • "eventName": "string",
  • "message": "string",
  • "optionalContent": null,
  • "textTemplateID": 0
}

tag

GetOverwrittenAlarmMessages

Get a history of all manually triggered tags

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of an organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

tags-protected

ListProtectedTagRequests

Get all usage requests for protected tags created by or opened for the given organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer

id of requested organization

action
required
string

which list to request, either "open" or "created" requests

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SetProtectedTagDecision

Set a final decision about a usage request for a protected tag

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
requestID
required
integer

id of the request

query Parameters
decision
required
string

decision made by tag-owner about given request, either "approve" or "decline"

Responses

units

Creates a unit using the given data.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
description
required
string

user-defined description for this unit

externalID
string

an external, but per organization unique, identifier this Unit can be accessed with; empty or null to unset

isLocked
boolean

a locked unit cannot be edited

name
required
string

user-defined name for this unit

organizationID
required
integer <int64>

id of the assigned organization

object (UnitPosition contains the current position of a unit.)
statusID
integer <int64>

the current status ID of this Unit as described by the organization's UnitStatuses; null to unset

required
Array of objects (UnitPartCreationRequest is used to create a new UnitPart when creating a new Unit.)

assigned unit parts for labels and their amounts

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "statusID": 0,
  • "unitParts": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Sets the position of a specific unit identified by its ExternalID. Using an empty body removes the Unit's position.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
externalID
required
string

the Unit's externalID

organizationID
required
integer <int64>

the Unit's organizationID

object (UnitPosition contains the current position of a unit.)

Responses

Request samples

Content type
application/json
{
  • "externalID": "string",
  • "organizationID": 0,
  • "position": {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Sets the status of a specific unit identified by its ExternalID. Omitting StatusID removes the Unit's status.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required
externalID
required
string

the Unit's externalID

organizationID
required
integer <int64>

the Unit's organizationID

statusID
integer <int64>

the current status ID of this Unit as described by the organization's UnitStatuses; null to unset

Responses

Request samples

Content type
application/json
{
  • "externalID": "string",
  • "organizationID": 0,
  • "statusID": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Returns a specific unit identified by its ID.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
unitID
required
integer

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Updates a specific unit identified by its ID using the given data.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
unitID
required
integer
Request Body schema: application/json
required
description
required
string

user-defined description for this unit

externalID
string

an external, but per organization unique, identifier this Unit can be accessed with; empty or null to unset

isLocked
boolean

a locked unit cannot be edited

name
required
string

user-defined name for this unit

organizationID
required
integer <int64>

id of the assigned organization

object (UnitPosition contains the current position of a unit.)
statusID
integer <int64>

the current status ID of this Unit as described by the organization's UnitStatuses; null to unset

required
Array of objects (UnitPartCreationRequest is used to create a new UnitPart when creating a new Unit.)

assigned unit parts for labels and their amounts

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "statusID": 0,
  • "unitParts": [
    ]
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Deletes a specific unit identified by its ID.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
unitID
required
integer

Responses

Sets the position of a specific unit identified by its ID. Using an empty body removes the Unit's position.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
unitID
required
integer
Request Body schema: application/json
required
latitude
number <double>
longitude
number <double>

Responses

Request samples

Content type
application/json
{
  • "latitude": 0.1,
  • "longitude": 0.1
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Sets the status of a specific unit identified by its ID. Omitting statusID removes the Unit's status.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
unitID
required
integer
statusID
required
integer

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "externalID": "string",
  • "id": 0,
  • "isLocked": true,
  • "name": "string",
  • "organizationID": 0,
  • "position": {
    },
  • "status": {
    },
  • "unitParts": [
    ]
}

Returns all units of an organization.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization
required
integer
limit
integer [ 1 .. 50 ]
Default: 10

max. amount of entries in list

offset
integer
Default: 0

amount of entries to skip

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

search
string

query to filter unit list by a name

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "units": [
    ]
}

unit-status

Returns a list of all unit-statuses in your organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "organizationID": 0,
  • "unitStatuses": [
    ]
}

Sets the given list of unit-statuses for your organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required
organizationID
integer <int64>
required
Array of objects (UnitStatus describes the status a unit could be in.) [ 1 .. 10 ]

list of UnitStatus objects for an organization with unique IDs

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "unitStatuses": [
    ]
}

Response samples

Content type
application/json
{
  • "organizationID": 0,
  • "unitStatuses": [
    ]
}

Resets the unit-statuses for your organization to our default values.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "message": "successfully delete unit"
}

Returns your organization's current unit-status settings.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "alarmedUnitStatusID": 0,
  • "eventEndUnitStatusID": 0,
  • "organizationID": 0
}

Sets the given unit-status settings for your organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required
alarmedUnitStatusID
integer <int64>
eventEndUnitStatusID
integer <int64>
organizationID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "alarmedUnitStatusID": 0,
  • "eventEndUnitStatusID": 0,
  • "organizationID": 0
}

Response samples

Content type
application/json
{
  • "alarmedUnitStatusID": 0,
  • "eventEndUnitStatusID": 0,
  • "organizationID": 0
}