Download OpenAPI specification:
The alarming service is used to configure and manage alarms.
Creates an alarm for an event and calculate required user for a notification
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 | ||||||||||||||||||||||||
eventSeverityLevel | integer <int64> EventSeverityLevel is a number (from 0-9) indicating the severity of the event | ||||||||||||||||||||||||
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 when creating an alarm, significant keys are shown in the tables below, keys that are not in the tables below have no effect on the alarm. location
storage api fileKeys
| ||||||||||||||||||||||||
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. |
{- "alarmResourceTemplateID": 0,
- "alarmResources": {
- "allUsers": true,
- "labels": [
- {
- "amount": 0,
- "labelID": 0
}
], - "scenarios": [
- 0
], - "unitExternalIDs": [
- "string"
], - "units": [
- 0
], - "users": [
- 0
]
}, - "alarmTemplateID": 0,
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "eventExternalID": "string",
- "eventID": 0,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "scenarioID": 0,
- "scheduledEndTime": null,
- "startTime": null
}
{- "alarmResources": {
- "labels": [
- {
- "amount": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0
}
], - "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": null
}
], - "triggering": [
- {
- "organization": null,
- "scenario": null
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": null
}
], - "triggering": [
- {
- "organization": null,
- "scenario": null
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- null
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- null
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": null,
- "geofenceIDs": [ ],
- "labelIDs": [ ]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
], - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
], - "users": [
- 0
]
}, - "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "endDate": null,
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "event": {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}, - "feedback": [
- {
- "alarmID": 0,
- "feedback": true,
- "labelID": 0,
- "responseTime": null,
- "state": "string",
- "unitID": 0,
- "userDistance": 0,
- "userDuration": 0,
- "userID": 0
}
], - "feedbackPercentage": {
- "negative": 0.1,
- "positive": 0.1,
- "unknown": 0.1
}, - "id": 1,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "startDate": null,
- "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}
}, - "success": true
}
Returns a preview of a planned alarm using the given resources
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 | ||||||||||||||||||||||||
eventSeverityLevel | integer <int64> EventSeverityLevel is a number (from 0-9) indicating the severity of the event | ||||||||||||||||||||||||
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 when creating an alarm, significant keys are shown in the tables below, keys that are not in the tables below have no effect on the alarm. location
storage api fileKeys
| ||||||||||||||||||||||||
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. |
{- "alarmResourceTemplateID": 0,
- "alarmResources": {
- "allUsers": true,
- "labels": [
- {
- "amount": 0,
- "labelID": 0
}
], - "scenarios": [
- 0
], - "unitExternalIDs": [
- "string"
], - "units": [
- 0
], - "users": [
- 0
]
}, - "alarmTemplateID": 0,
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "eventExternalID": "string",
- "eventID": 0,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "scenarioID": 0,
- "scheduledEndTime": null,
- "startTime": null
}
{- "alarmResources": {
- "labels": [
- {
- "amount": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0
}
], - "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": null
}
], - "triggering": [
- {
- "organization": null,
- "scenario": null
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": null
}
], - "triggering": [
- {
- "organization": null,
- "scenario": null
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- null
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- null
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": null,
- "geofenceIDs": [ ],
- "labelIDs": [ ]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
], - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
], - "users": [
- 0
]
}, - "plan": [
- {
- "labelID": 0,
- "unitID": 0,
- "userID": 0
}
], - "positionsFulfilled": true
}
Returns an alarm payload for requested alarm id
alarmID required | integer |
update_for_user | boolean optional parameter to update alarm with data for querying user (e.g. replaced variables in message) |
{- "alarmResources": {
- "labels": [
- {
- "amount": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0
}
], - "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": null
}
], - "triggering": [
- {
- "organization": null,
- "scenario": null
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": null
}
], - "triggering": [
- {
- "organization": null,
- "scenario": null
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- null
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- null
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": null,
- "geofenceIDs": [ ],
- "labelIDs": [ ]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
], - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
], - "users": [
- 0
]
}, - "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "endDate": null,
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "event": {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}, - "feedback": [
- {
- "alarmID": 0,
- "feedback": true,
- "labelID": 0,
- "responseTime": null,
- "state": "string",
- "unitID": 0,
- "userDistance": 0,
- "userDuration": 0,
- "userID": 0
}
], - "feedbackPercentage": {
- "negative": 0.1,
- "positive": 0.1,
- "unknown": 0.1
}, - "id": 1,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "startDate": null,
- "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}
}, - "success": true
}
Returns all alarms for an organization
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 |
{- "alarms": [
- {
- "alarmResources": {
- "labels": [
- {
- "amount": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0
}
], - "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- null
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [ ],
- "triggering": [ ]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- null
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [ ],
- "triggering": [ ]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": null,
- "id": null,
- "isSubstitute": null,
- "label": null,
- "substitutedAmount": null,
- "unitID": null,
- "userID": null
}
]
}
]
}
], - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- null
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- null
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": null,
- "geofenceIDs": [ ],
- "labelIDs": [ ]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
], - "users": [
- 0
]
}, - "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "endDate": null,
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "event": {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}, - "feedback": [
- {
- "alarmID": 0,
- "feedback": true,
- "labelID": 0,
- "responseTime": null,
- "state": "string",
- "unitID": 0,
- "userDistance": 0,
- "userDuration": 0,
- "userID": 0
}
], - "feedbackPercentage": {
- "negative": 0.1,
- "positive": 0.1,
- "unknown": 0.1
}, - "id": 1,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "startDate": null,
- "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}
}
]
}
}, - "success": true
}
], - "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}
}, - "totalAlarms": 0
}
Returns all alarms the current user has been alarmed in from all organizations they are a member of
limit | integer [ 1 .. 50 ] Default: 10 amount of entries in paginated list |
offset | integer >= 0 Default: 0 amount of skipped entries in paginated list |
{- "alarms": [
- {
- "alarmResources": {
- "labels": [
- {
- "amount": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0
}
], - "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- null
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [ ],
- "triggering": [ ]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- null
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [ ],
- "triggering": [ ]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": null,
- "id": null,
- "isSubstitute": null,
- "label": null,
- "substitutedAmount": null,
- "unitID": null,
- "userID": null
}
]
}
]
}
], - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- null
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- null
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": null,
- "geofenceIDs": [ ],
- "labelIDs": [ ]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
], - "users": [
- 0
]
}, - "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "endDate": null,
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "event": {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}, - "feedback": [
- {
- "alarmID": 0,
- "feedback": true,
- "labelID": 0,
- "responseTime": null,
- "state": "string",
- "unitID": 0,
- "userDistance": 0,
- "userDuration": 0,
- "userID": 0
}
], - "feedbackPercentage": {
- "negative": 0.1,
- "positive": 0.1,
- "unknown": 0.1
}, - "id": 1,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "startDate": null,
- "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}
}
]
}
}, - "success": true
}
], - "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}
}, - "totalAlarms": 0
}
Returns all alarms from all organizations the current user is a member of
limit | integer [ 1 .. 50 ] Default: 10 amount of entries in paginated list |
offset | integer >= 0 Default: 0 amount of skipped entries in paginated list |
{- "alarms": [
- {
- "alarmResources": {
- "labels": [
- {
- "amount": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0
}
], - "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- null
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [ ],
- "triggering": [ ]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- null
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [ ],
- "triggering": [ ]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": null,
- "id": null,
- "isSubstitute": null,
- "label": null,
- "substitutedAmount": null,
- "unitID": null,
- "userID": null
}
]
}
]
}
], - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- null
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- null
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": null,
- "geofenceIDs": [ ],
- "labelIDs": [ ]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
], - "users": [
- 0
]
}, - "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "endDate": null,
- "escalationModeConfiguration": {
- "initialEscalationStage": 1,
- "shiftEscalationID": 0
}, - "event": {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}, - "feedback": [
- {
- "alarmID": 0,
- "feedback": true,
- "labelID": 0,
- "responseTime": null,
- "state": "string",
- "unitID": 0,
- "userDistance": 0,
- "userDuration": 0,
- "userID": 0
}
], - "feedbackPercentage": {
- "negative": 0.1,
- "positive": 0.1,
- "unknown": 0.1
}, - "id": 1,
- "message": "string",
- "mode": "string",
- "optionalContent": null,
- "organizationID": 0,
- "startDate": null,
- "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}
}
]
}
}, - "success": true
}
], - "strength": {
- "property1": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}, - "property2": {
- "amount": 1,
- "labelStrengths": [
- {
- "amount": 1,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
}
]
}
}, - "totalAlarms": 0
}
Creates an alarm template with the passed parameters
the resource template struct
allUsers | boolean |
eventName | string |
eventSeverityLevel | integer <int64> EventSeverityLevel is the severity level for the given event |
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 > ] |
{- "allUsers": true,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "id": 0,
- "initialEscalationStage": 0,
- "labels": [
- {
- "amount": -1,
- "label": 0
}
], - "message": "string",
- "mode": "string",
- "name": "string",
- "optionalContent": null,
- "organizationID": 0,
- "organizationName": "string",
- "scenarios": [
- 0
], - "shiftEscalationID": 0,
- "units": [
- 0
], - "users": [
- 0
]
}
{- "allUsers": true,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "id": 0,
- "initialEscalationStage": 0,
- "labels": [
- {
- "amount": -1,
- "label": 0
}
], - "message": "string",
- "mode": "string",
- "name": "string",
- "optionalContent": null,
- "organizationID": 0,
- "organizationName": "string",
- "scenarios": [
- 0
], - "shiftEscalationID": 0,
- "units": [
- 0
], - "users": [
- 0
]
}
Returns a specific alarm resource template
id required | integer id of the alarm resource template |
organization_id | integer Optional id of the requesting organization. This is required if you try to fetch a shared template from a different organization. |
{- "allUsers": true,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "id": 0,
- "initialEscalationStage": 0,
- "labels": [
- {
- "amount": -1,
- "label": 0
}
], - "message": "string",
- "mode": "string",
- "name": "string",
- "optionalContent": null,
- "organizationID": 0,
- "organizationName": "string",
- "scenarios": [
- 0
], - "shiftEscalationID": 0,
- "units": [
- 0
], - "users": [
- 0
]
}
Updates an alarm template with the passed parameters
id required | integer id of the alarm resource template |
the resource template struct
allUsers | boolean |
eventName | string |
eventSeverityLevel | integer <int64> EventSeverityLevel is the severity level for the given event |
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 > ] |
{- "allUsers": true,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "id": 0,
- "initialEscalationStage": 0,
- "labels": [
- {
- "amount": -1,
- "label": 0
}
], - "message": "string",
- "mode": "string",
- "name": "string",
- "optionalContent": null,
- "organizationID": 0,
- "organizationName": "string",
- "scenarios": [
- 0
], - "shiftEscalationID": 0,
- "units": [
- 0
], - "users": [
- 0
]
}
Returns a paginated list of alarm resource templates for the queried organization
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 |
{- "templates": [
- {
- "allUsers": true,
- "eventName": "string",
- "eventSeverityLevel": 0,
- "id": 0,
- "initialEscalationStage": 0,
- "labels": [
- {
- "amount": -1,
- "label": 0
}
], - "message": "string",
- "mode": "string",
- "name": "string",
- "optionalContent": null,
- "organizationID": 0,
- "organizationName": "string",
- "scenarios": [
- 0
], - "shiftEscalationID": 0,
- "units": [
- 0
], - "users": [
- 0
]
}
], - "total": 0
}
Creates an alarm template with the passed parameters
template payload
id | integer <int64> |
message | string |
name | string |
organizationID | integer <int64> |
{- "id": 0,
- "message": "string",
- "name": "string",
- "organizationID": 0
}
{- "id": 0,
- "message": "string",
- "name": "string",
- "organizationID": 0
}
Returns a specific alarm template for passed template id
id required | integer id of the template |
organization_id required | integer id of organization |
[- {
- "id": 0,
- "message": "string",
- "name": "string",
- "organizationID": 0
}
]
Updates an alarm template with the passed parameters
id required | integer id of the alarm template |
template payload
id | integer <int64> |
message | string |
name | string |
organizationID | integer <int64> |
{- "id": 0,
- "message": "string",
- "name": "string",
- "organizationID": 0
}
Returns all alarm templates for passed organization id
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 |
{- "templates": [
- {
- "id": 0,
- "message": "string",
- "name": "string",
- "organizationID": 0
}
], - "total": 0
}
required data for key redemption
key | string |
organizationID | integer <int64> |
{- "key": "string",
- "organizationID": 0
}
templateID required | integer id of the alarm resource template |
required data for key creation
name | string |
templateID | integer <int64> |
{- "name": "string",
- "templateID": 0
}
{- "id": 0,
- "key": "string",
- "name": "string",
- "organizationID": 0,
- "redeemedOrganizationIDs": [
- 0
], - "templateID": 0
}
templateID required | integer id of the alarm resource template |
keyID required | integer id of the alarm resource template sharing key |
{- "id": 0,
- "key": "string",
- "name": "string",
- "organizationID": 0,
- "redeemedOrganizationIDs": [
- 0
], - "templateID": 0
}
templateID required | integer id of the alarm resource template |
keyID required | integer id of the alarm resource template sharing key |
templateID required | integer id of the alarm resource template |
[- {
- "id": 0,
- "key": "string",
- "name": "string",
- "organizationID": 0,
- "redeemedOrganizationIDs": [
- 0
], - "templateID": 0
}
]
Gets the configured organization alarm settings
organizationID required | integer |
{- "alarmDispatchedUsers": true,
- "hideFeedback": true,
- "hideGeolocation": true,
- "messengerAddTimeoutedUsersToEventRoom": true,
- "messengerCreateRoomForEvent": true,
- "messengerDeleteEventRoomAfterMinutes": 0
}
Creates or updates the alarm settings for the passed organization
organizationID required | integer |
alarmDispatchedUsers | boolean |
hideFeedback | boolean |
hideGeolocation | boolean |
messengerAddTimeoutedUsersToEventRoom | boolean |
messengerCreateRoomForEvent | boolean |
messengerDeleteEventRoomAfterMinutes | integer <int64> |
{- "alarmDispatchedUsers": true,
- "hideFeedback": true,
- "hideGeolocation": true,
- "messengerAddTimeoutedUsersToEventRoom": true,
- "messengerCreateRoomForEvent": true,
- "messengerDeleteEventRoomAfterMinutes": 0
}
Searches an event with the passed externalID or name
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 |
{- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}
Creates an event with the passed event payload
externalID | string |
name | string |
organizationID | integer <int64> |
scheduledEndtime | any |
severityLevel | integer <int64> |
startDate | any |
{- "externalID": "string",
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severityLevel": 0,
- "startDate": null
}
{- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}
Gets an event with the passed event ID
eventID required | integer |
{- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}
Returns paginated events of a passed organization
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 |
{- "events": [
- {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}
], - "totalEvents": 0
}
Returns all open events of a passed organization
organization required | integer ID of an organization |
[- {
- "abort": {
- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}, - "archived": true,
- "endDate": null,
- "externalID": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "scheduledEndtime": null,
- "severity": {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}, - "startDate": null
}
]
Aborts an event with the passed event ID or external ID
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 |
Event abort details
creatorID | integer <int64> |
creatorName | string |
creatorType | string |
eventID | integer <int64> |
message | string |
organizationID | integer <int64> |
time | any |
{- "creatorID": 0,
- "creatorName": "string",
- "creatorType": "string",
- "eventID": 0,
- "message": "string",
- "organizationID": 0,
- "time": null
}
Returns all severities for a given organization id
organizationID required | integer |
[- {
- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}
]
oldLevel required | integer |
color required | string Color is a customizable hex-color |
icon required | string Icon is an icon for the severity |
level required | integer <int64> [ 0 .. 9 ] Level is the level of the severity |
name required | string [ 1 .. 32 ] Name is the name of the severity |
organizationID required | integer <int64> organizationID is the ID of the organization where the severity belongs to |
{- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}
{- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}
Creates a severity with the passed severity payload
color required | string Color is a customizable hex-color |
icon required | string Icon is an icon for the severity |
level required | integer <int64> [ 0 .. 9 ] Level is the level of the severity |
name required | string [ 1 .. 32 ] Name is the name of the severity |
organizationID required | integer <int64> organizationID is the ID of the organization where the severity belongs to |
{- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}
{- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}
Returns the severity for a given level and organization id
organizationID required | integer |
level required | integer |
{- "color": "string",
- "icon": "string",
- "level": 9,
- "name": "string",
- "organizationID": 0
}
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 |
{- "geofences": [
- {
- "assignees": [
- 0
], - "color": "string",
- "id": 0,
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "organizationID": 0,
- "radius": 100
}
], - "total": 0
}
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 |
{- "color": "string",
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "organizationID": 0,
- "radius": 100
}
{- "assignees": [
- 0
], - "color": "string",
- "id": 0,
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "organizationID": 0,
- "radius": 100
}
id required | integer unique identifier of the geofence |
{- "assignees": [
- 0
], - "color": "string",
- "id": 0,
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "organizationID": 0,
- "radius": 100
}
id required | integer unique identifier of the geofence |
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 |
{- "color": "string",
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "organizationID": 0,
- "radius": 100
}
{- "assignees": [
- 0
], - "color": "string",
- "id": 0,
- "latitude": -90,
- "longitude": -180,
- "name": "string",
- "organizationID": 0,
- "radius": 100
}
Creates a new label with the passed label payload parameters
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. if this is nil, the label is not pauseable |
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 |
{- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
{- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
Get paginated organizations along with all labels assigned for user with the passed JWT token
limit | integer max. amount of entries in list |
offset | integer amount of entries to skip |
{- "organizationsWithLabels": [
- {
- "labels": [
- {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
], - "organization": null
}
], - "totalOrganizations": 0
}
Returns a specific label with passed ID
labelID required | integer |
{- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
Updates a specific label by a passed label ID and a label payload
labelID required | integer |
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. if this is nil, the label is not pauseable |
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 |
{- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
{- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
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.
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 |
[- {
- "labels": [
- {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}
], - "total": 0
}
]
Creates a new or changes an existing strength configuration for passed organization
organization required | integer id of an organization |
user-rank assignment payload
required | Array of objects (RankLabels) |
{- "configs": [
- {
- "labels": [
- 0
], - "rank": "string"
}
]
}
[- {
- "labels": [
- 0
], - "rank": "string"
}
]
Get the strength rank and names configuration for this organization
organization required | integer id of an organization |
{- "names": {
- "general": "string",
- "officer": "string",
- "soldier": "string"
}, - "ranks": [
- {
- "labels": [
- 0
], - "rank": "string"
}
]
}
Inserts or updates a rank name configuration for the passed organization
organization required | integer id of an organization |
rank names configuration payload
general | string |
officer | string |
soldier | string |
{- "general": "string",
- "officer": "string",
- "soldier": "string"
}
Assing a rank to passed user
organization required | integer id of an organization |
user-rank assignment payload
rank required | string rank value |
userID required | integer <int64> userID |
{- "rank": "string",
- "userID": 0
}
{- "message": "success"
}
Creates a scenario with the passed parameters of a scenario payload
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 |
{- "description": "string",
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- 0
], - "triggering": [
- 0
]
}, - "units": [
- 0
]
}
[- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
]
Returns a specific scenario payload for a scenario with passed ID
scenarioID required | integer |
{- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
Updates an existing scenario with passed scenario ID and scenario payload
scenarioID required | integer |
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 |
{- "description": "string",
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- 0
], - "triggering": [
- 0
]
}, - "units": [
- 0
]
}
{- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
Returns all scenarios in the organization with the passed ID
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 |
{- "scenarios": [
- {
- "description": "string",
- "id": 0,
- "instructionCatalogID": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "sendPosition": true,
- "tags": {
- "triggered_by": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
], - "triggering": [
- {
- "allowed_organizations": [
- 0
], - "color": "string",
- "date_create": null,
- "date_edit": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organization": null,
- "organization_id": 0,
- "protected": true,
- "scenarios": {
- "triggered_by": [
- {
- "organization": null,
- "scenario": { }
}
], - "triggering": [
- {
- "organization": null,
- "scenario": { }
}
]
}
}
]
}, - "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- null
], - "labelIDs": [
- null
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
], - "total": 0
}
Get all shift schedules for queried organization
organization required | integer id of an organization |
[- {
- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
]
Create a new shift schedule
active | boolean |
id | integer <int64> |
name | string |
organizationID | integer <int64> |
Array of objects (Shift) |
{- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
{- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
Get a single shift schedule
id required | integer id of a shift schedule |
{- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
Update an existing shift schedule
id required | integer id of a shift schedule |
active | boolean |
id | integer <int64> |
name | string |
organizationID | integer <int64> |
Array of objects (Shift) |
{- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
{- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
id required | integer id of an alarm |
{- "alarmID": 0,
- "items": [
- {
- "assignees": [
- 0
], - "escalationTime": null,
- "secondsUntilNextStage": 0,
- "stageName": "string"
}
], - "organizationID": 0,
- "shiftEscalationName": "string"
}
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 |
{- "entries": [
- {
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "secondsUntilNextStage": [
- 0
], - "stages": [
- {
- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
]
}
], - "total": 0
}
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 > ] |
{- "name": "string",
- "organizationID": 0,
- "secondsUntilNextStage": [
- 0
], - "shiftScheduleIDs": [
- 0
]
}
{- "id": 0,
- "name": "string",
- "organizationID": 0,
- "secondsUntilNextStage": [
- 0
], - "stages": [
- {
- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
]
}
id required | integer id of a shift escalation |
{- "id": 0,
- "name": "string",
- "organizationID": 0,
- "secondsUntilNextStage": [
- 0
], - "stages": [
- {
- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
]
}
id required | integer id of a shift escalation |
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 > ] |
{- "name": "string",
- "organizationID": 0,
- "secondsUntilNextStage": [
- 0
], - "shiftScheduleIDs": [
- 0
]
}
{- "id": 0,
- "name": "string",
- "organizationID": 0,
- "secondsUntilNextStage": [
- 0
], - "stages": [
- {
- "active": true,
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "shifts": [
- {
- "assignees": [
- 0
], - "color": "string",
- "days": [
- 0
], - "endTime": "string",
- "id": 0,
- "mappingDate": null,
- "mappingLength": 0,
- "name": "string",
- "shiftGroups": [
- 0
], - "shiftScheduleID": 0,
- "startTime": "string"
}
]
}
]
}
Creates a new shift group
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> |
{- "assignees": [
- 0
], - "id": 0,
- "labels": [
- 0
], - "name": "string",
- "organizationID": 0
}
{- "assignees": [
- 0
], - "id": 0,
- "labels": [
- 0
], - "name": "string",
- "organizationID": 0
}
Returns a specific shift group with the passed id
groupID required | integer id of a shift group |
{- "assignees": [
- 0
], - "id": 0,
- "labels": [
- 0
], - "name": "string",
- "organizationID": 0
}
Updates a shift group
groupID required | integer id of a shift group |
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> |
{- "assignees": [
- 0
], - "id": 0,
- "labels": [
- 0
], - "name": "string",
- "organizationID": 0
}
Returns all configured shift groups for the given organization
organizationID required | integer id of the organization |
[- {
- "assignees": [
- 0
], - "id": 0,
- "labels": [
- 0
], - "name": "string",
- "organizationID": 0
}
]
Get a history of all manually triggered tags
organization required | integer id of an organization |
[- {
- "id": 0,
- "message": "string",
- "organizationID": 0,
- "tagID": 0
}
]
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 |
{- "description": "string",
- "externalID": "string",
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "statusID": 0,
- "unitParts": [
- {
- "amount": -1,
- "labelID": 0
}
]
}
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
externalID required | string the Unit's externalID |
organizationID required | integer <int64> the Unit's organizationID |
object (UnitPosition contains the current position of a unit.) |
{- "externalID": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}
}
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
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 |
{- "externalID": "string",
- "organizationID": 0,
- "statusID": 0
}
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
unitID required | integer |
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
unitID required | integer |
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 |
{- "description": "string",
- "externalID": "string",
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "statusID": 0,
- "unitParts": [
- {
- "amount": -1,
- "labelID": 0
}
]
}
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
unitID required | integer |
latitude | number <double> |
longitude | number <double> |
{- "latitude": 0.1,
- "longitude": 0.1
}
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
unitID required | integer |
statusID required | integer |
{- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
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 |
{- "total": 0,
- "units": [
- {
- "description": "string",
- "externalID": "string",
- "id": 0,
- "isLocked": true,
- "name": "string",
- "organizationID": 0,
- "position": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "status": {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}, - "unitParts": [
- {
- "amount": 0,
- "id": 0,
- "isSubstitute": true,
- "label": {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0,
- "pauseableUsers": [
- 0
], - "priority": 0,
- "smartLabelConfiguration": {
- "conjunctionType": "and",
- "geofenceIDs": [
- 0
], - "labelIDs": [
- 0
]
}, - "substitute": { }
}, - "substitutedAmount": 0,
- "unitID": 0,
- "userID": 0
}
]
}
]
}
organizationID required | integer |
{- "organizationID": 0,
- "unitStatuses": [
- {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}
]
}
organizationID required | integer |
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 |
{- "organizationID": 0,
- "unitStatuses": [
- {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}
]
}
{- "organizationID": 0,
- "unitStatuses": [
- {
- "color": "string",
- "id": 9,
- "isAvailable": true,
- "name": "string"
}
]
}
organizationID required | integer |
alarmedUnitStatusID | integer <int64> |
eventEndUnitStatusID | integer <int64> |
organizationID | integer <int64> |
{- "alarmedUnitStatusID": 0,
- "eventEndUnitStatusID": 0,
- "organizationID": 0
}
{- "alarmedUnitStatusID": 0,
- "eventEndUnitStatusID": 0,
- "organizationID": 0
}