openapi: 3.0.3
info:
  title: Kentix SmartAPI
  description: |-
    # Important Remarks
    **Before you start, please read the following information carefully**
    * **Foreknowledge**
        * This documentation assumes knowledge of [ReST concepts](https://en.wikipedia.org/wiki/Representational_state_transfer).
        * In order to use the KentixONE [ReST API](https://en.wikipedia.org/wiki/Representational_state_transfer), you need knowledge of the corresponding programming concepts and their methods.



    * **Support**
        * We ask for your understanding that we cannot offer free support for questions regarding program implementation or project integration within the scope of our technical support.
        * For this purpose, we offer [bookable support packages](https://shop.kentix.com/de-de/60-minuten-remote-support-durch-kentix-experten-fuer-inbetriebnahme-konfiguration-und-migration/krservice1) for optimal support in your project and integration questions.



    * **Developer Notes**
        * Please be sure to always include the `Accept: application/json` header in your requests. Not doing so will result in being redirected to the login page.
        * For automated integrations see our [YAML OpenAPI schema](https://docs.kentix.com/smartapi/8.5.0/schema).



    * **Authentication**
        * The Kentix SmartAPI uses Bearer Token authentication
        * A user may find his personal API Bearer Token in his user profile or as JSON key 'api_token' when requesting a users detail.



    ***
  version: 8.5.3
  license:
    name: Kentix GmbH
    url: https://kentix.com/de/impressum/
  contact:
    name: Kentix GmbH
    url: https://kentix.com/
    email: info@kentix.com
  x-logo:
    url: https://docs.kentix.com/smartapi/kentixone-logo.svg
    backgroundColor: '#FAFAFA'
    altText: Kentix GmbH
servers:
  - url: https://192.168.100.224
    description: Kentix AccessManager
  - url: https://192.168.100.222
    description: Kentix AlarmManager
  - url: https://192.168.100.223
    description: Kentix MultiSensor
  - url: https://192.168.100.226
    description: Kentix SmartPDU
tags:
  - name: access-event
    x-displayName: Access-Events
    description: Access-Event List
  - name: access-event-export
    x-displayName: Access-Event Export
    description: Access-Event Export
  - name: access-event-images
    x-displayName: Access-Event Images
    description: Access-Event Images
  - name: access
    x-displayName: Access Settings
    description: Functions to request and update the general access settings.
  - name: accessmanagers
    x-displayName: AccessManager List
    description: Functions to manage AccessManagers.
  - name: accessmanagers-names
    x-displayName: AccessManager Names
    description: Function to get a list of all the names of the AccessManagers.
  - name: accessmanager-accessmanager_id
    x-displayName: AccessManager Details
    description: Functions to get or modify a specific AccessManager via the id.
  - name: alarm-event
    x-displayName: Alarm-Events
    description: Alarm-Event List
  - name: alarm-event-export
    x-displayName: Alarm-Event Export
    description: Alarm-Event Export
  - name: alarm-event-images
    x-displayName: Alarm-Event Images
    description: Alarm-Event Images
  - name: alarmgroups
    x-displayName: Alarmgroups List
  - name: alarmgroup
    x-displayName: Alarmgroup Details
  - name: alarmgroup-arm
    x-displayName: Arm Alarmgroup
  - name: alarmgroup-disarm
    x-displayName: Disarm Alarmgroup
  - name: alarmgroup-quit
    x-displayName: Quit Alarmgroup
  - name: alarmgroup-state
    x-displayName: Alarmgroup Names
  - name: alarmhorn
    x-displayName: Alarm Siren List
    description: Get a list of all alarm sirens
  - name: alarmhorn-names
    x-displayName: Alarm Siren Names
    description: Get a shortened list of all alarm sirens
  - name: alarmhorn-id
    x-displayName: Alarm Siren Details
    description: Get the detailed configuration parameters of a single alarm siren
  - name: alarmmanager
    x-displayName: Alarmmanager List
    description: Alarmmanagers
  - name: alarmmanager-names
    x-displayName: Alarmmanager Names
    description: Alarmmanager Names
  - name: alarmmanager-id
    x-displayName: Alarmmanager Details
    description: Alarmmanager configuration
  - name: anti-passback-settings
    x-displayName: Anti-Passback Settings
    description: Anti-Passback Settings
  - name: anti-passback-users
    x-displayName: Anti-Passback User Settings
    description: Anti-Passback User Settings
  - name: anti-passback
    x-displayName: anti-passback
  - name: backup
    x-displayName: Backup Configuration
    description: Backup Configuration
  - name: autobackup
    x-displayName: Automatic Backup Configuration
    description: Automatic Backup Configuration
  - name: cameras
    x-displayName: Camera List
    description: Functions to modify and update network cameras.
  - name: cameras-names
    x-displayName: Camera Names
    description: Get the names of all cameras.
  - name: camera_id
    x-displayName: Camera Details
    description: Functions to get and modify a specific camera.
  - name: camera_live_image
    x-displayName: Camera Live Image
    description: Get the live image of a specific camera.
  - name: cloud
    x-displayName: KentixONE Onlineservice
  - name: dashboard
    x-displayName: Dashboard Data
    description: Data deemed useful for a dashboard
  - name: datetimeconfig
    x-displayName: Date & Time Configuration
    description: Date and Time configuration
  - name: device-info
    x-displayName: General Device Information
    description: Device-Info
  - name: doorlocklist
    x-displayName: DoorLocks List
  - name: doorlocksingle
    x-displayName: DoorLock Details
  - name: doorlockopen
    x-displayName: Remote open DoorLock
  - name: doorlockinfo
    x-displayName: DoorLock Information
  - name: doorlocknames
    x-displayName: DoorLock Names
  - name: doorlocklock
    x-displayName: Disable multiple DoorLocks
  - name: doorlockunlock
    x-displayName: Enable multiple DoorLocks
  - name: blockingprofiles
    x-displayName: Exceptionday Profile List
    description: Exceptionday Profiles
  - name: blockingprofiles-id
    x-displayName: Exceptionday Profile Details
    description: Exceptionday Profile configuration
  - name: blockingprofiles-import
    x-displayName: Exceptionday Import - Export
    description: Exceptionday Import - Export
  - name: extmodassignment
    x-displayName: IO and their assignments
  - name: gsm
    x-displayName: GSM Configuration
  - name: sim
    x-displayName: SIM Configuration
  - name: sms-gateway
    x-displayName: SMS Gateway Configuration
  - name: history
    x-displayName: Measurement history
  - name: integration
    x-displayName: Integration
    description: Integration of an existing system
  - name: iomodule
    x-displayName: IO-Module List
    description: IO-Modules
  - name: iomodule-names
    x-displayName: IO-Module Names
    description: IO-Module Names
  - name: iomodule-id
    x-displayName: IO-Module Details
    description: IO-Module configuration
  - name: iostates
    x-displayName: Get Io States
  - name: kentix-ai
    x-displayName: KAI settings
    description: Configuration for KAI, the Kentix AI
  - name: kpiconfig
    x-displayName: KPIs
    description: KPI configuration
  - name: ldap
    description: LDAP
    x-displayName: LDAP Settings
  - name: ldapsync
    description: LDAP Sync
    x-displayName: LDAP Sync
  - name: levelprofile
    x-displayName: Levelprofile List
    description: Get levelprofiles
  - name: levelprofile-id
    x-displayName: Levelprofile Details
    description: Get a specific levelprofile by an Id
  - name: levelprofile-names
    x-displayName: Levelprofile Names
    description: Get the names of the levelprofiles
  - name: mail
    x-displayName: Email Configuration
    description: Email configuration
  - name: mailtest
    x-displayName: Test Email Configuration
    description: Test Email configuration
  - name: massedit
    x-displayName: Massedit
    description: Massedit
  - name: multisensor
    x-displayName: MultiSensor List
    description: MultiSensors
  - name: multisensor-names
    x-displayName: MultiSensor Names
    description: MultiSensor Names
  - name: multisensor-id
    x-displayName: MultiSensor Details
    description: MultiSensor configuration
  - name: network-sensor
    x-displayName: Network-Sensor List
    description: Network-Sensors
  - name: network-sensor-names
    x-displayName: Network-Sensor Names
    description: Network-Sensor Names
  - name: network-sensor-id
    x-displayName: Network-Sensor Details
    description: Network-Sensor configuration
  - name: networkconfig
    x-displayName: Network Configuration
    description: Network configuration
  - name: sslcertificate
    x-displayName: SSL Certificate Configuration
    description: SSL Certificate configuration
  - name: passage
    x-displayName: Passage List
    description: Get passages
  - name: passage-id
    x-displayName: Passage Details
    description: Get a specific passage by its' Id
  - name: passage-names
    x-displayName: Passage Names
    description: Get the names of the passages
  - name: powermanagers-name
    x-displayName: SmartPDU Names
  - name: powermanagers
    x-displayName: SmartPDU List
  - name: powermanager
    x-displayName: SmartPDU Details
  - name: kmpdu-overview
    x-displayName: SmartPDU overview
  - name: outlet
    x-displayName: Outlet overview
  - name: outlet-switch
    x-displayName: Switch outlet
  - name: privacy
    x-displayName: Privacy Configuration
    description: Privacy configuration
  - name: profile
    x-displayName: Current user profile
    description: User profile
  - name: proxy
    x-displayName: HTTP-Proxy Settings
    description: Get HTTP Proxy Settings
  - name: quicklinks
    x-displayName: Shortcuts
    description: Shortcuts
  - name: rack
    x-displayName: Rack List
    description: Racks
  - name: rack-names
    x-displayName: Rack Names
    description: Rack Names
  - name: rack-id
    x-displayName: Rack Details
    description: Rack Details
  - name: rack-attach
    x-displayName: Attach Rack to Alarmgroup
    description: Attach Rack
  - name: region
    x-displayName: Locale Configuration
    description: Locale configuration
  - name: reset
    x-displayName: Factory Reset
    description: Reset the device
  - name: reboot
    x-displayName: Reboot
    description: Reboot the device
  - name: security
    x-displayName: Security settings
    description: Configure communication key, pin length and RFID mode
  - name: signal
    x-displayName: Output Switching
  - name: systemname
    x-displayName: System name
    description: System name
  - name: teachin
    x-displayName: Add device
  - name: teachout
    x-displayName: Remove device
  - name: update
    x-displayName: Software Update
    description: Software Update
  - name: update-settings
    x-displayName: Update Settings
    description: Update Settings
  - name: ota-update
    x-displayName: OTA-Update
    description: Contains requests regarding an OTA update of the local device.
  - name: update-state
    x-displayName: Update State
    description: Get general information on the current update state of the system.
paths:
  /api/log/access:
    get:
      tags:
        - access-event
      description: Get a list of Access-Events.
      summary: Get Access-Events
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: id
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Filters on the event with the given ID.
        - name: search
          in: query
          required: false
          schema:
            type: string
          example: Fire
          description: >-
            Searches for occurences of the given string within the columns
            "user", "door" and "alarmgroup".
        - name: doorlock
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Returns all events concerning a doorlock with the given ID.
        - name: alarmgroup
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Returns all events concerning an alarmgroup with the given ID.
        - name: remote
          in: query
          required: false
          schema:
            type: integer
          example: 0
          description: >-
            If set to 1 only remote open events will be returned.<br /> If set
            to zero, no remote open events will be returned.<br /> If omitted,
            the filter will be ignored.
        - name: system
          in: query
          required: false
          schema:
            type: integer
          example: 0
          description: >-
            If set to 1, only system notifications will be returned.<br /> If
            set to 0, no system notifications will be returned.<br /> If
            omitted, the filter will be ignored.
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Sorts the results by the given column. By adding a pipe "|" and
            "acs" or "desc" after the column name, the sorting will be ascending
            or descending.
          example: created_at|asc
        - name: start_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-01-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the start date. Please be sure to use the correct timezone.
        - name: stop_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-02-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the end date. Please be sure to use the correct timezone.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
          example: 25
          description: >-
            Sets the number of datasets provided per page. Note: It is not
            advised to set this value above 100, as this may cause performance
            issues.
        - name: page
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Requests the given page.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      description: The data of an access-event
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: The ID of the event
                        created_at:
                          example: '2022-11-28T16:09:25+01:00'
                          type: string
                          description: The created timestamp
                        door:
                          example: DoorLock 1
                          type: string
                          description: The name of the DoorLock that triggered the event
                        user:
                          example: Mustermann
                          type: string
                          description: The name of the user that triggered the event
                        alarmgroup:
                          example: Group
                          type: string
                          description: Alarmgroup of the device which triggered this entry
                        access_granted:
                          example: false
                          type: boolean
                          description: The status of the booking (Was access granted?)
                        detail:
                          example: No permission
                          type: string
                          description: The detailed description of the event
                        has_images:
                          example: false
                          type: boolean
                          description: Flags if images are included in the event
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/log/access/export:
    get:
      tags:
        - access-event-export
      description: Export all Access-Events as CSV file.
      summary: Export Access-Events
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: id
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Filters on the event with the given ID.
        - name: search
          in: query
          required: false
          schema:
            type: string
          example: Fire
          description: >-
            Searches for occurences of the given string within the columns
            "user", "door" and "alarmgroup".
        - name: doorlock
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Returns all events concerning a doorlock with the given ID.
        - name: alarmgroup
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Returns all events concerning an alarmgroup with the given ID.
        - name: remote
          in: query
          required: false
          schema:
            type: integer
          example: 0
          description: >-
            If set to 1 only remote open events will be returned.<br /> If set
            to zero, no remote open events will be returned.<br /> If omitted,
            the filter will be ignored.
        - name: system
          in: query
          required: false
          schema:
            type: integer
          example: 0
          description: >-
            If set to 1, only system notifications will be returned.<br /> If
            set to 0, no system notifications will be returned.<br /> If
            omitted, the filter will be ignored.
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Sorts the results by the given column. By adding a pipe "|" and
            "acs" or "desc" after the column name, the sorting will be ascending
            or descending.
          example: created_at|asc
        - name: start_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-01-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the start date. Please be sure to use the correct timezone.
        - name: stop_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-02-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the end date. Please be sure to use the correct timezone.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
          example: 25
          description: >-
            Sets the number of datasets provided per page. Note: It is not
            advised to set this value above 100, as this may cause performance
            issues.
        - name: page
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Requests the given page.
      responses:
        '200':
          description: Successful operation
          content:
            text/csv:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/log/access/{access_event}/images:
    get:
      tags:
        - access-event-images
      description: Get a list of Access-Events.
      summary: Get Access-Events
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: access_event
          in: path
          description: Access-Event ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: string
                      format: base64
                      description: The data of the image
                    name:
                      example: 000.jpg
                      type: string
                      description: The name of the image
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/access/settings:
    get:
      description: Request the access settings.
      summary: Get the access settings
      tags:
        - access
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  external_evaluation:
                    example: true
                    type: boolean
                    description: >-
                      If true, the manager will not evaluate access permissions.
                      Instead, upon bookings a webhook is sent and DoorLocks can
                      only be remote-opened.
                  pinlength:
                    example: '1'
                    type: string
                    minimum: 4
                    maximum: 10
                    description: Sets the length of the user pin. Must be between 4 and 10.
                  memorydepth:
                    example: '1'
                    type: string
                    minimum: 0
                    maximum: 720
                    description: >-
                      Sets the number of days during which all user-related data
                      (bookings, images, etc) is stored. 0 = Unlimited, must be
                      between 0 and 720.
                  mode:
                    example: 1
                    type: integer
                    description: >-
                      Sets the RFID security mode. 0=Off, 1=Kentix Token,
                      2=Custom security token.
                  bus_protocol:
                    example: v1
                    type: string
                    enum:
                      - v1
                      - v2
                    description: >-
                      Select what version of wallreaders are used with this
                      device. V2 devices are labeled with 'V2' next to their
                      respective devicetype. V1 devices do not have a version
                      label.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: >-
        Updates the access settings. Validation errors are returned in the
        response body with HTTP 422.
      summary: Update the access settings.
      tags:
        - access
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: abcdef...
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                external_evaluation:
                  example: true
                  type: boolean
                  description: >-
                    If true, the manager will not evaluate access permissions.
                    Instead, upon bookings a webhook is sent and DoorLocks can
                    only be remote-opened.
                pinlength:
                  example: '1'
                  type: string
                  minimum: 4
                  maximum: 10
                  description: Sets the length of the user pin. Must be between 4 and 10.
                memorydepth:
                  example: '1'
                  type: string
                  minimum: 0
                  maximum: 720
                  description: >-
                    Sets the number of days during which all user-related data
                    (bookings, images, etc) is stored. 0 = Unlimited, must be
                    between 0 and 720.
                mode:
                  example: 1
                  type: integer
                  description: >-
                    Sets the RFID security mode. 0=Off, 1=Kentix Token, 2=Custom
                    security token.
                bus_protocol:
                  example: v1
                  type: string
                  enum:
                    - v1
                    - v2
                  description: >-
                    Select what version of wallreaders are used with this
                    device. V2 devices are labeled with 'V2' next to their
                    respective devicetype. V1 devices do not have a version
                    label.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    external_evaluation:
                      example: true
                      type: boolean
                      description: >-
                        If true, the manager will not evaluate access
                        permissions. Instead, upon bookings a webhook is sent
                        and DoorLocks can only be remote-opened.
                    pinlength:
                      example: '1'
                      type: string
                      minimum: 4
                      maximum: 10
                      description: >-
                        Sets the length of the user pin. Must be between 4 and
                        10.
                    memorydepth:
                      example: '1'
                      type: string
                      minimum: 0
                      maximum: 720
                      description: >-
                        Sets the number of days during which all user-related
                        data (bookings, images, etc) is stored. 0 = Unlimited,
                        must be between 0 and 720.
                    mode:
                      example: 1
                      type: integer
                      description: >-
                        Sets the RFID security mode. 0=Off, 1=Kentix Token,
                        2=Custom security token.
                    bus_protocol:
                      example: v1
                      type: string
                      enum:
                        - v1
                        - v2
                      description: >-
                        Select what version of wallreaders are used with this
                        device. V2 devices are labeled with 'V2' next to their
                        respective devicetype. V1 devices do not have a version
                        label.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/accessmanagers:
    get:
      description: Get a list of all AccessManagers.
      summary: Get Accessmanagers
      tags:
        - accessmanagers
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: Id of the AccessManager.
                        name:
                          example: AccessManager
                          type: string
                          description: Name of the Accessmanager
                        type:
                          example: 105
                          type: integer
                          description: Devicetype of the AccessManager.
                        device_type:
                          example: ''
                          type: string
                          description: Devicetype name of the AccessManager.
                        address:
                          example: 192.168.100.224
                          type: string
                          description: IP or DNS address of the AccessManager.
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/accessmanagers/names:
    get:
      description: Get the names of all AccessManagers.
      summary: Get names of Accessmanagers
      tags:
        - accessmanagers-names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of the AccessManager.
                    name:
                      example: AccessManager
                      type: string
                      description: Name of the Accessmanager
                    type:
                      example: 105
                      type: integer
                      description: Devicetype of the AccessManager.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/accessmanager/{accessmanager_id}:
    get:
      description: Requests all detail of a specific AccessManager via the id.
      summary: Get Accessmanager informations
      tags:
        - accessmanager-accessmanager_id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: accessmanager_id
          in: path
          description: ID of the Accessmanager to be queried
          required: true
          example: '1'
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: ID of the AccessManager.
                  type:
                    example: 105
                    type: integer
                    description: Devicetype of the AccessManager.
                  is_active:
                    example: true
                    type: boolean
                    description: >-
                      True if the alarm evaluation and communication for this
                      device is activated
                  name:
                    example: AccessManager
                    type: string
                    description: Name of the AccessManager.
                  mac_adress:
                    example: 70:82:0e:10:81:3d
                    type: string
                    description: MAC address of the AccessManager
                  address:
                    example: 192.168.100.224
                    type: string
                    description: IP or DNS address of the AccessManager.
                  doorlocks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: ID of this DoorLock.
                        name:
                          example: Doorlock
                          type: string
                          description: Name of this DoorLock.
                        relais_action:
                          example: 0
                          type: integer
                          description: >-
                            Sets the output to be switched, when a booking
                            happened. 1=DO1, 2=DO2.
                  ios:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: ID of this IO.
                        device_id:
                          example: 1
                          type: integer
                          description: ID of the IO-Device.
                        type:
                          example: 301
                          type: integer
                          description: Devicetype of the IO.
                        number:
                          example: 1
                          type: integer
                          description: Number of the IO.
                        input_type:
                          example: default
                          type: string
                          description: Type of the Input.
                        group_id:
                          example: 5
                          type: integer
                          description: ID of the group.
                        sort_index:
                          example: null
                          type: integer
                          description: Not used.
                        name:
                          example: Digital Input 1
                          type: string
                          description: Name of the IO.
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Describes if the status of external contacts should
                            be ignored during arming. This is useful if e.g. a
                            magnetic door contact must be opened during the
                            arming phase.
                        alarmdelay:
                          example: 0
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        logic:
                          example: 0
                          type: integer
                          description: >-
                            Alarm logic of the IO. 0=Normally open, 1=Normally
                            closed.
                        assigned_to_id:
                          example: 0
                          type: integer
                          description: >-
                            Id of the AccessManager to which the IO device is
                            related
                        icon:
                          example: ethernet
                          type: string
                          enum:
                            - power-off
                            - times-circle
                            - plus-circle
                            - minus-circle
                            - cogs
                            - trash
                            - save
                            - ethernet
                            - chart-network
                            - network-wired
                            - sitemap
                            - server
                            - hdd
                            - router
                            - wifi
                            - signal
                            - sensor
                            - sensor-on
                            - sensor-alert
                            - thermometer-half
                            - lungs
                            - tint
                            - humidity
                            - dewpoint
                            - raindrops
                            - water
                            - air-conditioner
                            - braille
                            - fire
                            - fire-alt
                            - burn
                            - fire-smoke
                            - cloud
                            - sensor-fire
                            - lungs
                            - mask
                            - user-secret
                            - running
                            - hammer
                            - tools
                            - signal-stream
                            - house-damage
                            - key
                            - door-open
                            - door-closed
                            - garage
                            - cctv
                            - video
                            - fingerprint
                            - bolt
                            - plug
                            - lambda
                            - charging-station
                            - battery-full
                            - battery-empty
                            - car-battery
                          description: name of the selected icon
                        description_ok:
                          example: Ok
                          type: string
                          description: >-
                            This text will be showed if the IO device has no
                            errors
                        description_alert:
                          example: Error
                          type: string
                          description: This text will be showed if the IO device has errors
                        event_id:
                          example: 8
                          type: integer
                          description: >-
                            Describes the event that should be used. Must be an
                            Id of an existing event.
                        measurement:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                example: 1
                                type: integer
                                description: Measured value of the IO.
                              alarm:
                                example: false
                                type: boolean
                                description: Alarmstate of the IO.
                              connection_sabotage:
                                example: false
                                type: boolean
                                description: Sabotage alarm state of the IO.
                              sabotage_count:
                                example: 0
                                type: integer
                                description: Number of failed connection checks.
                              assigned_to_id:
                                example: 0
                                type: integer
                                description: >-
                                  Id of the IO to which the measurement is
                                  related
                  relais_action_arm:
                    example: none
                    type: string
                    enum:
                      - none
                      - channel1
                      - channel2
                      - backchannel1
                      - backchannel2
                      - backchannel_inevitability
                    description: >-
                      Configures if an external system should be switched on
                      bookings.
                  ext_arm_doorlocks:
                    example:
                      - 1
                      - 2
                      - 3
                    type: array
                    items:
                      type: integer
                    description: >-
                      List of all DoorLock IDs, which have been configured to
                      switch an external alarmsystem.
                  external:
                    type: object
                    properties:
                      channel1:
                        type: object
                        properties:
                          id:
                            example: 37
                            type: integer
                            description: Id of the channel.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          name:
                            example: Input 1
                            type: string
                            description: Name of the channel.
                          alarm_when:
                            example: open
                            type: string
                            enum:
                              - open
                              - close
                            description: Indicates when the channel should alarm.
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: Describes the input type of the channel.
                          alarmdelay:
                            example: 1
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >
                              Describes if the status of external contacts
                              should be ignored during arming.

                              This is useful if e.g. a magnetic door contact
                              must be opened during the arming phase.
                          icon:
                            example: ethernet
                            type: string
                            enum:
                              - power-off
                              - times-circle
                              - plus-circle
                              - minus-circle
                              - cogs
                              - trash
                              - save
                              - ethernet
                              - chart-network
                              - network-wired
                              - sitemap
                              - server
                              - hdd
                              - router
                              - wifi
                              - signal
                              - sensor
                              - sensor-on
                              - sensor-alert
                              - thermometer-half
                              - lungs
                              - tint
                              - humidity
                              - dewpoint
                              - raindrops
                              - water
                              - air-conditioner
                              - braille
                              - fire
                              - fire-alt
                              - burn
                              - fire-smoke
                              - cloud
                              - sensor-fire
                              - lungs
                              - mask
                              - user-secret
                              - running
                              - hammer
                              - tools
                              - signal-stream
                              - house-damage
                              - key
                              - door-open
                              - door-closed
                              - garage
                              - cctv
                              - video
                              - fingerprint
                              - bolt
                              - plug
                              - lambda
                              - charging-station
                              - battery-full
                              - battery-empty
                              - car-battery
                            description: Icon of the sensor.
                          description_ok:
                            example: OK
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has no
                              errors.
                          description_alert:
                            example: Alert
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has
                              errors.
                          group_id:
                            example: 2
                            type: integer
                            description: The ID of the group the device is assigned to.
                      channel2:
                        type: object
                        properties:
                          id:
                            example: 37
                            type: integer
                            description: Id of the channel.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          name:
                            example: Input 1
                            type: string
                            description: Name of the channel.
                          alarm_when:
                            example: open
                            type: string
                            enum:
                              - open
                              - close
                            description: Indicates when the channel should alarm.
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: Describes the input type of the channel.
                          alarmdelay:
                            example: 1
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >
                              Describes if the status of external contacts
                              should be ignored during arming.

                              This is useful if e.g. a magnetic door contact
                              must be opened during the arming phase.
                          icon:
                            example: ethernet
                            type: string
                            enum:
                              - power-off
                              - times-circle
                              - plus-circle
                              - minus-circle
                              - cogs
                              - trash
                              - save
                              - ethernet
                              - chart-network
                              - network-wired
                              - sitemap
                              - server
                              - hdd
                              - router
                              - wifi
                              - signal
                              - sensor
                              - sensor-on
                              - sensor-alert
                              - thermometer-half
                              - lungs
                              - tint
                              - humidity
                              - dewpoint
                              - raindrops
                              - water
                              - air-conditioner
                              - braille
                              - fire
                              - fire-alt
                              - burn
                              - fire-smoke
                              - cloud
                              - sensor-fire
                              - lungs
                              - mask
                              - user-secret
                              - running
                              - hammer
                              - tools
                              - signal-stream
                              - house-damage
                              - key
                              - door-open
                              - door-closed
                              - garage
                              - cctv
                              - video
                              - fingerprint
                              - bolt
                              - plug
                              - lambda
                              - charging-station
                              - battery-full
                              - battery-empty
                              - car-battery
                            description: Icon of the sensor.
                          description_ok:
                            example: OK
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has no
                              errors.
                          description_alert:
                            example: Alert
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has
                              errors.
                          group_id:
                            example: 2
                            type: integer
                            description: The ID of the group the device is assigned to.
                  group_id:
                    example: 89
                    type: integer
                    description: Id of the group the AccessManager beolongs to
                  rack_id:
                    example: 50
                    type: integer
                    description: Id of the rack the AccessManager belongs to
                  webhooks:
                    example:
                      - 1
                      - 2
                    type: array
                    items:
                      type: integer
                    description: Integer Array of the webhooks
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: >-
        Updates the configuration of a specific AccessManager. Validation errors
        are returned in the response body with HTTP 422.
      summary: Update the configuration of an AccessManager via the ID.
      tags:
        - accessmanager-accessmanager_id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: accessmanager_id
          in: path
          description: ID of the Accessmanager to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: AccessManager configuration to be updated.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 1
                  type: integer
                  description: ID of the AccessManager.
                type:
                  example: 105
                  type: integer
                  description: Devicetype of the AccessManager.
                is_active:
                  example: true
                  type: boolean
                  description: >-
                    True if the alarm evaluation and communication for this
                    device is activated
                name:
                  example: AccessManager
                  type: string
                  description: Name of the AccessManager.
                mac_adress:
                  example: 70:82:0e:10:81:3d
                  type: string
                  description: MAC address of the AccessManager
                address:
                  example: 192.168.100.224
                  type: string
                  description: IP or DNS address of the AccessManager.
                doorlocks:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        example: 1
                        type: integer
                        description: ID of this DoorLock.
                      name:
                        example: Doorlock
                        type: string
                        description: Name of this DoorLock.
                      relais_action:
                        example: 0
                        type: integer
                        description: >-
                          Sets the output to be switched, when a booking
                          happened. 1=DO1, 2=DO2.
                ios:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        example: 1
                        type: integer
                        description: ID of this IO.
                      device_id:
                        example: 1
                        type: integer
                        description: ID of the IO-Device.
                      type:
                        example: 301
                        type: integer
                        description: Devicetype of the IO.
                      number:
                        example: 1
                        type: integer
                        description: Number of the IO.
                      input_type:
                        example: default
                        type: string
                        description: Type of the Input.
                      group_id:
                        example: 5
                        type: integer
                        description: ID of the group.
                      sort_index:
                        example: null
                        type: integer
                        description: Not used.
                      name:
                        example: Digital Input 1
                        type: string
                        description: Name of the IO.
                      can_alwaysarm:
                        example: false
                        type: boolean
                        description: >-
                          Describes if the status of external contacts should be
                          ignored during arming. This is useful if e.g. a
                          magnetic door contact must be opened during the arming
                          phase.
                      alarmdelay:
                        example: 0
                        type: integer
                        description: Delay time after which an alarm is triggered.
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of this sensor
                      logic:
                        example: 0
                        type: integer
                        description: >-
                          Alarm logic of the IO. 0=Normally open, 1=Normally
                          closed.
                      assigned_to_id:
                        example: 0
                        type: integer
                        description: >-
                          Id of the AccessManager to which the IO device is
                          related
                      icon:
                        example: ethernet
                        type: string
                        enum:
                          - power-off
                          - times-circle
                          - plus-circle
                          - minus-circle
                          - cogs
                          - trash
                          - save
                          - ethernet
                          - chart-network
                          - network-wired
                          - sitemap
                          - server
                          - hdd
                          - router
                          - wifi
                          - signal
                          - sensor
                          - sensor-on
                          - sensor-alert
                          - thermometer-half
                          - lungs
                          - tint
                          - humidity
                          - dewpoint
                          - raindrops
                          - water
                          - air-conditioner
                          - braille
                          - fire
                          - fire-alt
                          - burn
                          - fire-smoke
                          - cloud
                          - sensor-fire
                          - lungs
                          - mask
                          - user-secret
                          - running
                          - hammer
                          - tools
                          - signal-stream
                          - house-damage
                          - key
                          - door-open
                          - door-closed
                          - garage
                          - cctv
                          - video
                          - fingerprint
                          - bolt
                          - plug
                          - lambda
                          - charging-station
                          - battery-full
                          - battery-empty
                          - car-battery
                        description: name of the selected icon
                      description_ok:
                        example: Ok
                        type: string
                        description: >-
                          This text will be showed if the IO device has no
                          errors
                      description_alert:
                        example: Error
                        type: string
                        description: This text will be showed if the IO device has errors
                      event_id:
                        example: 8
                        type: integer
                        description: >-
                          Describes the event that should be used. Must be an Id
                          of an existing event.
                      measurement:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              example: 1
                              type: integer
                              description: Measured value of the IO.
                            alarm:
                              example: false
                              type: boolean
                              description: Alarmstate of the IO.
                            connection_sabotage:
                              example: false
                              type: boolean
                              description: Sabotage alarm state of the IO.
                            sabotage_count:
                              example: 0
                              type: integer
                              description: Number of failed connection checks.
                            assigned_to_id:
                              example: 0
                              type: integer
                              description: Id of the IO to which the measurement is related
                relais_action_arm:
                  example: none
                  type: string
                  enum:
                    - none
                    - channel1
                    - channel2
                    - backchannel1
                    - backchannel2
                    - backchannel_inevitability
                  description: >-
                    Configures if an external system should be switched on
                    bookings.
                ext_arm_doorlocks:
                  example:
                    - 1
                    - 2
                    - 3
                  type: array
                  items:
                    type: integer
                  description: >-
                    List of all DoorLock IDs, which have been configured to
                    switch an external alarmsystem.
                external:
                  type: object
                  properties:
                    channel1:
                      type: object
                      properties:
                        id:
                          example: 37
                          type: integer
                          description: Id of the channel.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        name:
                          example: Input 1
                          type: string
                          description: Name of the channel.
                        alarm_when:
                          example: open
                          type: string
                          enum:
                            - open
                            - close
                          description: Indicates when the channel should alarm.
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: Describes the input type of the channel.
                        alarmdelay:
                          example: 1
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >
                            Describes if the status of external contacts should
                            be ignored during arming.

                            This is useful if e.g. a magnetic door contact must
                            be opened during the arming phase.
                        icon:
                          example: ethernet
                          type: string
                          enum:
                            - power-off
                            - times-circle
                            - plus-circle
                            - minus-circle
                            - cogs
                            - trash
                            - save
                            - ethernet
                            - chart-network
                            - network-wired
                            - sitemap
                            - server
                            - hdd
                            - router
                            - wifi
                            - signal
                            - sensor
                            - sensor-on
                            - sensor-alert
                            - thermometer-half
                            - lungs
                            - tint
                            - humidity
                            - dewpoint
                            - raindrops
                            - water
                            - air-conditioner
                            - braille
                            - fire
                            - fire-alt
                            - burn
                            - fire-smoke
                            - cloud
                            - sensor-fire
                            - lungs
                            - mask
                            - user-secret
                            - running
                            - hammer
                            - tools
                            - signal-stream
                            - house-damage
                            - key
                            - door-open
                            - door-closed
                            - garage
                            - cctv
                            - video
                            - fingerprint
                            - bolt
                            - plug
                            - lambda
                            - charging-station
                            - battery-full
                            - battery-empty
                            - car-battery
                          description: Icon of the sensor.
                        description_ok:
                          example: OK
                          type: string
                          nullable: true
                          description: >-
                            This text will be showed if the channel has no
                            errors.
                        description_alert:
                          example: Alert
                          type: string
                          nullable: true
                          description: This text will be showed if the channel has errors.
                        group_id:
                          example: 2
                          type: integer
                          description: The ID of the group the device is assigned to.
                    channel2:
                      type: object
                      properties:
                        id:
                          example: 37
                          type: integer
                          description: Id of the channel.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        name:
                          example: Input 1
                          type: string
                          description: Name of the channel.
                        alarm_when:
                          example: open
                          type: string
                          enum:
                            - open
                            - close
                          description: Indicates when the channel should alarm.
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: Describes the input type of the channel.
                        alarmdelay:
                          example: 1
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >
                            Describes if the status of external contacts should
                            be ignored during arming.

                            This is useful if e.g. a magnetic door contact must
                            be opened during the arming phase.
                        icon:
                          example: ethernet
                          type: string
                          enum:
                            - power-off
                            - times-circle
                            - plus-circle
                            - minus-circle
                            - cogs
                            - trash
                            - save
                            - ethernet
                            - chart-network
                            - network-wired
                            - sitemap
                            - server
                            - hdd
                            - router
                            - wifi
                            - signal
                            - sensor
                            - sensor-on
                            - sensor-alert
                            - thermometer-half
                            - lungs
                            - tint
                            - humidity
                            - dewpoint
                            - raindrops
                            - water
                            - air-conditioner
                            - braille
                            - fire
                            - fire-alt
                            - burn
                            - fire-smoke
                            - cloud
                            - sensor-fire
                            - lungs
                            - mask
                            - user-secret
                            - running
                            - hammer
                            - tools
                            - signal-stream
                            - house-damage
                            - key
                            - door-open
                            - door-closed
                            - garage
                            - cctv
                            - video
                            - fingerprint
                            - bolt
                            - plug
                            - lambda
                            - charging-station
                            - battery-full
                            - battery-empty
                            - car-battery
                          description: Icon of the sensor.
                        description_ok:
                          example: OK
                          type: string
                          nullable: true
                          description: >-
                            This text will be showed if the channel has no
                            errors.
                        description_alert:
                          example: Alert
                          type: string
                          nullable: true
                          description: This text will be showed if the channel has errors.
                        group_id:
                          example: 2
                          type: integer
                          description: The ID of the group the device is assigned to.
                group_id:
                  example: 89
                  type: integer
                  description: Id of the group the AccessManager beolongs to
                rack_id:
                  example: 50
                  type: integer
                  description: Id of the rack the AccessManager belongs to
                webhooks:
                  example:
                    - 1
                    - 2
                  type: array
                  items:
                    type: integer
                  description: Integer Array of the webhooks
                connection:
                  type: object
                  properties:
                    assignment:
                      example: 'off'
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of the connection
                    warning:
                      type: object
                      properties:
                        active:
                          type: boolean
                          example: true
                          description: >-
                            Configures whether connection issues should be
                            displayed as a warning instead of an alarm
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: ID of the AccessManager.
                    type:
                      example: 105
                      type: integer
                      description: Devicetype of the AccessManager.
                    is_active:
                      example: true
                      type: boolean
                      description: >-
                        True if the alarm evaluation and communication for this
                        device is activated
                    name:
                      example: AccessManager
                      type: string
                      description: Name of the AccessManager.
                    mac_adress:
                      example: 70:82:0e:10:81:3d
                      type: string
                      description: MAC address of the AccessManager
                    address:
                      example: 192.168.100.224
                      type: string
                      description: IP or DNS address of the AccessManager.
                    doorlocks:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            example: 1
                            type: integer
                            description: ID of this DoorLock.
                          name:
                            example: Doorlock
                            type: string
                            description: Name of this DoorLock.
                          relais_action:
                            example: 0
                            type: integer
                            description: >-
                              Sets the output to be switched, when a booking
                              happened. 1=DO1, 2=DO2.
                    ios:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            example: 1
                            type: integer
                            description: ID of this IO.
                          device_id:
                            example: 1
                            type: integer
                            description: ID of the IO-Device.
                          type:
                            example: 301
                            type: integer
                            description: Devicetype of the IO.
                          number:
                            example: 1
                            type: integer
                            description: Number of the IO.
                          input_type:
                            example: default
                            type: string
                            description: Type of the Input.
                          group_id:
                            example: 5
                            type: integer
                            description: ID of the group.
                          sort_index:
                            example: null
                            type: integer
                            description: Not used.
                          name:
                            example: Digital Input 1
                            type: string
                            description: Name of the IO.
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Describes if the status of external contacts
                              should be ignored during arming. This is useful if
                              e.g. a magnetic door contact must be opened during
                              the arming phase.
                          alarmdelay:
                            example: 0
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          logic:
                            example: 0
                            type: integer
                            description: >-
                              Alarm logic of the IO. 0=Normally open, 1=Normally
                              closed.
                          assigned_to_id:
                            example: 0
                            type: integer
                            description: >-
                              Id of the AccessManager to which the IO device is
                              related
                          icon:
                            example: ethernet
                            type: string
                            enum:
                              - power-off
                              - times-circle
                              - plus-circle
                              - minus-circle
                              - cogs
                              - trash
                              - save
                              - ethernet
                              - chart-network
                              - network-wired
                              - sitemap
                              - server
                              - hdd
                              - router
                              - wifi
                              - signal
                              - sensor
                              - sensor-on
                              - sensor-alert
                              - thermometer-half
                              - lungs
                              - tint
                              - humidity
                              - dewpoint
                              - raindrops
                              - water
                              - air-conditioner
                              - braille
                              - fire
                              - fire-alt
                              - burn
                              - fire-smoke
                              - cloud
                              - sensor-fire
                              - lungs
                              - mask
                              - user-secret
                              - running
                              - hammer
                              - tools
                              - signal-stream
                              - house-damage
                              - key
                              - door-open
                              - door-closed
                              - garage
                              - cctv
                              - video
                              - fingerprint
                              - bolt
                              - plug
                              - lambda
                              - charging-station
                              - battery-full
                              - battery-empty
                              - car-battery
                            description: name of the selected icon
                          description_ok:
                            example: Ok
                            type: string
                            description: >-
                              This text will be showed if the IO device has no
                              errors
                          description_alert:
                            example: Error
                            type: string
                            description: >-
                              This text will be showed if the IO device has
                              errors
                          event_id:
                            example: 8
                            type: integer
                            description: >-
                              Describes the event that should be used. Must be
                              an Id of an existing event.
                          measurement:
                            type: array
                            items:
                              type: object
                              properties:
                                value:
                                  example: 1
                                  type: integer
                                  description: Measured value of the IO.
                                alarm:
                                  example: false
                                  type: boolean
                                  description: Alarmstate of the IO.
                                connection_sabotage:
                                  example: false
                                  type: boolean
                                  description: Sabotage alarm state of the IO.
                                sabotage_count:
                                  example: 0
                                  type: integer
                                  description: Number of failed connection checks.
                                assigned_to_id:
                                  example: 0
                                  type: integer
                                  description: >-
                                    Id of the IO to which the measurement is
                                    related
                    relais_action_arm:
                      example: none
                      type: string
                      enum:
                        - none
                        - channel1
                        - channel2
                        - backchannel1
                        - backchannel2
                        - backchannel_inevitability
                      description: >-
                        Configures if an external system should be switched on
                        bookings.
                    ext_arm_doorlocks:
                      example:
                        - 1
                        - 2
                        - 3
                      type: array
                      items:
                        type: integer
                      description: >-
                        List of all DoorLock IDs, which have been configured to
                        switch an external alarmsystem.
                    external:
                      type: object
                      properties:
                        channel1:
                          type: object
                          properties:
                            id:
                              example: 37
                              type: integer
                              description: Id of the channel.
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            name:
                              example: Input 1
                              type: string
                              description: Name of the channel.
                            alarm_when:
                              example: open
                              type: string
                              enum:
                                - open
                                - close
                              description: Indicates when the channel should alarm.
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: Describes the input type of the channel.
                            alarmdelay:
                              example: 1
                              type: integer
                              description: Delay time after which an alarm is triggered.
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >
                                Describes if the status of external contacts
                                should be ignored during arming.

                                This is useful if e.g. a magnetic door contact
                                must be opened during the arming phase.
                            icon:
                              example: ethernet
                              type: string
                              enum:
                                - power-off
                                - times-circle
                                - plus-circle
                                - minus-circle
                                - cogs
                                - trash
                                - save
                                - ethernet
                                - chart-network
                                - network-wired
                                - sitemap
                                - server
                                - hdd
                                - router
                                - wifi
                                - signal
                                - sensor
                                - sensor-on
                                - sensor-alert
                                - thermometer-half
                                - lungs
                                - tint
                                - humidity
                                - dewpoint
                                - raindrops
                                - water
                                - air-conditioner
                                - braille
                                - fire
                                - fire-alt
                                - burn
                                - fire-smoke
                                - cloud
                                - sensor-fire
                                - lungs
                                - mask
                                - user-secret
                                - running
                                - hammer
                                - tools
                                - signal-stream
                                - house-damage
                                - key
                                - door-open
                                - door-closed
                                - garage
                                - cctv
                                - video
                                - fingerprint
                                - bolt
                                - plug
                                - lambda
                                - charging-station
                                - battery-full
                                - battery-empty
                                - car-battery
                              description: Icon of the sensor.
                            description_ok:
                              example: OK
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has no
                                errors.
                            description_alert:
                              example: Alert
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has
                                errors.
                            group_id:
                              example: 2
                              type: integer
                              description: The ID of the group the device is assigned to.
                        channel2:
                          type: object
                          properties:
                            id:
                              example: 37
                              type: integer
                              description: Id of the channel.
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            name:
                              example: Input 1
                              type: string
                              description: Name of the channel.
                            alarm_when:
                              example: open
                              type: string
                              enum:
                                - open
                                - close
                              description: Indicates when the channel should alarm.
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: Describes the input type of the channel.
                            alarmdelay:
                              example: 1
                              type: integer
                              description: Delay time after which an alarm is triggered.
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >
                                Describes if the status of external contacts
                                should be ignored during arming.

                                This is useful if e.g. a magnetic door contact
                                must be opened during the arming phase.
                            icon:
                              example: ethernet
                              type: string
                              enum:
                                - power-off
                                - times-circle
                                - plus-circle
                                - minus-circle
                                - cogs
                                - trash
                                - save
                                - ethernet
                                - chart-network
                                - network-wired
                                - sitemap
                                - server
                                - hdd
                                - router
                                - wifi
                                - signal
                                - sensor
                                - sensor-on
                                - sensor-alert
                                - thermometer-half
                                - lungs
                                - tint
                                - humidity
                                - dewpoint
                                - raindrops
                                - water
                                - air-conditioner
                                - braille
                                - fire
                                - fire-alt
                                - burn
                                - fire-smoke
                                - cloud
                                - sensor-fire
                                - lungs
                                - mask
                                - user-secret
                                - running
                                - hammer
                                - tools
                                - signal-stream
                                - house-damage
                                - key
                                - door-open
                                - door-closed
                                - garage
                                - cctv
                                - video
                                - fingerprint
                                - bolt
                                - plug
                                - lambda
                                - charging-station
                                - battery-full
                                - battery-empty
                                - car-battery
                              description: Icon of the sensor.
                            description_ok:
                              example: OK
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has no
                                errors.
                            description_alert:
                              example: Alert
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has
                                errors.
                            group_id:
                              example: 2
                              type: integer
                              description: The ID of the group the device is assigned to.
                    group_id:
                      example: 89
                      type: integer
                      description: Id of the group the AccessManager beolongs to
                    rack_id:
                      example: 50
                      type: integer
                      description: Id of the rack the AccessManager belongs to
                    webhooks:
                      example:
                        - 1
                        - 2
                      type: array
                      items:
                        type: integer
                      description: Integer Array of the webhooks
                    connection:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of the connection
                        warning:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: true
                              description: >-
                                Configures whether connection issues should be
                                displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/log/alarm:
    get:
      tags:
        - alarm-event
      description: Get a list of Alarm-Events.
      summary: Get Alarm-Events
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: id
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: >-
            Filters on the event with the given ID and its sub events (if not
            disabled by the subevents-parameter).
        - name: search
          in: query
          required: false
          schema:
            type: string
          example: Fire
          description: >-
            Searches for occurences of the given string within the columns
            "user", "function" and "detail".
        - name: subevents
          in: query
          required: false
          schema:
            type: integer
          example: 0
          description: >-
            If set to 0, only the main events will be returned and the subevents
            will be omitted.
        - name: filtertype
          in: query
          required: false
          schema:
            type: integer
          example: 2000
          description: |-
            Applies the given alarm type filter to the request.<br /> <table>
                <thead><td>Filter Code</td><td>Description</td></thead>
                <tr><td>2000</td><td>Pending alarms</td></tr>
                <tr><td>1</td><td>Temperature</td></tr>
                <tr><td>2</td><td>Humidity</td></tr>
                <tr><td>3</td><td>Dewpoint</td></tr>
                <tr><td>4</td><td>Fire</td></tr>
                <tr><td>5</td><td>Intrusion</td></tr>
                <tr><td>6</td><td>Vibration</td></tr>
                <tr><td>7</td><td>Latency</td></tr>
                <tr><td>8</td><td>Network service</td></tr>
                <tr><td>51</td><td>Sabotage/Tampering</td></tr>
                <tr><td>52</td><td>Connection loss</td></tr>
                <tr><td>101</td><td>Digital inputs</td></tr>
            </table>
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Sorts the results by the given column. By adding a pipe "|" and
            "acs" or "desc" after the column name, the sorting will be ascending
            or descending.
          example: created_at|asc
        - name: start_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-01-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the start date. Please be sure to use the correct timezone.
        - name: stop_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-02-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the end date. Please be sure to use the correct timezone.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
          example: 25
          description: >-
            Sets the number of datasets provided per page. Note: It is not
            advised to set this value above 100, as this may cause performance
            issues.
        - name: page
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Requests the given page.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      description: The data of an access-event
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: The ID of the event
                        created_at:
                          example: '2022-11-28T16:09:25+01:00'
                          type: string
                          description: The created timestamp
                        function:
                          example: Alarm
                          type: string
                          description: The type of event
                        user:
                          example: Mustermann
                          type: string
                          description: The name of the user that triggered the event
                        detail:
                          example: No permission
                          type: string
                          description: The detailed description of the event
                        has_images:
                          example: false
                          type: boolean
                          description: Flags if images are included in the event
                        status:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 5
                            - 10
                            - 11
                            - 12
                            - 13
                            - 14
                            - 15
                            - 16
                          description: The status of the event
                        filter_type:
                          example: 23
                          type: integer
                          description: Kentix internal type. Please disregard
                        device:
                          type: array
                          items:
                            type: object
                            properties:
                              address:
                                example: 192.168.0.1
                                type: string
                                format: IPv4
                                description: The address of the device
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: AlarmManager
                                type: string
                                description: The name of the device
                              type:
                                example: 101
                                type: integer
                                description: The type of the device
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              uuid:
                                example: 943dc5e6-155b-4aaa-89e3-5d31cd3a6f37
                                type: string
                                description: The UUID of the device
                        subevents:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                example: 6
                                type: integer
                                description: The ID of the event
                              created_at:
                                example: '2022-11-28T16:09:25+01:00'
                                type: string
                                description: The created timestamp
                              function:
                                example: Alarm
                                type: string
                                description: The type of event
                              user:
                                example: Mustermann
                                type: string
                                description: The name of the user that triggered the event
                              detail:
                                example: No permission
                                type: string
                                description: The detailed description of the event
                              has_images:
                                example: false
                                type: boolean
                                description: Flags if images are included in the event
                              filter_type:
                                example: 23
                                type: integer
                                description: Kentix internal type. Please disregard
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/log/alarm/export:
    get:
      tags:
        - alarm-event-export
      description: Export all Alarm-Events.
      summary: Export Alarm-Events
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: id
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: >-
            Filters on the event with the given ID and its sub events (if not
            disabled by the subevents-parameter).
        - name: search
          in: query
          required: false
          schema:
            type: string
          example: Fire
          description: >-
            Searches for occurences of the given string within the columns
            "user", "function" and "detail".
        - name: subevents
          in: query
          required: false
          schema:
            type: integer
          example: 0
          description: >-
            If set to 0, only the main events will be returned and the subevents
            will be omitted.
        - name: filtertype
          in: query
          required: false
          schema:
            type: integer
          example: 2000
          description: |-
            Applies the given alarm type filter to the request.<br /> <table>
                <thead><td>Filter Code</td><td>Description</td></thead>
                <tr><td>2000</td><td>Pending alarms</td></tr>
                <tr><td>1</td><td>Temperature</td></tr>
                <tr><td>2</td><td>Humidity</td></tr>
                <tr><td>3</td><td>Dewpoint</td></tr>
                <tr><td>4</td><td>Fire</td></tr>
                <tr><td>5</td><td>Intrusion</td></tr>
                <tr><td>6</td><td>Vibration</td></tr>
                <tr><td>7</td><td>Latency</td></tr>
                <tr><td>8</td><td>Network service</td></tr>
                <tr><td>51</td><td>Sabotage/Tampering</td></tr>
                <tr><td>52</td><td>Connection loss</td></tr>
                <tr><td>101</td><td>Digital inputs</td></tr>
            </table>
        - name: sort
          in: query
          required: false
          schema:
            type: string
          description: >-
            Sorts the results by the given column. By adding a pipe "|" and
            "acs" or "desc" after the column name, the sorting will be ascending
            or descending.
          example: created_at|asc
        - name: start_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-01-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the start date. Please be sure to use the correct timezone.
        - name: stop_at
          in: query
          required: false
          schema:
            type: string
            format: date-time
          example: '2025-02-01T00:00:00.000Z'
          description: >-
            Takes the given date-time string (ISO-8601, YYYY-MM-DDTHH:mm:ssZ)
            and sets the end date. Please be sure to use the correct timezone.
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
          example: 25
          description: >-
            Sets the number of datasets provided per page. Note: It is not
            advised to set this value above 100, as this may cause performance
            issues.
        - name: page
          in: query
          required: false
          schema:
            type: integer
          example: 1
          description: Requests the given page.
      responses:
        '200':
          description: Successful operation
          content:
            text/csv:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/log/alarm/{alarm_event}/images:
    get:
      tags:
        - alarm-event-images
      description: Get a list of Alarm-Events.
      summary: Get Alarm-Events
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarm_event
          in: path
          description: Alarm-Event ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: string
                      format: base64
                      description: The data of the image
                    name:
                      example: 000.jpg
                      type: string
                      description: The name of the image
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmgroups:
    get:
      description: Get all alarmgroups.
      summary: Get alarmgroups
      tags:
        - alarmgroups
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 2
                          type: integer
                          description: Id of the alarmgroup.
                        name:
                          example: Kentix HQ
                          type: string
                          description: Name of the alarmgroup.
                        sort_index:
                          example: 1
                          type: integer
                          description: Describes the sorting order.
                        group_id:
                          example: 1
                          type: integer
                          nullable: true
                          description: >-
                            Indicates the parent alarm group. Null if the
                            alarmgroup has no parent group
                        created_at:
                          example: '2023-01-05T16:24:46.000000Z'
                          type: string
                          format: ISO 8601
                          description: ISO 8601 when the alarmgroup was created.
                        updated_at:
                          example: '2023-01-05T16:47:27.000000Z'
                          type: string
                          format: ISO 8601
                          description: ISO 8601 when the alarmgroup was updated.
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      description: Add a new alarmgroup.
      summary: Add alarmgroup
      tags:
        - alarmgroups
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 1
                  type: integer
                  readOnly: true
                  description: Id of the alarmgroup.
                created_at:
                  example: '2023-01-07T18:08:44.000000Z'
                  type: string
                  format: ISO 8601
                  readOnly: true
                  description: Indicates when the alarmgroup was created.
                updated_at:
                  example: '2023-01-07T18:08:44.000000Z'
                  type: string
                  format: ISO 8601
                  readOnly: true
                  description: Indicates when the alarmgroup was updated.
                name:
                  example: Kentix HQ
                  type: string
                  description: Describes the name of the alarmgroup.
                group_id:
                  example: 1
                  type: integer
                  description: >-
                    Indicates the parent alarm group. Must be an Id of an
                    existing group.
                sort_index:
                  example: 1
                  type: integer
                  readOnly: true
                  description: Describes the sorting order.
                in_stealthmode:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the internal status LED of all devices in this
                    alarmgroup should be activated.
                signaling_group:
                  example: 1
                  type: integer
                  nullable: true
                  description: >-
                    Describes the range in which a signaling is triggered, if an
                    alarm occurs within this alarmgroup. Must be an Id of an
                    parent group.
                maintenance:
                  example: inactive
                  type: string
                  enum:
                    - active
                    - inactive
                  description: Describes if the alarmgroup is in maintenance mode.
                maintenance_start:
                  example: '2023-02-17T01:00:00.000Z'
                  type: string
                  format: ISO 8601
                  nullable: true
                  description: >-
                    Describes when the alarmgroup automatically switches to
                    maintenance mode.
                maintenance_stop:
                  example: '2023-02-17T23:59:00.000Z'
                  type: string
                  format: ISO 8601
                  nullable: true
                  description: >-
                    Describes until when the alarmgroup remains in maintenance
                    mode.
                inherit_notification:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the notification settings should be inherited
                    from the parent group.
                is_alarmrepetition_active:
                  example: false
                  type: boolean
                  description: >-
                    Describes if active alarms should be repeated by it's
                    configured interval. Acknowledgment of the alarm stops the
                    repetition.
                alarmrepetition_interval:
                  example: 1
                  type: integer
                  minimum: 1
                  maximum: 999
                  description: >-
                    Describes how alarms are sent to all users configured for
                    alarms, depending on the configured time and repetitions.
                alarmrepetition_count:
                  example: 0
                  type: integer
                  minimum: 0
                  maximum: 100
                  description: >-
                    Describes the number of alarm repetitions with the interval
                    of the configured time.
                send_quitable_notifications:
                  example: false
                  type: boolean
                  description: >-
                    Describes if a notification should be sent as soon as an
                    alarm is quitable.
                limit_notifications_always:
                  example: true
                  type: boolean
                  description: >-
                    Limits the always-active notifications per hour. Manual
                    acknowledgement resets the counter, repeated alarms do not
                    count.
                notification_count_always_alarm:
                  example: 1
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Describes the limit of always-active alarm notifications. 0
                    deactivates the notifications. Only required if
                    limit_notifications_always is true.
                notification_count_always_warning:
                  example: false
                  type: boolean
                  nullable: true
                  description: >-
                    Notify in case of always-active warnings. Only required if
                    limit_notifications_always is true.
                limit_notifications_armed:
                  example: true
                  type: boolean
                  description: >-
                    Limits the armed-active notifications per hour. Manual
                    acknowledgement resets the counter, repeated alarms do not
                    count.
                notification_count_armed_alarm:
                  example: 1
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Describes the limit of armed-active alarm notifications. 0
                    deactivates the notifications. Only required if
                    limit_notifications_armed is true.
                notification_count_armed_warning:
                  example: false
                  type: boolean
                  nullable: true
                  description: >-
                    Notify in case of armed-active warnings. Only required if
                    limit_notifications_armed is true.
                limit_notifications_fire:
                  example: false
                  type: boolean
                  description: >-
                    Limits the fire notifications per hour. Manual
                    acknowledgement resets the counter, repeated alarms do not
                    count.
                notification_count_fire_alarm:
                  example: 0
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Describes the limit of fire alarm notifications. 0
                    deactivates the notifications. Only required if
                    limit_notifications_fire is true.
                notification_count_fire_warning:
                  example: false
                  type: boolean
                  nullable: true
                  description: >-
                    Notify in case of fire warnings. Only required if
                    limit_notifications_fire is true.
                limit_notifications_sabotage:
                  example: false
                  type: boolean
                  description: >-
                    Limits the sabotage notifications per hour. Manual
                    acknowledgement resets the counter, repeated alarms do not
                    count.
                notification_count_sabotage_alarm:
                  example: 0
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Describes the limit of sabotage alarm notifications. 0
                    deactivates the notifications. Only required if
                    limit_notifications_sabotage is true.
                notification_count_sabotage_warning:
                  example: false
                  type: boolean
                  nullable: true
                  description: >-
                    Notify in case of sabotage warnings. Only required if
                    limit_notifications_sabotage is true.
                limit_notifications_system:
                  example: false
                  type: boolean
                  description: >-
                    Limits the system notifications per hour. Manual
                    acknowledgement resets the counter, repeated alarms do not
                    count.
                notification_count_system_alarm:
                  example: 0
                  type: integer
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  description: >-
                    Describes the limit of system alarm notifications. 0
                    deactivates the notifications. Only required if
                    limit_notifications_system is true.
                notification_count_system_warning:
                  example: false
                  type: boolean
                  nullable: true
                  description: >-
                    Notify in case of system warnings. Only required if
                    limit_notifications_system is true.
                inherit_arm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the arm settings should be inherited from the
                    parent group.
                arm_delay:
                  example: 0
                  type: integer
                  enum:
                    - 0
                    - 10
                    - 30
                    - 60
                    - 120
                    - 180
                    - 240
                    - 300
                    - 600
                    - 1200
                    - 1800
                    - 3600
                  description: >-
                    Describes the arm delay. Only required if inherit_arm is
                    false.
                buzzer_arm_duration:
                  example: 0
                  type: integer
                  enum:
                    - 0
                    - 1
                    - 3
                    - 10
                    - 30
                    - 60
                    - 120
                    - 180
                    - 300
                    - 600
                    - 1200
                    - 1800
                    - 3600
                  description: >-
                    Describes the arm buzzer duration. Only required if
                    inherit_arm is false.
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the status of external contacts should be
                    ignored during arming. This is useful if e.g. a magnetic
                    door contact must be opened during the arming phase.
                inherit_autoquit:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the autoquit settings should be inherited from
                    the parent group.
                can_autoquit_always_alarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if always-active alarms should be automatically
                    acknowledged after the given interval. Only required if
                    inherit_autoquit is false.
                can_autoquit_armed_alarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if armed-active alarms should be automatically
                    acknowledged after the given interval. Only required if
                    inherit_autoquit is false.
                can_autoquit_fire_alarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if fire alarms should be automatically
                    acknowledged after the given interval. Only required if
                    inherit_autoquit is false.
                can_autoquit_sabotage_alarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if sabotage alarms should be automatically
                    acknowledged after the given interval. Only required if
                    inherit_autoquit is false.
                can_autoquit_system_notification_alarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if system alarms should be automatically
                    acknowledged after the given interval. Only required if
                    inherit_autoquit is false.
                autoquit_duration:
                  example: 0
                  type: integer
                  enum:
                    - 0
                    - 30
                    - 60
                    - 180
                    - 600
                    - 1800
                  description: >-
                    Describes the time after which automatic quitting is
                    executed. Only required if inherit_autoquit is false.
                inherit_alarm:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the alarm settings should be inherited from the
                    parent group.
                has_prealarm:
                  example: false
                  type: boolean
                  description: Describes if the Prealarm is en-/disabled.
                buzzer_alwaysalarm_duration:
                  example: 0
                  type: integer
                  enum:
                    - -1
                    - 0
                    - 1
                    - 3
                    - 10
                    - 30
                    - 60
                    - 120
                    - 180
                    - 300
                    - 600
                    - 1200
                    - 1800
                    - 3600
                  description: >-
                    Describes the buzzer length for always-active alarms (-1
                    stands for permanent). Only required if inherit_alarm is
                    false.
                buzzer_armedalarm_duration:
                  example: 0
                  type: integer
                  enum:
                    - -1
                    - 0
                    - 1
                    - 3
                    - 10
                    - 30
                    - 60
                    - 120
                    - 180
                    - 300
                    - 600
                    - 1200
                    - 1800
                    - 3600
                  description: >-
                    Describes the buzzer length for armed-active alarms (-1
                    stands for permanent). Only required if inherit_alarm is
                    false.
                buzzer_firealarm_duration:
                  example: 0
                  type: integer
                  enum:
                    - -1
                    - 0
                    - 1
                    - 3
                    - 10
                    - 30
                    - 60
                    - 120
                    - 180
                    - 300
                    - 600
                    - 1200
                    - 1800
                    - 3600
                  description: >-
                    Describes the buzzer length for fire alarms (-1 stands for
                    permanent). Only required if inherit_alarm is false.
                buzzer_sabotagealarm_duration:
                  example: 0
                  type: integer
                  enum:
                    - -1
                    - 0
                    - 1
                    - 3
                    - 10
                    - 30
                    - 60
                    - 120
                    - 180
                    - 300
                    - 600
                    - 1200
                    - 1800
                    - 3600
                  description: >-
                    Describes the buzzer length for sabotage alarms (-1 stands
                    for permanent). Only required if inherit_alarm is false.
                inherit_sabotagesignal:
                  example: false
                  type: boolean
                  description: >-
                    Describes if the signaling sabotage settings should be
                    inherited from the parent group.
                sabotage_powerdevice_duration:
                  example: 300
                  type: integer
                  enum:
                    - 300
                    - 600
                    - 900
                    - 1200
                    - 1500
                    - 1800
                    - 2100
                    - 2400
                    - 2700
                    - 3000
                    - 3300
                    - 3600
                  description: >-
                    Describes how long a plugged device should wait, until it
                    fires a tampering alarm. Only required if
                    inherit_sabotagesignal is false.
                sabotage_batterydevice_duration:
                  example: 900
                  type: integer
                  enum:
                    - 900
                    - 1200
                    - 1500
                    - 1800
                    - 2100
                    - 2400
                    - 2700
                    - 3000
                    - 3300
                    - 3600
                  description: >-
                    Describes how long a battery device should wait, until it
                    fires a tampering alarm. Only required if
                    inherit_sabotagesignal is false.
                sabotage_service_duration:
                  example: 600
                  type: integer
                  enum:
                    - 600
                    - 900
                    - 1200
                    - 1500
                    - 1800
                    - 2100
                    - 2400
                    - 2700
                    - 3000
                    - 3300
                    - 3600
                  description: >-
                    Describes how long a service should wait, until it fires a
                    tampering alarm. Only required if inherit_sabotagesignal is
                    false.
                event_id:
                  example: 0
                  type: integer
                  nullable: true
                  description: >-
                    Describes the event that should be used. Must be an Id of an
                    existing event.
                webhooks:
                  type: array
                  description: >-
                    Describes the webhooks that should be fired when an event
                    happens
                  items:
                    type: object
                    properties:
                      id:
                        example: 0
                        type: integer
                        description: Must be an Id of an existing webhook.
                      event:
                        example: 0
                        type: integer
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                          - 51
                        description: Must be an Id of an existing webhook event type.
                      cycle_time:
                        example: 5
                        type: integer
                        nullable: true
                        enum:
                          - 5
                          - 10
                          - 15
                          - 30
                        description: >-
                          Describes how often the webhook should be executed.
                          Only required if event is 51.
                      trigger_on_alarm:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          an alarm.
                      trigger_on_warning:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          a warning.
                assigned_doorlock:
                  example: 3
                  type: integer
                  nullable: true
                  description: The ID of the doorlock directly assigned to the alarmgroup.
                activepower:
                  type: object
                  properties:
                    supply_a:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                    supply_b:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                apparentpower:
                  type: object
                  properties:
                    supply_a:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                    supply_b:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                consumption:
                  type: object
                  properties:
                    supply_a:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                    supply_b:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                arm_if_empty:
                  type: boolean
                  example: false
                  description: >-
                    Requires Anti-Passback functionality, therefore KentixONE
                    plan "Large" and all it's entrances configured as passages.
                    If this alarmgroup is considered empty, i.e. no user is
                    currently booked in through a passage, it will automatically
                    be armed.
                external_alarmsystem:
                  type: object
                  description: >-
                    Settings for assigning this alarmgroup to an external
                    alarmsystem.
                  properties:
                    device_id:
                      type: integer
                      example: 1
                      description: >-
                        ID of the device whose inputs and outputs shall be used
                        for the external alarmsystem
                      nullable: true
                    channel_returnchannel:
                      type: integer
                      example: 1
                      description: >-
                        Channel number of the external input on which the
                        external alarmsystem will signal its arming state.
                      nullable: true
                    channel_armready:
                      type: integer
                      example: 2
                      description: >-
                        Channel number of the external input on which the
                        external alarmsystem will signal wether it can be armed
                        or not. Not every alarmsystem does support this feature.
                      nullable: true
                    channel_armsignal:
                      type: integer
                      example: 1
                      description: >-
                        Channel number of the digital output on which the Kentix
                        device will send an arm command to the external
                        alarmsystem.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Id of the alarmgroup.
                  created_at:
                    example: '2023-01-07T18:08:44.000000Z'
                    type: string
                    format: ISO 8601
                    readOnly: true
                    description: Indicates when the alarmgroup was created.
                  updated_at:
                    example: '2023-01-07T18:08:44.000000Z'
                    type: string
                    format: ISO 8601
                    readOnly: true
                    description: Indicates when the alarmgroup was updated.
                  name:
                    example: Kentix HQ
                    type: string
                    description: Describes the name of the alarmgroup.
                  group_id:
                    example: 1
                    type: integer
                    description: >-
                      Indicates the parent alarm group. Must be an Id of an
                      existing group.
                  sort_index:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Describes the sorting order.
                  in_stealthmode:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the internal status LED of all devices in
                      this alarmgroup should be activated.
                  signaling_group:
                    example: 1
                    type: integer
                    nullable: true
                    description: >-
                      Describes the range in which a signaling is triggered, if
                      an alarm occurs within this alarmgroup. Must be an Id of
                      an parent group.
                  maintenance:
                    example: inactive
                    type: string
                    enum:
                      - active
                      - inactive
                    description: Describes if the alarmgroup is in maintenance mode.
                  maintenance_start:
                    example: '2023-02-17T01:00:00.000Z'
                    type: string
                    format: ISO 8601
                    nullable: true
                    description: >-
                      Describes when the alarmgroup automatically switches to
                      maintenance mode.
                  maintenance_stop:
                    example: '2023-02-17T23:59:00.000Z'
                    type: string
                    format: ISO 8601
                    nullable: true
                    description: >-
                      Describes until when the alarmgroup remains in maintenance
                      mode.
                  inherit_notification:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the notification settings should be inherited
                      from the parent group.
                  is_alarmrepetition_active:
                    example: false
                    type: boolean
                    description: >-
                      Describes if active alarms should be repeated by it's
                      configured interval. Acknowledgment of the alarm stops the
                      repetition.
                  alarmrepetition_interval:
                    example: 1
                    type: integer
                    minimum: 1
                    maximum: 999
                    description: >-
                      Describes how alarms are sent to all users configured for
                      alarms, depending on the configured time and repetitions.
                  alarmrepetition_count:
                    example: 0
                    type: integer
                    minimum: 0
                    maximum: 100
                    description: >-
                      Describes the number of alarm repetitions with the
                      interval of the configured time.
                  send_quitable_notifications:
                    example: false
                    type: boolean
                    description: >-
                      Describes if a notification should be sent as soon as an
                      alarm is quitable.
                  limit_notifications_always:
                    example: true
                    type: boolean
                    description: >-
                      Limits the always-active notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_always_alarm:
                    example: 1
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of always-active alarm notifications.
                      0 deactivates the notifications. Only required if
                      limit_notifications_always is true.
                  notification_count_always_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of always-active warnings. Only required if
                      limit_notifications_always is true.
                  limit_notifications_armed:
                    example: true
                    type: boolean
                    description: >-
                      Limits the armed-active notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_armed_alarm:
                    example: 1
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of armed-active alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_armed is true.
                  notification_count_armed_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of armed-active warnings. Only required if
                      limit_notifications_armed is true.
                  limit_notifications_fire:
                    example: false
                    type: boolean
                    description: >-
                      Limits the fire notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_fire_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of fire alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_fire is true.
                  notification_count_fire_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of fire warnings. Only required if
                      limit_notifications_fire is true.
                  limit_notifications_sabotage:
                    example: false
                    type: boolean
                    description: >-
                      Limits the sabotage notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_sabotage_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of sabotage alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_sabotage is true.
                  notification_count_sabotage_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of sabotage warnings. Only required if
                      limit_notifications_sabotage is true.
                  limit_notifications_system:
                    example: false
                    type: boolean
                    description: >-
                      Limits the system notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_system_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of system alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_system is true.
                  notification_count_system_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of system warnings. Only required if
                      limit_notifications_system is true.
                  inherit_arm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the arm settings should be inherited from the
                      parent group.
                  arm_delay:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 240
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the arm delay. Only required if inherit_arm is
                      false.
                  buzzer_arm_duration:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the arm buzzer duration. Only required if
                      inherit_arm is false.
                  can_alwaysarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the status of external contacts should be
                      ignored during arming. This is useful if e.g. a magnetic
                      door contact must be opened during the arming phase.
                  inherit_autoquit:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the autoquit settings should be inherited
                      from the parent group.
                  can_autoquit_always_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if always-active alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_armed_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if armed-active alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_fire_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if fire alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_sabotage_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if sabotage alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_system_notification_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if system alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  autoquit_duration:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 30
                      - 60
                      - 180
                      - 600
                      - 1800
                    description: >-
                      Describes the time after which automatic quitting is
                      executed. Only required if inherit_autoquit is false.
                  inherit_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the alarm settings should be inherited from
                      the parent group.
                  has_prealarm:
                    example: false
                    type: boolean
                    description: Describes if the Prealarm is en-/disabled.
                  buzzer_alwaysalarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for always-active alarms (-1
                      stands for permanent). Only required if inherit_alarm is
                      false.
                  buzzer_armedalarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for armed-active alarms (-1
                      stands for permanent). Only required if inherit_alarm is
                      false.
                  buzzer_firealarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for fire alarms (-1 stands for
                      permanent). Only required if inherit_alarm is false.
                  buzzer_sabotagealarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for sabotage alarms (-1 stands
                      for permanent). Only required if inherit_alarm is false.
                  inherit_sabotagesignal:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the signaling sabotage settings should be
                      inherited from the parent group.
                  sabotage_powerdevice_duration:
                    example: 300
                    type: integer
                    enum:
                      - 300
                      - 600
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a plugged device should wait, until it
                      fires a tampering alarm. Only required if
                      inherit_sabotagesignal is false.
                  sabotage_batterydevice_duration:
                    example: 900
                    type: integer
                    enum:
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a battery device should wait, until it
                      fires a tampering alarm. Only required if
                      inherit_sabotagesignal is false.
                  sabotage_service_duration:
                    example: 600
                    type: integer
                    enum:
                      - 600
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a service should wait, until it fires a
                      tampering alarm. Only required if inherit_sabotagesignal
                      is false.
                  event_id:
                    example: 0
                    type: integer
                    nullable: true
                    description: >-
                      Describes the event that should be used. Must be an Id of
                      an existing event.
                  webhooks:
                    type: array
                    description: >-
                      Describes the webhooks that should be fired when an event
                      happens
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  assigned_doorlock:
                    example: 3
                    type: integer
                    nullable: true
                    description: >-
                      The ID of the doorlock directly assigned to the
                      alarmgroup.
                  activepower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  apparentpower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  consumption:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  arm_if_empty:
                    type: boolean
                    example: false
                    description: >-
                      Requires Anti-Passback functionality, therefore KentixONE
                      plan "Large" and all it's entrances configured as
                      passages. If this alarmgroup is considered empty, i.e. no
                      user is currently booked in through a passage, it will
                      automatically be armed.
                  external_alarmsystem:
                    type: object
                    description: >-
                      Settings for assigning this alarmgroup to an external
                      alarmsystem.
                    properties:
                      device_id:
                        type: integer
                        example: 1
                        description: >-
                          ID of the device whose inputs and outputs shall be
                          used for the external alarmsystem
                        nullable: true
                      channel_returnchannel:
                        type: integer
                        example: 1
                        description: >-
                          Channel number of the external input on which the
                          external alarmsystem will signal its arming state.
                        nullable: true
                      channel_armready:
                        type: integer
                        example: 2
                        description: >-
                          Channel number of the external input on which the
                          external alarmsystem will signal wether it can be
                          armed or not. Not every alarmsystem does support this
                          feature.
                        nullable: true
                      channel_armsignal:
                        type: integer
                        example: 1
                        description: >-
                          Channel number of the digital output on which the
                          Kentix device will send an arm command to the external
                          alarmsystem.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}:
    get:
      description: Get a specific alarmgroup via its ID.
      summary: Get alarmgroup
      tags:
        - alarmgroup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgroup to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Id of the alarmgroup.
                  created_at:
                    example: '2023-01-07T18:08:44.000000Z'
                    type: string
                    format: ISO 8601
                    readOnly: true
                    description: Indicates when the alarmgroup was created.
                  updated_at:
                    example: '2023-01-07T18:08:44.000000Z'
                    type: string
                    format: ISO 8601
                    readOnly: true
                    description: Indicates when the alarmgroup was updated.
                  name:
                    example: Kentix HQ
                    type: string
                    description: Describes the name of the alarmgroup.
                  group_id:
                    example: 1
                    type: integer
                    description: >-
                      Indicates the parent alarm group. Must be an Id of an
                      existing group.
                  sort_index:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Describes the sorting order.
                  in_stealthmode:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the internal status LED of all devices in
                      this alarmgroup should be activated.
                  signaling_group:
                    example: 1
                    type: integer
                    nullable: true
                    description: >-
                      Describes the range in which a signaling is triggered, if
                      an alarm occurs within this alarmgroup. Must be an Id of
                      an parent group.
                  maintenance:
                    example: inactive
                    type: string
                    enum:
                      - active
                      - inactive
                    description: Describes if the alarmgroup is in maintenance mode.
                  maintenance_start:
                    example: '2023-02-17T01:00:00.000Z'
                    type: string
                    format: ISO 8601
                    nullable: true
                    description: >-
                      Describes when the alarmgroup automatically switches to
                      maintenance mode.
                  maintenance_stop:
                    example: '2023-02-17T23:59:00.000Z'
                    type: string
                    format: ISO 8601
                    nullable: true
                    description: >-
                      Describes until when the alarmgroup remains in maintenance
                      mode.
                  inherit_notification:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the notification settings should be inherited
                      from the parent group.
                  is_alarmrepetition_active:
                    example: false
                    type: boolean
                    description: >-
                      Describes if active alarms should be repeated by it's
                      configured interval. Acknowledgment of the alarm stops the
                      repetition.
                  alarmrepetition_interval:
                    example: 1
                    type: integer
                    minimum: 1
                    maximum: 999
                    description: >-
                      Describes how alarms are sent to all users configured for
                      alarms, depending on the configured time and repetitions.
                  alarmrepetition_count:
                    example: 0
                    type: integer
                    minimum: 0
                    maximum: 100
                    description: >-
                      Describes the number of alarm repetitions with the
                      interval of the configured time.
                  send_quitable_notifications:
                    example: false
                    type: boolean
                    description: >-
                      Describes if a notification should be sent as soon as an
                      alarm is quitable.
                  limit_notifications_always:
                    example: true
                    type: boolean
                    description: >-
                      Limits the always-active notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_always_alarm:
                    example: 1
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of always-active alarm notifications.
                      0 deactivates the notifications. Only required if
                      limit_notifications_always is true.
                  notification_count_always_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of always-active warnings. Only required if
                      limit_notifications_always is true.
                  limit_notifications_armed:
                    example: true
                    type: boolean
                    description: >-
                      Limits the armed-active notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_armed_alarm:
                    example: 1
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of armed-active alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_armed is true.
                  notification_count_armed_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of armed-active warnings. Only required if
                      limit_notifications_armed is true.
                  limit_notifications_fire:
                    example: false
                    type: boolean
                    description: >-
                      Limits the fire notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_fire_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of fire alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_fire is true.
                  notification_count_fire_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of fire warnings. Only required if
                      limit_notifications_fire is true.
                  limit_notifications_sabotage:
                    example: false
                    type: boolean
                    description: >-
                      Limits the sabotage notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_sabotage_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of sabotage alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_sabotage is true.
                  notification_count_sabotage_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of sabotage warnings. Only required if
                      limit_notifications_sabotage is true.
                  limit_notifications_system:
                    example: false
                    type: boolean
                    description: >-
                      Limits the system notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_system_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of system alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_system is true.
                  notification_count_system_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of system warnings. Only required if
                      limit_notifications_system is true.
                  inherit_arm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the arm settings should be inherited from the
                      parent group.
                  arm_delay:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 240
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the arm delay. Only required if inherit_arm is
                      false.
                  buzzer_arm_duration:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the arm buzzer duration. Only required if
                      inherit_arm is false.
                  can_alwaysarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the status of external contacts should be
                      ignored during arming. This is useful if e.g. a magnetic
                      door contact must be opened during the arming phase.
                  inherit_autoquit:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the autoquit settings should be inherited
                      from the parent group.
                  can_autoquit_always_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if always-active alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_armed_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if armed-active alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_fire_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if fire alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_sabotage_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if sabotage alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_system_notification_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if system alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  autoquit_duration:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 30
                      - 60
                      - 180
                      - 600
                      - 1800
                    description: >-
                      Describes the time after which automatic quitting is
                      executed. Only required if inherit_autoquit is false.
                  inherit_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the alarm settings should be inherited from
                      the parent group.
                  has_prealarm:
                    example: false
                    type: boolean
                    description: Describes if the Prealarm is en-/disabled.
                  buzzer_alwaysalarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for always-active alarms (-1
                      stands for permanent). Only required if inherit_alarm is
                      false.
                  buzzer_armedalarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for armed-active alarms (-1
                      stands for permanent). Only required if inherit_alarm is
                      false.
                  buzzer_firealarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for fire alarms (-1 stands for
                      permanent). Only required if inherit_alarm is false.
                  buzzer_sabotagealarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for sabotage alarms (-1 stands
                      for permanent). Only required if inherit_alarm is false.
                  inherit_sabotagesignal:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the signaling sabotage settings should be
                      inherited from the parent group.
                  sabotage_powerdevice_duration:
                    example: 300
                    type: integer
                    enum:
                      - 300
                      - 600
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a plugged device should wait, until it
                      fires a tampering alarm. Only required if
                      inherit_sabotagesignal is false.
                  sabotage_batterydevice_duration:
                    example: 900
                    type: integer
                    enum:
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a battery device should wait, until it
                      fires a tampering alarm. Only required if
                      inherit_sabotagesignal is false.
                  sabotage_service_duration:
                    example: 600
                    type: integer
                    enum:
                      - 600
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a service should wait, until it fires a
                      tampering alarm. Only required if inherit_sabotagesignal
                      is false.
                  event_id:
                    example: 0
                    type: integer
                    nullable: true
                    description: >-
                      Describes the event that should be used. Must be an Id of
                      an existing event.
                  webhooks:
                    type: array
                    description: >-
                      Describes the webhooks that should be fired when an event
                      happens
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  assigned_doorlock:
                    example: 3
                    type: integer
                    nullable: true
                    description: >-
                      The ID of the doorlock directly assigned to the
                      alarmgroup.
                  activepower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  apparentpower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  consumption:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  arm_if_empty:
                    type: boolean
                    example: false
                    description: >-
                      Requires Anti-Passback functionality, therefore KentixONE
                      plan "Large" and all it's entrances configured as
                      passages. If this alarmgroup is considered empty, i.e. no
                      user is currently booked in through a passage, it will
                      automatically be armed.
                  external_alarmsystem:
                    type: object
                    description: >-
                      Settings for assigning this alarmgroup to an external
                      alarmsystem.
                    properties:
                      device_id:
                        type: integer
                        example: 1
                        description: >-
                          ID of the device whose inputs and outputs shall be
                          used for the external alarmsystem
                        nullable: true
                      channel_returnchannel:
                        type: integer
                        example: 1
                        description: >-
                          Channel number of the external input on which the
                          external alarmsystem will signal its arming state.
                        nullable: true
                      channel_armready:
                        type: integer
                        example: 2
                        description: >-
                          Channel number of the external input on which the
                          external alarmsystem will signal wether it can be
                          armed or not. Not every alarmsystem does support this
                          feature.
                        nullable: true
                      channel_armsignal:
                        type: integer
                        example: 1
                        description: >-
                          Channel number of the digital output on which the
                          Kentix device will send an arm command to the external
                          alarmsystem.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update a specific alarmgroup via its ID.
      summary: Update alarmgroup
      tags:
        - alarmgroup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgroup to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - title: System-Group
                  type: object
                  properties:
                    sort_index:
                      example: 1
                      type: integer
                      description: Describes the sorting order.
                    in_stealthmode:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the internal status LED of all devices in
                        this alarmgroup should be activated.
                    maintenance:
                      example: inactive
                      type: string
                      enum:
                        - active
                        - inactive
                      description: Describes if the alarmgroup is in maintenance mode.
                    maintenance_start:
                      example: '2023-02-17T01:00:00.000Z'
                      type: string
                      format: ISO 8601
                      nullable: true
                      description: >-
                        Describes when the alarmgroup automatically switches to
                        maintenance mode.
                    maintenance_stop:
                      example: '2023-02-17T23:59:00.000Z'
                      type: string
                      format: ISO 8601
                      nullable: true
                      description: >-
                        Describes until when the alarmgroup remains in
                        maintenance mode.
                    is_alarmrepetition_active:
                      example: false
                      type: boolean
                      description: >-
                        Describes if active alarms should be repeated by it's
                        configured interval. Acknowledgment of the alarm stops
                        the repetition.
                    alarmrepetition_interval:
                      example: 1
                      type: integer
                      minimum: 1
                      maximum: 999
                      description: >-
                        Describes how alarms are sent to all users configured
                        for alarms, depending on the configured time and
                        repetitions.
                    alarmrepetition_count:
                      example: 0
                      type: integer
                      minimum: 0
                      maximum: 100
                      description: >-
                        Describes the number of alarm repetitions with the
                        interval of the configured time.
                    send_quitable_notifications:
                      example: false
                      type: boolean
                      description: >-
                        Describes if a notification should be sent as soon as an
                        alarm is quitable.
                    limit_notifications_always:
                      example: true
                      type: boolean
                      description: >-
                        Limits the always-active notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_always_alarm:
                      example: 1
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of always-active alarm
                        notifications. 0 deactivates the notifications. Only
                        required if limit_notifications_always is true.
                    notification_count_always_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of always-active warnings. Only required
                        if limit_notifications_always is true.
                    limit_notifications_armed:
                      example: true
                      type: boolean
                      description: >-
                        Limits the armed-active notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_armed_alarm:
                      example: 1
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of armed-active alarm notifications.
                        0 deactivates the notifications. Only required if
                        limit_notifications_armed is true.
                    notification_count_armed_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of armed-active warnings. Only required
                        if limit_notifications_armed is true.
                    limit_notifications_fire:
                      example: false
                      type: boolean
                      description: >-
                        Limits the fire notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_fire_alarm:
                      example: 0
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of fire alarm notifications. 0
                        deactivates the notifications. Only required if
                        limit_notifications_fire is true.
                    notification_count_fire_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of fire warnings. Only required if
                        limit_notifications_fire is true.
                    limit_notifications_sabotage:
                      example: false
                      type: boolean
                      description: >-
                        Limits the sabotage notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_sabotage_alarm:
                      example: 0
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of sabotage alarm notifications. 0
                        deactivates the notifications. Only required if
                        limit_notifications_sabotage is true.
                    notification_count_sabotage_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of sabotage warnings. Only required if
                        limit_notifications_sabotage is true.
                    limit_notifications_system:
                      example: false
                      type: boolean
                      description: >-
                        Limits the system notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_system_alarm:
                      example: 0
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of system alarm notifications. 0
                        deactivates the notifications. Only required if
                        limit_notifications_system is true.
                    notification_count_system_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of system warnings. Only required if
                        limit_notifications_system is true.
                    arm_delay:
                      example: 0
                      type: integer
                      enum:
                        - 0
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 240
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: Describes the arm delay.
                    buzzer_arm_duration:
                      example: 0
                      type: integer
                      enum:
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: Describes the arm buzzer duration.
                    can_alwaysarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the status of external contacts should be
                        ignored during arming. This is useful if e.g. a magnetic
                        door contact must be opened during the arming phase.
                    can_autoquit_always_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if always-active alarms should be
                        automatically acknowledged after the given interval.
                    can_autoquit_armed_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if armed-active alarms should be automatically
                        acknowledged after the given interval.
                    can_autoquit_fire_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if fire alarms should be automatically
                        acknowledged after the given interval.
                    can_autoquit_sabotage_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if sabotage alarms should be automatically
                        acknowledged after the given interval.
                    can_autoquit_system_notification_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if system alarms should be automatically
                        acknowledged after the given interval.
                    autoquit_duration:
                      example: 0
                      type: integer
                      enum:
                        - 0
                        - 30
                        - 60
                        - 180
                        - 600
                        - 1800
                      description: >-
                        Describes the time after which automatic quitting is
                        executed.
                    has_prealarm:
                      example: false
                      type: boolean
                      description: Describes if the Prealarm is en-/disabled.
                    buzzer_alwaysalarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for always-active alarms (-1
                        stands for permanent).
                    buzzer_armedalarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for armed-active alarms (-1
                        stands for permanent).
                    buzzer_firealarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for fire alarms (-1 stands
                        for permanent).
                    buzzer_sabotagealarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for sabotage alarms (-1
                        stands for permanent).
                    sabotage_powerdevice_duration:
                      example: 300
                      type: integer
                      enum:
                        - 300
                        - 600
                        - 900
                        - 1200
                        - 1500
                        - 1800
                        - 2100
                        - 2400
                        - 2700
                        - 3000
                        - 3300
                        - 3600
                      description: >-
                        Describes how long a plugged device should wait, until
                        it fires a tampering alarm.
                    sabotage_batterydevice_duration:
                      example: 900
                      type: integer
                      enum:
                        - 900
                        - 1200
                        - 1500
                        - 1800
                        - 2100
                        - 2400
                        - 2700
                        - 3000
                        - 3300
                        - 3600
                      description: >-
                        Describes how long a battery device should wait, until
                        it fires a tampering alarm.
                    sabotage_service_duration:
                      example: 600
                      type: integer
                      enum:
                        - 600
                        - 900
                        - 1200
                        - 1500
                        - 1800
                        - 2100
                        - 2400
                        - 2700
                        - 3000
                        - 3300
                        - 3600
                      description: >-
                        Describes how long a service should wait, until it fires
                        a tampering alarm.
                    event_id:
                      example: 0
                      type: integer
                      nullable: true
                      description: >-
                        Describes the event that should be used. Must be an Id
                        of an existing event.
                    webhooks:
                      type: array
                      description: >-
                        Describes the webhooks that should be fired when an
                        event happens
                      items:
                        type: object
                        properties:
                          id:
                            example: 0
                            type: integer
                            description: Must be an Id of an existing webhook.
                          event:
                            example: 0
                            type: integer
                            enum:
                              - 0
                              - 1
                              - 2
                              - 3
                              - 4
                              - 5
                              - 51
                            description: Must be an Id of an existing webhook event type.
                          cycle_time:
                            example: 5
                            type: integer
                            nullable: true
                            enum:
                              - 5
                              - 10
                              - 15
                              - 30
                            description: >-
                              Describes how often the webhook should be
                              executed. Only required if event is 51.
                          trigger_on_alarm:
                            example: false
                            type: boolean
                            nullable: true
                            description: >-
                              Describes if the webhook should be executed in
                              case of an alarm.
                          trigger_on_warning:
                            example: false
                            type: boolean
                            nullable: true
                            description: >-
                              Describes if the webhook should be executed in
                              case of a warning.
                    assigned_doorlock:
                      example: 3
                      type: integer
                      nullable: true
                      description: >-
                        The ID of the doorlock directly assigned to the
                        alarmgroup.
                - title: Other
                  type: object
                  properties:
                    name:
                      example: Kentix HQ
                      type: string
                      description: Describes the name of the alarmgroup.
                    group_id:
                      example: 1
                      type: integer
                      description: >-
                        Indicates the parent alarm group. Must be an Id of an
                        existing group.
                    sort_index:
                      example: 1
                      type: integer
                      description: Describes the sorting order.
                    in_stealthmode:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the internal status LED of all devices in
                        this alarmgroup should be activated.
                    signaling_group:
                      example: 1
                      type: integer
                      nullable: true
                      description: >-
                        Describes the range in which a signaling is triggered,
                        if an alarm occurs within this alarmgroup. Must be an Id
                        of an parent group.
                    maintenance:
                      example: inactive
                      type: string
                      enum:
                        - active
                        - inactive
                      description: Describes if the alarmgroup is in maintenance mode.
                    maintenance_start:
                      example: '2023-02-17T01:00:00.000Z'
                      type: string
                      format: ISO 8601
                      nullable: true
                      description: >-
                        Describes when the alarmgroup automatically switches to
                        maintenance mode.
                    maintenance_stop:
                      example: '2023-02-17T23:59:00.000Z'
                      type: string
                      format: ISO 8601
                      nullable: true
                      description: >-
                        Describes until when the alarmgroup remains in
                        maintenance mode.
                    inherit_notification:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the notification settings should be
                        inherited from the parent group.
                    is_alarmrepetition_active:
                      example: false
                      type: boolean
                      description: >-
                        Describes if active alarms should be repeated by it's
                        configured interval. Acknowledgment of the alarm stops
                        the repetition.
                    alarmrepetition_interval:
                      example: 1
                      type: integer
                      minimum: 1
                      maximum: 999
                      description: >-
                        Describes how alarms are sent to all users configured
                        for alarms, depending on the configured time and
                        repetitions.
                    alarmrepetition_count:
                      example: 0
                      type: integer
                      minimum: 0
                      maximum: 100
                      description: >-
                        Describes the number of alarm repetitions with the
                        interval of the configured time.
                    send_quitable_notifications:
                      example: false
                      type: boolean
                      description: >-
                        Describes if a notification should be sent as soon as an
                        alarm is quitable.
                    limit_notifications_always:
                      example: true
                      type: boolean
                      description: >-
                        Limits the always-active notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_always_alarm:
                      example: 1
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of always-active alarm
                        notifications. 0 deactivates the notifications. Only
                        required if limit_notifications_always is true.
                    notification_count_always_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of always-active warnings. Only required
                        if limit_notifications_always is true.
                    limit_notifications_armed:
                      example: true
                      type: boolean
                      description: >-
                        Limits the armed-active notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_armed_alarm:
                      example: 1
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of armed-active alarm notifications.
                        0 deactivates the notifications. Only required if
                        limit_notifications_armed is true.
                    notification_count_armed_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of armed-active warnings. Only required
                        if limit_notifications_armed is true.
                    limit_notifications_fire:
                      example: false
                      type: boolean
                      description: >-
                        Limits the fire notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_fire_alarm:
                      example: 0
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of fire alarm notifications. 0
                        deactivates the notifications. Only required if
                        limit_notifications_fire is true.
                    notification_count_fire_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of fire warnings. Only required if
                        limit_notifications_fire is true.
                    limit_notifications_sabotage:
                      example: false
                      type: boolean
                      description: >-
                        Limits the sabotage notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_sabotage_alarm:
                      example: 0
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of sabotage alarm notifications. 0
                        deactivates the notifications. Only required if
                        limit_notifications_sabotage is true.
                    notification_count_sabotage_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of sabotage warnings. Only required if
                        limit_notifications_sabotage is true.
                    limit_notifications_system:
                      example: false
                      type: boolean
                      description: >-
                        Limits the system notifications per hour. Manual
                        acknowledgement resets the counter, repeated alarms do
                        not count.
                    notification_count_system_alarm:
                      example: 0
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 1000
                      description: >-
                        Describes the limit of system alarm notifications. 0
                        deactivates the notifications. Only required if
                        limit_notifications_system is true.
                    notification_count_system_warning:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        Notify in case of system warnings. Only required if
                        limit_notifications_system is true.
                    inherit_arm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the arm settings should be inherited from
                        the parent group.
                    arm_delay:
                      example: 0
                      type: integer
                      enum:
                        - 0
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 240
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the arm delay. Only required if inherit_arm is
                        false.
                    buzzer_arm_duration:
                      example: 0
                      type: integer
                      enum:
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the arm buzzer duration. Only required if
                        inherit_arm is false.
                    can_alwaysarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the status of external contacts should be
                        ignored during arming. This is useful if e.g. a magnetic
                        door contact must be opened during the arming phase.
                    inherit_autoquit:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the autoquit settings should be inherited
                        from the parent group.
                    can_autoquit_always_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if always-active alarms should be
                        automatically acknowledged after the given interval.
                        Only required if inherit_autoquit is false.
                    can_autoquit_armed_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if armed-active alarms should be automatically
                        acknowledged after the given interval. Only required if
                        inherit_autoquit is false.
                    can_autoquit_fire_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if fire alarms should be automatically
                        acknowledged after the given interval. Only required if
                        inherit_autoquit is false.
                    can_autoquit_sabotage_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if sabotage alarms should be automatically
                        acknowledged after the given interval. Only required if
                        inherit_autoquit is false.
                    can_autoquit_system_notification_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if system alarms should be automatically
                        acknowledged after the given interval. Only required if
                        inherit_autoquit is false.
                    autoquit_duration:
                      example: 0
                      type: integer
                      enum:
                        - 0
                        - 30
                        - 60
                        - 180
                        - 600
                        - 1800
                      description: >-
                        Describes the time after which automatic quitting is
                        executed. Only required if inherit_autoquit is false.
                    inherit_alarm:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the alarm settings should be inherited from
                        the parent group.
                    has_prealarm:
                      example: false
                      type: boolean
                      description: Describes if the Prealarm is en-/disabled.
                    buzzer_alwaysalarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for always-active alarms (-1
                        stands for permanent). Only required if inherit_alarm is
                        false.
                    buzzer_armedalarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for armed-active alarms (-1
                        stands for permanent). Only required if inherit_alarm is
                        false.
                    buzzer_firealarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for fire alarms (-1 stands
                        for permanent). Only required if inherit_alarm is false.
                    buzzer_sabotagealarm_duration:
                      example: 0
                      type: integer
                      enum:
                        - -1
                        - 0
                        - 1
                        - 3
                        - 10
                        - 30
                        - 60
                        - 120
                        - 180
                        - 300
                        - 600
                        - 1200
                        - 1800
                        - 3600
                      description: >-
                        Describes the buzzer length for sabotage alarms (-1
                        stands for permanent). Only required if inherit_alarm is
                        false.
                    inherit_sabotagesignal:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the signaling sabotage settings should be
                        inherited from the parent group.
                    sabotage_powerdevice_duration:
                      example: 300
                      type: integer
                      enum:
                        - 300
                        - 600
                        - 900
                        - 1200
                        - 1500
                        - 1800
                        - 2100
                        - 2400
                        - 2700
                        - 3000
                        - 3300
                        - 3600
                      description: >-
                        Describes how long a plugged device should wait, until
                        it fires a tampering alarm. Only required if
                        inherit_sabotagesignal is false.
                    sabotage_batterydevice_duration:
                      example: 900
                      type: integer
                      enum:
                        - 900
                        - 1200
                        - 1500
                        - 1800
                        - 2100
                        - 2400
                        - 2700
                        - 3000
                        - 3300
                        - 3600
                      description: >-
                        Describes how long a battery device should wait, until
                        it fires a tampering alarm. Only required if
                        inherit_sabotagesignal is false.
                    sabotage_service_duration:
                      example: 600
                      type: integer
                      enum:
                        - 600
                        - 900
                        - 1200
                        - 1500
                        - 1800
                        - 2100
                        - 2400
                        - 2700
                        - 3000
                        - 3300
                        - 3600
                      description: >-
                        Describes how long a service should wait, until it fires
                        a tampering alarm. Only required if
                        inherit_sabotagesignal is false.
                    event_id:
                      example: 0
                      type: integer
                      nullable: true
                      description: >-
                        Describes the event that should be used. Must be an Id
                        of an existing event.
                    webhooks:
                      type: array
                      description: >-
                        Describes the webhooks that should be fired when an
                        event happens
                      items:
                        type: object
                        properties:
                          id:
                            example: 0
                            type: integer
                            description: Must be an Id of an existing webhook.
                          event:
                            example: 0
                            type: integer
                            enum:
                              - 0
                              - 1
                              - 2
                              - 3
                              - 4
                              - 5
                              - 51
                            description: Must be an Id of an existing webhook event type.
                          cycle_time:
                            example: 5
                            type: integer
                            nullable: true
                            enum:
                              - 5
                              - 10
                              - 15
                              - 30
                            description: >-
                              Describes how often the webhook should be
                              executed. Only required if event is 51.
                          trigger_on_alarm:
                            example: false
                            type: boolean
                            nullable: true
                            description: >-
                              Describes if the webhook should be executed in
                              case of an alarm.
                          trigger_on_warning:
                            example: false
                            type: boolean
                            nullable: true
                            description: >-
                              Describes if the webhook should be executed in
                              case of a warning.
                    assigned_doorlock:
                      example: 3
                      type: integer
                      nullable: true
                      description: >-
                        The ID of the doorlock directly assigned to the
                        alarmgroup.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Id of the alarmgroup.
                  created_at:
                    example: '2023-01-07T18:08:44.000000Z'
                    type: string
                    format: ISO 8601
                    readOnly: true
                    description: Indicates when the alarmgroup was created.
                  updated_at:
                    example: '2023-01-07T18:08:44.000000Z'
                    type: string
                    format: ISO 8601
                    readOnly: true
                    description: Indicates when the alarmgroup was updated.
                  name:
                    example: Kentix HQ
                    type: string
                    description: Describes the name of the alarmgroup.
                  group_id:
                    example: 1
                    type: integer
                    description: >-
                      Indicates the parent alarm group. Must be an Id of an
                      existing group.
                  sort_index:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Describes the sorting order.
                  in_stealthmode:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the internal status LED of all devices in
                      this alarmgroup should be activated.
                  signaling_group:
                    example: 1
                    type: integer
                    nullable: true
                    description: >-
                      Describes the range in which a signaling is triggered, if
                      an alarm occurs within this alarmgroup. Must be an Id of
                      an parent group.
                  maintenance:
                    example: inactive
                    type: string
                    enum:
                      - active
                      - inactive
                    description: Describes if the alarmgroup is in maintenance mode.
                  maintenance_start:
                    example: '2023-02-17T01:00:00.000Z'
                    type: string
                    format: ISO 8601
                    nullable: true
                    description: >-
                      Describes when the alarmgroup automatically switches to
                      maintenance mode.
                  maintenance_stop:
                    example: '2023-02-17T23:59:00.000Z'
                    type: string
                    format: ISO 8601
                    nullable: true
                    description: >-
                      Describes until when the alarmgroup remains in maintenance
                      mode.
                  inherit_notification:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the notification settings should be inherited
                      from the parent group.
                  is_alarmrepetition_active:
                    example: false
                    type: boolean
                    description: >-
                      Describes if active alarms should be repeated by it's
                      configured interval. Acknowledgment of the alarm stops the
                      repetition.
                  alarmrepetition_interval:
                    example: 1
                    type: integer
                    minimum: 1
                    maximum: 999
                    description: >-
                      Describes how alarms are sent to all users configured for
                      alarms, depending on the configured time and repetitions.
                  alarmrepetition_count:
                    example: 0
                    type: integer
                    minimum: 0
                    maximum: 100
                    description: >-
                      Describes the number of alarm repetitions with the
                      interval of the configured time.
                  send_quitable_notifications:
                    example: false
                    type: boolean
                    description: >-
                      Describes if a notification should be sent as soon as an
                      alarm is quitable.
                  limit_notifications_always:
                    example: true
                    type: boolean
                    description: >-
                      Limits the always-active notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_always_alarm:
                    example: 1
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of always-active alarm notifications.
                      0 deactivates the notifications. Only required if
                      limit_notifications_always is true.
                  notification_count_always_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of always-active warnings. Only required if
                      limit_notifications_always is true.
                  limit_notifications_armed:
                    example: true
                    type: boolean
                    description: >-
                      Limits the armed-active notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_armed_alarm:
                    example: 1
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of armed-active alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_armed is true.
                  notification_count_armed_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of armed-active warnings. Only required if
                      limit_notifications_armed is true.
                  limit_notifications_fire:
                    example: false
                    type: boolean
                    description: >-
                      Limits the fire notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_fire_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of fire alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_fire is true.
                  notification_count_fire_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of fire warnings. Only required if
                      limit_notifications_fire is true.
                  limit_notifications_sabotage:
                    example: false
                    type: boolean
                    description: >-
                      Limits the sabotage notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_sabotage_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of sabotage alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_sabotage is true.
                  notification_count_sabotage_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of sabotage warnings. Only required if
                      limit_notifications_sabotage is true.
                  limit_notifications_system:
                    example: false
                    type: boolean
                    description: >-
                      Limits the system notifications per hour. Manual
                      acknowledgement resets the counter, repeated alarms do not
                      count.
                  notification_count_system_alarm:
                    example: 0
                    type: integer
                    nullable: true
                    minimum: 0
                    maximum: 1000
                    description: >-
                      Describes the limit of system alarm notifications. 0
                      deactivates the notifications. Only required if
                      limit_notifications_system is true.
                  notification_count_system_warning:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Notify in case of system warnings. Only required if
                      limit_notifications_system is true.
                  inherit_arm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the arm settings should be inherited from the
                      parent group.
                  arm_delay:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 240
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the arm delay. Only required if inherit_arm is
                      false.
                  buzzer_arm_duration:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the arm buzzer duration. Only required if
                      inherit_arm is false.
                  can_alwaysarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the status of external contacts should be
                      ignored during arming. This is useful if e.g. a magnetic
                      door contact must be opened during the arming phase.
                  inherit_autoquit:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the autoquit settings should be inherited
                      from the parent group.
                  can_autoquit_always_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if always-active alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_armed_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if armed-active alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_fire_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if fire alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_sabotage_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if sabotage alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  can_autoquit_system_notification_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if system alarms should be automatically
                      acknowledged after the given interval. Only required if
                      inherit_autoquit is false.
                  autoquit_duration:
                    example: 0
                    type: integer
                    enum:
                      - 0
                      - 30
                      - 60
                      - 180
                      - 600
                      - 1800
                    description: >-
                      Describes the time after which automatic quitting is
                      executed. Only required if inherit_autoquit is false.
                  inherit_alarm:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the alarm settings should be inherited from
                      the parent group.
                  has_prealarm:
                    example: false
                    type: boolean
                    description: Describes if the Prealarm is en-/disabled.
                  buzzer_alwaysalarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for always-active alarms (-1
                      stands for permanent). Only required if inherit_alarm is
                      false.
                  buzzer_armedalarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for armed-active alarms (-1
                      stands for permanent). Only required if inherit_alarm is
                      false.
                  buzzer_firealarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for fire alarms (-1 stands for
                      permanent). Only required if inherit_alarm is false.
                  buzzer_sabotagealarm_duration:
                    example: 0
                    type: integer
                    enum:
                      - -1
                      - 0
                      - 1
                      - 3
                      - 10
                      - 30
                      - 60
                      - 120
                      - 180
                      - 300
                      - 600
                      - 1200
                      - 1800
                      - 3600
                    description: >-
                      Describes the buzzer length for sabotage alarms (-1 stands
                      for permanent). Only required if inherit_alarm is false.
                  inherit_sabotagesignal:
                    example: false
                    type: boolean
                    description: >-
                      Describes if the signaling sabotage settings should be
                      inherited from the parent group.
                  sabotage_powerdevice_duration:
                    example: 300
                    type: integer
                    enum:
                      - 300
                      - 600
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a plugged device should wait, until it
                      fires a tampering alarm. Only required if
                      inherit_sabotagesignal is false.
                  sabotage_batterydevice_duration:
                    example: 900
                    type: integer
                    enum:
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a battery device should wait, until it
                      fires a tampering alarm. Only required if
                      inherit_sabotagesignal is false.
                  sabotage_service_duration:
                    example: 600
                    type: integer
                    enum:
                      - 600
                      - 900
                      - 1200
                      - 1500
                      - 1800
                      - 2100
                      - 2400
                      - 2700
                      - 3000
                      - 3300
                      - 3600
                    description: >-
                      Describes how long a service should wait, until it fires a
                      tampering alarm. Only required if inherit_sabotagesignal
                      is false.
                  event_id:
                    example: 0
                    type: integer
                    nullable: true
                    description: >-
                      Describes the event that should be used. Must be an Id of
                      an existing event.
                  webhooks:
                    type: array
                    description: >-
                      Describes the webhooks that should be fired when an event
                      happens
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  assigned_doorlock:
                    example: 3
                    type: integer
                    nullable: true
                    description: >-
                      The ID of the doorlock directly assigned to the
                      alarmgroup.
                  activepower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  apparentpower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  consumption:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  arm_if_empty:
                    type: boolean
                    example: false
                    description: >-
                      Requires Anti-Passback functionality, therefore KentixONE
                      plan "Large" and all it's entrances configured as
                      passages. If this alarmgroup is considered empty, i.e. no
                      user is currently booked in through a passage, it will
                      automatically be armed.
                  external_alarmsystem:
                    type: object
                    description: >-
                      Settings for assigning this alarmgroup to an external
                      alarmsystem.
                    properties:
                      device_id:
                        type: integer
                        example: 1
                        description: >-
                          ID of the device whose inputs and outputs shall be
                          used for the external alarmsystem
                        nullable: true
                      channel_returnchannel:
                        type: integer
                        example: 1
                        description: >-
                          Channel number of the external input on which the
                          external alarmsystem will signal its arming state.
                        nullable: true
                      channel_armready:
                        type: integer
                        example: 2
                        description: >-
                          Channel number of the external input on which the
                          external alarmsystem will signal wether it can be
                          armed or not. Not every alarmsystem does support this
                          feature.
                        nullable: true
                      channel_armsignal:
                        type: integer
                        example: 1
                        description: >-
                          Channel number of the digital output on which the
                          Kentix device will send an arm command to the external
                          alarmsystem.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    delete:
      description: Delete specific alarmgroup via its ID.
      summary: Delete alarmgroup
      tags:
        - alarmgroup
      parameters:
        - name: alarmgroup
          in: path
          description: ID of the alarmgroup to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}/devices/{device}:
    put:
      description: Add specified device to alarmgroup.
      summary: Add Device
      tags:
        - alarmgroup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgroup (must be a leaf node) to be queried
          required: true
          example: 1
          schema:
            type: string
        - name: device
          in: path
          description: ID of the device to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}/ios/{io}:
    put:
      description: Add specified IO to alarmgroup.
      summary: Add IO
      tags:
        - alarmgroup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: >-
            ID of the alarmgroup (must be a leaf node, except for digital
            output) to be queried
          required: true
          example: 1
          schema:
            type: string
        - name: io
          in: path
          description: ID of the device to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/oid/alarmgroups/{alarmgroup}:
    get:
      description: Get OID-List for sepcified alarmgroup.
      summary: Get OID-List
      tags:
        - alarmgroup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgroup to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  group:
                    type: object
                    properties:
                      '{ID}':
                        type: array
                        description: Describes the ID of the queried alarmgroup.
                        items:
                          type: object
                          properties:
                            label:
                              example: General
                              type: string
                              description: Describes the node in the OID tree.
                            attributes:
                              type: array
                              items:
                                type: object
                                properties:
                                  label:
                                    example: Name
                                    type: string
                                    description: Describes the node in the OID tree.
                                  oid:
                                    example: .1.3.6.1.4.1.37954.5.3.1.1.2.2
                                    type: string
                                    description: Describes the OID path of the node.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}/arm:
    put:
      description: Arm a specific alarmgroup via its ID.
      summary: Arm alarmgroup
      tags:
        - alarmgroup-arm
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgoup to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}/disarm:
    put:
      description: Disarm a specific alarmgroup via its ID.
      summary: Disarm alarmgroup
      tags:
        - alarmgroup-disarm
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgoup to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}/quit:
    put:
      description: Quit a specific alarmgroup via its ID.
      summary: Quit alarmgroup
      tags:
        - alarmgroup-quit
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: ID of the alarmgoup to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/armstategroups/names:
    get:
      description: Requests all alarmgroups which the user has access to.
      summary: Get alarmgroup names
      tags:
        - alarmgroup-state
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 0
                      type: integer
                      description: Id of the alarmgroup.
                    name:
                      example: Kentix HQ
                      type: string
                      description: Name of the alarmgroup.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmhorns:
    get:
      tags:
        - alarmhorn
      description: Get a list of all Alarm Sirens.
      summary: Get Alarm Sirens
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        device_id:
                          example: 1
                          type: integer
                          description: the ID of the device this device is assigned to
                        is_active:
                          example: true
                          type: boolean
                          description: The flag to determine the status of the device
                        name:
                          example: Kentix Alarm Siren (Ethernet)
                          type: string
                          description: The name of the device
                        type:
                          example: 124
                          type: integer
                          description: The type of the device
                        address:
                          example: 192.168.0.1
                          type: string
                          description: The address of the device
                        port:
                          example: 502
                          type: integer
                          description: The port of the device
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        signalprofile_id:
                          example: 3
                          type: integer
                          description: >-
                            The ID of the Signalprofile the device is assigned
                            to
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmhorns/names:
    get:
      tags:
        - alarmhorn-names
      description: Get a list of Alarm Sirens names.
      summary: Get Alarm Sirens names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: Kentix Alarm Siren (Ethernet)
                      type: string
                      description: The name of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmhorns/{alarmhorn}:
    get:
      tags:
        - alarmhorn-id
      description: Get the details of the given Alarm Siren.
      summary: Get Details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmhorn
          in: path
          description: Alarm Siren ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                oneOf:
                  - title: Kentix Alarm Siren (Ethernet)
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix Alarm Siren (Ethernet)
                        type: string
                        description: The name of the device
                      type:
                        example: 124
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      signalprofile_id:
                        example: 3
                        type: integer
                        description: The ID of the Signalprofile the device is assigned to
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - alarmhorn-id
      description: Update the configuration of given Alarm Siren.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmhorn
          in: path
          description: Alarm Siren ID
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              oneOf:
                - title: Kentix Alarm Siren (Ethernet)
                  type: object
                  properties:
                    id:
                      example: 2
                      type: integer
                      description: the ID of the device
                    device_id:
                      example: 1
                      type: integer
                      description: the ID of the device this device is assigned to
                    is_active:
                      example: true
                      type: boolean
                      description: The flag to determine the status of the device
                    name:
                      example: Kentix Alarm Siren (Ethernet)
                      type: string
                      description: The name of the device
                    type:
                      example: 124
                      type: integer
                      description: The type of the device
                    address:
                      example: 192.168.0.1
                      type: string
                      description: The address of the device
                    port:
                      example: 502
                      type: integer
                      description: The port of the device
                    group_id:
                      example: 1
                      type: integer
                      description: The ID of the group the device is assigned to
                    signalprofile_id:
                      example: 3
                      type: integer
                      description: The ID of the Signalprofile the device is assigned to
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                oneOf:
                  - title: Kentix Alarm Siren (Ethernet)
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix Alarm Siren (Ethernet)
                        type: string
                        description: The name of the device
                      type:
                        example: 124
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      signalprofile_id:
                        example: 3
                        type: integer
                        description: The ID of the Signalprofile the device is assigned to
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmmanagers:
    get:
      tags:
        - alarmmanager
      description: Get a list of AlarmManagers.
      summary: Get AlarmManagers
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: the ID of the device
                        name:
                          example: AlarmManager
                          type: string
                          description: The name of the device
                        type:
                          example: 101
                          type: integer
                          description: The type of the device
                        is_active:
                          example: true
                          type: boolean
                          description: The flag to determine the status of the device
                        address:
                          example: 192.168.0.1
                          type: string
                          description: The address of the device
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        type_name:
                          example: Alarmmanager
                          type: string
                          description: The name of the type
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmmanagers/names:
    get:
      tags:
        - alarmmanager-names
      description: Get a list of AlarmManager names.
      summary: Get AlarmManager names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: AlarmManager
                      type: string
                      description: The name of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmmanagers/{alarmmanager_id}:
    get:
      tags:
        - alarmmanager-id
      description: Get the details of the given AlarmManager.
      summary: Get Details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmmanager_id
          in: path
          description: AlarmManager ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  device_id:
                    example: 1
                    type: integer
                    description: the ID of the device this device is assigned to
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: AlarmManager
                    type: string
                    description: The name of the device
                  description:
                    example: Alarmmanager main hall
                    type: string
                    description: The description of the device
                  type:
                    example: 101
                    type: integer
                    description: The type of the device
                  type_name:
                    example: Alarmmanager
                    type: string
                    description: The name of the type
                  address:
                    example: 192.168.0.1
                    type: string
                    description: The address of the device
                  alarmdelay:
                    example: 10
                    type: integer
                    description: The amount of seconds an alarm will be delayed
                  monitoring:
                    type: object
                    properties:
                      temperature:
                        type: object
                        description: The configuration for the temperature sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 15
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 25
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          offset:
                            example: 2
                            type: integer
                            description: The offset applied to the value
                          units:
                            type: object
                            properties:
                              min:
                                example: °C
                                type: string
                                description: The unit for the min field
                              max:
                                example: °C
                                type: string
                                description: The unit for the max field
                              offset:
                                example: °C
                                type: string
                                description: The unit for the offset field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 17
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 23
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      humidity:
                        type: object
                        description: The configuration for the humidity sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 40
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 60
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          units:
                            type: object
                            properties:
                              min:
                                example: '%'
                                type: string
                                description: The unit for the min field
                              max:
                                example: '%'
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 45
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 55
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      dewpoint:
                        type: object
                        description: The configuration for the dewpoint sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          hysteresis:
                            example: 2
                            type: integer
                            description: >-
                              The hysteresis threshold where an alarm is
                              triggered
                          units:
                            type: object
                            properties:
                              hysteresis:
                                example: °C
                                type: string
                                description: The unit for the hysteresis field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  fire:
                    type: object
                    properties:
                      heat:
                        type: object
                        description: The configuration for the heat sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 4
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: °C/min
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 2
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  intrusion:
                    type: object
                    properties:
                      vibration:
                        type: object
                        description: The configuration for the vibration sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          sensitivity:
                            example: medium
                            type: string
                            description: >-
                              The sensitivity threshold where an alarm is
                              triggered
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  rack_id:
                    example: null
                    type: integer
                    description: The ID of the rack the device is assigned to
                  external:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel2:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel3:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel4:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                  output:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel2:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel3:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel4:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - alarmmanager-id
      description: Update the configuration of given AlarmManager.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmmanager_id
          in: path
          description: AlarmManager ID
          example: 1
          required: true
          schema:
            type: string
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                device_id:
                  example: 1
                  type: integer
                  description: the ID of the device this device is assigned to
                is_active:
                  example: true
                  type: boolean
                  description: The flag to determine the status of the device
                name:
                  example: AlarmManager
                  type: string
                  description: The name of the device
                description:
                  example: Alarmmanager main hall
                  type: string
                  description: The description of the device
                type:
                  example: 101
                  type: integer
                  description: The type of the device
                type_name:
                  example: Alarmmanager
                  type: string
                  description: The name of the type
                address:
                  example: 192.168.0.1
                  type: string
                  description: The address of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                monitoring:
                  type: object
                  properties:
                    temperature:
                      type: object
                      description: The configuration for the temperature sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        min:
                          example: 15
                          type: integer
                          description: The minimal threshold before an alarm is triggered
                        max:
                          example: 25
                          type: integer
                          description: The maximum threshold before an alarm is triggered
                        offset:
                          example: 2
                          type: integer
                          description: The offset applied to the value
                        units:
                          type: object
                          properties:
                            min:
                              example: °C
                              type: string
                              description: The unit for the min field
                            max:
                              example: °C
                              type: string
                              description: The unit for the max field
                            offset:
                              example: °C
                              type: string
                              description: The unit for the offset field
                        warning:
                          type: object
                          properties:
                            min:
                              example: 17
                              type: integer
                              description: The warning threshold for the min value
                            max:
                              example: 23
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    humidity:
                      type: object
                      description: The configuration for the humidity sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        min:
                          example: 40
                          type: integer
                          description: The minimal threshold before an alarm is triggered
                        max:
                          example: 60
                          type: integer
                          description: The maximum threshold before an alarm is triggered
                        units:
                          type: object
                          properties:
                            min:
                              example: '%'
                              type: string
                              description: The unit for the min field
                            max:
                              example: '%'
                              type: string
                              description: The unit for the max field
                        warning:
                          type: object
                          properties:
                            min:
                              example: 45
                              type: integer
                              description: The warning threshold for the min value
                            max:
                              example: 55
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    dewpoint:
                      type: object
                      description: The configuration for the dewpoint sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        hysteresis:
                          example: 2
                          type: integer
                          description: The hysteresis threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            hysteresis:
                              example: °C
                              type: string
                              description: The unit for the hysteresis field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 1
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                fire:
                  type: object
                  properties:
                    heat:
                      type: object
                      description: The configuration for the heat sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 4
                          type: integer
                          description: The threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            threshold:
                              example: °C/min
                              type: string
                              description: The unit for the threshold field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 2
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                intrusion:
                  type: object
                  properties:
                    vibration:
                      type: object
                      description: The configuration for the vibration sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        sensitivity:
                          example: medium
                          type: string
                          description: >-
                            The sensitivity threshold where an alarm is
                            triggered
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                rack_id:
                  example: null
                  type: integer
                  description: The ID of the rack the device is assigned to
                external:
                  type: object
                  properties:
                    channel1:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
                    channel2:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
                    channel3:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
                    channel4:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
                output:
                  type: object
                  properties:
                    channel1:
                      type: object
                      description: The configuration for an digital output
                      properties:
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        event_id:
                          example: 1
                          type: integer
                          description: The ID of the Eventprofile applied to this device
                        output_time:
                          example: 1
                          type: integer
                          description: >-
                            Determines how long this output will be opened on
                            alarm
                    channel2:
                      type: object
                      description: The configuration for an digital output
                      properties:
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        event_id:
                          example: 1
                          type: integer
                          description: The ID of the Eventprofile applied to this device
                        output_time:
                          example: 1
                          type: integer
                          description: >-
                            Determines how long this output will be opened on
                            alarm
                    channel3:
                      type: object
                      description: The configuration for an digital output
                      properties:
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        event_id:
                          example: 1
                          type: integer
                          description: The ID of the Eventprofile applied to this device
                        output_time:
                          example: 1
                          type: integer
                          description: >-
                            Determines how long this output will be opened on
                            alarm
                    channel4:
                      type: object
                      description: The configuration for an digital output
                      properties:
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        event_id:
                          example: 1
                          type: integer
                          description: The ID of the Eventprofile applied to this device
                        output_time:
                          example: 1
                          type: integer
                          description: >-
                            Determines how long this output will be opened on
                            alarm
                webhooks:
                  type: array
                  description: The webhook relations of this device
                  items:
                    type: object
                    properties:
                      id:
                        example: 0
                        type: integer
                        description: Must be an Id of an existing webhook.
                      event:
                        example: 0
                        type: integer
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                          - 51
                        description: Must be an Id of an existing webhook event type.
                      cycle_time:
                        example: 5
                        type: integer
                        nullable: true
                        enum:
                          - 5
                          - 10
                          - 15
                          - 30
                        description: >-
                          Describes how often the webhook should be executed.
                          Only required if event is 51.
                      trigger_on_alarm:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          an alarm.
                      trigger_on_warning:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          a warning.
                connection:
                  type: object
                  properties:
                    assignment:
                      example: 'off'
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of the connection
                    warning:
                      type: object
                      properties:
                        active:
                          type: boolean
                          example: true
                          description: >-
                            Configures whether connection issues should be
                            displayed as a warning instead of an alarm
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  device_id:
                    example: 1
                    type: integer
                    description: the ID of the device this device is assigned to
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: AlarmManager
                    type: string
                    description: The name of the device
                  description:
                    example: Alarmmanager main hall
                    type: string
                    description: The description of the device
                  type:
                    example: 101
                    type: integer
                    description: The type of the device
                  type_name:
                    example: Alarmmanager
                    type: string
                    description: The name of the type
                  address:
                    example: 192.168.0.1
                    type: string
                    description: The address of the device
                  alarmdelay:
                    example: 10
                    type: integer
                    description: The amount of seconds an alarm will be delayed
                  monitoring:
                    type: object
                    properties:
                      temperature:
                        type: object
                        description: The configuration for the temperature sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 15
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 25
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          offset:
                            example: 2
                            type: integer
                            description: The offset applied to the value
                          units:
                            type: object
                            properties:
                              min:
                                example: °C
                                type: string
                                description: The unit for the min field
                              max:
                                example: °C
                                type: string
                                description: The unit for the max field
                              offset:
                                example: °C
                                type: string
                                description: The unit for the offset field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 17
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 23
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      humidity:
                        type: object
                        description: The configuration for the humidity sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 40
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 60
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          units:
                            type: object
                            properties:
                              min:
                                example: '%'
                                type: string
                                description: The unit for the min field
                              max:
                                example: '%'
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 45
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 55
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      dewpoint:
                        type: object
                        description: The configuration for the dewpoint sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          hysteresis:
                            example: 2
                            type: integer
                            description: >-
                              The hysteresis threshold where an alarm is
                              triggered
                          units:
                            type: object
                            properties:
                              hysteresis:
                                example: °C
                                type: string
                                description: The unit for the hysteresis field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  fire:
                    type: object
                    properties:
                      heat:
                        type: object
                        description: The configuration for the heat sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 4
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: °C/min
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 2
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  intrusion:
                    type: object
                    properties:
                      vibration:
                        type: object
                        description: The configuration for the vibration sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          sensitivity:
                            example: medium
                            type: string
                            description: >-
                              The sensitivity threshold where an alarm is
                              triggered
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  rack_id:
                    example: null
                    type: integer
                    description: The ID of the rack the device is assigned to
                  external:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel2:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel3:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel4:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                  output:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel2:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel3:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel4:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/anti-passback/settings:
    get:
      tags:
        - anti-passback-settings
      description: Get anti-passback configuration.
      summary: Get settings
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    type: boolean
                    example: false
                    description: >-
                      Enables the anti-passback module. This will prevent a user
                      (pin/rfid-token) from entering the same alarmgroup
                      multiple times in short succession. After the configured
                      timeout a booked in user will be able to enter again.
                  timeout:
                    type: string
                    example: '30'
                    enum:
                      - 'off'
                      - '10'
                      - '15'
                      - '30'
                      - '60'
                      - '120'
                      - '480'
                      - '720'
                      - '1440'
                    description: >-
                      Configures the time after which a user will be able to
                      enter an alarmgroup again. The value is given in minutes.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - anti-passback-settings
      description: Update the anti-passback configuration.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  type: boolean
                  example: false
                  description: >-
                    Enables the anti-passback module. This will prevent a user
                    (pin/rfid-token) from entering the same alarmgroup multiple
                    times in short succession. After the configured timeout a
                    booked in user will be able to enter again.
                timeout:
                  type: string
                  example: '30'
                  enum:
                    - 'off'
                    - '10'
                    - '15'
                    - '30'
                    - '60'
                    - '120'
                    - '480'
                    - '720'
                    - '1440'
                  description: >-
                    Configures the time after which a user will be able to enter
                    an alarmgroup again. The value is given in minutes.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    type: boolean
                    example: false
                    description: >-
                      Enables the anti-passback module. This will prevent a user
                      (pin/rfid-token) from entering the same alarmgroup
                      multiple times in short succession. After the configured
                      timeout a booked in user will be able to enter again.
                  timeout:
                    type: string
                    example: '30'
                    enum:
                      - 'off'
                      - '10'
                      - '15'
                      - '30'
                      - '60'
                      - '120'
                      - '480'
                      - '720'
                      - '1440'
                    description: >-
                      Configures the time after which a user will be able to
                      enter an alarmgroup again. The value is given in minutes.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/anti-passback/users:
    get:
      tags:
        - anti-passback-users
      description: Get a list of all users who are booked into an alarmgroup.
      summary: Get booked in users
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          example: 1
                          description: API/SNMP-ID of the user
                        username:
                          type: string
                          example: exmpl_usr
                          description: Username of the user
                        fullname:
                          type: string
                          example: Example User
                          description: Full name of the user
                        location:
                          type: number
                          example: 1
                          description: API/SNMP-ID of the alarmgroup the user entered last
                        entered_at:
                          type: string
                          format: date-time
                          example: '2024-10-03T10:00:00Z'
                          description: Timestamp of when the user entered the alarmgroup
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    delete:
      tags:
        - anti-passback
      description: Reset booking state of all users.
      summary: Reset booking state of all users
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/anti-passback/users/{user_id}:
    delete:
      tags:
        - anti-passback-users
      description: Reset booking state of a specific user.
      summary: Reset booking state of a user
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: user_id
          in: path
          required: true
          example: 1
          schema:
            type: number
            example: 1
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/backup:
    get:
      description: >-
        Requests the status of the last backup and the possible storage
        locations.
      summary: Get backup status
      tags:
        - backup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  latest:
                    type: object
                    readOnly: true
                    properties:
                      status:
                        example: true
                        type: boolean
                        description: Describes if the last backup succeeded.
                      message:
                        type: object
                        nullable: true
                        description: Describes if there is a message about the last backup.
                        properties:
                          status:
                            example: ok
                            type: string
                            enum:
                              - ok
                              - error
                            description: Status of the last backup.
                          address:
                            example: 192.188.100.224
                            type: string
                            description: |
                              New IP address of the device.

                              Exist only when status is `ok`.
                          type:
                            example: >-
                              Another system process is already running. Please
                              try again later.
                            type: string
                            description: |
                              Type of the error that occurred.

                              Exist only when status is `error`.
                      destination:
                        example: download
                        type: string
                        nullable: true
                        description: >-
                          Describes the location where the last backup was
                          stored.
                      event:
                        example: manual
                        type: string
                        nullable: true
                        description: Describes the event of the latest backup.
                      created_at:
                        example: '1675340108'
                        type: string
                        nullable: true
                        description: >-
                          Describes the Unix timestamp (seconds) when the last
                          backup was created.
                      is_uptodate:
                        example: false
                        type: boolean
                        description: >-
                          Describes if the last backup was less than 15 minutes
                          ago.
                      human_diff:
                        example: 2 weeks ago
                        type: string
                        nullable: true
                        description: Describes when a backup was last created.
                  available_destinations:
                    type: object
                    readOnly: true
                    properties:
                      sd_card:
                        example: false
                        type: boolean
                        description: Describes if an SD card is available.
                      internal:
                        example: false
                        type: boolean
                        description: >-
                          Describes if an SD card is not available but an
                          internal storage.
                      network_drives:
                        type: object
                        properties:
                          label:
                            example: ''
                            type: string
                            description: Describes an available network drive.
                  password:
                    example: password
                    type: string
                    writeOnly: true
                    nullable: true
                    maximum: 250
                    description: Password for encryption of the backup.
                  destination:
                    example: download
                    type: string
                    writeOnly: true
                    description: Destination for the backup.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      description: Creates a new backup.
      summary: Create backup
      tags:
        - backup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                latest:
                  type: object
                  readOnly: true
                  properties:
                    status:
                      example: true
                      type: boolean
                      description: Describes if the last backup succeeded.
                    message:
                      type: object
                      nullable: true
                      description: Describes if there is a message about the last backup.
                      properties:
                        status:
                          example: ok
                          type: string
                          enum:
                            - ok
                            - error
                          description: Status of the last backup.
                        address:
                          example: 192.188.100.224
                          type: string
                          description: |
                            New IP address of the device.

                            Exist only when status is `ok`.
                        type:
                          example: >-
                            Another system process is already running. Please
                            try again later.
                          type: string
                          description: |
                            Type of the error that occurred.

                            Exist only when status is `error`.
                    destination:
                      example: download
                      type: string
                      nullable: true
                      description: Describes the location where the last backup was stored.
                    event:
                      example: manual
                      type: string
                      nullable: true
                      description: Describes the event of the latest backup.
                    created_at:
                      example: '1675340108'
                      type: string
                      nullable: true
                      description: >-
                        Describes the Unix timestamp (seconds) when the last
                        backup was created.
                    is_uptodate:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the last backup was less than 15 minutes
                        ago.
                    human_diff:
                      example: 2 weeks ago
                      type: string
                      nullable: true
                      description: Describes when a backup was last created.
                available_destinations:
                  type: object
                  readOnly: true
                  properties:
                    sd_card:
                      example: false
                      type: boolean
                      description: Describes if an SD card is available.
                    internal:
                      example: false
                      type: boolean
                      description: >-
                        Describes if an SD card is not available but an internal
                        storage.
                    network_drives:
                      type: object
                      properties:
                        label:
                          example: ''
                          type: string
                          description: Describes an available network drive.
                password:
                  example: password
                  type: string
                  writeOnly: true
                  nullable: true
                  maximum: 250
                  description: Password for encryption of the backup.
                destination:
                  example: download
                  type: string
                  writeOnly: true
                  description: Destination for the backup.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  latest:
                    type: object
                    readOnly: true
                    properties:
                      status:
                        example: true
                        type: boolean
                        description: Describes if the last backup succeeded.
                      message:
                        type: object
                        nullable: true
                        description: Describes if there is a message about the last backup.
                        properties:
                          status:
                            example: ok
                            type: string
                            enum:
                              - ok
                              - error
                            description: Status of the last backup.
                          address:
                            example: 192.188.100.224
                            type: string
                            description: |
                              New IP address of the device.

                              Exist only when status is `ok`.
                          type:
                            example: >-
                              Another system process is already running. Please
                              try again later.
                            type: string
                            description: |
                              Type of the error that occurred.

                              Exist only when status is `error`.
                      destination:
                        example: download
                        type: string
                        nullable: true
                        description: >-
                          Describes the location where the last backup was
                          stored.
                      event:
                        example: manual
                        type: string
                        nullable: true
                        description: Describes the event of the latest backup.
                      created_at:
                        example: '1675340108'
                        type: string
                        nullable: true
                        description: >-
                          Describes the Unix timestamp (seconds) when the last
                          backup was created.
                      is_uptodate:
                        example: false
                        type: boolean
                        description: >-
                          Describes if the last backup was less than 15 minutes
                          ago.
                      human_diff:
                        example: 2 weeks ago
                        type: string
                        nullable: true
                        description: Describes when a backup was last created.
                  available_destinations:
                    type: object
                    readOnly: true
                    properties:
                      sd_card:
                        example: false
                        type: boolean
                        description: Describes if an SD card is available.
                      internal:
                        example: false
                        type: boolean
                        description: >-
                          Describes if an SD card is not available but an
                          internal storage.
                      network_drives:
                        type: object
                        properties:
                          label:
                            example: ''
                            type: string
                            description: Describes an available network drive.
                  password:
                    example: password
                    type: string
                    writeOnly: true
                    nullable: true
                    maximum: 250
                    description: Password for encryption of the backup.
                  destination:
                    example: download
                    type: string
                    writeOnly: true
                    description: Destination for the backup.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/backup/download:
    get:
      description: Downloads the latest backup and then deletes the backup.
      summary: Download backup
      tags:
        - backup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            text/plain:
              schema:
                type: string
                format: base64
                description: Backup as binary file
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/backup/restore:
    post:
      description: Restores a provided backup.
      summary: Restore backup
      tags:
        - backup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - backup
              properties:
                backup:
                  type: string
                  format: base64
                  description: Backup as binary file
                password:
                  type: string
                  description: Password of the encrypted backup.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - error
                    description: Status of the backup restore.
                  address:
                    example: 192.188.100.224
                    type: string
                    description: >-
                      New IP address of the device. Exist only when status is
                      `ok`.
                  type:
                    example: The backup file is not compatible with this device.
                    type: string
                    description: >-
                      Type of the error that occurred. Exist only when status is
                      `error`.
        '400':
          description: Bad Request - Cannot or will not handle the request.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/autobackup:
    get:
      description: Requests the status of the automatic backup configuration.
      summary: Get automatic backup configuration
      tags:
        - autobackup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: object
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes it automatic backup is en-/disabled.
                      time:
                        example: '00:00'
                        type: string
                        format: HH:mm
                        description: Describes at which time the backup should be created.
                      type:
                        example: 2
                        type: integer
                        minimum: 1
                        maximum: 2
                        description: >-
                          Describes the selected Storage Drive [1 => SD-Card; 2
                          => Network Drive (SMB)]
                      delete_after_days:
                        example: 1
                        type: integer
                        minimum: 0
                        maximum: 7
                        description: |
                          Describes how long Backups should be stored.

                          0 (never) is only for type 2 allowed.
                      address:
                        example: 0.0.0.0
                        type: string
                        nullable: true
                        description: |
                          Describes the IP-Address of the Network Drive.

                          Needed when type is 2.
                      share:
                        example: SMB Rack
                        type: string
                        nullable: true
                        description: |
                          Describes the share name.

                          Needed when type is 2.
                      path:
                        example: /home/kentix/backup
                        type: string
                        nullable: true
                        description: Describes the storage path.
                      username:
                        example: root
                        type: string
                        nullable: true
                        description: Describes the username for the SMB share.
                      password:
                        example: password
                        type: string
                        nullable: true
                        description: Describes the password for the SMB share.
                      send_notification:
                        example: true
                        type: boolean
                        description: >-
                          Describes if a notification should be send after a
                          backup was created.
                  history:
                    type: object
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes it automatic backup is en-/disabled.
                      time:
                        example: '00:00'
                        type: string
                        format: HH:mm
                        description: Describes at which time the backup should be created.
                      type:
                        example: 2
                        type: integer
                        minimum: 1
                        maximum: 2
                        description: >-
                          Describes the selected Storage Drive [1 => SD-Card; 2
                          => Network Drive (SMB)]
                      delete_after_days:
                        example: 1
                        type: integer
                        minimum: 0
                        maximum: 7
                        description: |
                          Describes how long Backups should be stored.

                          0 (never) is only for type 2 allowed.
                      address:
                        example: 0.0.0.0
                        type: string
                        nullable: true
                        description: |
                          Describes the IP-Address of the Network Drive.

                          Needed when type is 2.
                      share:
                        example: SMB Rack
                        type: string
                        nullable: true
                        description: |
                          Describes the share name.

                          Needed when type is 2.
                      path:
                        example: /home/kentix/backup
                        type: string
                        nullable: true
                        description: Describes the storage path.
                      username:
                        example: root
                        type: string
                        nullable: true
                        description: Describes the username for the SMB share.
                      password:
                        example: password
                        type: string
                        nullable: true
                        description: Describes the password for the SMB share.
                      send_notification:
                        example: true
                        type: boolean
                        description: >-
                          Describes if a notification should be send after a
                          backup was created.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the automatic backup configuration.
      summary: Update automatic backup configuration
      tags:
        - autobackup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                settings:
                  type: object
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: Describes it automatic backup is en-/disabled.
                    time:
                      example: '00:00'
                      type: string
                      format: HH:mm
                      description: Describes at which time the backup should be created.
                    type:
                      example: 2
                      type: integer
                      minimum: 1
                      maximum: 2
                      description: >-
                        Describes the selected Storage Drive [1 => SD-Card; 2 =>
                        Network Drive (SMB)]
                    delete_after_days:
                      example: 1
                      type: integer
                      minimum: 0
                      maximum: 7
                      description: |
                        Describes how long Backups should be stored.

                        0 (never) is only for type 2 allowed.
                    address:
                      example: 0.0.0.0
                      type: string
                      nullable: true
                      description: |
                        Describes the IP-Address of the Network Drive.

                        Needed when type is 2.
                    share:
                      example: SMB Rack
                      type: string
                      nullable: true
                      description: |
                        Describes the share name.

                        Needed when type is 2.
                    path:
                      example: /home/kentix/backup
                      type: string
                      nullable: true
                      description: Describes the storage path.
                    username:
                      example: root
                      type: string
                      nullable: true
                      description: Describes the username for the SMB share.
                    password:
                      example: password
                      type: string
                      nullable: true
                      description: Describes the password for the SMB share.
                    send_notification:
                      example: true
                      type: boolean
                      description: >-
                        Describes if a notification should be send after a
                        backup was created.
                history:
                  type: object
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: Describes it automatic backup is en-/disabled.
                    time:
                      example: '00:00'
                      type: string
                      format: HH:mm
                      description: Describes at which time the backup should be created.
                    type:
                      example: 2
                      type: integer
                      minimum: 1
                      maximum: 2
                      description: >-
                        Describes the selected Storage Drive [1 => SD-Card; 2 =>
                        Network Drive (SMB)]
                    delete_after_days:
                      example: 1
                      type: integer
                      minimum: 0
                      maximum: 7
                      description: |
                        Describes how long Backups should be stored.

                        0 (never) is only for type 2 allowed.
                    address:
                      example: 0.0.0.0
                      type: string
                      nullable: true
                      description: |
                        Describes the IP-Address of the Network Drive.

                        Needed when type is 2.
                    share:
                      example: SMB Rack
                      type: string
                      nullable: true
                      description: |
                        Describes the share name.

                        Needed when type is 2.
                    path:
                      example: /home/kentix/backup
                      type: string
                      nullable: true
                      description: Describes the storage path.
                    username:
                      example: root
                      type: string
                      nullable: true
                      description: Describes the username for the SMB share.
                    password:
                      example: password
                      type: string
                      nullable: true
                      description: Describes the password for the SMB share.
                    send_notification:
                      example: true
                      type: boolean
                      description: >-
                        Describes if a notification should be send after a
                        backup was created.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: object
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes it automatic backup is en-/disabled.
                      time:
                        example: '00:00'
                        type: string
                        format: HH:mm
                        description: Describes at which time the backup should be created.
                      type:
                        example: 2
                        type: integer
                        minimum: 1
                        maximum: 2
                        description: >-
                          Describes the selected Storage Drive [1 => SD-Card; 2
                          => Network Drive (SMB)]
                      delete_after_days:
                        example: 1
                        type: integer
                        minimum: 0
                        maximum: 7
                        description: |
                          Describes how long Backups should be stored.

                          0 (never) is only for type 2 allowed.
                      address:
                        example: 0.0.0.0
                        type: string
                        nullable: true
                        description: |
                          Describes the IP-Address of the Network Drive.

                          Needed when type is 2.
                      share:
                        example: SMB Rack
                        type: string
                        nullable: true
                        description: |
                          Describes the share name.

                          Needed when type is 2.
                      path:
                        example: /home/kentix/backup
                        type: string
                        nullable: true
                        description: Describes the storage path.
                      username:
                        example: root
                        type: string
                        nullable: true
                        description: Describes the username for the SMB share.
                      password:
                        example: password
                        type: string
                        nullable: true
                        description: Describes the password for the SMB share.
                      send_notification:
                        example: true
                        type: boolean
                        description: >-
                          Describes if a notification should be send after a
                          backup was created.
                  history:
                    type: object
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes it automatic backup is en-/disabled.
                      time:
                        example: '00:00'
                        type: string
                        format: HH:mm
                        description: Describes at which time the backup should be created.
                      type:
                        example: 2
                        type: integer
                        minimum: 1
                        maximum: 2
                        description: >-
                          Describes the selected Storage Drive [1 => SD-Card; 2
                          => Network Drive (SMB)]
                      delete_after_days:
                        example: 1
                        type: integer
                        minimum: 0
                        maximum: 7
                        description: |
                          Describes how long Backups should be stored.

                          0 (never) is only for type 2 allowed.
                      address:
                        example: 0.0.0.0
                        type: string
                        nullable: true
                        description: |
                          Describes the IP-Address of the Network Drive.

                          Needed when type is 2.
                      share:
                        example: SMB Rack
                        type: string
                        nullable: true
                        description: |
                          Describes the share name.

                          Needed when type is 2.
                      path:
                        example: /home/kentix/backup
                        type: string
                        nullable: true
                        description: Describes the storage path.
                      username:
                        example: root
                        type: string
                        nullable: true
                        description: Describes the username for the SMB share.
                      password:
                        example: password
                        type: string
                        nullable: true
                        description: Describes the password for the SMB share.
                      send_notification:
                        example: true
                        type: boolean
                        description: >-
                          Describes if a notification should be send after a
                          backup was created.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/autobackup/test:
    get:
      description: >-
        Checks if the current Network Drive (SMB) configuration is correct /
        works.
      summary: Check SMB configuration
      tags:
        - autobackup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  has_response:
                    example: true
                    type: boolean
                    readOnly: true
                    description: Describes whether the check has been handled.
                  response_code:
                    example: 0
                    type: integer
                    readOnly: true
                    description: |
                      1 => Network Drive not mounted<br>
                      2 => Path is invalid<br>
                      3 => No permissions granted
                  address:
                    example: 0.0.0.0
                    type: string
                    writeOnly: true
                    description: Describes the IP-Address of the Network Drive.
                  share:
                    example: SMB Rack
                    type: string
                    writeOnly: true
                    description: |
                      Describes the share name.

                      Needed when type is 2.
                  path:
                    example: /home/kentix/backup
                    type: string
                    nullable: true
                    writeOnly: true
                    description: Describes the storage path.
                  username:
                    example: root
                    type: string
                    nullable: true
                    writeOnly: true
                    description: Describes the username for the SMB share.
                  password:
                    example: password
                    type: string
                    nullable: true
                    writeOnly: true
                    description: Describes the password for the SMB share.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      description: Tests the current Network Drive (SMB) configuration.
      summary: Test SMB configuration
      tags:
        - autobackup
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                has_response:
                  example: true
                  type: boolean
                  readOnly: true
                  description: Describes whether the check has been handled.
                response_code:
                  example: 0
                  type: integer
                  readOnly: true
                  description: |
                    1 => Network Drive not mounted<br>
                    2 => Path is invalid<br>
                    3 => No permissions granted
                address:
                  example: 0.0.0.0
                  type: string
                  writeOnly: true
                  description: Describes the IP-Address of the Network Drive.
                share:
                  example: SMB Rack
                  type: string
                  writeOnly: true
                  description: |
                    Describes the share name.

                    Needed when type is 2.
                path:
                  example: /home/kentix/backup
                  type: string
                  nullable: true
                  writeOnly: true
                  description: Describes the storage path.
                username:
                  example: root
                  type: string
                  nullable: true
                  writeOnly: true
                  description: Describes the username for the SMB share.
                password:
                  example: password
                  type: string
                  nullable: true
                  writeOnly: true
                  description: Describes the password for the SMB share.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  has_response:
                    example: true
                    type: boolean
                    readOnly: true
                    description: Describes whether the check has been handled.
                  response_code:
                    example: 0
                    type: integer
                    readOnly: true
                    description: |
                      1 => Network Drive not mounted<br>
                      2 => Path is invalid<br>
                      3 => No permissions granted
                  address:
                    example: 0.0.0.0
                    type: string
                    writeOnly: true
                    description: Describes the IP-Address of the Network Drive.
                  share:
                    example: SMB Rack
                    type: string
                    writeOnly: true
                    description: |
                      Describes the share name.

                      Needed when type is 2.
                  path:
                    example: /home/kentix/backup
                    type: string
                    nullable: true
                    writeOnly: true
                    description: Describes the storage path.
                  username:
                    example: root
                    type: string
                    nullable: true
                    writeOnly: true
                    description: Describes the username for the SMB share.
                  password:
                    example: password
                    type: string
                    nullable: true
                    writeOnly: true
                    description: Describes the password for the SMB share.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/cameras:
    get:
      description: Requests a list of all camera names the user has access to.
      summary: Get cameras
      tags:
        - cameras
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: Id of the camera
                        is_active:
                          example: true
                          type: boolean
                          description: True if the camera is active
                        name:
                          example: Camera
                          type: string
                          description: Name of the camera
                        address:
                          example: address
                          type: string
                          description: IP Address of the camera
                        group_id:
                          example: 1
                          type: integer
                          description: The group id to which the camera belongs to
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/cameras/names:
    get:
      description: Requests a list of all camera names the user has access to.
      summary: Get camera names
      tags:
        - cameras-names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of the camera
                    name:
                      example: Camera
                      type: string
                      description: Name of the camera
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/cameras/{camera_id}:
    get:
      description: Requests all detail of a specific camera via the id.
      summary: Get camera informations
      tags:
        - camera_id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: camera_id
          in: path
          description: ID of the camera to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: Id of the camera.
                  is_active:
                    example: true
                    type: boolean
                    description: True if the camera is active.
                  name:
                    example: Camera
                    type: string
                    description: Name of the camera.
                  camera_location:
                    example: outdoor
                    type: string
                    description: >-
                      Mounting area of the camera, can be: indoor, outdoor.
                      Outdoor cameras use a prebuffer to capture persons before
                      the actual booking.
                  protocol:
                    example: http
                    type: string
                    description: 'Communication protocol, can be: http, https.'
                  address:
                    example: 192.168.100.2
                    type: string
                    description: Network address of the camera.
                  profile:
                    example: ipro
                    type: string
                    description: Manufacturer of the camera.
                  capture_path:
                    example: /image/picture.png
                    type: string
                    description: Path/URL to get the images of the camera.
                  stream_path:
                    example: /video/
                    type: string
                    description: Path/URL to get the livestream of the camera.
                  username:
                    example: user
                    type: string
                    description: Username for logging in on the camera, if needed.
                  passsword:
                    example: password
                    type: string
                    description: Password for logging in on the camera, if needed.
                  append_mail:
                    example: false
                    type: boolean
                    description: If true the system appends an image to the alarm e-mail
                  alarm_assignments:
                    example:
                      - armed-active
                      - always-active
                    type: array
                    items:
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                    description: Array of all alarm assignments of the specific camera
                  group_id:
                    example: 1
                    type: integer
                    description: Group Id which the camera belongs to.
                  rack_id:
                    example: 1
                    type: integer
                    description: Rack Id which the camera belongs to.
                  webhooks:
                    example:
                      - 1
                      - 2
                    type: array
                    items:
                      type: integer
                    description: Integer Array of the webhooks
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: >-
        Updates the configuration of a specific camera. Validation errors are
        returned in the response body with HTTP 422.
      summary: Update a camera via the ID
      tags:
        - camera_id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: camera_id
          in: path
          description: ID of the camera to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Camera configuration to be updated.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  example: Camera
                  type: string
                  description: Name of the camera.
                camera_location:
                  example: outdoor
                  type: string
                  description: >-
                    Mounting area of the camera, can be: indoor, outdoor.
                    Outdoor cameras use a prebuffer to capture persons before
                    the actual booking.
                protocol:
                  example: http
                  type: string
                  description: 'Communication protocol, can be: http, https.'
                address:
                  example: 192.168.100.2
                  type: string
                  description: Network address of the camera.
                profile:
                  example: ipro
                  type: string
                  description: Manufacturer of the camera.
                capture_path:
                  example: /image/picture.png
                  type: string
                  description: Path/URL to get the images of the camera.
                username:
                  example: user
                  type: string
                  description: Username for logging in on the camera, if needed.
                passsword:
                  example: password
                  type: string
                  description: Password for logging in on the camera, if needed.
                append_mail:
                  example: false
                  type: boolean
                  description: If true the system appends an image to the alarm e-mail
                image_count:
                  example: 10
                  type: integer
                  description: Sets the number of images to be stored for every booking.
                prebuffer_count:
                  example: 4
                  type: integer
                  description: >-
                    Sets the number of images BEFORE the actual booking to be
                    stored, outdoor cameras only. Counts to the actual
                    image_count, e.g. if 10 images should be stored and
                    prebuffer is 4, only 6 additional imaged AFTER the booking
                    are stored.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of the camera.
                    is_active:
                      example: true
                      type: boolean
                      description: True if the camera is active.
                    name:
                      example: Camera
                      type: string
                      description: Name of the camera.
                    camera_location:
                      example: outdoor
                      type: string
                      description: >-
                        Mounting area of the camera, can be: indoor, outdoor.
                        Outdoor cameras use a prebuffer to capture persons
                        before the actual booking.
                    protocol:
                      example: http
                      type: string
                      description: 'Communication protocol, can be: http, https.'
                    address:
                      example: 192.168.100.2
                      type: string
                      description: Network address of the camera.
                    profile:
                      example: ipro
                      type: string
                      description: Manufacturer of the camera.
                    capture_path:
                      example: /image/picture.png
                      type: string
                      description: Path/URL to get the images of the camera.
                    stream_path:
                      example: /video/
                      type: string
                      description: Path/URL to get the livestream of the camera.
                    username:
                      example: user
                      type: string
                      description: Username for logging in on the camera, if needed.
                    passsword:
                      example: password
                      type: string
                      description: Password for logging in on the camera, if needed.
                    append_mail:
                      example: false
                      type: boolean
                      description: If true the system appends an image to the alarm e-mail
                    alarm_assignments:
                      example:
                        - armed-active
                        - always-active
                      type: array
                      items:
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                      description: Array of all alarm assignments of the specific camera
                    group_id:
                      example: 1
                      type: integer
                      description: Group Id which the camera belongs to.
                    rack_id:
                      example: 1
                      type: integer
                      description: Rack Id which the camera belongs to.
                    webhooks:
                      example:
                        - 1
                        - 2
                      type: array
                      items:
                        type: integer
                      description: Integer Array of the webhooks
                    connection:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of the connection
                        warning:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: true
                              description: >-
                                Configures whether connection issues should be
                                displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/cameras/{camera_id}/image:
    get:
      description: Requests the live image of a specific camera via the id.
      summary: Get camera live image
      tags:
        - camera_live_image
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: camera_id
          in: path
          description: ID of the camera to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: string
                format: base64
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/cloud-status:
    get:
      description: Requests status information of KentixONE Onlineservice connection state.
      summary: Get KentixONE Onlineservice information
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  has_token:
                    example: true
                    type: boolean
                    description: >-
                      Describes if a KentixONE Onlineservice bearer token is
                      available on the device to authenticate in KentixONE
                      Onlineservice.
                  is_active:
                    example: false
                    type: boolean
                    description: Describes if KentixONE Onlineservice service is active.
                  licence_type:
                    example: 1
                    type: integer
                    description: >-
                      Describes the type of the license. (0 - no license, 1 - S,
                      3 - M, 4 - L, 5 - XL)
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /api/cloud-managers:
    get:
      description: Requests the KentixONE Onlineservice License of a manager if registered.
      summary: Get manager license
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        licence:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                example: 1
                                type: integer
                                description: License ID
                              licence:
                                example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                                type: string
                                description: >-
                                  Shows the current activated KentixONE
                                  Onlineservice License.
                              type:
                                example: 4
                                type: integer
                                description: >-
                                  Describes the type of the license. (0 - no
                                  license, 1 - S, 3 - M, 4 - L, 5 - XL).
                              start_at:
                                example: '2022-03-31T07:29:20.000000Z'
                                type: string
                                description: Date when the license starts.
                                nullable: true
                              stop_at:
                                example: '2022-03-31T07:29:20.000000Z'
                                type: string
                                description: Date when the license expires.
                                nullable: true
                              is_active:
                                example: true
                                type: boolean
                                description: >-
                                  Describes if the KentixONE Onlineservice
                                  license is active.
                              is_canceled:
                                example: false
                                type: boolean
                                description: >-
                                  Describes if the KentixONE Onlineservice
                                  license is canceled.
                              serialnumber:
                                example: '1337000011234'
                                type: string
                                description: >-
                                  Describes the serialnumber registered to the
                                  license.
                              physical_devices:
                                example: 250
                                type: integer
                                description: >-
                                  Describes the amount of possible physical
                                  devices with the registered license.
                              virtual_devices:
                                example: 500
                                type: integer
                                description: >-
                                  Describes the amount of possible virtual
                                  devices with the registered license.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
    put:
      description: Add or update a KentixONE Onlineservice license.
      summary: Store/Update KentixONE Onlineservice license
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - licence
              properties:
                licence:
                  example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                  type: string
                  description: KentixONE Onlineservice License to be activated.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    example: 1
                    type: integer
                    description: License ID
                  name:
                    example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                    type: string
                    description: >-
                      Shows the current activated KentixONE Onlineservice
                      License.
                  type:
                    example: 4
                    type: integer
                    description: >-
                      Describes the type of the license. (0 - no license, 1 - S,
                      3 - M, 4 - L, 5 - XL).
                  serialnumber:
                    example: '1337000011234'
                    type: string
                    description: Describes the serialnumber registered to the license.
                  otp_required:
                    example: '2022-03-31T07:29:20.000000Z'
                    type: boolean
                    description: Date when the license expires.
                    nullable: true
                  licence:
                    type: object
                    properties:
                      id:
                        example: 1
                        type: integer
                        description: License ID
                      licence:
                        example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                        type: string
                        description: >-
                          Shows the current activated KentixONE Onlineservice
                          License.
                      type:
                        example: 4
                        type: integer
                        description: >-
                          Describes the type of the license. (0 - no license, 1
                          - S, 3 - M, 4 - L, 5 - XL).
                      start_at:
                        example: '2022-03-31T07:29:20.000000Z'
                        type: string
                        description: Date when the license starts.
                        nullable: true
                      stop_at:
                        example: '2022-03-31T07:29:20.000000Z'
                        type: string
                        description: Date when the license expires.
                        nullable: true
                      is_active:
                        example: true
                        type: boolean
                        description: >-
                          Describes if the KentixONE Onlineservice license is
                          active.
                      is_canceled:
                        example: false
                        type: boolean
                        description: >-
                          Describes if the KentixONE Onlineservice license is
                          canceled.
                      serialnumber:
                        example: '1337000011234'
                        type: string
                        description: Describes the serialnumber registered to the license.
                      physical_devices:
                        example: 250
                        type: integer
                        description: >-
                          Describes the amount of possible physical devices with
                          the registered license.
                      virtual_devices:
                        example: 500
                        type: integer
                        description: >-
                          Describes the amount of possible virtual devices with
                          the registered license.
                  license:
                    example: >-
                      U2FsdGVkX19u+BENt371XUqleug+Ug3wn3+1TBrcpv5OQWekz7Bd844+K2Uk63UpQ8KBnCTmKm2e059l7AV3bA==
                    type: string
                    description: >-
                      Describes the current activated KentixONE Onlineservice
                      License encrypted.
                  subdomain:
                    example: auth.cloud.kentixone.com
                    type: string
                    description: >-
                      Describes the subdomain where the Manager connects to
                      KentixONE Onlineservice.
                  token:
                    example: iXJFjObE9UeAxmzhR188EEfncn6yu3YUv1jFoAe1Nv
                    type: string
                    description: >-
                      Describes the token for Manager to authenticate with
                      KentixONE Onlineservice.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
    patch:
      description: Set KentixONE Onlineservice active/inactive on Manager.
      summary: Set KentixONE Onlineservice active/inactive
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - is_active
              properties:
                is_active:
                  example: true
                  type: boolean
                  description: KentixONE Onlineservice active/inactive.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /api/cloud-managers/licence/replace:
    patch:
      description: Upgrade/Downgrade a KentixONE Onlineservice license.
      summary: Upgrade/Downgrade KentixONE Onlineservice license
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - licence
              properties:
                licence:
                  example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                  type: string
                  description: KentixONE Onlineservice License to be activated.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    example: 1
                    type: integer
                    description: License ID
                  name:
                    example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                    type: string
                    description: >-
                      Shows the current activated KentixONE Onlineservice
                      License.
                  type:
                    example: 4
                    type: integer
                    description: >-
                      Describes the type of the license. (0 - no license, 1 - S,
                      3 - M, 4 - L, 5 - XL).
                  serialnumber:
                    example: '1337000011234'
                    type: string
                    description: Describes the serialnumber registered to the license.
                  otp_required:
                    example: '2022-03-31T07:29:20.000000Z'
                    type: boolean
                    description: Date when the license expires.
                    nullable: true
                  licence:
                    type: object
                    properties:
                      id:
                        example: 1
                        type: integer
                        description: License ID
                      licence:
                        example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
                        type: string
                        description: >-
                          Shows the current activated KentixONE Onlineservice
                          License.
                      type:
                        example: 4
                        type: integer
                        description: >-
                          Describes the type of the license. (0 - no license, 1
                          - S, 3 - M, 4 - L, 5 - XL).
                      start_at:
                        example: '2022-03-31T07:29:20.000000Z'
                        type: string
                        description: Date when the license starts.
                        nullable: true
                      stop_at:
                        example: '2022-03-31T07:29:20.000000Z'
                        type: string
                        description: Date when the license expires.
                        nullable: true
                      is_active:
                        example: true
                        type: boolean
                        description: >-
                          Describes if the KentixONE Onlineservice license is
                          active.
                      is_canceled:
                        example: false
                        type: boolean
                        description: >-
                          Describes if the KentixONE Onlineservice license is
                          canceled.
                      serialnumber:
                        example: '1337000011234'
                        type: string
                        description: Describes the serialnumber registered to the license.
                      physical_devices:
                        example: 250
                        type: integer
                        description: >-
                          Describes the amount of possible physical devices with
                          the registered license.
                      virtual_devices:
                        example: 500
                        type: integer
                        description: >-
                          Describes the amount of possible virtual devices with
                          the registered license.
                  license:
                    example: >-
                      U2FsdGVkX19u+BENt371XUqleug+Ug3wn3+1TBrcpv5OQWekz7Bd844+K2Uk63UpQ8KBnCTmKm2e059l7AV3bA==
                    type: string
                    description: >-
                      Describes the current activated KentixONE Onlineservice
                      License encrypted.
                  subdomain:
                    example: auth.cloud.kentixone.com
                    type: string
                    description: >-
                      Describes the subdomain where the Manager connects to
                      KentixONE Onlineservice.
                  token:
                    example: iXJFjObE9UeAxmzhR188EEfncn6yu3YUv1jFoAe1Nv
                    type: string
                    description: >-
                      Describes the token for Manager to authenticate with
                      KentixONE Onlineservice.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /api/cloud-users:
    put:
      description: Invite or revoke permission of an user for the KentixONE Onlineservice.
      summary: Invite/Revoke user to KentixONE Onlineservice
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: User access invitation/revocation details
        content:
          application/json:
            schema:
              type: object
              required:
                - email
                - user_id
                - nfc_only
              properties:
                email:
                  example: mail@example.org
                  type: string
                  description: Email address of the user to be invited/revoked.
                user_id:
                  example: 10
                  type: integer
                  description: Id of the user to be invited/revoked.
                nfc_only:
                  example: false
                  type: boolean
                  description: Remote open permission only via NFC
                overwrite_existing_user:
                  example: false
                  type: boolean
                  description: Force overwrite existing user with another email.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: User ID
                  email:
                    example: mail@example.com
                    type: string
                    description: Shows the email address of the user.
                  otp_active:
                    example: true
                    type: boolean
                    description: Shows if the user has otp active.
                    nullable: true
                  activation:
                    example: 1
                    type: integer
                    description: Shows the activation status of the user.
                  nfc_only:
                    example: true
                    type: boolean
                    description: Shows if the user can only remote open via NFC.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/cloud-users/{user_id}:
    get:
      description: Checks the user status in the KentixONE Onlineservice.
      summary: Get User KentixONE Onlineservice status
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: User ID
                  email:
                    example: mail@example.com
                    type: string
                    description: Shows the email address of the user.
                  otp_active:
                    example: true
                    type: boolean
                    description: Shows if the user has otp active.
                    nullable: true
                  activation:
                    example: 1
                    type: integer
                    description: Shows the activation status of the user.
                  nfc_only:
                    example: true
                    type: boolean
                    description: Shows if the user can only remote open via NFC.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
    patch:
      description: Updating email address of a user in the KentixONE Onlineservice.
      summary: Updates email address of a user in KentixONE Onlineservice
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  example: example@kentix.com
                  type: string
                  description: New email address of the user.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: User ID
                  email:
                    example: mail@example.com
                    type: string
                    description: Shows the email address of the user.
                  otp_active:
                    example: true
                    type: boolean
                    description: Shows if the user has otp active.
                    nullable: true
                  activation:
                    example: 1
                    type: integer
                    description: Shows the activation status of the user.
                  nfc_only:
                    example: true
                    type: boolean
                    description: Shows if the user can only remote open via NFC.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
    delete:
      description: Revoke access of an user for the KentixONE Onlineservice.
      summary: Revokes user access to KentixONE Onlineservice
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '204':
          description: Successful operation without content
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /api/cloud-users/resend/{user_id}:
    put:
      description: Resend the invitation email to a user for the KentixONE Onlineservice.
      summary: Resend user invitation
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: User ID
                  email:
                    example: mail@example.com
                    type: string
                    description: Shows the email address of the user.
                  otp_active:
                    example: true
                    type: boolean
                    description: Shows if the user has otp active.
                    nullable: true
                  activation:
                    example: 1
                    type: integer
                    description: Shows the activation status of the user.
                  nfc_only:
                    example: true
                    type: boolean
                    description: Shows if the user can only remote open via NFC.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /api/push-test/{user_id}:
    put:
      description: >-
        Triggers sending a test push notification to the user to be displayed by
        mobile app.
      summary: Sends a test push notification to the user
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '204':
          description: Successful operation without content
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /shared-access/new/share:
    post:
      description: >-
        Share KentixONE Onlineservice access including doorlocks, timeprofile
        and (access) limited cloud permissions, with a user. This user is marked
        as a guest and only has access to the shared doorlocks and the assigned
        timeprofile.
      summary: Share DoorLock access with a user via the KentixONE Onlineservice
      tags:
        - cloud
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: User access invitation/revocation details
        content:
          application/json:
            schema:
              type: object
              required:
                - doorlocks
                - timeprofile
              properties:
                doorlocks:
                  type: array
                  items:
                    example: 5
                    type: integer
                    description: Doorlock IDs to share access with.
                timeprofile:
                  example: 10
                  type: integer
                  description: Timeprofile ID for doorlock access.
                user_uuid:
                  example: 7faa0e2d-2ba6-43d8-bbbf-9e20593f3e95
                  type: string
                  description: User UUID to share access with.
                user_email:
                  example: test@kentix.com
                  type: string
                  description: User email to share access with.
                user_unlock_at:
                  example: '2025-03-21T11:00:00.000Z'
                  type: string
                  description: Unlock user at specific time.
                user_lock_at:
                  example: '2025-03-21T11:00:00.000Z'
                  type: string
                  description: Lock user at specific time.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: User ID
                  email:
                    example: mail@example.com
                    type: string
                    description: Shows the email address of the user.
                  otp_active:
                    example: true
                    type: boolean
                    description: Shows if the user has otp active.
                    nullable: true
                  activation:
                    example: 1
                    type: integer
                    description: Shows the activation status of the user.
                  nfc_only:
                    example: true
                    type: boolean
                    description: Shows if the user can only remote open via NFC.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/dashboard:
    get:
      tags:
        - dashboard
      description: Get the dashboard data.
      summary: Get dashboard data
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    description: The status of the system displayed in current alarm stats.
                    type: object
                    properties:
                      alarms:
                        example: 5
                        type: integer
                        description: The amount of current alarms
                      quitable_alarms:
                        example: 3
                        type: integer
                        description: The amount of current alarms ready to be quit
                      warnings:
                        example: 10
                        type: integer
                        description: The amount of current warnings
                      quitable_warnings:
                        example: 3
                        type: integer
                        description: The amount of current warnings ready to be quit
                      pre_alarms:
                        example: 1
                        type: integer
                        description: >-
                          The amount of alarms currently in idle due to
                          alarm_delay
                      inactive:
                        example: 2
                        type: integer
                        description: The amount of inactive devices in the system
                  events:
                    description: The last 10 events logged in the system
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 135927
                          type: integer
                          description: The ID of the event
                        timestamp:
                          example: 2023-03-03T08:11:27+0100
                          type: string
                          description: The time the event occurred
                        device:
                          example: MultiSensor Room 1
                          type: string
                          description: The name of the device the event occurred on
                        user:
                          example: null
                          type: string
                          description: >-
                            The name of the user that triggered the event. null
                            if no user was involved
                        function:
                          example: Alarm
                          type: string
                          description: The function of the event
                        detail:
                          example: Serverroom 1, MultiSensor Room 1, Room Temperature
                          type: string
                          description: The detail on the event
                        status:
                          example: alarm
                          type: string
                          description: >-
                            The status of the event. If the event is an alarm
                            the status "ok" indicates that the alarm was quit.
                        type:
                          example: alarm
                          type: string
                          enum:
                            - alarm
                            - access
                          description: >-
                            The type of the event, indicating which logbook it
                            belongs to.
                  active_alarms:
                    description: The last 5 alarms
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 269
                          type: integer
                          description: The ID of the alarm
                        alarmgroup_id:
                          example: 21
                          type: integer
                          description: >-
                            The ID of the alarmgroup in which the alarm was
                            triggered
                        alarmgroup:
                          example: Room 1
                          type: integer
                          description: >-
                            The name of the alarmgroup in which the alarm was
                            triggered
                        device_id:
                          example: 214
                          type: integer
                          description: The ID of the device which triggered the alarm
                        rack_id:
                          example: 43
                          type: integer
                          description: The ID of the rack in which the alarm was triggered
                        alarm_event_id:
                          example: 135927
                          type: integer
                          description: The ID of the event for the alarm
                        device:
                          example: MultiSensor Room 1
                          type: string
                          description: The name of the device the event occurred on
                        timestamp:
                          example: 2023-03-03T08:11:27+0100
                          type: string
                          description: The time the event occurred
                        value:
                          example: '30'
                          type: string
                          description: The value of the sensor that triggered the alarm
                        unit:
                          example: °C
                          type: string
                          description: The unit for the value
                        name:
                          example: Room Temperature
                          type: string
                          description: The name of the sensor that triggered the alarm
                        type:
                          example: '1'
                          type: string
                          description: The type of the alarm
                        assignment:
                          example: 5
                          type: integer
                          description: The assignment of the sensor
                        is_quitable:
                          example: false
                          type: boolean
                          description: Flag if the alarm is quitable
                  key_figures:
                    type: array
                    items:
                      type: object
                      properties:
                        category_name:
                          example: access
                          type: string
                          description: The name of the category
                        measurements:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                example: access_granted
                                type: string
                                description: The name of the measurement
                              value:
                                type: object
                                example:
                                  lastMonth: '77'
                                  currentMonth: '10'
                                description: The values of the measurement
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/date-time:
    get:
      description: Requests the date and time configuration of the device.
      summary: Get date and time configuration
      tags:
        - datetimeconfig
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    auto:
                      type: boolean
                      description: >-
                        If true, the device will automatically set the date and
                        time using the configured NTP server.
                      example: true
                    ntp1:
                      type: string
                      description: >-
                        The first NTP server to use for automatic date and time
                        configuration.
                      example: 0.pool.ntp.org
                    ntp2:
                      type: string
                      description: >-
                        The second NTP server to use for automatic date and time
                        configuration.
                      example: 1.pool.ntp.org
                    timezone:
                      type: string
                      description: >-
                        The timezone to use for automatic date and time
                        configuration.
                      example: Europe/Berlin
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the date and time configuration of the device.
      summary: Update date and time configuration
      tags:
        - datetimeconfig
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  auto:
                    type: boolean
                    description: >-
                      If true, the device will automatically set the date and
                      time using the configured NTP server.
                    example: true
                  ntp1:
                    type: string
                    description: >-
                      The first NTP server to use for automatic date and time
                      configuration.
                    example: 0.pool.ntp.org
                  ntp2:
                    type: string
                    description: >-
                      The second NTP server to use for automatic date and time
                      configuration.
                    example: 1.pool.ntp.org
                  timezone:
                    type: string
                    description: >-
                      The timezone to use for automatic date and time
                      configuration.
                    example: Europe/Berlin
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  auto:
                    type: boolean
                    description: >-
                      If true, the device will automatically set the date and
                      time using the configured NTP server.
                    example: true
                  ntp1:
                    type: string
                    description: >-
                      The first NTP server to use for automatic date and time
                      configuration.
                    example: 0.pool.ntp.org
                  ntp2:
                    type: string
                    description: >-
                      The second NTP server to use for automatic date and time
                      configuration.
                    example: 1.pool.ntp.org
                  timezone:
                    type: string
                    description: >-
                      The timezone to use for automatic date and time
                      configuration.
                    example: Europe/Berlin
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/system/info:
    get:
      tags:
        - device-info
      description: Get the Device-Info.
      summary: Get Device-Info
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      example: Manager
                      type: string
                      description: The name of the device
                    type:
                      example: KSM
                      type: string
                      description: The type code of the device type of the device
                    version:
                      example: 8.1.3 (Build 946)
                      type: string
                      description: The KentixONE version running on the device
                    serialnumber:
                      example: 1234567890987
                      type: integer
                      description: The serialnumber of the device
                    address:
                      example: 192.168.0.1
                      type: integer
                      description: The current address of the device
                    mac_address:
                      example: 12:34:56:78:90:ab
                      type: string
                      description: The MAC-Address of the device
                    mode:
                      example: Main Device
                      type: string
                      enum:
                        - Main Device
                        - Satellite Device
                        - Standalone Device
                    manager_address:
                      example: null
                      type: string
                      nullable: true
                      description: >-
                        The address of the managing device this device reports
                        to
                    mail_active:
                      example: 1
                      type: integer
                      description: The active status of the mailing function
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/doorlocks:
    get:
      description: Request a list of all DoorLocks the user has access to.
      summary: Get a list of all DoorLocks
      tags:
        - doorlocklist
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                      description: ID of the DoorLock
                      example: 2
                    device_id:
                      type: number
                      description: >-
                        ID of the DoorLock's host device, i.e. the device on
                        which is has been teached-in.
                      example: 1
                    name:
                      type: string
                      description: Name of the DoorLock
                      example: Frontdoor
                    is_active:
                      type: boolean
                      description: Describes if the DoorLock is active or inactive.
                      example: true
                    type:
                      type: number
                      description: Numerical devicetype
                      example: 21
                    group_id:
                      type: number
                      description: ID of the DoorLock's assigned alarmgroup
                      example: 2
                    batterylevel:
                      type: string
                      description: Battery level of the DoorLock
                      example: full
                      enum:
                        - full
                        - half
                        - low
                        - critical
                        - wired
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/doorlocks/{doorlock_id}:
    get:
      description: Requests the complete configuration of a specific DoorLock via its ID.
      summary: Get DoorLock by ID
      tags:
        - doorlocksingle
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: doorlock_id
          in: path
          description: ID of the DoorLock to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                    description: ID of the DoorLock
                    example: 2
                  device_id:
                    type: number
                    description: >-
                      ID of the DoorLock's host device, i.e. the device on which
                      is has been teached-in.
                    example: 1
                  is_active:
                    type: boolean
                    description: Describes if the DoorLock is active or inactive.
                    example: true
                  is_teachin_default:
                    type: boolean
                    description: >-
                      Describes if this DoorLock is preselected, when a RFID
                      token will be teached-id.
                    example: false
                  name:
                    type: string
                    description: Name of the DoorLock
                    example: Frontdoor
                  type:
                    type: number
                    description: Numerical devicetype
                    example: 21
                  signal_zonestate:
                    type: boolean
                    description: >-
                      Set true, if the DoorLock should show the current arm
                      state of the assigned alarmzone.
                    example: false
                  coupletime:
                    example: 3
                    type: number
                    description: >-
                      Time in seconds after the booking while the door can be
                      opened.
                  doubleauth_mode:
                    example: 0
                    type: number
                    nullable: true
                    description: >-
                      Mode for double authentication. 0=Off, 1=On, 2=Only when
                      arming/disarming, 3=time controlled via timeprofile.
                  doubleauth_timeprofile_id:
                    example: 0
                    type: number
                    nullable: true
                    description: >-
                      ID of the timeprofile which shall be used to enable and
                      disable the double authentication on specific times.
                  log_level:
                    example: 1
                    type: number
                    description: >-
                      Sets the logbook logging mode for this DoorLock.
                      1=Default, 2=No user-related data (names, pictures),
                      3=Only unauthorized bookings, 4=No logging.
                  timeprofile_mode:
                    example: 0
                    type: number
                    enum:
                      - 0
                      - 1
                      - 2
                    description: >-
                      Mode for timeprofile usage. 0=Off, 1=On, 2=Open after
                      first booking within the time profile.
                  timeprofile_id:
                    type: number
                    description: ID of the DoorLock's assigned timeprofile
                    example: 2
                  group_id:
                    type: number
                    description: ID of the DoorLock's assigned alarmgroup
                    example: 2
                  armlevel:
                    example: 0
                    type: number
                    enum:
                      - 0
                      - 1
                      - 2
                      - 3
                      - 4
                    description: >-
                      Set the arming level of this DoorLock. 0=Off, 1=Assigned
                      Alarmzone, 2=Building containing the assigned Alarmzone,
                      3=System, 4=External Alarmsystem.
                  webhooks:
                    type: array
                    items:
                      type: integer
                    description: IDs of all assigned webhooks.
                  cameras:
                    type: array
                    items:
                      type: integer
                    description: IDs of all assigned cameras.
                  batterylevel:
                    type: string
                    description: Battery level of the DoorLock
                    example: full
                    enum:
                      - full
                      - half
                      - low
                      - critical
                      - wired
                  reed_bypass_time:
                    type: number
                    description: >-
                      Time in seconds after the booking while the door can be
                      opened without reed contact alarming.
                    example: 30
                    enum:
                      - 0
                      - 5
                      - 10
                      - 15
                      - 30
                      - 45
                      - 60
                      - 90
                      - 120
                  reed_bypass_buzzer_time:
                    type: number
                    description: >-
                      Time in seconds to buzzer after the bypass time and before
                      triggering the door contact alarm.
                    example: 30
                    enum:
                      - 0
                      - 5
                      - 10
                      - 15
                      - 30
                      - 45
                      - 60
                      - 90
                      - 120
                  sabotage:
                    type: object
                    properties:
                      assignment:
                        example: always-active
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the disassembly alarm.
                  reed_source_id:
                    type: number
                    example: 'off'
                    description: >-
                      API-ID of the external sensor, which is assigned to be the
                      doorlock's reed sensor.
                  reed_assignment:
                    type: string
                    example: 'off'
                    description: Alarm-Assignment for the assigned reed sensor.
                  reed_delay:
                    type: number
                    example: 3600
                    description: >-
                      If the reed sensor triggers an alarm, it will be delayed
                      by this time (in seconds).
                  reed_warning_active:
                    type: boolean
                    example: true
                    description: >-
                      Enables signaling on the DoorLock if the door is open for
                      the set time (in seconds). The signaling will stop when
                      the door is closed again.
                  reed_warning_delay:
                    type: number
                    example: 1800
                    description: >-
                      The door must stay open for the set time to start the
                      signalization.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: >-
        Updates the configuration of a specific DoorLock. Validation errors are
        returned in the response body with HTTP 422.
      summary: Update DoorLock by ID
      tags:
        - doorlocksingle
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: doorlock_id
          in: path
          description: ID of the DoorLock to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: DoorLock configuration to be updated
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: number
                  description: ID of the DoorLock
                  example: 2
                device_id:
                  type: number
                  description: >-
                    ID of the DoorLock's host device, i.e. the device on which
                    is has been teached-in.
                  example: 1
                is_active:
                  type: boolean
                  description: Describes if the DoorLock is active or inactive.
                  example: true
                is_teachin_default:
                  type: boolean
                  description: >-
                    Describes if this DoorLock is preselected, when a RFID token
                    will be teached-id.
                  example: false
                name:
                  type: string
                  description: Name of the DoorLock
                  example: Frontdoor
                type:
                  type: number
                  description: Numerical devicetype
                  example: 21
                signal_zonestate:
                  type: boolean
                  description: >-
                    Set true, if the DoorLock should show the current arm state
                    of the assigned alarmzone.
                  example: false
                coupletime:
                  example: 3
                  type: number
                  description: >-
                    Time in seconds after the booking while the door can be
                    opened.
                doubleauth_mode:
                  example: 0
                  type: number
                  nullable: true
                  description: >-
                    Mode for double authentication. 0=Off, 1=On, 2=Only when
                    arming/disarming, 3=time controlled via timeprofile.
                doubleauth_timeprofile_id:
                  example: 0
                  type: number
                  nullable: true
                  description: >-
                    ID of the timeprofile which shall be used to enable and
                    disable the double authentication on specific times.
                log_level:
                  example: 1
                  type: number
                  description: >-
                    Sets the logbook logging mode for this DoorLock. 1=Default,
                    2=No user-related data (names, pictures), 3=Only
                    unauthorized bookings, 4=No logging.
                timeprofile_mode:
                  example: 0
                  type: number
                  enum:
                    - 0
                    - 1
                    - 2
                  description: >-
                    Mode for timeprofile usage. 0=Off, 1=On, 2=Open after first
                    booking within the time profile.
                timeprofile_id:
                  type: number
                  description: ID of the DoorLock's assigned timeprofile
                  example: 2
                group_id:
                  type: number
                  description: ID of the DoorLock's assigned alarmgroup
                  example: 2
                armlevel:
                  example: 0
                  type: number
                  enum:
                    - 0
                    - 1
                    - 2
                    - 3
                    - 4
                  description: >-
                    Set the arming level of this DoorLock. 0=Off, 1=Assigned
                    Alarmzone, 2=Building containing the assigned Alarmzone,
                    3=System, 4=External Alarmsystem.
                webhooks:
                  type: array
                  items:
                    type: integer
                  description: IDs of all assigned webhooks.
                cameras:
                  type: array
                  items:
                    type: integer
                  description: IDs of all assigned cameras.
                batterylevel:
                  type: string
                  description: Battery level of the DoorLock
                  example: full
                  enum:
                    - full
                    - half
                    - low
                    - critical
                    - wired
                reed_bypass_time:
                  type: number
                  description: >-
                    Time in seconds after the booking while the door can be
                    opened without reed contact alarming.
                  example: 30
                  enum:
                    - 0
                    - 5
                    - 10
                    - 15
                    - 30
                    - 45
                    - 60
                    - 90
                    - 120
                reed_bypass_buzzer_time:
                  type: number
                  description: >-
                    Time in seconds to buzzer after the bypass time and before
                    triggering the door contact alarm.
                  example: 30
                  enum:
                    - 0
                    - 5
                    - 10
                    - 15
                    - 30
                    - 45
                    - 60
                    - 90
                    - 120
                sabotage:
                  type: object
                  properties:
                    assignment:
                      example: always-active
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of the disassembly alarm.
                reed_source_id:
                  type: number
                  example: 'off'
                  description: >-
                    API-ID of the external sensor, which is assigned to be the
                    doorlock's reed sensor.
                reed_assignment:
                  type: string
                  example: 'off'
                  description: Alarm-Assignment for the assigned reed sensor.
                reed_delay:
                  type: number
                  example: 3600
                  description: >-
                    If the reed sensor triggers an alarm, it will be delayed by
                    this time (in seconds).
                reed_warning_active:
                  type: boolean
                  example: true
                  description: >-
                    Enables signaling on the DoorLock if the door is open for
                    the set time (in seconds). The signaling will stop when the
                    door is closed again.
                reed_warning_delay:
                  type: number
                  example: 1800
                  description: >-
                    The door must stay open for the set time to start the
                    signalization.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                    description: ID of the DoorLock
                    example: 2
                  device_id:
                    type: number
                    description: >-
                      ID of the DoorLock's host device, i.e. the device on which
                      is has been teached-in.
                    example: 1
                  is_active:
                    type: boolean
                    description: Describes if the DoorLock is active or inactive.
                    example: true
                  is_teachin_default:
                    type: boolean
                    description: >-
                      Describes if this DoorLock is preselected, when a RFID
                      token will be teached-id.
                    example: false
                  name:
                    type: string
                    description: Name of the DoorLock
                    example: Frontdoor
                  type:
                    type: number
                    description: Numerical devicetype
                    example: 21
                  signal_zonestate:
                    type: boolean
                    description: >-
                      Set true, if the DoorLock should show the current arm
                      state of the assigned alarmzone.
                    example: false
                  coupletime:
                    example: 3
                    type: number
                    description: >-
                      Time in seconds after the booking while the door can be
                      opened.
                  doubleauth_mode:
                    example: 0
                    type: number
                    nullable: true
                    description: >-
                      Mode for double authentication. 0=Off, 1=On, 2=Only when
                      arming/disarming, 3=time controlled via timeprofile.
                  doubleauth_timeprofile_id:
                    example: 0
                    type: number
                    nullable: true
                    description: >-
                      ID of the timeprofile which shall be used to enable and
                      disable the double authentication on specific times.
                  log_level:
                    example: 1
                    type: number
                    description: >-
                      Sets the logbook logging mode for this DoorLock.
                      1=Default, 2=No user-related data (names, pictures),
                      3=Only unauthorized bookings, 4=No logging.
                  timeprofile_mode:
                    example: 0
                    type: number
                    enum:
                      - 0
                      - 1
                      - 2
                    description: >-
                      Mode for timeprofile usage. 0=Off, 1=On, 2=Open after
                      first booking within the time profile.
                  timeprofile_id:
                    type: number
                    description: ID of the DoorLock's assigned timeprofile
                    example: 2
                  group_id:
                    type: number
                    description: ID of the DoorLock's assigned alarmgroup
                    example: 2
                  armlevel:
                    example: 0
                    type: number
                    enum:
                      - 0
                      - 1
                      - 2
                      - 3
                      - 4
                    description: >-
                      Set the arming level of this DoorLock. 0=Off, 1=Assigned
                      Alarmzone, 2=Building containing the assigned Alarmzone,
                      3=System, 4=External Alarmsystem.
                  webhooks:
                    type: array
                    items:
                      type: integer
                    description: IDs of all assigned webhooks.
                  cameras:
                    type: array
                    items:
                      type: integer
                    description: IDs of all assigned cameras.
                  batterylevel:
                    type: string
                    description: Battery level of the DoorLock
                    example: full
                    enum:
                      - full
                      - half
                      - low
                      - critical
                      - wired
                  reed_bypass_time:
                    type: number
                    description: >-
                      Time in seconds after the booking while the door can be
                      opened without reed contact alarming.
                    example: 30
                    enum:
                      - 0
                      - 5
                      - 10
                      - 15
                      - 30
                      - 45
                      - 60
                      - 90
                      - 120
                  reed_bypass_buzzer_time:
                    type: number
                    description: >-
                      Time in seconds to buzzer after the bypass time and before
                      triggering the door contact alarm.
                    example: 30
                    enum:
                      - 0
                      - 5
                      - 10
                      - 15
                      - 30
                      - 45
                      - 60
                      - 90
                      - 120
                  sabotage:
                    type: object
                    properties:
                      assignment:
                        example: always-active
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the disassembly alarm.
                  reed_source_id:
                    type: number
                    example: 'off'
                    description: >-
                      API-ID of the external sensor, which is assigned to be the
                      doorlock's reed sensor.
                  reed_assignment:
                    type: string
                    example: 'off'
                    description: Alarm-Assignment for the assigned reed sensor.
                  reed_delay:
                    type: number
                    example: 3600
                    description: >-
                      If the reed sensor triggers an alarm, it will be delayed
                      by this time (in seconds).
                  reed_warning_active:
                    type: boolean
                    example: true
                    description: >-
                      Enables signaling on the DoorLock if the door is open for
                      the set time (in seconds). The signaling will stop when
                      the door is closed again.
                  reed_warning_delay:
                    type: number
                    example: 1800
                    description: >-
                      The door must stay open for the set time to start the
                      signalization.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/doorlocks/{doorlock_id}/open:
    get:
      description: >-
        Remotely open a specific DoorLock. Only allowed if the user has
        permission to open the DoorLock or was assigned a matching access
        profile.
      summary: Open DoorLock
      tags:
        - doorlockopen
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: doorlock_id
          in: path
          description: ID of the DoorLock to be queried
          required: true
          example: 1
          schema:
            type: string
      deprecated: true
      responses:
        '200':
          description: Successful operation
        '400':
          description: DoorLock could not be opened.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: >-
            User does not have permission to open the DoorLock or no matching
            accessprofile was found.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    put:
      description: >-
        Remotely open a specific DoorLock. Only allowed if the user has
        permission to open the DoorLock or was assigned a matching access
        profile.
      summary: Open DoorLock
      tags:
        - doorlockopen
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: doorlock_id
          in: path
          description: ID of the DoorLock to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
        '400':
          description: DoorLock could not be opened.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: >-
            User does not have permission to open the DoorLock or no matching
            accessprofile was found.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/doorlocks/{doorlock_id}/info:
    get:
      description: Requests general information regarding a specific DoorLock.
      summary: DoorLock general information
      tags:
        - doorlockinfo
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: doorlock_id
          in: path
          description: ID of the DoorLock to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      example: DoorLock
                      type: string
                      description: Name of the DoorLock
                    type:
                      example: '20'
                      type: string
                      description: Devicetype of the DoorLock.
                    device_type:
                      example: DoorLock
                      type: string
                      description: Devicetype name of the DoorLock.
                    serial:
                      example: 123456789012
                      type: string
                      description: Serial number of the DoorLock.
                    version:
                      example: 01.00.00
                      type: string
                      description: Firmware Version of the DoorLock.
                    device_id:
                      example: 1
                      type: number
                      description: AccessManager, to which the DoorLock was teached-in.
                    batterylevel:
                      example: full
                      type: string
                      enum:
                        - full
                        - half
                        - low
                        - critical
                        - wired
                      description: Current batterylevel of the DoorLock.
                    switches_ext_system:
                      example: false
                      type: boolean
                      description: >-
                        Describes if the DoorLock is configured to switch an
                        external alarmsystem.
                    armlevel:
                      example: 0
                      type: string
                      default: 0
                      enum:
                        - '0'
                        - '1'
                        - '2'
                        - '3'
                        - '4'
                      description: >-
                        Set the arming level of this DoorLock. 0=Off, 1=Assigned
                        Alarmzone, 2=Building containing the assigned Alarmzone,
                        3=System, 4=External Alarmsystem.
                    group_id:
                      example: 1
                      type: number
                      description: >-
                        ID of the alarmgroup, to which this DoorLock was
                        assigned.
                    log_level:
                      example: 1
                      type: number
                      enum:
                        - 1
                        - 2
                        - 3
                        - 4
                      description: >-
                        Sets the logbook logging mode for this DoorLock.
                        1=Default, 2=No user-related data (names, pictures),
                        3=Only unauthorized bookings, 4=No logging.
                    latch_logic:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        DoorLock RA4 Only. Configures if the latch logic should
                        be inverted.
                    reed_logic:
                      example: false
                      type: boolean
                      nullable: true
                      description: >-
                        DoorLock RA4 Only. Configures if the reed logic should
                        be inverted.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/doorlocks/names:
    get:
      description: Requests a list of all DoorLocks the user has access to.
      summary: Get all DoorLock names
      tags:
        - doorlocknames
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                      description: ID of the DoorLock
                      example: 2
                    name:
                      type: string
                      description: Name of the DoorLock
                      example: Frontdoor
                    device_id:
                      type: number
                      description: >-
                        ID of the DoorLock's host device, i.e. the device on
                        which is has been teached-in.
                      example: 1
                    is_teachin_default:
                      type: boolean
                      description: >-
                        Describes if this DoorLock is preselected, when a RFID
                        token will be teached-id.
                      example: false
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/doorlocks/lock:
    post:
      description: Disable multiple DoorLocks and prevent any bookings on them.
      summary: Disable DoorLocks
      tags:
        - doorlocklock
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: integer
                  description: ID of the DoorLock
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/doorlocks/unlock:
    post:
      description: (Re-)Enable multiple DoorLocks and re-enable any bookings on them.
      summary: Enable DoorLocks
      tags:
        - doorlockunlock
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: integer
                  description: ID of the DoorLock
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/blockingprofiles:
    get:
      tags:
        - blockingprofiles
      description: Get a list of Exceptionday-Profiles.
      summary: Get Exceptionday-Profiles
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        data:
                          description: The list of Exceptionday-profiles
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                example: 1
                                type: integer
                                description: Id of the Exceptionday-profile.
                              name:
                                example: Holidays
                                type: string
                                description: Name of the Exceptionday-profile.
                        meta:
                          type: object
                          properties:
                            current_page:
                              example: 1
                              type: integer
                              description: The key of the current page
                            from:
                              example: 1
                              type: integer
                              description: >-
                                The index of the first element on the current
                                page
                            last_page:
                              example: 10
                              type: integer
                              description: The index of the last page
                            path:
                              example: https://example.com/api/timeprofiles
                              type: string
                              description: The route just called
                            per_page:
                              example: 25
                              type: integer
                              description: The amount of elements per page
                            to:
                              example: 25
                              type: integer
                              description: >-
                                The index of the last element on the current
                                page
                            total:
                              example: 245
                              type: integer
                              description: The total amount of elements
                        links:
                          type: object
                          description: >-
                            Attention: When using filters/query parameters,
                            those must be appended to the given links.
                          properties:
                            first:
                              example: https://example.com/api/example?page=1
                              type: string
                              description: The link to the first page
                            last:
                              example: https://example.com/api/example?page=10
                              type: string
                              description: The link to the last page
                            prev:
                              example: 'null'
                              type: string
                              description: The link to the previous page
                            next:
                              example: https://example.com/api/example?page=2
                              type: string
                              description: The link to the next page
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      tags:
        - blockingprofiles
      description: Add new Exceptionday-Profile.
      summary: Add Exceptionday-Profile
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Exceptionday-Profile Data
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 1
                  type: integer
                  description: >-
                    The ID of the profile (if not included a new profile with
                    the given data will be created)
                name:
                  example: Holidays
                  type: string
                  description: The name of the profile
                days:
                  type: array
                  description: The days, on which the exception occures
                  items:
                    properties:
                      name:
                        example: Christmas Eve
                        type: string
                        description: Name of the exception
                      date:
                        example: 20231224
                        type: integer
                        format: YYYYMMDD
                        description: Date of the exception
                      is_repeatable:
                        example: false
                        type: boolean
                        description: If the exception is repeatable
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: >-
                        The ID of the profile (if not included a new profile
                        with the given data will be created)
                    name:
                      example: Holidays
                      type: string
                      description: The name of the profile
                    days:
                      type: array
                      description: The days, on which the exception occures
                      items:
                        properties:
                          name:
                            example: Christmas Eve
                            type: string
                            description: Name of the exception
                          date:
                            example: 20231224
                            type: integer
                            format: YYYYMMDD
                            description: Date of the exception
                          is_repeatable:
                            example: false
                            type: boolean
                            description: If the exception is repeatable
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    delete:
      tags:
        - blockingprofiles
      description: Delete all given Exceptionday-Profiles.
      summary: Mass-delete Exceptionday-Profiles
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              type: array
              items:
                type: array
                example:
                  - 1
                  - 2
                  - 3
                description: A list of ids of the events to be deleted
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/blockingprofiles/{profile}:
    get:
      tags:
        - blockingprofiles-id
      description: Get the configuration of given Exceptionday-Profile.
      summary: Get Details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: profile
          in: path
          description: Exceptionday-Profile ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: >-
                        The ID of the profile (if not included a new profile
                        with the given data will be created)
                    name:
                      example: Holidays
                      type: string
                      description: The name of the profile
                    days:
                      type: array
                      description: The days, on which the exception occures
                      items:
                        properties:
                          name:
                            example: Christmas Eve
                            type: string
                            description: Name of the exception
                          date:
                            example: 20231224
                            type: integer
                            format: YYYYMMDD
                            description: Date of the exception
                          is_repeatable:
                            example: false
                            type: boolean
                            description: If the exception is repeatable
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - blockingprofiles-id
      description: Update the configuration of given Exceptionday-Profile.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: profile
          in: path
          description: Exceptionday-Profile ID
          example: 1
          required: true
          schema:
            type: string
      requestBody:
        description: Exceptionday-Profile Data
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 1
                  type: integer
                  description: >-
                    The ID of the profile (if not included a new profile with
                    the given data will be created)
                name:
                  example: Holidays
                  type: string
                  description: The name of the profile
                days:
                  type: array
                  description: The days, on which the exception occures
                  items:
                    properties:
                      name:
                        example: Christmas Eve
                        type: string
                        description: Name of the exception
                      date:
                        example: 20231224
                        type: integer
                        format: YYYYMMDD
                        description: Date of the exception
                      is_repeatable:
                        example: false
                        type: boolean
                        description: If the exception is repeatable
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: >-
                        The ID of the profile (if not included a new profile
                        with the given data will be created)
                    name:
                      example: Holidays
                      type: string
                      description: The name of the profile
                    days:
                      type: array
                      description: The days, on which the exception occures
                      items:
                        properties:
                          name:
                            example: Christmas Eve
                            type: string
                            description: Name of the exception
                          date:
                            example: 20231224
                            type: integer
                            format: YYYYMMDD
                            description: Date of the exception
                          is_repeatable:
                            example: false
                            type: boolean
                            description: If the exception is repeatable
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    delete:
      tags:
        - blockingprofiles-id
      description: Delete given Exceptionday-Profile.
      summary: Delete Exceptionday-Profile
      parameters:
        - name: profile
          in: path
          description: Exceptionday-Profile ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/blockingprofiles/import:
    post:
      tags:
        - blockingprofiles-import
      description: Import Exceptiondays from ICS-File.
      summary: Import from ICS
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: ICS File
        required: true
        content:
          text/calendar:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/blockingprofiles/exportICS/{profile}:
    get:
      tags:
        - blockingprofiles-import
      description: Export all Exceptiondays as ICS.
      summary: Export as ICS
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: profile
          in: path
          description: Exceptionday-Profile ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            text/calendar:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/blockingprofiles/exportCSV/{profile}:
    get:
      tags:
        - blockingprofiles-import
      description: Export all Exceptiondays as CSV
      summary: Export as CSV
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: profile
          in: path
          description: Exceptionday-Profile ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            text/csv:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/assigned-ios:
    get:
      description: >-
        Requests a list of all extension modules (KIO70XX), their IOs an the
        respective assignments
      summary: IO Assigments
      tags:
        - extmodassignment
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: number
                      description: The extension module's API/SNMP-ID
                    name:
                      example: KIO7052
                      type: string
                      description: Name of the extension module
                    type:
                      example: '121'
                      type: string
                      description: Devicetype of the extension module.
                    external:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel2:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel3:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel4:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel5:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel6:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel7:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                        channel8:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            name:
                              example: External Input
                              type: string
                              description: The name of the input
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this input.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the input was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment of the input.
                    output:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel2:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel3:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel4:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel5:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel6:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel7:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                        channel8:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            name:
                              example: Digital Output
                              type: string
                              description: The name of the output
                            channel:
                              example: 1
                              type: number
                              description: The channel number of this output.
                            external_alarmsystem:
                              nullable: true
                              example: Alarmgroup 1
                              type: string
                              description: >-
                                If the output was assigned to an external
                                alarmsystem, the name of the assigned alarmgroup
                                will be printed here. Otherwise it will be null.
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/gsm:
    get:
      description: Requests status information of the GSM.
      summary: Get GSM status
      tags:
        - gsm
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: Describes if GSM/cell service is active or not.
                  authentication:
                    example: false
                    type: boolean
                    description: Describes if the SIM uses PIN protection.
                  state:
                    type: object
                    properties:
                      iccid:
                        example: '1234567890123456789'
                        type: string
                        description: The ICCID of the SIM card.
                      modem_state:
                        example: 1
                        type: integer
                        description: The state of the modem.
                      operator:
                        example: TelekomDE
                        type: string
                        description: The name of the operator.
                  gateway:
                    type: object
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes if the SMS gateway is active or not.
                      password:
                        example: password
                        type: string
                        description: The password of the SMS gateway.
                  forwarding:
                    type: object
                    description: >-
                      Only for SiteManagers without GSM modem. If enabled, all
                      SMS will be forwarded to the AlarmManager IP and sent via
                      it's modem.
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes if the SMS forwarding is active or not.
                      address:
                        example: 192.168.100.222
                        type: string
                        description: The IP address of the AlarmManager.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the GSM configuration.
      summary: Update GSM configuration
      tags:
        - gsm
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: GSM configuration
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  example: true
                  type: boolean
                  description: Describes if GSM/cell service is active or not.
                gateway:
                  type: object
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: Describes if the SMS gateway is active or not.
                    password:
                      example: password
                      type: string
                      description: The password of the SMS gateway.
                forwarding:
                  type: object
                  description: >-
                    Only for SiteManagers without GSM modem. If enabled, all SMS
                    will be forwarded to the AlarmManager IP and sent via it's
                    modem.
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: Describes if the SMS forwarding is active or not.
                    address:
                      example: 192.168.100.222
                      type: string
                      description: The IP address of the AlarmManager.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: Describes if GSM/cell service is active or not.
                  authentication:
                    example: false
                    type: boolean
                    description: Describes if the SIM uses PIN protection.
                  state:
                    type: object
                    properties:
                      iccid:
                        example: '1234567890123456789'
                        type: string
                        description: The ICCID of the SIM card.
                      modem_state:
                        example: 1
                        type: integer
                        description: The state of the modem.
                      operator:
                        example: TelekomDE
                        type: string
                        description: The name of the operator.
                  gateway:
                    type: object
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes if the SMS gateway is active or not.
                      password:
                        example: password
                        type: string
                        description: The password of the SMS gateway.
                  forwarding:
                    type: object
                    description: >-
                      Only for SiteManagers without GSM modem. If enabled, all
                      SMS will be forwarded to the AlarmManager IP and sent via
                      it's modem.
                    properties:
                      is_active:
                        example: true
                        type: boolean
                        description: Describes if the SMS forwarding is active or not.
                      address:
                        example: 192.168.100.222
                        type: string
                        description: The IP address of the AlarmManager.
        '400':
          description: Bad Request - Cannot or will not handle the request.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/state/cell:
    get:
      description: Requests status information of cell state.
      summary: Get cell state
      tags:
        - gsm
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: Describes if GSM/cell service is active or not.
                  state:
                    example: ready
                    type: string
                    enum:
                      - initializing
                      - no-sim
                      - pin1
                      - pin2
                      - puk1
                      - puk2
                      - ready
                      - error
                    description: Describes the state of the modem.
                  signal_strength:
                    example: medium
                    type: string
                    nullable: true
                    enum:
                      - no-signal
                      - bad
                      - medium
                      - good
                      - very-good
                    description: Describes the mobile radio signal strength.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '405':
          description: Method Not Allowed - Used HTTP method is not allowed for this route.
      security:
        - bearer: []
  /api/test-phone:
    put:
      description: Send test sms to provided phone number.
      summary: Send test sms
      tags:
        - sim
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phone:
                  example: '+123456789'
                  type: string
                  description: Phone number to which the test SMS should be sent.
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/sim-pin:
    put:
      description: Configuration options to set the PIN of the SIM card.
      summary: Set SIM card PIN
      tags:
        - sim
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pin:
                  example: '1234'
                  type: string
                  description: SIM cards current PIN.
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/sim-unlock:
    put:
      description: Unlock the SIM card with PUK and set a new PIN.
      summary: Unlock SIM card
      tags:
        - sim
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                puk:
                  example: '12345678'
                  type: string
                  description: SIM cards PUK.
                pin:
                  example: '1234'
                  type: string
                  description: SIM cards new PIN.
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/sim-pin-change:
    put:
      description: Configuration options to change the PIN of the SIM card.
      summary: Change SIM card PIN
      tags:
        - sim
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                old_pin:
                  example: '1234'
                  type: string
                  description: SIM cards current PIN.
                new_pin:
                  example: '1234'
                  type: string
                  description: SIM cards new PIN.
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/sim-pin-protection:
    put:
      description: Configuration options for the PIN protection of the SIM card.
      summary: Set SIM card PIN
      tags:
        - sim
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: Describes if SIM protection should be active or not.
                pin:
                  example: '1234'
                  type: string
                  description: SIM cards current PIN.
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/sms-gateway:
    get:
      description: Requests the SMS gateway information for sending SMS messages.
      summary: Get SMS gateway configuration
      tags:
        - sms-gateway
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: Describes if SMS gateway is active or not.
                  password:
                    example: password
                    type: string
                    nullable: true
                    description: Password for the SMS-Gateway.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update the SMS gateway information for sending SMS messages.
      summary: Update SMS gateway configuration
      tags:
        - sms-gateway
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  example: true
                  type: boolean
                  description: Describes if SMS gateway is active or not.
                password:
                  example: password
                  type: string
                  nullable: true
                  description: Password for the SMS-Gateway.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: Describes if SMS gateway is active or not.
                  password:
                    example: password
                    type: string
                    nullable: true
                    description: Password for the SMS-Gateway.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
    put:
      description: Sends an SMS with given content to given recipients.
      summary: Send SMS to recipients
      tags:
        - sms-gateway
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  example: password
                  type: string
                  description: Password for the SMS-Gateway.
                recipients:
                  example:
                    - '+123456789'
                  type: array
                  items:
                    type: string
                  description: Persons to whom the SMS is to be sent.
                body:
                  example: This is an example
                  type: string
                  description: Body of the SMS.
                alarm_event_id:
                  example: 0
                  type: integer
                  nullable: true
                  description: The ID of the alarm event
                retries:
                  example: 0
                  type: integer
                  nullable: true
                  description: Attempts to send SMS
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
        '503':
          description: Service Unavailable - Not ready to handle the request.
      security:
        - bearer: []
  /api/{type}/{resource_id}/history:
    get:
      description: >-
        Query measurement history of devices. All query parameters can be
        chained if not stated otherwise
      summary: Measurement history
      tags:
        - history
      parameters:
        - name: type
          in: path
          description: Queries the history data of the specified type
          required: true
          schema:
            type: string
            enum:
              - device
              - group
              - rack
              - io
        - name: resource_id
          in: path
          description: ID of the data source
          required: true
          example: 1
          schema:
            type: number
        - name: temperature
          in: query
          description: Queries the history data of room temperature
          schema:
            type: boolean
        - name: humidity
          in: query
          description: Queries the history data of humidity
          schema:
            type: boolean
        - name: dewpoint
          in: query
          description: Queries the history data of dewpoint
          schema:
            type: boolean
        - name: air_quality
          in: query
          description: Queries the history data of air quality
          schema:
            type: boolean
        - name: co
          in: query
          description: Queries the history data of co
          schema:
            type: boolean
        - name: fire_temperature
          in: query
          description: >-
            Queries the history data of the measured IR temperature (Only
            MultiSensor-TI)
          schema:
            type: boolean
        - name: snmp
          in: query
          description: Queries the history data of an snmp sensor
          schema:
            type: boolean
        - name: latency
          in: query
          description: Queries the history data of latency
          schema:
            type: boolean
        - name: external[]
          in: query
          description: >-
            Queries the history data of an external sensor. Use array notation
            and the input number as index
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: rcm_ac
          in: query
          description: Queries the history data of RCM (AC)
          schema:
            type: boolean
        - name: rcm_dc
          in: query
          description: Queries the history data of RCM (DC)
          schema:
            type: boolean
        - name: pue
          in: query
          description: Queries the history data of PUE measurement
          schema:
            type: boolean
        - name: powerfactor[]
          in: query
          description: >-
            Queries the history data of power factor for the given phases. Use
            array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: active_power[]
          in: query
          description: >-
            Queries the history data of active power for the given phases. Use
            array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: active_power_a
          in: query
          description: Queries the history data of active power for supplyline A
          schema:
            type: boolean
        - name: active_power_b
          in: query
          description: Queries the history data of active power for supplyline B
          schema:
            type: boolean
        - name: apparent_power[]
          in: query
          description: >-
            Queries the history data of apparent power for the given phases. Use
            array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: apparent_power_a
          in: query
          description: Queries the history data of apparent power for supplyline A
          schema:
            type: boolean
        - name: apparent_power_b
          in: query
          description: Queries the history data of apparent power for supplyline B
          schema:
            type: boolean
        - name: reactive_power[]
          in: query
          description: >-
            Queries the history data of reactive power for the given phases. Use
            array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: voltage[]
          in: query
          description: >-
            Queries the history data of voltage for the given phases. Use array
            notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: current[]
          in: query
          description: >-
            Queries the history data of current for the given phases. Use array
            notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: consumption[]
          in: query
          description: >-
            Queries the history data of consumption for the given phases. Use
            array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: consumption_a
          in: query
          description: Queries the history data of consumption for supplyline A
          schema:
            type: boolean
        - name: consumption_b
          in: query
          description: Queries the history data of consumption for supplyline B
          schema:
            type: boolean
        - name: frequency[]
          in: query
          description: >-
            Queries the history data of frequency for the given phases. Use
            array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: loadprofile[]
          in: query
          description: >-
            Queries the history data of the loadprofile for the given phases.
            Use array notation and the phase number as index.
          schema:
            type: array
            items:
              type: number
            example:
              - 1
              - 2
        - name: loadprofile_a
          in: query
          description: Queries the history data of the loadprofile for supplyline A
          schema:
            type: boolean
        - name: loadprofile_b
          in: query
          description: Queries the history data of the loadprofile for supplyline B
          schema:
            type: boolean
        - name: begin
          description: Begin timestamp in ISO8601 format.
          in: query
          schema:
            type: string
            format: date-time
            default: Current time - 30 days
        - name: end
          description: End timestamp in ISO8601 format.
          in: query
          schema:
            type: string
            format: date-time
            default: <current time>
        - name: operation
          description: >
            The operation is applied to calculate statistics on the raw
            measurement history data.


            First, the data is grouped by timestamp according to the `interval`
            parameter. Then the operation is applied to each group. The possible
            values map to the following meaning `0 = sum`, `1 = mean`, `2 =
            min`, `3 = max`.
          in: query
          schema:
            type: integer
            enum:
              - 0
              - 1
              - 2
              - 3
            default: 0
        - name: interval
          description: >
            The raw measurement history data is grouped by timestamp according
            to the interval parameter.


            Then the operation defined by the `operation` parameter is applied
            to each group. `None` does not perform temporal grouping, i.e. the
            return value contains the raw measurement data, independent of the
            queried `operation`. All possible values are case-insensitive.
          in: query
          schema:
            type: string
            enum:
              - none
              - daily
              - weekly
              - monthly
              - yearly
            default: none
        - name: format
          description: Output format. All possible values are case-insensitive.
          in: query
          schema:
            type: string
            enum:
              - csv
              - json
            default: json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                title: History of the queried measurements
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          example: voltage
                          description: The type of the measurement
                        channel:
                          type: string
                          description: >-
                            The channel of the measurement, if applicable. Can
                            be a phase number or a supply line
                          example: 1
                        unit:
                          type: string
                          description: The unit of the measurement
                          example: V
                        timestamps:
                          type: array
                          items:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          description: The timestamps of the measurements
                        values:
                          type: array
                          items:
                            type: string
                            description: Can be a string or a number.
                            example: 230
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/integrate:
    put:
      description: Starts the integration of an existing system.
      summary: Start the integration of an existing system
      tags:
        - integration
      requestBody:
        description: Data of the main device of the system to be integrated
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  example: 192.168.100.224
                  type: string
                  description: The address of the device.
                apikey:
                  example: mfyLv9Y263tOd6xTMM94yzBHtVID7rvQCcEbQXaI
                  type: string
                  description: The apikey of an admin of the device to be integrated.
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/integrate/report:
    get:
      description: Get the report of the last integration.
      summary: Get the report of the last integration.
      tags:
        - integration
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  step:
                    type: object
                    properties:
                      created:
                        type: integer
                        example: 12
                        description: The amount of entries integrated in this step
                      failed:
                        type: integer
                        example: 0
                        description: The amount of entries that were failed to integrate
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/iomodules:
    get:
      tags:
        - iomodule
      description: Get a list of all IO-Modules.
      summary: Get IO-Modules
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: the ID of the device
                        name:
                          example: MultiSensor
                          type: string
                          description: The name of the device
                        type:
                          example: 1
                          type: integer
                          description: The type of the device
                        is_active:
                          example: true
                          type: boolean
                          description: The flag to determine the status of the device
                        address:
                          example: 192.168.0.1
                          type: string
                          description: The address of the device
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        device_id:
                          example: 1
                          type: integer
                          description: the ID of the device this device is assigned to
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/iomodules/names:
    get:
      tags:
        - iomodule-names
      description: Get a list of IO-Module names.
      summary: Get IO-Module names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: Kentix I/O Module 7052
                      type: string
                      description: The name of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/iomodules/{iomodule}:
    get:
      tags:
        - iomodule-id
      description: Get the details of the given IO-Module.
      summary: Get Details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: iomodule
          in: path
          description: IO-Module ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                oneOf:
                  - title: Kentix I/O Module 7017
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix I/O Module 7017
                        type: string
                        description: The name of the device
                      type:
                        example: 123
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      rack_id:
                        example: null
                        type: integer
                        description: The ID of the rack the device is assigned to
                      external:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel2:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel3:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel4:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel5:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel6:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel7:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel8:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                      output:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel2:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel3:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel4:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                      webhooks:
                        example:
                          - webhook_id: 1
                            event: 0
                            trigger_on_alarm: true
                            trigger_on_warning: false
                            cycle_time: null
                        type: array
                        description: The webhook relations of this device
                      connection:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of the connection
                          warning:
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                                description: >-
                                  Configures whether connection issues should be
                                  displayed as a warning instead of an alarm
                  - title: Kentix I/O Module 7052
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix I/O Module 7052
                        type: string
                        description: The name of the device
                      type:
                        example: 121
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      rack_id:
                        example: null
                        type: integer
                        description: The ID of the rack the device is assigned to
                      external:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel2:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel3:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel4:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel5:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel6:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel7:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel8:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                      output:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel2:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel3:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel4:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel5:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel6:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel7:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel8:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                      webhooks:
                        example:
                          - webhook_id: 1
                            event: 0
                            trigger_on_alarm: true
                            trigger_on_warning: false
                            cycle_time: null
                        type: array
                        description: The webhook relations of this device
                      connection:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of the connection
                          warning:
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                                description: >-
                                  Configures whether connection issues should be
                                  displayed as a warning instead of an alarm
                  - title: Kentix I/O Module 7053
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix I/O Module 7053
                        type: string
                        description: The name of the device
                      type:
                        example: 122
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      rack_id:
                        example: null
                        type: integer
                        description: The ID of the rack the device is assigned to
                      external:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel2:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel3:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel4:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel5:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel6:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel7:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel8:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel9:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel10:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel11:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel12:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel13:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel14:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel15:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel16:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                      webhooks:
                        example:
                          - webhook_id: 1
                            event: 0
                            trigger_on_alarm: true
                            trigger_on_warning: false
                            cycle_time: null
                        type: array
                        description: The webhook relations of this device
                      connection:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of the connection
                          warning:
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                                description: >-
                                  Configures whether connection issues should be
                                  displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - iomodule-id
      description: Update the configuration of given IO-Module.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: iomodule
          in: path
          description: IO-Module ID
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              oneOf:
                - title: Kentix I/O Module 7017
                  type: object
                  properties:
                    id:
                      example: 2
                      type: integer
                      description: the ID of the device
                    device_id:
                      example: 1
                      type: integer
                      description: the ID of the device this device is assigned to
                    is_active:
                      example: true
                      type: boolean
                      description: The flag to determine the status of the device
                    name:
                      example: Kentix I/O Module 7017
                      type: string
                      description: The name of the device
                    type:
                      example: 123
                      type: integer
                      description: The type of the device
                    address:
                      example: 192.168.0.1
                      type: string
                      description: The address of the device
                    port:
                      example: 502
                      type: integer
                      description: The port of the device
                    group_id:
                      example: 1
                      type: integer
                      description: The ID of the group the device is assigned to
                    rack_id:
                      example: null
                      type: integer
                      description: The ID of the rack the device is assigned to
                    external:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel2:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel3:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel4:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel5:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel6:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel7:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                        channel8:
                          type: object
                          description: The configuration for an analog input
                          properties:
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            decimal:
                              example: 1
                              type: integer
                              enum:
                                - 1
                                - 2
                                - 3
                                - 4
                              description: The amount of decimals
                            min:
                              example: 10
                              type: integer
                              description: The lower threshold where an alarm is triggered
                            max:
                              example: 10
                              type: integer
                              description: The upper threshold where an alarm is triggered
                            offset:
                              example: 1
                              type: integer
                              description: The offset to be applied on the value
                            physical_min:
                              example: -50
                              type: integer
                              description: The lower end on the measurement scale
                            physical_max:
                              example: -50
                              type: integer
                              description: The upper end on the measurement scale
                            unit:
                              example: °C
                              type: string
                              description: The unit corresponding to the value
                            electrical_min:
                              example: 0
                              type: integer
                              description: Minimal electrical value of the sensor
                            electrical_max:
                              example: 10
                              type: integer
                              description: Maximal electrical value of the sensor
                            measuring_mode:
                              example: voltage
                              type: string
                              enum:
                                - voltage
                                - current
                              description: The type of measurement
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                    output:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel2:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel3:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel4:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                    webhooks:
                      example:
                        - webhook_id: 1
                          event: 0
                          trigger_on_alarm: true
                          trigger_on_warning: false
                          cycle_time: null
                      type: array
                      description: The webhook relations of this device
                    connection:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of the connection
                        warning:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: true
                              description: >-
                                Configures whether connection issues should be
                                displayed as a warning instead of an alarm
                - title: Kentix I/O Module 7052
                  type: object
                  properties:
                    id:
                      example: 2
                      type: integer
                      description: the ID of the device
                    device_id:
                      example: 1
                      type: integer
                      description: the ID of the device this device is assigned to
                    is_active:
                      example: true
                      type: boolean
                      description: The flag to determine the status of the device
                    name:
                      example: Kentix I/O Module 7052
                      type: string
                      description: The name of the device
                    type:
                      example: 121
                      type: integer
                      description: The type of the device
                    address:
                      example: 192.168.0.1
                      type: string
                      description: The address of the device
                    port:
                      example: 502
                      type: integer
                      description: The port of the device
                    group_id:
                      example: 1
                      type: integer
                      description: The ID of the group the device is assigned to
                    rack_id:
                      example: null
                      type: integer
                      description: The ID of the rack the device is assigned to
                    external:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel2:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel3:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel4:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel5:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel6:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel7:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel8:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                    output:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel2:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel3:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel4:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel5:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel6:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel7:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                        channel8:
                          type: object
                          description: The configuration for an digital output
                          properties:
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            event_id:
                              example: 1
                              type: integer
                              description: >-
                                The ID of the Eventprofile applied to this
                                device
                            output_time:
                              example: 1
                              type: integer
                              description: >-
                                Determines how long this output will be opened
                                on alarm
                    webhooks:
                      example:
                        - webhook_id: 1
                          event: 0
                          trigger_on_alarm: true
                          trigger_on_warning: false
                          cycle_time: null
                      type: array
                      description: The webhook relations of this device
                    connection:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of the connection
                        warning:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: true
                              description: >-
                                Configures whether connection issues should be
                                displayed as a warning instead of an alarm
                - title: Kentix I/O Module 7053
                  type: object
                  properties:
                    id:
                      example: 2
                      type: integer
                      description: the ID of the device
                    device_id:
                      example: 1
                      type: integer
                      description: the ID of the device this device is assigned to
                    is_active:
                      example: true
                      type: boolean
                      description: The flag to determine the status of the device
                    name:
                      example: Kentix I/O Module 7053
                      type: string
                      description: The name of the device
                    type:
                      example: 122
                      type: integer
                      description: The type of the device
                    address:
                      example: 192.168.0.1
                      type: string
                      description: The address of the device
                    port:
                      example: 502
                      type: integer
                      description: The port of the device
                    group_id:
                      example: 1
                      type: integer
                      description: The ID of the group the device is assigned to
                    rack_id:
                      example: null
                      type: integer
                      description: The ID of the rack the device is assigned to
                    external:
                      type: object
                      properties:
                        channel1:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel2:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel3:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel4:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel5:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel6:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel7:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel8:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel9:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel10:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel11:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel12:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel13:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel14:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel15:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                        channel16:
                          type: object
                          description: The configuration for an digital input
                          properties:
                            alarm_when:
                              example: close
                              type: string
                              enum:
                                - close
                                - open
                              description: >-
                                Configures on which state an alarm will be
                                triggered
                            alarmdelay:
                              example: 10
                              type: integer
                              description: The amount of seconds an alarm will be delayed
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                                - arm-disarm
                                - arm
                                - disarm
                              description: The alarm assignment
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >-
                                Determines if the alarmstate of this device is
                                ignored during arming
                            description_alert:
                              example: Alarm
                              type: string
                              description: >-
                                The description to be displayed when an alarm
                                occurs
                            description_ok:
                              example: OK
                              type: string
                              description: >-
                                The description to be displayed when no alarm
                                occurs
                            group_id:
                              example: 1
                              type: integer
                              description: The ID of the group the device is assigned to
                            icon:
                              example: ethernet
                              type: string
                              description: The icon to be displayed
                            id:
                              example: 2
                              type: integer
                              description: the ID of the device
                            name:
                              example: External Input
                              type: string
                              description: The name of the device
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: The type of input
                    webhooks:
                      example:
                        - webhook_id: 1
                          event: 0
                          trigger_on_alarm: true
                          trigger_on_warning: false
                          cycle_time: null
                      type: array
                      description: The webhook relations of this device
                    connection:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of the connection
                        warning:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: true
                              description: >-
                                Configures whether connection issues should be
                                displayed as a warning instead of an alarm
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                oneOf:
                  - title: Kentix I/O Module 7017
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix I/O Module 7017
                        type: string
                        description: The name of the device
                      type:
                        example: 123
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      rack_id:
                        example: null
                        type: integer
                        description: The ID of the rack the device is assigned to
                      external:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel2:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel3:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel4:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel5:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel6:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel7:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                          channel8:
                            type: object
                            description: The configuration for an analog input
                            properties:
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              decimal:
                                example: 1
                                type: integer
                                enum:
                                  - 1
                                  - 2
                                  - 3
                                  - 4
                                description: The amount of decimals
                              min:
                                example: 10
                                type: integer
                                description: >-
                                  The lower threshold where an alarm is
                                  triggered
                              max:
                                example: 10
                                type: integer
                                description: >-
                                  The upper threshold where an alarm is
                                  triggered
                              offset:
                                example: 1
                                type: integer
                                description: The offset to be applied on the value
                              physical_min:
                                example: -50
                                type: integer
                                description: The lower end on the measurement scale
                              physical_max:
                                example: -50
                                type: integer
                                description: The upper end on the measurement scale
                              unit:
                                example: °C
                                type: string
                                description: The unit corresponding to the value
                              electrical_min:
                                example: 0
                                type: integer
                                description: Minimal electrical value of the sensor
                              electrical_max:
                                example: 10
                                type: integer
                                description: Maximal electrical value of the sensor
                              measuring_mode:
                                example: voltage
                                type: string
                                enum:
                                  - voltage
                                  - current
                                description: The type of measurement
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                      output:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel2:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel3:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel4:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                      webhooks:
                        example:
                          - webhook_id: 1
                            event: 0
                            trigger_on_alarm: true
                            trigger_on_warning: false
                            cycle_time: null
                        type: array
                        description: The webhook relations of this device
                      connection:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of the connection
                          warning:
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                                description: >-
                                  Configures whether connection issues should be
                                  displayed as a warning instead of an alarm
                  - title: Kentix I/O Module 7052
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix I/O Module 7052
                        type: string
                        description: The name of the device
                      type:
                        example: 121
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      rack_id:
                        example: null
                        type: integer
                        description: The ID of the rack the device is assigned to
                      external:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel2:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel3:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel4:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel5:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel6:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel7:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel8:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                      output:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel2:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel3:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel4:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel5:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel6:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel7:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                          channel8:
                            type: object
                            description: The configuration for an digital output
                            properties:
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              event_id:
                                example: 1
                                type: integer
                                description: >-
                                  The ID of the Eventprofile applied to this
                                  device
                              output_time:
                                example: 1
                                type: integer
                                description: >-
                                  Determines how long this output will be opened
                                  on alarm
                      webhooks:
                        example:
                          - webhook_id: 1
                            event: 0
                            trigger_on_alarm: true
                            trigger_on_warning: false
                            cycle_time: null
                        type: array
                        description: The webhook relations of this device
                      connection:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of the connection
                          warning:
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                                description: >-
                                  Configures whether connection issues should be
                                  displayed as a warning instead of an alarm
                  - title: Kentix I/O Module 7053
                    type: object
                    properties:
                      id:
                        example: 2
                        type: integer
                        description: the ID of the device
                      device_id:
                        example: 1
                        type: integer
                        description: the ID of the device this device is assigned to
                      is_active:
                        example: true
                        type: boolean
                        description: The flag to determine the status of the device
                      name:
                        example: Kentix I/O Module 7053
                        type: string
                        description: The name of the device
                      type:
                        example: 122
                        type: integer
                        description: The type of the device
                      address:
                        example: 192.168.0.1
                        type: string
                        description: The address of the device
                      port:
                        example: 502
                        type: integer
                        description: The port of the device
                      group_id:
                        example: 1
                        type: integer
                        description: The ID of the group the device is assigned to
                      rack_id:
                        example: null
                        type: integer
                        description: The ID of the rack the device is assigned to
                      external:
                        type: object
                        properties:
                          channel1:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel2:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel3:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel4:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel5:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel6:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel7:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel8:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel9:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel10:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel11:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel12:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel13:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel14:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel15:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                          channel16:
                            type: object
                            description: The configuration for an digital input
                            properties:
                              alarm_when:
                                example: close
                                type: string
                                enum:
                                  - close
                                  - open
                                description: >-
                                  Configures on which state an alarm will be
                                  triggered
                              alarmdelay:
                                example: 10
                                type: integer
                                description: The amount of seconds an alarm will be delayed
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                  - arm-disarm
                                  - arm
                                  - disarm
                                description: The alarm assignment
                              can_alwaysarm:
                                example: false
                                type: boolean
                                description: >-
                                  Determines if the alarmstate of this device is
                                  ignored during arming
                              description_alert:
                                example: Alarm
                                type: string
                                description: >-
                                  The description to be displayed when an alarm
                                  occurs
                              description_ok:
                                example: OK
                                type: string
                                description: >-
                                  The description to be displayed when no alarm
                                  occurs
                              group_id:
                                example: 1
                                type: integer
                                description: The ID of the group the device is assigned to
                              icon:
                                example: ethernet
                                type: string
                                description: The icon to be displayed
                              id:
                                example: 2
                                type: integer
                                description: the ID of the device
                              name:
                                example: External Input
                                type: string
                                description: The name of the device
                              input_type:
                                example: default
                                type: string
                                enum:
                                  - default
                                  - door
                                  - leakage
                                description: The type of input
                      webhooks:
                        example:
                          - webhook_id: 1
                            event: 0
                            trigger_on_alarm: true
                            trigger_on_warning: false
                            cycle_time: null
                        type: array
                        description: The webhook relations of this device
                      connection:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of the connection
                          warning:
                            type: object
                            properties:
                              active:
                                type: boolean
                                example: true
                                description: >-
                                  Configures whether connection issues should be
                                  displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/state/io:
    get:
      deprecated: false
      description: Get the state of the specified ios.
      summary: Get io state
      tags:
        - iostates
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    ids:
                      type: array
                      description: Array of the ids to check as string
                      items:
                        type: string
                        example: '1'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 5
                          type: integer
                          description: The ID of the io
                        value:
                          example: 1
                          type: integer
                          description: The value of the io
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/kentix-ai:
    get:
      description: Requests the settings for Kentix AI.
      summary: Get KAI configuration
      tags:
        - kentix-ai
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: >-
                      If set to true KAI, the Kentix AI will be useable by every
                      user with the corresponding permissions set in their
                      respective usergroup.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the Kentix AI settings.
      summary: Update KAI settings
      tags:
        - kentix-ai
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  example: true
                  type: boolean
                  description: >-
                    If set to true KAI, the Kentix AI will be useable by every
                    user with the corresponding permissions set in their
                    respective usergroup.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    example: true
                    type: boolean
                    description: >-
                      If set to true KAI, the Kentix AI will be useable by every
                      user with the corresponding permissions set in their
                      respective usergroup.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/kpiconfig/{user}:
    get:
      tags:
        - kpiconfig
      description: Get the KPI configuration for the given user.
      summary: Get configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: user
          in: path
          description: User ID
          example: 1
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    user_id:
                      example: 1
                      type: integer
                      description: The ID of the user related to the configuration
                    config:
                      type: object
                      properties:
                        access_denied:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Access denied
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        access_granted:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Access granted
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        active_power:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: total
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Active power
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 2
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: lastMonth
                                type: string
                        alarms:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Alarms
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 3f263f3f-be94-49b7-b3c7-ab79567f8145
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        consumption:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Consumption
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        pue:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Power Usage Effectivenes
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      tags:
        - kpiconfig
      description: Update the KPI configuration for the given user.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: user
          in: path
          description: User ID
          example: 1
          required: true
          schema:
            type: string
      requestBody:
        description: KPIs Data
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  example: 1
                  type: integer
                  description: The ID of the user related to the configuration
                config:
                  type: object
                  properties:
                    access_denied:
                      type: array
                      items:
                        type: object
                        properties:
                          comparedto:
                            example: none
                            type: string
                            description: Value to be compared with.
                          label:
                            example: Access denied
                            type: string
                            description: Name of the KPI.
                          order:
                            example: 1
                            type: integer
                            description: Describes the position.
                          uuid:
                            example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                            type: string
                            format: UUID
                            description: UUID of the KPI.
                          value:
                            example: currentMonth
                            type: string
                    access_granted:
                      type: array
                      items:
                        type: object
                        properties:
                          comparedto:
                            example: none
                            type: string
                            description: Value to be compared with.
                          label:
                            example: Access granted
                            type: string
                            description: Name of the KPI.
                          order:
                            example: 1
                            type: integer
                            description: Describes the position.
                          uuid:
                            example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                            type: string
                            format: UUID
                            description: UUID of the KPI.
                          value:
                            example: currentMonth
                            type: string
                    active_power:
                      type: array
                      items:
                        type: object
                        properties:
                          comparedto:
                            example: total
                            type: string
                            description: Value to be compared with.
                          label:
                            example: Active power
                            type: string
                            description: Name of the KPI.
                          order:
                            example: 2
                            type: integer
                            description: Describes the position.
                          uuid:
                            example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                            type: string
                            format: UUID
                            description: UUID of the KPI.
                          value:
                            example: lastMonth
                            type: string
                    alarms:
                      type: array
                      items:
                        type: object
                        properties:
                          comparedto:
                            example: none
                            type: string
                            description: Value to be compared with.
                          label:
                            example: Alarms
                            type: string
                            description: Name of the KPI.
                          order:
                            example: 1
                            type: integer
                            description: Describes the position.
                          uuid:
                            example: 3f263f3f-be94-49b7-b3c7-ab79567f8145
                            type: string
                            format: UUID
                            description: UUID of the KPI.
                          value:
                            example: currentMonth
                            type: string
                    consumption:
                      type: array
                      items:
                        type: object
                        properties:
                          comparedto:
                            example: none
                            type: string
                            description: Value to be compared with.
                          label:
                            example: Consumption
                            type: string
                            description: Name of the KPI.
                          order:
                            example: 1
                            type: integer
                            description: Describes the position.
                          uuid:
                            example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                            type: string
                            format: UUID
                            description: UUID of the KPI.
                          value:
                            example: currentMonth
                            type: string
                    pue:
                      type: array
                      items:
                        type: object
                        properties:
                          comparedto:
                            example: none
                            type: string
                            description: Value to be compared with.
                          label:
                            example: Power Usage Effectivenes
                            type: string
                            description: Name of the KPI.
                          order:
                            example: 1
                            type: integer
                            description: Describes the position.
                          uuid:
                            example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                            type: string
                            format: UUID
                            description: UUID of the KPI.
                          value:
                            example: currentMonth
                            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    user_id:
                      example: 1
                      type: integer
                      description: The ID of the user related to the configuration
                    config:
                      type: object
                      properties:
                        access_denied:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Access denied
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        access_granted:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Access granted
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        active_power:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: total
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Active power
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 2
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: lastMonth
                                type: string
                        alarms:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Alarms
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 3f263f3f-be94-49b7-b3c7-ab79567f8145
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        consumption:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Consumption
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
                        pue:
                          type: array
                          items:
                            type: object
                            properties:
                              comparedto:
                                example: none
                                type: string
                                description: Value to be compared with.
                              label:
                                example: Power Usage Effectivenes
                                type: string
                                description: Name of the KPI.
                              order:
                                example: 1
                                type: integer
                                description: Describes the position.
                              uuid:
                                example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                                type: string
                                format: UUID
                                description: UUID of the KPI.
                              value:
                                example: currentMonth
                                type: string
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/ldap:
    get:
      description: Get the LDAP settings
      summary: Get LDAP settings
      tags:
        - ldap
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    type: boolean
                    description: Is LDAP active
                    example: true
                  soft_deletes:
                    type: boolean
                    description: >-
                      Describes, if deleted users should be disabled or deleted.
                      If true, the user will be disabled.
                    example: false
                  server_type:
                    type: string
                    description: >-
                      Select the type of LDAP server you are using. If the wrong
                      type is selected, issue may occur when requesting groups.
                    enum:
                      - active_directory
                      - openldap
                    example: active_directory
                  use_range:
                    type: boolean
                    example: false
                    description: >-
                      If you are importing huge numbers of users, you should
                      enable this function to import them in chunks. Be aware,
                      that this function must be enabled on your server.
                  range_size:
                    type: number
                    example: 900
                    description: >-
                      Sets the range size for chunk-requesting users. If not
                      neccessary, do not change this setting.
                  security:
                    type: integer
                    description: >-
                      Describes the security level of the LDAP connection. 0 =
                      None 1 = SSL (LDAPS)
                    enum:
                      - 0
                      - 1
                    example: 1
                  address:
                    type: string
                    description: LDAP server address
                    example: ldap.example.com
                  port:
                    type: integer
                    description: LDAP server port
                    example: 389
                  basedn:
                    type: string
                    description: LDAP base DN
                    example: dc=example,dc=com
                  binddn:
                    type: string
                    description: LDAP bind DN
                    example: cn=admin,dc=example,dc=com
                  binddn_password:
                    type: string
                    nullable: true
                    description: LDAP bind DN password
                    example: password
                  usergroup_1:
                    type: integer
                    description: >-
                      ID of the Kentix system usergroup, which should be used
                      for LDAP usergroup 1
                    example: 1
                  usergroup_1_path:
                    type: string
                    description: LDAP usergroup 1 path
                    example: cn=users,ou=groups,dc=example,dc=com
                  usergroup_2:
                    type: integer
                    description: >-
                      ID of the Kentix system usergroup, which should be used
                      for LDAP usergroup 2
                    example: 2
                  usergroup_2_path:
                    type: string
                    description: LDAP usergroup 2 path
                    example: cn=admins,ou=groups,dc=example,dc=com
                  admin_group:
                    type: string
                    description: LDAP admin group
                    example: cn=admins,ou=groups,dc=example,dc=com
                  user_active:
                    type: string
                    description: LDAP user active attribute
                    example: active
                  username:
                    type: string
                    description: LDAP username attribute
                    example: sAMAccountName
                  fullname:
                    type: string
                    description: LDAP fullname attribute
                    example: name
                  email:
                    type: string
                    description: LDAP email attribute
                    example: mail
                  phone:
                    type: string
                    description: LDAP phone attribute, only required for AlarmManagers
                    example: telephoneNumber
                  pin:
                    type: string
                    description: LDAP pin attribute
                    example: pin
                  rfid:
                    type: string
                    description: LDAP rfid attribute
                    example: rfid
                  description:
                    type: string
                    description: LDAP description attribute
                    example: description
                  emergency_access:
                    type: string
                    description: LDAP emergency access attribute
                    example: emergency
                  notifications:
                    type: string
                    description: >-
                      LDAP attribute to describe if a user may receive
                      notifications
                    example: receives_notifications
                  levelprofiles:
                    type: string
                    description: LDAP attribute to describe the accessprofiles of a user
                    example: accessprofiles
                  sync_interval:
                    type: integer
                    description: LDAP sync interval in seconds
                    example: 3600
                    enum:
                      - 3600
                      - 10800
                      - 21600
                      - 43200
                      - 86400
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update the LDAP settings
      summary: Update LDAP settings
      tags:
        - ldap
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  type: boolean
                  description: Is LDAP active
                  example: true
                soft_deletes:
                  type: boolean
                  description: >-
                    Describes, if deleted users should be disabled or deleted.
                    If true, the user will be disabled.
                  example: false
                server_type:
                  type: string
                  description: >-
                    Select the type of LDAP server you are using. If the wrong
                    type is selected, issue may occur when requesting groups.
                  enum:
                    - active_directory
                    - openldap
                  example: active_directory
                use_range:
                  type: boolean
                  example: false
                  description: >-
                    If you are importing huge numbers of users, you should
                    enable this function to import them in chunks. Be aware,
                    that this function must be enabled on your server.
                range_size:
                  type: number
                  example: 900
                  description: >-
                    Sets the range size for chunk-requesting users. If not
                    neccessary, do not change this setting.
                security:
                  type: integer
                  description: >-
                    Describes the security level of the LDAP connection. 0 =
                    None 1 = SSL (LDAPS)
                  enum:
                    - 0
                    - 1
                  example: 1
                address:
                  type: string
                  description: LDAP server address
                  example: ldap.example.com
                port:
                  type: integer
                  description: LDAP server port
                  example: 389
                basedn:
                  type: string
                  description: LDAP base DN
                  example: dc=example,dc=com
                binddn:
                  type: string
                  description: LDAP bind DN
                  example: cn=admin,dc=example,dc=com
                binddn_password:
                  type: string
                  description: LDAP bind DN password
                  example: password
                password_confirmation:
                  type: string
                  description: >-
                    If you want to change LDAP settings and a password is
                    already stored, you need to submit the stored
                    binddn_password in this attribute
                  example: password
                usergroup_1:
                  type: integer
                  description: >-
                    ID of the Kentix system usergroup, which should be used for
                    LDAP usergroup 1
                  example: 1
                usergroup_1_path:
                  type: string
                  description: LDAP usergroup 1 path
                  example: cn=users,ou=groups,dc=example,dc=com
                usergroup_2:
                  type: integer
                  description: >-
                    ID of the Kentix system usergroup, which should be used for
                    LDAP usergroup 2
                  example: 2
                usergroup_2_path:
                  type: string
                  description: LDAP usergroup 2 path
                  example: cn=admins,ou=groups,dc=example,dc=com
                admin_group:
                  type: string
                  description: LDAP admin group
                  example: cn=admins,ou=groups,dc=example,dc=com
                user_active:
                  type: string
                  description: LDAP user active attribute
                  example: active
                username:
                  type: string
                  description: LDAP username attribute
                  example: sAMAccountName
                fullname:
                  type: string
                  description: LDAP fullname attribute
                  example: name
                email:
                  type: string
                  description: LDAP email attribute
                  example: mail
                phone:
                  type: string
                  description: LDAP phone attribute, only required for AlarmManagers
                  example: telephoneNumber
                pin:
                  type: string
                  description: LDAP pin attribute
                  example: pin
                rfid:
                  type: string
                  description: LDAP rfid attribute
                  example: rfid
                description:
                  type: string
                  description: LDAP description attribute
                  example: description
                emergency_access:
                  type: string
                  description: LDAP emergency access attribute
                  example: emergency
                notifications:
                  type: string
                  description: >-
                    LDAP attribute to describe if a user may receive
                    notifications
                  example: receives_notifications
                levelprofiles:
                  type: string
                  description: LDAP attribute to describe the accessprofiles of a user
                  example: accessprofiles
                sync_interval:
                  type: integer
                  description: LDAP sync interval in seconds
                  example: 3600
                  enum:
                    - 3600
                    - 10800
                    - 21600
                    - 43200
                    - 86400
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  is_active:
                    type: boolean
                    description: Is LDAP active
                    example: true
                  soft_deletes:
                    type: boolean
                    description: >-
                      Describes, if deleted users should be disabled or deleted.
                      If true, the user will be disabled.
                    example: false
                  server_type:
                    type: string
                    description: >-
                      Select the type of LDAP server you are using. If the wrong
                      type is selected, issue may occur when requesting groups.
                    enum:
                      - active_directory
                      - openldap
                    example: active_directory
                  use_range:
                    type: boolean
                    example: false
                    description: >-
                      If you are importing huge numbers of users, you should
                      enable this function to import them in chunks. Be aware,
                      that this function must be enabled on your server.
                  range_size:
                    type: number
                    example: 900
                    description: >-
                      Sets the range size for chunk-requesting users. If not
                      neccessary, do not change this setting.
                  security:
                    type: integer
                    description: >-
                      Describes the security level of the LDAP connection. 0 =
                      None 1 = SSL (LDAPS)
                    enum:
                      - 0
                      - 1
                    example: 1
                  address:
                    type: string
                    description: LDAP server address
                    example: ldap.example.com
                  port:
                    type: integer
                    description: LDAP server port
                    example: 389
                  basedn:
                    type: string
                    description: LDAP base DN
                    example: dc=example,dc=com
                  binddn:
                    type: string
                    description: LDAP bind DN
                    example: cn=admin,dc=example,dc=com
                  binddn_password:
                    type: string
                    nullable: true
                    description: LDAP bind DN password
                    example: password
                  usergroup_1:
                    type: integer
                    description: >-
                      ID of the Kentix system usergroup, which should be used
                      for LDAP usergroup 1
                    example: 1
                  usergroup_1_path:
                    type: string
                    description: LDAP usergroup 1 path
                    example: cn=users,ou=groups,dc=example,dc=com
                  usergroup_2:
                    type: integer
                    description: >-
                      ID of the Kentix system usergroup, which should be used
                      for LDAP usergroup 2
                    example: 2
                  usergroup_2_path:
                    type: string
                    description: LDAP usergroup 2 path
                    example: cn=admins,ou=groups,dc=example,dc=com
                  admin_group:
                    type: string
                    description: LDAP admin group
                    example: cn=admins,ou=groups,dc=example,dc=com
                  user_active:
                    type: string
                    description: LDAP user active attribute
                    example: active
                  username:
                    type: string
                    description: LDAP username attribute
                    example: sAMAccountName
                  fullname:
                    type: string
                    description: LDAP fullname attribute
                    example: name
                  email:
                    type: string
                    description: LDAP email attribute
                    example: mail
                  phone:
                    type: string
                    description: LDAP phone attribute, only required for AlarmManagers
                    example: telephoneNumber
                  pin:
                    type: string
                    description: LDAP pin attribute
                    example: pin
                  rfid:
                    type: string
                    description: LDAP rfid attribute
                    example: rfid
                  description:
                    type: string
                    description: LDAP description attribute
                    example: description
                  emergency_access:
                    type: string
                    description: LDAP emergency access attribute
                    example: emergency
                  notifications:
                    type: string
                    description: >-
                      LDAP attribute to describe if a user may receive
                      notifications
                    example: receives_notifications
                  levelprofiles:
                    type: string
                    description: LDAP attribute to describe the accessprofiles of a user
                    example: accessprofiles
                  sync_interval:
                    type: integer
                    description: LDAP sync interval in seconds
                    example: 3600
                    enum:
                      - 3600
                      - 10800
                      - 21600
                      - 43200
                      - 86400
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/ldap/sync:
    get:
      description: Start an LDAP sync
      summary: Synchronize LDAP users
      tags:
        - ldapsync
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '204':
          description: Successfully started LDAP sync
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '500':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/levelprofiles/names:
    get:
      description: Requests a list of all levelprofiles the user has access to.
      summary: Levelprofiles names
      tags:
        - levelprofile-names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of levelprofile name
                    name:
                      example: Levelprofile
                      type: string
                      description: Name of the levelprofile
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/levelprofiles:
    get:
      description: Requests all levelprofiles which the user has access to.
      summary: Get all levelprofiles
      tags:
        - levelprofile
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - name
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: Id of the levelprofile
                        name:
                          example: Levelprofile
                          type: string
                          description: Name of the levelprofile
                        timeprofile:
                          example: Timeprofile
                          type: string
                          description: Name of the timeprofile
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      description: Creates a new levelprofile.
      summary: Create levelprofile
      tags:
        - levelprofile
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Levelprofile configuration to be added
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  example: Levelprofile
                  type: string
                  description: Name of the levelprofile
                timeprofile_id:
                  example: 1
                  type: integer
                  description: Id of the assigned timeprofile
                doorlocks:
                  type: array
                  description: Ids of the doorlocks
                  items:
                    type: integer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of levelprofile
                    name:
                      example: Levelprofile
                      type: string
                      description: Name of the levelprofile
                    timeprofile_id:
                      example: 1
                      type: integer
                      description: Id of the assigned timeprofile
                    doorlocks:
                      type: array
                      description: Id of the doorlocks
                      items:
                        type: integer
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/levelprofiles/{levelprofile_id}:
    get:
      description: Requests the levelprofile via its ID.
      summary: Get levelprofile by ID
      tags:
        - levelprofile-id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: levelprofile_id
          in: path
          description: ID of the levelprofile to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of levelprofile
                    name:
                      example: Levelprofile
                      type: string
                      description: Name of the levelprofile
                    timeprofile_id:
                      example: 1
                      type: integer
                      description: Id of the assigned timeprofile
                    doorlocks:
                      type: array
                      description: Id of the doorlocks
                      items:
                        type: integer
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: >-
        Updates the configuration of a specific levelprofile. Validation errors
        are returned in the response body with HTTP 422.
      summary: Update levelprofile by ID
      tags:
        - levelprofile-id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: levelprofile_id
          in: path
          description: ID of the levelprofile to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Levelprofile configuration to be updated
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  example: Levelprofile
                  type: string
                  description: Name of the timeprofile
                timeprofile_id:
                  example: 1
                  type: integer
                  description: Id of the timeprofile connected to the levelprofile
                doorlocks:
                  type: array
                  description: Id of the doorlocks
                  items:
                    type: integer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: Id of levelprofile
                    name:
                      example: Levelprofile
                      type: string
                      description: Name of the levelprofile
                    timeprofile_id:
                      example: 1
                      type: integer
                      description: Id of the assigned timeprofile
                    doorlocks:
                      type: array
                      description: Id of the doorlocks
                      items:
                        type: integer
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
    delete:
      description: Delete the levelprofile with a specific id.
      summary: Delete a single levelprofile
      tags:
        - levelprofile-id
      parameters:
        - name: levelprofile_id
          in: path
          description: ID of the levelprofile to be deleted
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Levelprofile successfully removed
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/email:
    get:
      description: Requests the email configuration of the device.
      summary: Get email configuration
      tags:
        - mail
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: Describes if mailing is active or not.
                    sender:
                      example: sender@mail.test
                      type: string
                      description: Sender email address
                    address:
                      example: smtp.mail.test
                      type: string
                      description: SMTP server address
                    port:
                      example: 587
                      type: integer
                      description: SMTP server port
                    security:
                      example: starttls
                      type: string
                      enum:
                        - 'off'
                        - starttls
                        - ssl
                      description: SMTP server security
                    username:
                      example: myusername
                      type: string
                      description: SMTP server username
                    password:
                      example: mypassword
                      type: string
                      description: SMTP server password
                    signature:
                      example: My signature
                      type: string
                      description: Email signature
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the email configuration of the device.
      summary: Update email configuration
      tags:
        - mail
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                is_active:
                  example: true
                  type: boolean
                  description: Describes if mailing is active or not.
                sender:
                  example: sender@mail.test
                  type: string
                  description: Sender email address
                address:
                  example: smtp.mail.test
                  type: string
                  description: SMTP server address
                port:
                  example: 587
                  type: integer
                  description: SMTP server port
                security:
                  example: starttls
                  type: string
                  enum:
                    - 'off'
                    - starttls
                    - ssl
                  description: SMTP server security
                username:
                  example: myusername
                  type: string
                  description: SMTP server username
                password:
                  example: mypassword
                  type: string
                  description: SMTP server password
                signature:
                  example: My signature
                  type: string
                  description: Email signature
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: Describes if mailing is active or not.
                    sender:
                      example: sender@mail.test
                      type: string
                      description: Sender email address
                    address:
                      example: smtp.mail.test
                      type: string
                      description: SMTP server address
                    port:
                      example: 587
                      type: integer
                      description: SMTP server port
                    security:
                      example: starttls
                      type: string
                      enum:
                        - 'off'
                        - starttls
                        - ssl
                      description: SMTP server security
                    username:
                      example: myusername
                      type: string
                      description: SMTP server username
                    password:
                      example: mypassword
                      type: string
                      description: SMTP server password
                    signature:
                      example: My signature
                      type: string
                      description: Email signature
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/email-test:
    post:
      description: >-
        Send a test email. This will send a test email to the configured email
        address.
      summary: Send test email
      tags:
        - mailtest
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                sender:
                  example: sender@mail.test
                  type: string
                  description: Sender email address
                address:
                  example: smtp.mail.test
                  type: string
                  description: SMTP server address
                port:
                  example: 587
                  type: integer
                  description: SMTP server port
                security:
                  example: starttls
                  type: string
                  enum:
                    - 'off'
                    - starttls
                    - ssl
                  description: SMTP server security
                username:
                  example: myusername
                  type: string
                  description: SMTP server username
                password:
                  example: mypassword
                  type: string
                  description: SMTP server password
                signature:
                  example: My signature
                  type: string
                  description: Email signature
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: Invalid SMTP configuration
        '424':
          description: >-
            Email not sent due to no valid recipients. Only administrators with
            a configured mail address may receive this test email.
      security:
        - bearer: []
  /api/massedit:
    post:
      tags:
        - massedit
      description: Send a massedit request.
      summary: Massedit
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Massedit Data
        content:
          application/json:
            schema:
              type: object
              description: The data to massedit
              properties:
                ids:
                  type: object
                  description: An Object that contains all ids of the devices to be edited
                  properties:
                    devices:
                      type: object
                      description: >-
                        An object that holds the device_id as key and the
                        devicetype as value
                      example:
                        '1': 113
                        '43': 110
                        '69': 109
                    phases:
                      type: array
                      description: An array that holds the ids of the phases to be edited
                      items:
                        type: integer
                    ios:
                      type: array
                      description: An array that holds the ids of the ios to be edited
                      items:
                        type: integer
                    racks:
                      type: array
                      description: An array that holds the ids of the racks to be edited
                      items:
                        type: integer
                fields:
                  type: object
                  description: >-
                    An Object that contains all the fields and their values to
                    be edited (Remember to properly layer the fields e.g.
                    temerature and dewpoint have to be inside of monitoring)
                  example:
                    is_active: true
                    monitoring:
                      temperature:
                        min: '3'
                        max: '4'
                    phases:
                      voltage:
                        assignment: armed-active
                        min: '1'
                        max: '2'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                description: >-
                  A full device list of all edited devices and their edit
                  success.
                items:
                  type: object
                  properties:
                    device:
                      type: string
                      description: Name of the device
                    id:
                      type: integer
                      description: ID of the device
                    success:
                      type: string
                      description: Status if the editing failed or not
                    type:
                      type: integer
                      description: Type of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/multisensors:
    get:
      tags:
        - multisensor
      description: Get a list of all MultiSensors.
      summary: Get MultiSensors
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: the ID of the device
                        name:
                          example: MultiSensor
                          type: string
                          description: The name of the device
                        type:
                          example: 1
                          type: integer
                          description: The type of the device
                        is_active:
                          example: true
                          type: boolean
                          description: The flag to determine the status of the device
                        address:
                          example: 192.168.0.1
                          type: string
                          description: The address of the device
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        type_name:
                          example: MultiSensor-RF
                          type: string
                          description: The name of the type
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/multisensors/names:
    get:
      tags:
        - multisensor-names
      description: Get the names of all MultiSensors.
      summary: Get MultiSensor names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: MultiSensor
                      type: string
                      description: The name of the device
                    type:
                      example: 1
                      type: integer
                      description: The type of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/multisensors/{multisensor}:
    get:
      tags:
        - multisensor-id
      description: Get the configuration of given MultiSensor.
      summary: Get Details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: multisensor
          in: path
          description: MultiSensor ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  device_id:
                    example: 1
                    type: integer
                    description: the ID of the device this device is assigned to
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: MultiSensor
                    type: string
                    description: The name of the device
                  description:
                    example: MultiSensor main hall
                    type: string
                    description: The description of the device
                  type:
                    example: 1
                    type: integer
                    description: The type of the device
                  type_name:
                    example: MultiSensor-RF
                    type: string
                    description: The name of the type
                  address:
                    example: 192.168.0.1
                    type: string
                    description: The address of the device
                  alarmdelay:
                    example: 10
                    type: integer
                    description: The amount of seconds an alarm will be delayed
                  monitoring:
                    type: object
                    properties:
                      temperature:
                        type: object
                        description: The configuration for the temperature sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 15
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 25
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          offset:
                            example: 2
                            type: integer
                            description: The offset applied to the value
                          units:
                            type: object
                            properties:
                              min:
                                example: °C
                                type: string
                                description: The unit for the min field
                              max:
                                example: °C
                                type: string
                                description: The unit for the max field
                              offset:
                                example: °C
                                type: string
                                description: The unit for the offset field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 17
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 23
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      humidity:
                        type: object
                        description: The configuration for the humidity sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 40
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 60
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          units:
                            type: object
                            properties:
                              min:
                                example: '%'
                                type: string
                                description: The unit for the min field
                              max:
                                example: '%'
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 45
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 55
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      dewpoint:
                        type: object
                        description: The configuration for the dewpoint sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          hysteresis:
                            example: 2
                            type: integer
                            description: >-
                              The hysteresis threshold where an alarm is
                              triggered
                          units:
                            type: object
                            properties:
                              hysteresis:
                                example: °C
                                type: string
                                description: The unit for the hysteresis field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      air_quality:
                        type: object
                        description: The configuration for the air_quality sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                    description: co2 and air_quality MultiSensorTI only
                  fire:
                    type: object
                    properties:
                      heat:
                        type: object
                        description: The configuration for the heat sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 4
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: °C/min
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 2
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      co:
                        type: object
                        description: The configuration for the CO sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 20
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: '%'
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      air_quality:
                        type: object
                        description: The configuration for the air_quality sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                    description: air_quality MultiSensorTI only
                  intrusion:
                    type: object
                    properties:
                      vibration:
                        type: object
                        description: The configuration for the vibration sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          sensitivity:
                            example: medium
                            type: string
                            description: >-
                              The sensitivity threshold where an alarm is
                              triggered
                      motion:
                        type: object
                        description: The configuration for the motion sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 30
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: '%'
                                type: string
                                description: The unit for the threshold field
                      door_contact:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                        description: '[MultiSensor-Door only]'
                  ir_color_mode:
                    example: color
                    type: string
                    enum:
                      - color
                      - gray
                    description: '[MultiSensor-TI only] The mode in which the data is given'
                  ir_custom_range:
                    example: true
                    type: boolean
                    description: >-
                      [MultiSensor-TI only] The flag, if a custom range is
                      active
                  ir_distance:
                    example: 250
                    type: integer
                    description: >-
                      [MultiSensor-TI only] The distance between the device and
                      the ground (in cm)
                  ir_emissivity:
                    example: '0.9499999999999999996'
                    type: string
                    description: '[MultiSensor-TI only] The emissivity'
                  ir_max_value:
                    example: 1500
                    type: integer
                    description: >-
                      [MultiSensor-TI only] The max value for scaling the
                      temperature
                  ir_min_value:
                    example: 1000
                    type: integer
                    description: >-
                      [MultiSensor-TI only] The min value for scaling the
                      temperature
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  rack_id:
                    example: null
                    type: integer
                    description: The ID of the rack the device is assigned to
                  external:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel2:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                  output:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel2:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - multisensor-id
      description: Update the configuration of given MultiSensor.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: multisensor
          in: path
          description: MultiSensor ID
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                device_id:
                  example: 1
                  type: integer
                  description: the ID of the device this device is assigned to
                is_active:
                  example: true
                  type: boolean
                  description: The flag to determine the status of the device
                name:
                  example: MultiSensor
                  type: string
                  description: The name of the device
                description:
                  example: MultiSensor main hall
                  type: string
                  description: The description of the device
                type:
                  example: 1
                  type: integer
                  description: The type of the device
                type_name:
                  example: MultiSensor-RF
                  type: string
                  description: The name of the type
                address:
                  example: 192.168.0.1
                  type: string
                  description: The address of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                monitoring:
                  type: object
                  properties:
                    temperature:
                      type: object
                      description: The configuration for the temperature sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        min:
                          example: 15
                          type: integer
                          description: The minimal threshold before an alarm is triggered
                        max:
                          example: 25
                          type: integer
                          description: The maximum threshold before an alarm is triggered
                        offset:
                          example: 2
                          type: integer
                          description: The offset applied to the value
                        units:
                          type: object
                          properties:
                            min:
                              example: °C
                              type: string
                              description: The unit for the min field
                            max:
                              example: °C
                              type: string
                              description: The unit for the max field
                            offset:
                              example: °C
                              type: string
                              description: The unit for the offset field
                        warning:
                          type: object
                          properties:
                            min:
                              example: 17
                              type: integer
                              description: The warning threshold for the min value
                            max:
                              example: 23
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    humidity:
                      type: object
                      description: The configuration for the humidity sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        min:
                          example: 40
                          type: integer
                          description: The minimal threshold before an alarm is triggered
                        max:
                          example: 60
                          type: integer
                          description: The maximum threshold before an alarm is triggered
                        units:
                          type: object
                          properties:
                            min:
                              example: '%'
                              type: string
                              description: The unit for the min field
                            max:
                              example: '%'
                              type: string
                              description: The unit for the max field
                        warning:
                          type: object
                          properties:
                            min:
                              example: 45
                              type: integer
                              description: The warning threshold for the min value
                            max:
                              example: 55
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    dewpoint:
                      type: object
                      description: The configuration for the dewpoint sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        hysteresis:
                          example: 2
                          type: integer
                          description: The hysteresis threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            hysteresis:
                              example: °C
                              type: string
                              description: The unit for the hysteresis field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 1
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    air_quality:
                      type: object
                      description: The configuration for the air_quality sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 20
                          type: integer
                          description: The max threshold where an alarm is triggered
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                  description: co2 and air_quality MultiSensorTI only
                fire:
                  type: object
                  properties:
                    heat:
                      type: object
                      description: The configuration for the heat sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 4
                          type: integer
                          description: The threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            threshold:
                              example: °C/min
                              type: string
                              description: The unit for the threshold field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 2
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    co:
                      type: object
                      description: The configuration for the CO sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 20
                          type: integer
                          description: The threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            threshold:
                              example: '%'
                              type: string
                              description: The unit for the threshold field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    air_quality:
                      type: object
                      description: The configuration for the air_quality sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 20
                          type: integer
                          description: The max threshold where an alarm is triggered
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                  description: air_quality MultiSensorTI only
                intrusion:
                  type: object
                  properties:
                    vibration:
                      type: object
                      description: The configuration for the vibration sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        sensitivity:
                          example: medium
                          type: string
                          description: >-
                            The sensitivity threshold where an alarm is
                            triggered
                    motion:
                      type: object
                      description: The configuration for the motion sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 30
                          type: integer
                          description: The threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            threshold:
                              example: '%'
                              type: string
                              description: The unit for the threshold field
                    door_contact:
                      type: object
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                      description: '[MultiSensor-Door only]'
                ir_color_mode:
                  example: color
                  type: string
                  enum:
                    - color
                    - gray
                  description: '[MultiSensor-TI only] The mode in which the data is given'
                ir_custom_range:
                  example: true
                  type: boolean
                  description: '[MultiSensor-TI only] The flag, if a custom range is active'
                ir_distance:
                  example: 250
                  type: integer
                  description: >-
                    [MultiSensor-TI only] The distance between the device and
                    the ground (in cm)
                ir_emissivity:
                  example: '0.9499999999999999996'
                  type: string
                  description: '[MultiSensor-TI only] The emissivity'
                ir_max_value:
                  example: 1500
                  type: integer
                  description: >-
                    [MultiSensor-TI only] The max value for scaling the
                    temperature
                ir_min_value:
                  example: 1000
                  type: integer
                  description: >-
                    [MultiSensor-TI only] The min value for scaling the
                    temperature
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                rack_id:
                  example: null
                  type: integer
                  description: The ID of the rack the device is assigned to
                external:
                  type: object
                  properties:
                    channel1:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
                    channel2:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
                output:
                  type: object
                  properties:
                    channel1:
                      type: object
                      description: The configuration for an digital output
                      properties:
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        event_id:
                          example: 1
                          type: integer
                          description: The ID of the Eventprofile applied to this device
                        output_time:
                          example: 1
                          type: integer
                          description: >-
                            Determines how long this output will be opened on
                            alarm
                    channel2:
                      type: object
                      description: The configuration for an digital output
                      properties:
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        event_id:
                          example: 1
                          type: integer
                          description: The ID of the Eventprofile applied to this device
                        output_time:
                          example: 1
                          type: integer
                          description: >-
                            Determines how long this output will be opened on
                            alarm
                webhooks:
                  type: array
                  description: The webhook relations of this device
                  items:
                    type: object
                    properties:
                      id:
                        example: 0
                        type: integer
                        description: Must be an Id of an existing webhook.
                      event:
                        example: 0
                        type: integer
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                          - 51
                        description: Must be an Id of an existing webhook event type.
                      cycle_time:
                        example: 5
                        type: integer
                        nullable: true
                        enum:
                          - 5
                          - 10
                          - 15
                          - 30
                        description: >-
                          Describes how often the webhook should be executed.
                          Only required if event is 51.
                      trigger_on_alarm:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          an alarm.
                      trigger_on_warning:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          a warning.
                connection:
                  type: object
                  properties:
                    assignment:
                      example: 'off'
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of the connection
                    warning:
                      type: object
                      properties:
                        active:
                          type: boolean
                          example: true
                          description: >-
                            Configures whether connection issues should be
                            displayed as a warning instead of an alarm
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  device_id:
                    example: 1
                    type: integer
                    description: the ID of the device this device is assigned to
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: MultiSensor
                    type: string
                    description: The name of the device
                  description:
                    example: MultiSensor main hall
                    type: string
                    description: The description of the device
                  type:
                    example: 1
                    type: integer
                    description: The type of the device
                  type_name:
                    example: MultiSensor-RF
                    type: string
                    description: The name of the type
                  address:
                    example: 192.168.0.1
                    type: string
                    description: The address of the device
                  alarmdelay:
                    example: 10
                    type: integer
                    description: The amount of seconds an alarm will be delayed
                  monitoring:
                    type: object
                    properties:
                      temperature:
                        type: object
                        description: The configuration for the temperature sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 15
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 25
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          offset:
                            example: 2
                            type: integer
                            description: The offset applied to the value
                          units:
                            type: object
                            properties:
                              min:
                                example: °C
                                type: string
                                description: The unit for the min field
                              max:
                                example: °C
                                type: string
                                description: The unit for the max field
                              offset:
                                example: °C
                                type: string
                                description: The unit for the offset field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 17
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 23
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      humidity:
                        type: object
                        description: The configuration for the humidity sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 40
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 60
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          units:
                            type: object
                            properties:
                              min:
                                example: '%'
                                type: string
                                description: The unit for the min field
                              max:
                                example: '%'
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 45
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 55
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      dewpoint:
                        type: object
                        description: The configuration for the dewpoint sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          hysteresis:
                            example: 2
                            type: integer
                            description: >-
                              The hysteresis threshold where an alarm is
                              triggered
                          units:
                            type: object
                            properties:
                              hysteresis:
                                example: °C
                                type: string
                                description: The unit for the hysteresis field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      air_quality:
                        type: object
                        description: The configuration for the air_quality sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                    description: co2 and air_quality MultiSensorTI only
                  fire:
                    type: object
                    properties:
                      heat:
                        type: object
                        description: The configuration for the heat sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 4
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: °C/min
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 2
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      co:
                        type: object
                        description: The configuration for the CO sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 20
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: '%'
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      air_quality:
                        type: object
                        description: The configuration for the air_quality sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                    description: air_quality MultiSensorTI only
                  intrusion:
                    type: object
                    properties:
                      vibration:
                        type: object
                        description: The configuration for the vibration sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          sensitivity:
                            example: medium
                            type: string
                            description: >-
                              The sensitivity threshold where an alarm is
                              triggered
                      motion:
                        type: object
                        description: The configuration for the motion sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 30
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: '%'
                                type: string
                                description: The unit for the threshold field
                      door_contact:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                        description: '[MultiSensor-Door only]'
                  ir_color_mode:
                    example: color
                    type: string
                    enum:
                      - color
                      - gray
                    description: '[MultiSensor-TI only] The mode in which the data is given'
                  ir_custom_range:
                    example: true
                    type: boolean
                    description: >-
                      [MultiSensor-TI only] The flag, if a custom range is
                      active
                  ir_distance:
                    example: 250
                    type: integer
                    description: >-
                      [MultiSensor-TI only] The distance between the device and
                      the ground (in cm)
                  ir_emissivity:
                    example: '0.9499999999999999996'
                    type: string
                    description: '[MultiSensor-TI only] The emissivity'
                  ir_max_value:
                    example: 1500
                    type: integer
                    description: >-
                      [MultiSensor-TI only] The max value for scaling the
                      temperature
                  ir_min_value:
                    example: 1000
                    type: integer
                    description: >-
                      [MultiSensor-TI only] The min value for scaling the
                      temperature
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  rack_id:
                    example: null
                    type: integer
                    description: The ID of the rack the device is assigned to
                  external:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                      channel2:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
                  output:
                    type: object
                    properties:
                      channel1:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                      channel2:
                        type: object
                        description: The configuration for an digital output
                        properties:
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          event_id:
                            example: 1
                            type: integer
                            description: The ID of the Eventprofile applied to this device
                          output_time:
                            example: 1
                            type: integer
                            description: >-
                              Determines how long this output will be opened on
                              alarm
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/network-sensors:
    get:
      tags:
        - network-sensor
      description: Get a list of all Network-Sensors.
      summary: Get Network-Sensors
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 1
                          type: integer
                          description: the ID of the device
                        name:
                          example: Network-Sensor
                          type: string
                          description: The name of the device
                        type:
                          example: 142
                          type: integer
                          description: The type of the device
                        is_active:
                          example: true
                          type: boolean
                          description: The flag to determine the status of the device
                        address:
                          example: 192.168.0.1
                          type: string
                          description: The address of the device
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/network-sensors/names:
    get:
      tags:
        - network-sensor-names
      description: Get the names of all Network-Sensors.
      summary: Get Network-Sensor names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: Network-Sensor
                      type: string
                      description: The name of the device
                    type:
                      example: 142
                      type: integer
                      description: The type of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/network-sensors/{sensor}:
    get:
      tags:
        - network-sensor-id
      description: Get the configuration of given Network-Sensors.
      summary: Get Details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: sensor
          in: path
          example: 1
          description: Network-Sensor ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  type:
                    example: 142
                    type: integer
                    description: The type of the device
                  name:
                    example: Network-Sensor
                    type: string
                    description: The name of the device
                  address:
                    example: 192.168.0.1
                    type: string
                    description: The address of the device
                  port:
                    example: 8080
                    type: integer
                    description: If service_type is port the monitored port is set here
                  description:
                    example: Network-Sensor Server1
                    type: string
                    description: The description of the device
                  service_type:
                    example: ping
                    type: string
                    enum:
                      - ping
                      - port
                    description: The type of sensor
                  service_interval:
                    example: 180
                    type: integer
                    description: Interval in which the given server is checked
                  protocol:
                    example: http
                    type: string
                    enum:
                      - http
                      - https
                    description: The protocol to be used
                  alarmvalue:
                    type: object
                    properties:
                      latency:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 100
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: null
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 80
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  rack_id:
                    example: null
                    type: integer
                    description: The ID of the rack the device is assigned to
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - network-sensor-id
      description: Update the configuration of given Network-Sensor.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: sensor
          in: path
          description: Network-Sensor ID
          example: 1
          required: true
          schema:
            type: string
      requestBody:
        description: Successful operation
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                is_active:
                  example: true
                  type: boolean
                  description: The flag to determine the status of the device
                type:
                  example: 142
                  type: integer
                  description: The type of the device
                name:
                  example: Network-Sensor
                  type: string
                  description: The name of the device
                address:
                  example: 192.168.0.1
                  type: string
                  description: The address of the device
                port:
                  example: 8080
                  type: integer
                  description: If service_type is port the monitored port is set here
                description:
                  example: Network-Sensor Server1
                  type: string
                  description: The description of the device
                service_type:
                  example: ping
                  type: string
                  enum:
                    - ping
                    - port
                  description: The type of sensor
                service_interval:
                  example: 180
                  type: integer
                  description: Interval in which the given server is checked
                protocol:
                  example: http
                  type: string
                  enum:
                    - http
                    - https
                  description: The protocol to be used
                alarmvalue:
                  type: object
                  properties:
                    latency:
                      type: object
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 100
                          type: integer
                          description: The max threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            max:
                              example: null
                              type: string
                              description: The unit for the max field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 80
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                rack_id:
                  example: null
                  type: integer
                  description: The ID of the rack the device is assigned to
                webhooks:
                  type: array
                  description: The webhook relations of this device
                  items:
                    type: object
                    properties:
                      id:
                        example: 0
                        type: integer
                        description: Must be an Id of an existing webhook.
                      event:
                        example: 0
                        type: integer
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                          - 51
                        description: Must be an Id of an existing webhook event type.
                      cycle_time:
                        example: 5
                        type: integer
                        nullable: true
                        enum:
                          - 5
                          - 10
                          - 15
                          - 30
                        description: >-
                          Describes how often the webhook should be executed.
                          Only required if event is 51.
                      trigger_on_alarm:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          an alarm.
                      trigger_on_warning:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          a warning.
                connection:
                  type: object
                  properties:
                    assignment:
                      example: 'off'
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of the connection
                    warning:
                      type: object
                      properties:
                        active:
                          type: boolean
                          example: true
                          description: >-
                            Configures whether connection issues should be
                            displayed as a warning instead of an alarm
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  type:
                    example: 142
                    type: integer
                    description: The type of the device
                  name:
                    example: Network-Sensor
                    type: string
                    description: The name of the device
                  address:
                    example: 192.168.0.1
                    type: string
                    description: The address of the device
                  port:
                    example: 8080
                    type: integer
                    description: If service_type is port the monitored port is set here
                  description:
                    example: Network-Sensor Server1
                    type: string
                    description: The description of the device
                  service_type:
                    example: ping
                    type: string
                    enum:
                      - ping
                      - port
                    description: The type of sensor
                  service_interval:
                    example: 180
                    type: integer
                    description: Interval in which the given server is checked
                  protocol:
                    example: http
                    type: string
                    enum:
                      - http
                      - https
                    description: The protocol to be used
                  alarmvalue:
                    type: object
                    properties:
                      latency:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 100
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: null
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 80
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  rack_id:
                    example: null
                    type: integer
                    description: The ID of the rack the device is assigned to
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/network:
    get:
      description: Requests the network configuration of the device.
      summary: Get network configuration
      tags:
        - networkconfig
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    dhcp_active:
                      example: true
                      type: boolean
                      description: Describes if DHCP is active or not.
                    dhcp_address:
                      example: 192.168.100.224
                      type: string
                      description: DHCP IP address of the device.
                    dhcp_netmask:
                      example: 255.255.255.0
                      type: string
                      description: DHCP netmask of the device.
                    static_active:
                      example: false
                      type: boolean
                      description: Describes if static IP is active or not.
                    static_address:
                      example: 192.168.100.224
                      type: string
                      nullable: true
                      description: Static IP address of the device.
                    static_netmask:
                      example: 255.255.255.0
                      type: string
                      description: Static netmask of the device.
                    gateway:
                      example: 192.168.100.1
                      type: string
                      description: Network gateway of the device.
                    dns1:
                      example: 192.168.100.1
                      type: string
                      description: Primary DNS server of the device.
                    dns2:
                      example: 192.168.100.2
                      type: string
                      description: Secondary DNS server of the device.
                    dyndns_address:
                      example: my-alarmmanager.internal.mycompany.com
                      type: string
                      description: Dynymic DNS address of the device.
                    port_auth:
                      description: IEEE 802.1X port authentication settings.
                      type: object
                      properties:
                        is_active:
                          example: true
                          type: boolean
                          description: >-
                            Describes if IEEE 802.1X port authentication is
                            enabled or not.
                        method:
                          example: eap-peap
                          type: string
                          enum:
                            - eap-peap
                          description: IEEE 802.1X port authentication method.
                        identity:
                          example: myusername
                          type: string
                          description: IEEE 802.1X port authentication identity.
                        password:
                          example: mypassword
                          type: string
                          description: IEEE 802.1X port authentication password.
                        is_password_hashed:
                          example: false
                          type: boolean
                          description: Describes if the given password is already hashed.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the network configuration of the device.
      summary: Update network configuration
      tags:
        - networkconfig
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                dhcp_active:
                  example: true
                  type: boolean
                  description: Describes if DHCP is active or not.
                dhcp_address:
                  example: 192.168.100.224
                  type: string
                  description: DHCP IP address of the device.
                dhcp_netmask:
                  example: 255.255.255.0
                  type: string
                  description: DHCP netmask of the device.
                static_active:
                  example: false
                  type: boolean
                  description: Describes if static IP is active or not.
                static_address:
                  example: 192.168.100.224
                  type: string
                  nullable: true
                  description: Static IP address of the device.
                static_netmask:
                  example: 255.255.255.0
                  type: string
                  description: Static netmask of the device.
                gateway:
                  example: 192.168.100.1
                  type: string
                  description: Network gateway of the device.
                dns1:
                  example: 192.168.100.1
                  type: string
                  description: Primary DNS server of the device.
                dns2:
                  example: 192.168.100.2
                  type: string
                  description: Secondary DNS server of the device.
                dyndns_address:
                  example: my-alarmmanager.internal.mycompany.com
                  type: string
                  description: Dynymic DNS address of the device.
                port_auth:
                  description: IEEE 802.1X port authentication settings.
                  type: object
                  properties:
                    is_active:
                      example: true
                      type: boolean
                      description: >-
                        Describes if IEEE 802.1X port authentication is enabled
                        or not.
                    method:
                      example: eap-peap
                      type: string
                      enum:
                        - eap-peap
                      description: IEEE 802.1X port authentication method.
                    identity:
                      example: myusername
                      type: string
                      description: IEEE 802.1X port authentication identity.
                    password:
                      example: mypassword
                      type: string
                      description: IEEE 802.1X port authentication password.
                    is_password_hashed:
                      example: false
                      type: boolean
                      description: Describes if the given password is already hashed.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    dhcp_active:
                      example: true
                      type: boolean
                      description: Describes if DHCP is active or not.
                    dhcp_address:
                      example: 192.168.100.224
                      type: string
                      description: DHCP IP address of the device.
                    dhcp_netmask:
                      example: 255.255.255.0
                      type: string
                      description: DHCP netmask of the device.
                    static_active:
                      example: false
                      type: boolean
                      description: Describes if static IP is active or not.
                    static_address:
                      example: 192.168.100.224
                      type: string
                      nullable: true
                      description: Static IP address of the device.
                    static_netmask:
                      example: 255.255.255.0
                      type: string
                      description: Static netmask of the device.
                    gateway:
                      example: 192.168.100.1
                      type: string
                      description: Network gateway of the device.
                    dns1:
                      example: 192.168.100.1
                      type: string
                      description: Primary DNS server of the device.
                    dns2:
                      example: 192.168.100.2
                      type: string
                      description: Secondary DNS server of the device.
                    dyndns_address:
                      example: my-alarmmanager.internal.mycompany.com
                      type: string
                      description: Dynymic DNS address of the device.
                    port_auth:
                      description: IEEE 802.1X port authentication settings.
                      type: object
                      properties:
                        is_active:
                          example: true
                          type: boolean
                          description: >-
                            Describes if IEEE 802.1X port authentication is
                            enabled or not.
                        method:
                          example: eap-peap
                          type: string
                          enum:
                            - eap-peap
                          description: IEEE 802.1X port authentication method.
                        identity:
                          example: myusername
                          type: string
                          description: IEEE 802.1X port authentication identity.
                        password:
                          example: mypassword
                          type: string
                          description: IEEE 802.1X port authentication password.
                        is_password_hashed:
                          example: false
                          type: boolean
                          description: Describes if the given password is already hashed.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/ssl-certificate:
    get:
      description: Requests the SSL certificate of the device.
      summary: Get SSL certificate
      tags:
        - sslcertificate
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: string
                      description: The SSL certificate of the device.
                    upload:
                      type: string
                      description: The date and time the certificate was uploaded.
                      example: '2020-01-01 00:00:00'
                    begin:
                      type: string
                      description: The date and time the certificate is valid from.
                      example: '2020-01-01 00:00:00'
                    end:
                      type: string
                      description: The date and time the certificate is valid until.
                      example: '2020-01-01 00:00:00'
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      description: Uploads a new SSL certificate to the device.
      summary: Upload SSL certificate
      tags:
        - sslcertificate
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: The SSL certificate to upload.
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: string
                      description: The SSL certificate of the device.
                    upload:
                      type: string
                      description: The date and time the certificate was uploaded.
                      example: '2020-01-01 00:00:00'
                    begin:
                      type: string
                      description: The date and time the certificate is valid from.
                      example: '2020-01-01 00:00:00'
                    end:
                      type: string
                      description: The date and time the certificate is valid until.
                      example: '2020-01-01 00:00:00'
        '400':
          description: Invalid certificate
      security:
        - bearer: []
    delete:
      description: Deletes the SSL certificate of the device.
      summary: Delete SSL certificate
      tags:
        - sslcertificate
      responses:
        '204':
          description: Certificate successfully removed
        '400':
          description: Certificate could not be removed
      security:
        - bearer: []
  /api/passages/names:
    get:
      description: Requests a list of all passages the user has access to.
      summary: Gets a list of all passage names
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      tags:
        - passage
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: The ID of the passage
                    name:
                      type: string
                      description: The name of the passage.
                    doorlocks:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            description: The ID of the doorlock
                          name:
                            type: string
                            description: The name of the doorlock.
                    external:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            description: The ID of the external input
                          name:
                            type: string
                            description: The name of the external input.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/passages/{passage_id}:
    get:
      description: Requests the passage via its ID.
      summary: Get passage
      tags:
        - passage-id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: passage_id
          in: path
          example: 1
          description: ID of the passage to be queried
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: ID of the passage
                  name:
                    type: string
                    example: Passage Name
                    description: Name of the passage
                  doorlocks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: ID of the DoorLock
                          example: 2
                        device_id:
                          type: number
                          description: >-
                            ID of the DoorLock's host device, i.e. the device on
                            which is has been teached-in.
                          example: 1
                        is_active:
                          type: boolean
                          description: Describes if the DoorLock is active or inactive.
                          example: true
                        is_teachin_default:
                          type: boolean
                          description: >-
                            Describes if this DoorLock is preselected, when a
                            RFID token will be teached-id.
                          example: false
                        name:
                          type: string
                          description: Name of the DoorLock
                          example: Frontdoor
                        type:
                          type: number
                          description: Numerical devicetype
                          example: 21
                        signal_zonestate:
                          type: boolean
                          description: >-
                            Set true, if the DoorLock should show the current
                            arm state of the assigned alarmzone.
                          example: false
                        coupletime:
                          example: 3
                          type: number
                          description: >-
                            Time in seconds after the booking while the door can
                            be opened.
                        doubleauth_mode:
                          example: 0
                          type: number
                          nullable: true
                          description: >-
                            Mode for double authentication. 0=Off, 1=On, 2=Only
                            when arming/disarming, 3=time controlled via
                            timeprofile.
                        doubleauth_timeprofile_id:
                          example: 0
                          type: number
                          nullable: true
                          description: >-
                            ID of the timeprofile which shall be used to enable
                            and disable the double authentication on specific
                            times.
                        log_level:
                          example: 1
                          type: number
                          description: >-
                            Sets the logbook logging mode for this DoorLock.
                            1=Default, 2=No user-related data (names, pictures),
                            3=Only unauthorized bookings, 4=No logging.
                        timeprofile_mode:
                          example: 0
                          type: number
                          enum:
                            - 0
                            - 1
                            - 2
                          description: >-
                            Mode for timeprofile usage. 0=Off, 1=On, 2=Open
                            after first booking within the time profile.
                        timeprofile_id:
                          type: number
                          description: ID of the DoorLock's assigned timeprofile
                          example: 2
                        group_id:
                          type: number
                          description: ID of the DoorLock's assigned alarmgroup
                          example: 2
                        armlevel:
                          example: 0
                          type: number
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                          description: >-
                            Set the arming level of this DoorLock. 0=Off,
                            1=Assigned Alarmzone, 2=Building containing the
                            assigned Alarmzone, 3=System, 4=External
                            Alarmsystem.
                        webhooks:
                          type: array
                          items:
                            type: integer
                          description: IDs of all assigned webhooks.
                        cameras:
                          type: array
                          items:
                            type: integer
                          description: IDs of all assigned cameras.
                        batterylevel:
                          type: string
                          description: Battery level of the DoorLock
                          example: full
                          enum:
                            - full
                            - half
                            - low
                            - critical
                            - wired
                        reed_bypass_time:
                          type: number
                          description: >-
                            Time in seconds after the booking while the door can
                            be opened without reed contact alarming.
                          example: 30
                          enum:
                            - 0
                            - 5
                            - 10
                            - 15
                            - 30
                            - 45
                            - 60
                            - 90
                            - 120
                        reed_bypass_buzzer_time:
                          type: number
                          description: >-
                            Time in seconds to buzzer after the bypass time and
                            before triggering the door contact alarm.
                          example: 30
                          enum:
                            - 0
                            - 5
                            - 10
                            - 15
                            - 30
                            - 45
                            - 60
                            - 90
                            - 120
                        sabotage:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of the disassembly alarm.
                        reed_source_id:
                          type: number
                          example: 'off'
                          description: >-
                            API-ID of the external sensor, which is assigned to
                            be the doorlock's reed sensor.
                        reed_assignment:
                          type: string
                          example: 'off'
                          description: Alarm-Assignment for the assigned reed sensor.
                        reed_delay:
                          type: number
                          example: 3600
                          description: >-
                            If the reed sensor triggers an alarm, it will be
                            delayed by this time (in seconds).
                        reed_warning_active:
                          type: boolean
                          example: true
                          description: >-
                            Enables signaling on the DoorLock if the door is
                            open for the set time (in seconds). The signaling
                            will stop when the door is closed again.
                        reed_warning_delay:
                          type: number
                          example: 1800
                          description: >-
                            The door must stay open for the set time to start
                            the signalization.
                  external:
                    type: array
                    items:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: >-
        Updates the configuration of a specific passage. Validation errors are
        returned in the response body with HTTP 422.
      summary: Update passage
      tags:
        - passage-id
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: passage_id
          in: path
          description: ID of the patch to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Passage configuration to be updated
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Passage Name
                  description: Name of the passage
                doorlocks:
                  type: array
                  items:
                    type: integer
                    description: ID of an assigned doorlock
                external:
                  type: array
                  items:
                    type: integer
                    description: ID of an assigned external input
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    description: ID of the passage
                  name:
                    type: string
                    example: Passage Name
                    description: Name of the passage
                  doorlocks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: ID of the DoorLock
                          example: 2
                        device_id:
                          type: number
                          description: >-
                            ID of the DoorLock's host device, i.e. the device on
                            which is has been teached-in.
                          example: 1
                        is_active:
                          type: boolean
                          description: Describes if the DoorLock is active or inactive.
                          example: true
                        is_teachin_default:
                          type: boolean
                          description: >-
                            Describes if this DoorLock is preselected, when a
                            RFID token will be teached-id.
                          example: false
                        name:
                          type: string
                          description: Name of the DoorLock
                          example: Frontdoor
                        type:
                          type: number
                          description: Numerical devicetype
                          example: 21
                        signal_zonestate:
                          type: boolean
                          description: >-
                            Set true, if the DoorLock should show the current
                            arm state of the assigned alarmzone.
                          example: false
                        coupletime:
                          example: 3
                          type: number
                          description: >-
                            Time in seconds after the booking while the door can
                            be opened.
                        doubleauth_mode:
                          example: 0
                          type: number
                          nullable: true
                          description: >-
                            Mode for double authentication. 0=Off, 1=On, 2=Only
                            when arming/disarming, 3=time controlled via
                            timeprofile.
                        doubleauth_timeprofile_id:
                          example: 0
                          type: number
                          nullable: true
                          description: >-
                            ID of the timeprofile which shall be used to enable
                            and disable the double authentication on specific
                            times.
                        log_level:
                          example: 1
                          type: number
                          description: >-
                            Sets the logbook logging mode for this DoorLock.
                            1=Default, 2=No user-related data (names, pictures),
                            3=Only unauthorized bookings, 4=No logging.
                        timeprofile_mode:
                          example: 0
                          type: number
                          enum:
                            - 0
                            - 1
                            - 2
                          description: >-
                            Mode for timeprofile usage. 0=Off, 1=On, 2=Open
                            after first booking within the time profile.
                        timeprofile_id:
                          type: number
                          description: ID of the DoorLock's assigned timeprofile
                          example: 2
                        group_id:
                          type: number
                          description: ID of the DoorLock's assigned alarmgroup
                          example: 2
                        armlevel:
                          example: 0
                          type: number
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                          description: >-
                            Set the arming level of this DoorLock. 0=Off,
                            1=Assigned Alarmzone, 2=Building containing the
                            assigned Alarmzone, 3=System, 4=External
                            Alarmsystem.
                        webhooks:
                          type: array
                          items:
                            type: integer
                          description: IDs of all assigned webhooks.
                        cameras:
                          type: array
                          items:
                            type: integer
                          description: IDs of all assigned cameras.
                        batterylevel:
                          type: string
                          description: Battery level of the DoorLock
                          example: full
                          enum:
                            - full
                            - half
                            - low
                            - critical
                            - wired
                        reed_bypass_time:
                          type: number
                          description: >-
                            Time in seconds after the booking while the door can
                            be opened without reed contact alarming.
                          example: 30
                          enum:
                            - 0
                            - 5
                            - 10
                            - 15
                            - 30
                            - 45
                            - 60
                            - 90
                            - 120
                        reed_bypass_buzzer_time:
                          type: number
                          description: >-
                            Time in seconds to buzzer after the bypass time and
                            before triggering the door contact alarm.
                          example: 30
                          enum:
                            - 0
                            - 5
                            - 10
                            - 15
                            - 30
                            - 45
                            - 60
                            - 90
                            - 120
                        sabotage:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of the disassembly alarm.
                        reed_source_id:
                          type: number
                          example: 'off'
                          description: >-
                            API-ID of the external sensor, which is assigned to
                            be the doorlock's reed sensor.
                        reed_assignment:
                          type: string
                          example: 'off'
                          description: Alarm-Assignment for the assigned reed sensor.
                        reed_delay:
                          type: number
                          example: 3600
                          description: >-
                            If the reed sensor triggers an alarm, it will be
                            delayed by this time (in seconds).
                        reed_warning_active:
                          type: boolean
                          example: true
                          description: >-
                            Enables signaling on the DoorLock if the door is
                            open for the set time (in seconds). The signaling
                            will stop when the door is closed again.
                        reed_warning_delay:
                          type: number
                          example: 1800
                          description: >-
                            The door must stay open for the set time to start
                            the signalization.
                  external:
                    type: array
                    items:
                      type: object
                      description: The configuration for an digital input
                      properties:
                        alarm_when:
                          example: close
                          type: string
                          enum:
                            - close
                            - open
                          description: Configures on which state an alarm will be triggered
                        alarmdelay:
                          example: 10
                          type: integer
                          description: The amount of seconds an alarm will be delayed
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                            - arm-disarm
                            - arm
                            - disarm
                          description: The alarm assignment
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >-
                            Determines if the alarmstate of this device is
                            ignored during arming
                        description_alert:
                          example: Alarm
                          type: string
                          description: The description to be displayed when an alarm occurs
                        description_ok:
                          example: OK
                          type: string
                          description: The description to be displayed when no alarm occurs
                        group_id:
                          example: 1
                          type: integer
                          description: The ID of the group the device is assigned to
                        icon:
                          example: ethernet
                          type: string
                          description: The icon to be displayed
                        id:
                          example: 2
                          type: integer
                          description: the ID of the device
                        name:
                          example: External Input
                          type: string
                          description: The name of the device
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: The type of input
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
    delete:
      description: Delete the passage with a specific id.
      summary: Delete a passage
      tags:
        - passage-id
      parameters:
        - name: passage_id
          in: path
          description: ID of the passage to be deleted
          required: true
          example: 1
          schema:
            type: string
      responses:
        '204':
          description: Passage successfully removed
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/passages:
    get:
      description: Requests all passages which the user has access to.
      summary: Get all passages
      tags:
        - passage
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: ID of the passage
                    name:
                      type: string
                      description: Name of the passage
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      description: Creates a new passage.
      summary: Create passage
      tags:
        - passage
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: passage configuration to be added
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Passage Name
                  description: Name of the passage
                doorlocks:
                  type: array
                  items:
                    type: integer
                    description: ID of an assigned doorlock
                external:
                  type: array
                  items:
                    type: integer
                    description: ID of an assigned external input
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: ID of the passage
                    name:
                      type: string
                      example: Passage Name
                      description: Name of the passage
                    doorlocks:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: number
                            description: ID of the DoorLock
                            example: 2
                          device_id:
                            type: number
                            description: >-
                              ID of the DoorLock's host device, i.e. the device
                              on which is has been teached-in.
                            example: 1
                          is_active:
                            type: boolean
                            description: Describes if the DoorLock is active or inactive.
                            example: true
                          is_teachin_default:
                            type: boolean
                            description: >-
                              Describes if this DoorLock is preselected, when a
                              RFID token will be teached-id.
                            example: false
                          name:
                            type: string
                            description: Name of the DoorLock
                            example: Frontdoor
                          type:
                            type: number
                            description: Numerical devicetype
                            example: 21
                          signal_zonestate:
                            type: boolean
                            description: >-
                              Set true, if the DoorLock should show the current
                              arm state of the assigned alarmzone.
                            example: false
                          coupletime:
                            example: 3
                            type: number
                            description: >-
                              Time in seconds after the booking while the door
                              can be opened.
                          doubleauth_mode:
                            example: 0
                            type: number
                            nullable: true
                            description: >-
                              Mode for double authentication. 0=Off, 1=On,
                              2=Only when arming/disarming, 3=time controlled
                              via timeprofile.
                          doubleauth_timeprofile_id:
                            example: 0
                            type: number
                            nullable: true
                            description: >-
                              ID of the timeprofile which shall be used to
                              enable and disable the double authentication on
                              specific times.
                          log_level:
                            example: 1
                            type: number
                            description: >-
                              Sets the logbook logging mode for this DoorLock.
                              1=Default, 2=No user-related data (names,
                              pictures), 3=Only unauthorized bookings, 4=No
                              logging.
                          timeprofile_mode:
                            example: 0
                            type: number
                            enum:
                              - 0
                              - 1
                              - 2
                            description: >-
                              Mode for timeprofile usage. 0=Off, 1=On, 2=Open
                              after first booking within the time profile.
                          timeprofile_id:
                            type: number
                            description: ID of the DoorLock's assigned timeprofile
                            example: 2
                          group_id:
                            type: number
                            description: ID of the DoorLock's assigned alarmgroup
                            example: 2
                          armlevel:
                            example: 0
                            type: number
                            enum:
                              - 0
                              - 1
                              - 2
                              - 3
                              - 4
                            description: >-
                              Set the arming level of this DoorLock. 0=Off,
                              1=Assigned Alarmzone, 2=Building containing the
                              assigned Alarmzone, 3=System, 4=External
                              Alarmsystem.
                          webhooks:
                            type: array
                            items:
                              type: integer
                            description: IDs of all assigned webhooks.
                          cameras:
                            type: array
                            items:
                              type: integer
                            description: IDs of all assigned cameras.
                          batterylevel:
                            type: string
                            description: Battery level of the DoorLock
                            example: full
                            enum:
                              - full
                              - half
                              - low
                              - critical
                              - wired
                          reed_bypass_time:
                            type: number
                            description: >-
                              Time in seconds after the booking while the door
                              can be opened without reed contact alarming.
                            example: 30
                            enum:
                              - 0
                              - 5
                              - 10
                              - 15
                              - 30
                              - 45
                              - 60
                              - 90
                              - 120
                          reed_bypass_buzzer_time:
                            type: number
                            description: >-
                              Time in seconds to buzzer after the bypass time
                              and before triggering the door contact alarm.
                            example: 30
                            enum:
                              - 0
                              - 5
                              - 10
                              - 15
                              - 30
                              - 45
                              - 60
                              - 90
                              - 120
                          sabotage:
                            type: object
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of the disassembly alarm.
                          reed_source_id:
                            type: number
                            example: 'off'
                            description: >-
                              API-ID of the external sensor, which is assigned
                              to be the doorlock's reed sensor.
                          reed_assignment:
                            type: string
                            example: 'off'
                            description: Alarm-Assignment for the assigned reed sensor.
                          reed_delay:
                            type: number
                            example: 3600
                            description: >-
                              If the reed sensor triggers an alarm, it will be
                              delayed by this time (in seconds).
                          reed_warning_active:
                            type: boolean
                            example: true
                            description: >-
                              Enables signaling on the DoorLock if the door is
                              open for the set time (in seconds). The signaling
                              will stop when the door is closed again.
                          reed_warning_delay:
                            type: number
                            example: 1800
                            description: >-
                              The door must stay open for the set time to start
                              the signalization.
                    external:
                      type: array
                      items:
                        type: object
                        description: The configuration for an digital input
                        properties:
                          alarm_when:
                            example: close
                            type: string
                            enum:
                              - close
                              - open
                            description: >-
                              Configures on which state an alarm will be
                              triggered
                          alarmdelay:
                            example: 10
                            type: integer
                            description: The amount of seconds an alarm will be delayed
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                              - arm-disarm
                              - arm
                              - disarm
                            description: The alarm assignment
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >-
                              Determines if the alarmstate of this device is
                              ignored during arming
                          description_alert:
                            example: Alarm
                            type: string
                            description: >-
                              The description to be displayed when an alarm
                              occurs
                          description_ok:
                            example: OK
                            type: string
                            description: >-
                              The description to be displayed when no alarm
                              occurs
                          group_id:
                            example: 1
                            type: integer
                            description: The ID of the group the device is assigned to
                          icon:
                            example: ethernet
                            type: string
                            description: The icon to be displayed
                          id:
                            example: 2
                            type: integer
                            description: the ID of the device
                          name:
                            example: External Input
                            type: string
                            description: The name of the device
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: The type of input
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/powermanagers/names:
    get:
      description: Requests all Powernanagers which the user has access to.
      summary: Get Powermanager names
      tags:
        - powermanagers-name
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 0
                      type: integer
                      description: Id of the Powermanager.
                    name:
                      example: KentixPDU
                      type: string
                      description: Name of the Powermanager.
                    type:
                      example: 109
                      type: integer
                      description: Type of the Powermanager.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/powermanagers:
    get:
      description: Get all Powermanagers.
      summary: Get Powermanagers
      tags:
        - powermanagers
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 2
                          type: integer
                          description: Describes the ID of the Powermanager.
                        name:
                          example: KentixPDU
                          type: string
                          description: Describes the name of the Powermanager.
                        type:
                          example: 109
                          type: integer
                          description: Type of the Powermanager.
                        is_active:
                          example: true
                          type: boolean
                          description: Describes if the Powermanager is active.
                        address:
                          example: 192.168.100.226
                          type: string
                          description: IP address of the Powermanager.
                        group_id:
                          example: 1
                          type: integer
                          description: Indicates the alarmgroup of the Powermanager.
                  links:
                    type: object
                    description: >-
                      Attention: When using filters/query parameters, those must
                      be appended to the given links.
                    properties:
                      first:
                        example: https://example.com/api/example?page=1
                        type: string
                        description: The link to the first page
                      last:
                        example: https://example.com/api/example?page=10
                        type: string
                        description: The link to the last page
                      prev:
                        example: 'null'
                        type: string
                        description: The link to the previous page
                      next:
                        example: https://example.com/api/example?page=2
                        type: string
                        description: The link to the next page
                  meta:
                    type: object
                    properties:
                      current_page:
                        example: 1
                        type: integer
                        description: The key of the current page
                      from:
                        example: 1
                        type: integer
                        description: The index of the first element on the current page
                      last_page:
                        example: 10
                        type: integer
                        description: The index of the last page
                      path:
                        example: https://example.com/api/timeprofiles
                        type: string
                        description: The route just called
                      per_page:
                        example: 25
                        type: integer
                        description: The amount of elements per page
                      to:
                        example: 25
                        type: integer
                        description: The index of the last element on the current page
                      total:
                        example: 245
                        type: integer
                        description: The total amount of elements
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/powermanagers/{powermanager_id}:
    get:
      description: Get a specific Powermanager via its ID.
      summary: Get Powermanager
      tags:
        - powermanager
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: powermanager_id
          in: path
          description: ID of the Powermanager to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 2
                    type: integer
                    readOnly: true
                    description: Id of the Powermanager.
                  name:
                    example: KentixPDU
                    type: string
                    description: Name of the Powermanager.
                  type:
                    example: 109
                    type: integer
                    description: Type of the Powermanager.
                  group_id:
                    example: 1
                    type: integer
                    nullable: true
                    description: Indicates the alarmgroup of the Powermanager.
                  is_active:
                    example: true
                    type: boolean
                    description: Describes if the Powermanager is active.
                  address:
                    example: 192.168.100.226
                    type: string
                    description: IP address of the Powermanager.
                  synchronicity:
                    allOf:
                      - type: object
                        description: The configuration for the synchronicity sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          max:
                            example: 5
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: '%'
                                type: string
                                description: The unit for the max field
                              threshold:
                                example: W
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 3
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      - description: Only for SmartPDU
                  supplyline:
                    description: Configures to which supplyline the device is connected.
                    type: string
                    oneOf:
                      - title: a
                        description: Device is connected to supplyline A.
                      - title: b
                        description: Device is connected to supplyline B.
                      - title: ab
                        description: Device is connected to both supplylines A and B.
                  monitoring:
                    type: object
                    description: Only for kmpdu
                    properties:
                      temperature:
                        type: object
                        description: The configuration for the temperature sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 15
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 25
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          offset:
                            example: 2
                            type: integer
                            description: The offset applied to the value
                          units:
                            type: object
                            properties:
                              min:
                                example: °C
                                type: string
                                description: The unit for the min field
                              max:
                                example: °C
                                type: string
                                description: The unit for the max field
                              offset:
                                example: °C
                                type: string
                                description: The unit for the offset field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 17
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 23
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      humidity:
                        type: object
                        description: The configuration for the humidity sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          min:
                            example: 40
                            type: integer
                            description: The minimal threshold before an alarm is triggered
                          max:
                            example: 60
                            type: integer
                            description: The maximum threshold before an alarm is triggered
                          units:
                            type: object
                            properties:
                              min:
                                example: '%'
                                type: string
                                description: The unit for the min field
                              max:
                                example: '%'
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              min:
                                example: 45
                                type: integer
                                description: The warning threshold for the min value
                              max:
                                example: 55
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      dewpoint:
                        type: object
                        description: The configuration for the dewpoint sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          hysteresis:
                            example: 2
                            type: integer
                            description: >-
                              The hysteresis threshold where an alarm is
                              triggered
                          units:
                            type: object
                            properties:
                              hysteresis:
                                example: °C
                                type: string
                                description: The unit for the hysteresis field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      air_quality:
                        type: object
                        description: The configuration for the air_quality sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  fire:
                    type: object
                    description: Only for kmpdu
                    properties:
                      heat:
                        type: object
                        description: The configuration for the heat sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 4
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: °C/min
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 2
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      co:
                        type: object
                        description: The configuration for the CO sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          threshold:
                            example: 20
                            type: integer
                            description: The threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              threshold:
                                example: '%'
                                type: string
                                description: The unit for the threshold field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      air_quality:
                        type: object
                        description: The configuration for the air_quality sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20
                            type: integer
                            description: The max threshold where an alarm is triggered
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  intrusion:
                    type: object
                    description: Only for kmpdu
                    properties:
                      vibration:
                        type: object
                        description: The configuration for the vibration sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          sensitivity:
                            example: medium
                            type: string
                            description: >-
                              The sensitivity threshold where an alarm is
                              triggered
                  meter_type:
                    example: '0'
                    type: integer
                    description: >-
                      Configures if and how the device will be taken into
                      account on PUE calculation and summation.
                    oneOf:
                      - title: '0'
                        description: No PUE measurement or summation.
                      - title: '1'
                        description: >-
                          Device is a Sub meter and will be taken into account
                          for PUE and summation
                      - title: '2'
                        description: >-
                          Device is a Main meter. Main meters will be ignored on
                          summations.
                  uses_signed_integers:
                    example: 1
                    type: integer
                    description: Determines the prefix display. Only for SmartPDU
                  rcm_serial:
                    example: ''
                    type: string
                    nullable: true
                    description: Describes the serial of the RCM. Only for SmartPDU
                  rcm_address:
                    example: '100'
                    type: string
                    description: Describes the address of the RCM. Only for SmartPDU
                  rcm:
                    type: object
                    description: Only for kmpdu
                    properties:
                      ac:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 30
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              max:
                                example: mA
                                type: string
                                description: The unit for the max field.
                          warning:
                            type: object
                            properties:
                              active:
                                example: false
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                              max:
                                example: 20
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                      dc:
                        type: object
                        properties:
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 30
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              max:
                                example: mA
                                type: string
                                description: The unit for the max field.
                          warning:
                            type: object
                            properties:
                              active:
                                example: false
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                              max:
                                example: 20
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                  phases:
                    type: array
                    description: Only for SmartPDU
                    items:
                      type: object
                      properties:
                        id:
                          example: 3
                          type: integer
                          description: Id of the phase.
                        number:
                          example: 1
                          type: integer
                          description: Number of the phase.
                        name:
                          example: L1
                          type: string
                          description: Name of the phase.
                        address:
                          example: 1
                          type: integer
                          nullable: true
                          description: Address of the phase.
                        invoice_group_id:
                          example: null
                          type: integer
                          nullable: true
                          description: Connected invoice.
                        voltage:
                          type: object
                          description: The configuration for the voltage sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            min:
                              example: 0
                              type: integer
                              description: The min threshold where an alarm is triggered.
                            max:
                              example: 240
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                min:
                                  example: V
                                  type: string
                                  description: The unit for the min field.
                                max:
                                  example: V
                                  type: string
                                  description: The unit for the max field.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                            warning:
                              type: object
                              properties:
                                min:
                                  example: 100
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the min value.
                                max:
                                  example: 200
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                                active:
                                  example: false
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                        current:
                          type: object
                          description: The configuration for the current sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            min:
                              example: 0
                              type: integer
                              description: The min threshold where an alarm is triggered.
                            max:
                              example: 10
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                min:
                                  example: A
                                  type: string
                                  description: The unit for the min field.
                                max:
                                  example: A
                                  type: string
                                  description: The unit for the max field.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                            warning:
                              type: object
                              properties:
                                min:
                                  example: 100
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the min value.
                                max:
                                  example: 200
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                                active:
                                  example: false
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                        frequency:
                          type: object
                          description: The configuration for the frequency sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 1
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            refernce:
                              example: 50
                              type: integer
                              description: ''
                            units:
                              type: object
                              properties:
                                max:
                                  example: Hz
                                  type: string
                                  description: The unit for the max field.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 15000
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                        activepower:
                          type: object
                          description: The configuration for the activepower sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 20000
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                max:
                                  example: W
                                  type: string
                                  description: The unit for the max field.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 15000
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                        apparentpower:
                          type: object
                          description: The configuration for the apparentpower sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 2300
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                max:
                                  example: VA
                                  type: string
                                  description: The unit for the max field.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 1500
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                        reactivepower:
                          type: object
                          description: The configuration for the reactivepower sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 2300
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                max:
                                  example: var
                                  type: string
                                  description: The unit for the max field.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 1500
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                        powerfactor:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                        consumption:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                        fuse:
                          type: object
                          description: The configuration for the fuse
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 1
                              type: integer
                              nullable: true
                              description: The max threshold where an alarm is triggered.
                            modbus:
                              type: object
                              properties:
                                active:
                                  example: true
                                  type: boolean
                                  description: If the modbus is active.
                                register:
                                  example: '2530'
                                  type: string
                                  description: >-
                                    Address of the register from which the
                                    respective value should be read.
                                factor:
                                  example: '1.0'
                                  type: string
                                  description: Conversion factor for the respective value.
                                datatype:
                                  example: float_be
                                  type: string
                                  enum:
                                    - int8
                                    - int16
                                    - int32
                                    - int64
                                    - uint8
                                    - uint16
                                    - uint32
                                    - uint64
                                    - float_le
                                    - float_be
                                  description: Type and size of the respective value.
                  rack_id:
                    example: 1
                    type: integer
                    description: Rack Id which the Powermanager belongs to.
                  webhooks:
                    type: array
                    items:
                      type: integer
                    description: IDs of all assigned webhooks.
                  external:
                    type: object
                    properties:
                      channel1:
                        type: object
                        properties:
                          id:
                            example: 37
                            type: integer
                            description: Id of the channel.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          name:
                            example: Input 1
                            type: string
                            description: Name of the channel.
                          alarm_when:
                            example: open
                            type: string
                            enum:
                              - open
                              - close
                            description: Indicates when the channel should alarm.
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: Describes the input type of the channel.
                          alarmdelay:
                            example: 1
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >
                              Describes if the status of external contacts
                              should be ignored during arming.

                              This is useful if e.g. a magnetic door contact
                              must be opened during the arming phase.
                          icon:
                            example: ethernet
                            type: string
                            enum:
                              - power-off
                              - times-circle
                              - plus-circle
                              - minus-circle
                              - cogs
                              - trash
                              - save
                              - ethernet
                              - chart-network
                              - network-wired
                              - sitemap
                              - server
                              - hdd
                              - router
                              - wifi
                              - signal
                              - sensor
                              - sensor-on
                              - sensor-alert
                              - thermometer-half
                              - lungs
                              - tint
                              - humidity
                              - dewpoint
                              - raindrops
                              - water
                              - air-conditioner
                              - braille
                              - fire
                              - fire-alt
                              - burn
                              - fire-smoke
                              - cloud
                              - sensor-fire
                              - lungs
                              - mask
                              - user-secret
                              - running
                              - hammer
                              - tools
                              - signal-stream
                              - house-damage
                              - key
                              - door-open
                              - door-closed
                              - garage
                              - cctv
                              - video
                              - fingerprint
                              - bolt
                              - plug
                              - lambda
                              - charging-station
                              - battery-full
                              - battery-empty
                              - car-battery
                            description: Icon of the sensor.
                          description_ok:
                            example: OK
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has no
                              errors.
                          description_alert:
                            example: Alert
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has
                              errors.
                          group_id:
                            example: 2
                            type: integer
                            description: The ID of the group the device is assigned to.
                      channel2:
                        type: object
                        properties:
                          id:
                            example: 37
                            type: integer
                            description: Id of the channel.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          name:
                            example: Input 1
                            type: string
                            description: Name of the channel.
                          alarm_when:
                            example: open
                            type: string
                            enum:
                              - open
                              - close
                            description: Indicates when the channel should alarm.
                          input_type:
                            example: default
                            type: string
                            enum:
                              - default
                              - door
                              - leakage
                            description: Describes the input type of the channel.
                          alarmdelay:
                            example: 1
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          can_alwaysarm:
                            example: false
                            type: boolean
                            description: >
                              Describes if the status of external contacts
                              should be ignored during arming.

                              This is useful if e.g. a magnetic door contact
                              must be opened during the arming phase.
                          icon:
                            example: ethernet
                            type: string
                            enum:
                              - power-off
                              - times-circle
                              - plus-circle
                              - minus-circle
                              - cogs
                              - trash
                              - save
                              - ethernet
                              - chart-network
                              - network-wired
                              - sitemap
                              - server
                              - hdd
                              - router
                              - wifi
                              - signal
                              - sensor
                              - sensor-on
                              - sensor-alert
                              - thermometer-half
                              - lungs
                              - tint
                              - humidity
                              - dewpoint
                              - raindrops
                              - water
                              - air-conditioner
                              - braille
                              - fire
                              - fire-alt
                              - burn
                              - fire-smoke
                              - cloud
                              - sensor-fire
                              - lungs
                              - mask
                              - user-secret
                              - running
                              - hammer
                              - tools
                              - signal-stream
                              - house-damage
                              - key
                              - door-open
                              - door-closed
                              - garage
                              - cctv
                              - video
                              - fingerprint
                              - bolt
                              - plug
                              - lambda
                              - charging-station
                              - battery-full
                              - battery-empty
                              - car-battery
                            description: Icon of the sensor.
                          description_ok:
                            example: OK
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has no
                              errors.
                          description_alert:
                            example: Alert
                            type: string
                            nullable: true
                            description: >-
                              This text will be showed if the channel has
                              errors.
                          group_id:
                            example: 2
                            type: integer
                            description: The ID of the group the device is assigned to.
                  output:
                    type: object
                    properties:
                      channel1:
                        type: object
                        properties:
                          id:
                            example: 37
                            type: integer
                            description: Id of the channel.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          name:
                            example: Input 1
                            type: string
                            description: Name of the channel.
                          alarmdelay:
                            example: 1
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          output_time:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - continuous
                              - '1'
                              - '3'
                              - '10'
                              - '20'
                              - '30'
                              - '60'
                              - '120'
                              - '300'
                              - '600'
                              - '1200'
                              - '1800'
                              - '3600'
                            description: >-
                              Determines how long this output will be opened on
                              alarm.
                          event_id:
                            example: 1
                            type: integer
                            nullable: true
                            description: >-
                              Describes the event that should be used. Must be
                              an Id of an existing event.
                          group_id:
                            example: 2
                            type: integer
                            description: The ID of the group the device is assigned to.
                      channel2:
                        type: object
                        properties:
                          id:
                            example: 37
                            type: integer
                            description: Id of the channel.
                          assignment:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          name:
                            example: Input 1
                            type: string
                            description: Name of the channel.
                          alarmdelay:
                            example: 1
                            type: integer
                            description: Delay time after which an alarm is triggered.
                          output_time:
                            example: 'off'
                            type: string
                            enum:
                              - 'off'
                              - continuous
                              - '1'
                              - '3'
                              - '10'
                              - '20'
                              - '30'
                              - '60'
                              - '120'
                              - '300'
                              - '600'
                              - '1200'
                              - '1800'
                              - '3600'
                            description: >-
                              Determines how long this output will be opened on
                              alarm.
                          event_id:
                            example: 1
                            type: integer
                            nullable: true
                            description: >-
                              Describes the event that should be used. Must be
                              an Id of an existing event.
                          group_id:
                            example: 2
                            type: integer
                            description: The ID of the group the device is assigned to.
                  connection:
                    type: object
                    properties:
                      assignment:
                        example: 'off'
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of the connection
                      warning:
                        type: object
                        properties:
                          active:
                            type: boolean
                            example: true
                            description: >-
                              Configures whether connection issues should be
                              displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update a specific Powermanager via its ID.
      summary: Update Powermanager
      tags:
        - powermanager
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: powermanager_id
          in: path
          description: ID of the Powermanager to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 2
                  type: integer
                  readOnly: true
                  description: Id of the Powermanager.
                name:
                  example: KentixPDU
                  type: string
                  description: Name of the Powermanager.
                type:
                  example: 109
                  type: integer
                  description: Type of the Powermanager.
                group_id:
                  example: 1
                  type: integer
                  nullable: true
                  description: Indicates the alarmgroup of the Powermanager.
                is_active:
                  example: true
                  type: boolean
                  description: Describes if the Powermanager is active.
                address:
                  example: 192.168.100.226
                  type: string
                  description: IP address of the Powermanager.
                synchronicity:
                  allOf:
                    - type: object
                      description: The configuration for the synchronicity sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 20
                          type: integer
                          description: The max threshold where an alarm is triggered
                        max:
                          example: 5
                          type: integer
                          description: The max threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            max:
                              example: '%'
                              type: string
                              description: The unit for the max field
                            threshold:
                              example: W
                              type: string
                              description: The unit for the threshold field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 3
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    - description: Only for SmartPDU
                supplyline:
                  description: Configures to which supplyline the device is connected.
                  type: string
                  oneOf:
                    - title: a
                      description: Device is connected to supplyline A.
                    - title: b
                      description: Device is connected to supplyline B.
                    - title: ab
                      description: Device is connected to both supplylines A and B.
                monitoring:
                  type: object
                  description: Only for kmpdu
                  properties:
                    temperature:
                      type: object
                      description: The configuration for the temperature sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        min:
                          example: 15
                          type: integer
                          description: The minimal threshold before an alarm is triggered
                        max:
                          example: 25
                          type: integer
                          description: The maximum threshold before an alarm is triggered
                        offset:
                          example: 2
                          type: integer
                          description: The offset applied to the value
                        units:
                          type: object
                          properties:
                            min:
                              example: °C
                              type: string
                              description: The unit for the min field
                            max:
                              example: °C
                              type: string
                              description: The unit for the max field
                            offset:
                              example: °C
                              type: string
                              description: The unit for the offset field
                        warning:
                          type: object
                          properties:
                            min:
                              example: 17
                              type: integer
                              description: The warning threshold for the min value
                            max:
                              example: 23
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    humidity:
                      type: object
                      description: The configuration for the humidity sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        min:
                          example: 40
                          type: integer
                          description: The minimal threshold before an alarm is triggered
                        max:
                          example: 60
                          type: integer
                          description: The maximum threshold before an alarm is triggered
                        units:
                          type: object
                          properties:
                            min:
                              example: '%'
                              type: string
                              description: The unit for the min field
                            max:
                              example: '%'
                              type: string
                              description: The unit for the max field
                        warning:
                          type: object
                          properties:
                            min:
                              example: 45
                              type: integer
                              description: The warning threshold for the min value
                            max:
                              example: 55
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    dewpoint:
                      type: object
                      description: The configuration for the dewpoint sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        hysteresis:
                          example: 2
                          type: integer
                          description: The hysteresis threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            hysteresis:
                              example: °C
                              type: string
                              description: The unit for the hysteresis field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 1
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    air_quality:
                      type: object
                      description: The configuration for the air_quality sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 20
                          type: integer
                          description: The max threshold where an alarm is triggered
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                fire:
                  type: object
                  description: Only for kmpdu
                  properties:
                    heat:
                      type: object
                      description: The configuration for the heat sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 4
                          type: integer
                          description: The threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            threshold:
                              example: °C/min
                              type: string
                              description: The unit for the threshold field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 2
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    co:
                      type: object
                      description: The configuration for the CO sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        threshold:
                          example: 20
                          type: integer
                          description: The threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            threshold:
                              example: '%'
                              type: string
                              description: The unit for the threshold field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    air_quality:
                      type: object
                      description: The configuration for the air_quality sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 20
                          type: integer
                          description: The max threshold where an alarm is triggered
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                intrusion:
                  type: object
                  description: Only for kmpdu
                  properties:
                    vibration:
                      type: object
                      description: The configuration for the vibration sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        sensitivity:
                          example: medium
                          type: string
                          description: >-
                            The sensitivity threshold where an alarm is
                            triggered
                meter_type:
                  example: '0'
                  type: integer
                  description: >-
                    Configures if and how the device will be taken into account
                    on PUE calculation and summation.
                  oneOf:
                    - title: '0'
                      description: No PUE measurement or summation.
                    - title: '1'
                      description: >-
                        Device is a Sub meter and will be taken into account for
                        PUE and summation
                    - title: '2'
                      description: >-
                        Device is a Main meter. Main meters will be ignored on
                        summations.
                uses_signed_integers:
                  example: 1
                  type: integer
                  description: Determines the prefix display. Only for SmartPDU
                rcm_serial:
                  example: ''
                  type: string
                  nullable: true
                  description: Describes the serial of the RCM. Only for SmartPDU
                rcm_address:
                  example: '100'
                  type: string
                  description: Describes the address of the RCM. Only for SmartPDU
                rcm:
                  type: object
                  description: Only for kmpdu
                  properties:
                    ac:
                      type: object
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        max:
                          example: 30
                          type: integer
                          description: The max threshold where an alarm is triggered.
                        units:
                          type: object
                          properties:
                            max:
                              example: mA
                              type: string
                              description: The unit for the max field.
                        warning:
                          type: object
                          properties:
                            active:
                              example: false
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered.
                            max:
                              example: 20
                              type: integer
                              nullable: true
                              description: The warning threshold for the max value.
                    dc:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        max:
                          example: 30
                          type: integer
                          description: The max threshold where an alarm is triggered.
                        units:
                          type: object
                          properties:
                            max:
                              example: mA
                              type: string
                              description: The unit for the max field.
                        warning:
                          type: object
                          properties:
                            active:
                              example: false
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered.
                            max:
                              example: 20
                              type: integer
                              nullable: true
                              description: The warning threshold for the max value.
                phases:
                  type: array
                  description: Only for SmartPDU
                  items:
                    type: object
                    properties:
                      id:
                        example: 3
                        type: integer
                        description: Id of the phase.
                      number:
                        example: 1
                        type: integer
                        description: Number of the phase.
                      name:
                        example: L1
                        type: string
                        description: Name of the phase.
                      address:
                        example: 1
                        type: integer
                        nullable: true
                        description: Address of the phase.
                      invoice_group_id:
                        example: null
                        type: integer
                        nullable: true
                        description: Connected invoice.
                      voltage:
                        type: object
                        description: The configuration for the voltage sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          min:
                            example: 0
                            type: integer
                            description: The min threshold where an alarm is triggered.
                          max:
                            example: 240
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              min:
                                example: V
                                type: string
                                description: The unit for the min field.
                              max:
                                example: V
                                type: string
                                description: The unit for the max field.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                          warning:
                            type: object
                            properties:
                              min:
                                example: 100
                                type: integer
                                nullable: true
                                description: The warning threshold for the min value.
                              max:
                                example: 200
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                              active:
                                example: false
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                      current:
                        type: object
                        description: The configuration for the current sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          min:
                            example: 0
                            type: integer
                            description: The min threshold where an alarm is triggered.
                          max:
                            example: 10
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              min:
                                example: A
                                type: string
                                description: The unit for the min field.
                              max:
                                example: A
                                type: string
                                description: The unit for the max field.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                          warning:
                            type: object
                            properties:
                              min:
                                example: 100
                                type: integer
                                nullable: true
                                description: The warning threshold for the min value.
                              max:
                                example: 200
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                              active:
                                example: false
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                      frequency:
                        type: object
                        description: The configuration for the frequency sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 1
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          refernce:
                            example: 50
                            type: integer
                            description: ''
                          units:
                            type: object
                            properties:
                              max:
                                example: Hz
                                type: string
                                description: The unit for the max field.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                      activepower:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                      apparentpower:
                        type: object
                        description: The configuration for the apparentpower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 2300
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              max:
                                example: VA
                                type: string
                                description: The unit for the max field.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1500
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                      reactivepower:
                        type: object
                        description: The configuration for the reactivepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 2300
                            type: integer
                            description: The max threshold where an alarm is triggered.
                          units:
                            type: object
                            properties:
                              max:
                                example: var
                                type: string
                                description: The unit for the max field.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                          warning:
                            type: object
                            properties:
                              max:
                                example: 1500
                                type: integer
                                nullable: true
                                description: The warning threshold for the max value.
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered.
                      powerfactor:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                      consumption:
                        type: object
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                      fuse:
                        type: object
                        description: The configuration for the fuse
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor.
                          max:
                            example: 1
                            type: integer
                            nullable: true
                            description: The max threshold where an alarm is triggered.
                          modbus:
                            type: object
                            properties:
                              active:
                                example: true
                                type: boolean
                                description: If the modbus is active.
                              register:
                                example: '2530'
                                type: string
                                description: >-
                                  Address of the register from which the
                                  respective value should be read.
                              factor:
                                example: '1.0'
                                type: string
                                description: Conversion factor for the respective value.
                              datatype:
                                example: float_be
                                type: string
                                enum:
                                  - int8
                                  - int16
                                  - int32
                                  - int64
                                  - uint8
                                  - uint16
                                  - uint32
                                  - uint64
                                  - float_le
                                  - float_be
                                description: Type and size of the respective value.
                rack_id:
                  example: 1
                  type: integer
                  description: Rack Id which the Powermanager belongs to.
                webhooks:
                  type: array
                  items:
                    type: integer
                  description: IDs of all assigned webhooks.
                external:
                  type: object
                  properties:
                    channel1:
                      type: object
                      properties:
                        id:
                          example: 37
                          type: integer
                          description: Id of the channel.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        name:
                          example: Input 1
                          type: string
                          description: Name of the channel.
                        alarm_when:
                          example: open
                          type: string
                          enum:
                            - open
                            - close
                          description: Indicates when the channel should alarm.
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: Describes the input type of the channel.
                        alarmdelay:
                          example: 1
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >
                            Describes if the status of external contacts should
                            be ignored during arming.

                            This is useful if e.g. a magnetic door contact must
                            be opened during the arming phase.
                        icon:
                          example: ethernet
                          type: string
                          enum:
                            - power-off
                            - times-circle
                            - plus-circle
                            - minus-circle
                            - cogs
                            - trash
                            - save
                            - ethernet
                            - chart-network
                            - network-wired
                            - sitemap
                            - server
                            - hdd
                            - router
                            - wifi
                            - signal
                            - sensor
                            - sensor-on
                            - sensor-alert
                            - thermometer-half
                            - lungs
                            - tint
                            - humidity
                            - dewpoint
                            - raindrops
                            - water
                            - air-conditioner
                            - braille
                            - fire
                            - fire-alt
                            - burn
                            - fire-smoke
                            - cloud
                            - sensor-fire
                            - lungs
                            - mask
                            - user-secret
                            - running
                            - hammer
                            - tools
                            - signal-stream
                            - house-damage
                            - key
                            - door-open
                            - door-closed
                            - garage
                            - cctv
                            - video
                            - fingerprint
                            - bolt
                            - plug
                            - lambda
                            - charging-station
                            - battery-full
                            - battery-empty
                            - car-battery
                          description: Icon of the sensor.
                        description_ok:
                          example: OK
                          type: string
                          nullable: true
                          description: >-
                            This text will be showed if the channel has no
                            errors.
                        description_alert:
                          example: Alert
                          type: string
                          nullable: true
                          description: This text will be showed if the channel has errors.
                        group_id:
                          example: 2
                          type: integer
                          description: The ID of the group the device is assigned to.
                    channel2:
                      type: object
                      properties:
                        id:
                          example: 37
                          type: integer
                          description: Id of the channel.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        name:
                          example: Input 1
                          type: string
                          description: Name of the channel.
                        alarm_when:
                          example: open
                          type: string
                          enum:
                            - open
                            - close
                          description: Indicates when the channel should alarm.
                        input_type:
                          example: default
                          type: string
                          enum:
                            - default
                            - door
                            - leakage
                          description: Describes the input type of the channel.
                        alarmdelay:
                          example: 1
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        can_alwaysarm:
                          example: false
                          type: boolean
                          description: >
                            Describes if the status of external contacts should
                            be ignored during arming.

                            This is useful if e.g. a magnetic door contact must
                            be opened during the arming phase.
                        icon:
                          example: ethernet
                          type: string
                          enum:
                            - power-off
                            - times-circle
                            - plus-circle
                            - minus-circle
                            - cogs
                            - trash
                            - save
                            - ethernet
                            - chart-network
                            - network-wired
                            - sitemap
                            - server
                            - hdd
                            - router
                            - wifi
                            - signal
                            - sensor
                            - sensor-on
                            - sensor-alert
                            - thermometer-half
                            - lungs
                            - tint
                            - humidity
                            - dewpoint
                            - raindrops
                            - water
                            - air-conditioner
                            - braille
                            - fire
                            - fire-alt
                            - burn
                            - fire-smoke
                            - cloud
                            - sensor-fire
                            - lungs
                            - mask
                            - user-secret
                            - running
                            - hammer
                            - tools
                            - signal-stream
                            - house-damage
                            - key
                            - door-open
                            - door-closed
                            - garage
                            - cctv
                            - video
                            - fingerprint
                            - bolt
                            - plug
                            - lambda
                            - charging-station
                            - battery-full
                            - battery-empty
                            - car-battery
                          description: Icon of the sensor.
                        description_ok:
                          example: OK
                          type: string
                          nullable: true
                          description: >-
                            This text will be showed if the channel has no
                            errors.
                        description_alert:
                          example: Alert
                          type: string
                          nullable: true
                          description: This text will be showed if the channel has errors.
                        group_id:
                          example: 2
                          type: integer
                          description: The ID of the group the device is assigned to.
                output:
                  type: object
                  properties:
                    channel1:
                      type: object
                      properties:
                        id:
                          example: 37
                          type: integer
                          description: Id of the channel.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        name:
                          example: Input 1
                          type: string
                          description: Name of the channel.
                        alarmdelay:
                          example: 1
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        output_time:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - continuous
                            - '1'
                            - '3'
                            - '10'
                            - '20'
                            - '30'
                            - '60'
                            - '120'
                            - '300'
                            - '600'
                            - '1200'
                            - '1800'
                            - '3600'
                          description: >-
                            Determines how long this output will be opened on
                            alarm.
                        event_id:
                          example: 1
                          type: integer
                          nullable: true
                          description: >-
                            Describes the event that should be used. Must be an
                            Id of an existing event.
                        group_id:
                          example: 2
                          type: integer
                          description: The ID of the group the device is assigned to.
                    channel2:
                      type: object
                      properties:
                        id:
                          example: 37
                          type: integer
                          description: Id of the channel.
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor.
                        name:
                          example: Input 1
                          type: string
                          description: Name of the channel.
                        alarmdelay:
                          example: 1
                          type: integer
                          description: Delay time after which an alarm is triggered.
                        output_time:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - continuous
                            - '1'
                            - '3'
                            - '10'
                            - '20'
                            - '30'
                            - '60'
                            - '120'
                            - '300'
                            - '600'
                            - '1200'
                            - '1800'
                            - '3600'
                          description: >-
                            Determines how long this output will be opened on
                            alarm.
                        event_id:
                          example: 1
                          type: integer
                          nullable: true
                          description: >-
                            Describes the event that should be used. Must be an
                            Id of an existing event.
                        group_id:
                          example: 2
                          type: integer
                          description: The ID of the group the device is assigned to.
                connection:
                  type: object
                  properties:
                    assignment:
                      example: 'off'
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of the connection
                    warning:
                      type: object
                      properties:
                        active:
                          type: boolean
                          example: true
                          description: >-
                            Configures whether connection issues should be
                            displayed as a warning instead of an alarm
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 2
                      type: integer
                      readOnly: true
                      description: Id of the Powermanager.
                    name:
                      example: KentixPDU
                      type: string
                      description: Name of the Powermanager.
                    type:
                      example: 109
                      type: integer
                      description: Type of the Powermanager.
                    group_id:
                      example: 1
                      type: integer
                      nullable: true
                      description: Indicates the alarmgroup of the Powermanager.
                    is_active:
                      example: true
                      type: boolean
                      description: Describes if the Powermanager is active.
                    address:
                      example: 192.168.100.226
                      type: string
                      description: IP address of the Powermanager.
                    synchronicity:
                      allOf:
                        - type: object
                          description: The configuration for the synchronicity sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            threshold:
                              example: 20
                              type: integer
                              description: The max threshold where an alarm is triggered
                            max:
                              example: 5
                              type: integer
                              description: The max threshold where an alarm is triggered
                            units:
                              type: object
                              properties:
                                max:
                                  example: '%'
                                  type: string
                                  description: The unit for the max field
                                threshold:
                                  example: W
                                  type: string
                                  description: The unit for the threshold field
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 3
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                        - description: Only for SmartPDU
                    supplyline:
                      description: Configures to which supplyline the device is connected.
                      type: string
                      oneOf:
                        - title: a
                          description: Device is connected to supplyline A.
                        - title: b
                          description: Device is connected to supplyline B.
                        - title: ab
                          description: Device is connected to both supplylines A and B.
                    monitoring:
                      type: object
                      description: Only for kmpdu
                      properties:
                        temperature:
                          type: object
                          description: The configuration for the temperature sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            min:
                              example: 15
                              type: integer
                              description: >-
                                The minimal threshold before an alarm is
                                triggered
                            max:
                              example: 25
                              type: integer
                              description: >-
                                The maximum threshold before an alarm is
                                triggered
                            offset:
                              example: 2
                              type: integer
                              description: The offset applied to the value
                            units:
                              type: object
                              properties:
                                min:
                                  example: °C
                                  type: string
                                  description: The unit for the min field
                                max:
                                  example: °C
                                  type: string
                                  description: The unit for the max field
                                offset:
                                  example: °C
                                  type: string
                                  description: The unit for the offset field
                            warning:
                              type: object
                              properties:
                                min:
                                  example: 17
                                  type: integer
                                  description: The warning threshold for the min value
                                max:
                                  example: 23
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                        humidity:
                          type: object
                          description: The configuration for the humidity sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            min:
                              example: 40
                              type: integer
                              description: >-
                                The minimal threshold before an alarm is
                                triggered
                            max:
                              example: 60
                              type: integer
                              description: >-
                                The maximum threshold before an alarm is
                                triggered
                            units:
                              type: object
                              properties:
                                min:
                                  example: '%'
                                  type: string
                                  description: The unit for the min field
                                max:
                                  example: '%'
                                  type: string
                                  description: The unit for the max field
                            warning:
                              type: object
                              properties:
                                min:
                                  example: 45
                                  type: integer
                                  description: The warning threshold for the min value
                                max:
                                  example: 55
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                        dewpoint:
                          type: object
                          description: The configuration for the dewpoint sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            hysteresis:
                              example: 2
                              type: integer
                              description: >-
                                The hysteresis threshold where an alarm is
                                triggered
                            units:
                              type: object
                              properties:
                                hysteresis:
                                  example: °C
                                  type: string
                                  description: The unit for the hysteresis field
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 1
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                        air_quality:
                          type: object
                          description: The configuration for the air_quality sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            max:
                              example: 20
                              type: integer
                              description: The max threshold where an alarm is triggered
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 15
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                    fire:
                      type: object
                      description: Only for kmpdu
                      properties:
                        heat:
                          type: object
                          description: The configuration for the heat sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            threshold:
                              example: 4
                              type: integer
                              description: The threshold where an alarm is triggered
                            units:
                              type: object
                              properties:
                                threshold:
                                  example: °C/min
                                  type: string
                                  description: The unit for the threshold field
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 2
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                        co:
                          type: object
                          description: The configuration for the CO sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            threshold:
                              example: 20
                              type: integer
                              description: The threshold where an alarm is triggered
                            units:
                              type: object
                              properties:
                                threshold:
                                  example: '%'
                                  type: string
                                  description: The unit for the threshold field
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 15
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                        air_quality:
                          type: object
                          description: The configuration for the air_quality sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            max:
                              example: 20
                              type: integer
                              description: The max threshold where an alarm is triggered
                            warning:
                              type: object
                              properties:
                                max:
                                  example: 15
                                  type: integer
                                  description: The warning threshold for the max value
                                active:
                                  example: true
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered
                    intrusion:
                      type: object
                      description: Only for kmpdu
                      properties:
                        vibration:
                          type: object
                          description: The configuration for the vibration sensor
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor
                            sensitivity:
                              example: medium
                              type: string
                              description: >-
                                The sensitivity threshold where an alarm is
                                triggered
                    meter_type:
                      example: '0'
                      type: integer
                      description: >-
                        Configures if and how the device will be taken into
                        account on PUE calculation and summation.
                      oneOf:
                        - title: '0'
                          description: No PUE measurement or summation.
                        - title: '1'
                          description: >-
                            Device is a Sub meter and will be taken into account
                            for PUE and summation
                        - title: '2'
                          description: >-
                            Device is a Main meter. Main meters will be ignored
                            on summations.
                    uses_signed_integers:
                      example: 1
                      type: integer
                      description: Determines the prefix display. Only for SmartPDU
                    rcm_serial:
                      example: ''
                      type: string
                      nullable: true
                      description: Describes the serial of the RCM. Only for SmartPDU
                    rcm_address:
                      example: '100'
                      type: string
                      description: Describes the address of the RCM. Only for SmartPDU
                    rcm:
                      type: object
                      description: Only for kmpdu
                      properties:
                        ac:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 30
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                max:
                                  example: mA
                                  type: string
                                  description: The unit for the max field.
                            warning:
                              type: object
                              properties:
                                active:
                                  example: false
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                                max:
                                  example: 20
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                        dc:
                          type: object
                          properties:
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            max:
                              example: 30
                              type: integer
                              description: The max threshold where an alarm is triggered.
                            units:
                              type: object
                              properties:
                                max:
                                  example: mA
                                  type: string
                                  description: The unit for the max field.
                            warning:
                              type: object
                              properties:
                                active:
                                  example: false
                                  type: boolean
                                  description: >-
                                    The flag to determine if warnings should be
                                    triggered.
                                max:
                                  example: 20
                                  type: integer
                                  nullable: true
                                  description: The warning threshold for the max value.
                    phases:
                      type: array
                      description: Only for SmartPDU
                      items:
                        type: object
                        properties:
                          id:
                            example: 3
                            type: integer
                            description: Id of the phase.
                          number:
                            example: 1
                            type: integer
                            description: Number of the phase.
                          name:
                            example: L1
                            type: string
                            description: Name of the phase.
                          address:
                            example: 1
                            type: integer
                            nullable: true
                            description: Address of the phase.
                          invoice_group_id:
                            example: null
                            type: integer
                            nullable: true
                            description: Connected invoice.
                          voltage:
                            type: object
                            description: The configuration for the voltage sensor
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              min:
                                example: 0
                                type: integer
                                description: The min threshold where an alarm is triggered.
                              max:
                                example: 240
                                type: integer
                                description: The max threshold where an alarm is triggered.
                              units:
                                type: object
                                properties:
                                  min:
                                    example: V
                                    type: string
                                    description: The unit for the min field.
                                  max:
                                    example: V
                                    type: string
                                    description: The unit for the max field.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                              warning:
                                type: object
                                properties:
                                  min:
                                    example: 100
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the min value.
                                  max:
                                    example: 200
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the max value.
                                  active:
                                    example: false
                                    type: boolean
                                    description: >-
                                      The flag to determine if warnings should
                                      be triggered.
                          current:
                            type: object
                            description: The configuration for the current sensor
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              min:
                                example: 0
                                type: integer
                                description: The min threshold where an alarm is triggered.
                              max:
                                example: 10
                                type: integer
                                description: The max threshold where an alarm is triggered.
                              units:
                                type: object
                                properties:
                                  min:
                                    example: A
                                    type: string
                                    description: The unit for the min field.
                                  max:
                                    example: A
                                    type: string
                                    description: The unit for the max field.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                              warning:
                                type: object
                                properties:
                                  min:
                                    example: 100
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the min value.
                                  max:
                                    example: 200
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the max value.
                                  active:
                                    example: false
                                    type: boolean
                                    description: >-
                                      The flag to determine if warnings should
                                      be triggered.
                          frequency:
                            type: object
                            description: The configuration for the frequency sensor
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              max:
                                example: 1
                                type: integer
                                description: The max threshold where an alarm is triggered.
                              refernce:
                                example: 50
                                type: integer
                                description: ''
                              units:
                                type: object
                                properties:
                                  max:
                                    example: Hz
                                    type: string
                                    description: The unit for the max field.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                              warning:
                                type: object
                                properties:
                                  max:
                                    example: 15000
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the max value.
                                  active:
                                    example: true
                                    type: boolean
                                    description: >-
                                      The flag to determine if warnings should
                                      be triggered.
                          activepower:
                            type: object
                            description: The configuration for the activepower sensor
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              max:
                                example: 20000
                                type: integer
                                description: The max threshold where an alarm is triggered.
                              units:
                                type: object
                                properties:
                                  max:
                                    example: W
                                    type: string
                                    description: The unit for the max field.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                              warning:
                                type: object
                                properties:
                                  max:
                                    example: 15000
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the max value.
                                  active:
                                    example: true
                                    type: boolean
                                    description: >-
                                      The flag to determine if warnings should
                                      be triggered.
                          apparentpower:
                            type: object
                            description: The configuration for the apparentpower sensor
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              max:
                                example: 2300
                                type: integer
                                description: The max threshold where an alarm is triggered.
                              units:
                                type: object
                                properties:
                                  max:
                                    example: VA
                                    type: string
                                    description: The unit for the max field.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                              warning:
                                type: object
                                properties:
                                  max:
                                    example: 1500
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the max value.
                                  active:
                                    example: true
                                    type: boolean
                                    description: >-
                                      The flag to determine if warnings should
                                      be triggered.
                          reactivepower:
                            type: object
                            description: The configuration for the reactivepower sensor
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              max:
                                example: 2300
                                type: integer
                                description: The max threshold where an alarm is triggered.
                              units:
                                type: object
                                properties:
                                  max:
                                    example: var
                                    type: string
                                    description: The unit for the max field.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                              warning:
                                type: object
                                properties:
                                  max:
                                    example: 1500
                                    type: integer
                                    nullable: true
                                    description: The warning threshold for the max value.
                                  active:
                                    example: true
                                    type: boolean
                                    description: >-
                                      The flag to determine if warnings should
                                      be triggered.
                          powerfactor:
                            type: object
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                          consumption:
                            type: object
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                          fuse:
                            type: object
                            description: The configuration for the fuse
                            properties:
                              assignment:
                                example: always-active
                                type: string
                                enum:
                                  - 'off'
                                  - always-active
                                  - armed-active
                                  - fire
                                  - sabotage
                                  - display
                                  - system
                                description: The alarm assignment of this sensor.
                              max:
                                example: 1
                                type: integer
                                nullable: true
                                description: The max threshold where an alarm is triggered.
                              modbus:
                                type: object
                                properties:
                                  active:
                                    example: true
                                    type: boolean
                                    description: If the modbus is active.
                                  register:
                                    example: '2530'
                                    type: string
                                    description: >-
                                      Address of the register from which the
                                      respective value should be read.
                                  factor:
                                    example: '1.0'
                                    type: string
                                    description: >-
                                      Conversion factor for the respective
                                      value.
                                  datatype:
                                    example: float_be
                                    type: string
                                    enum:
                                      - int8
                                      - int16
                                      - int32
                                      - int64
                                      - uint8
                                      - uint16
                                      - uint32
                                      - uint64
                                      - float_le
                                      - float_be
                                    description: Type and size of the respective value.
                    rack_id:
                      example: 1
                      type: integer
                      description: Rack Id which the Powermanager belongs to.
                    webhooks:
                      type: array
                      items:
                        type: integer
                      description: IDs of all assigned webhooks.
                    external:
                      type: object
                      properties:
                        channel1:
                          type: object
                          properties:
                            id:
                              example: 37
                              type: integer
                              description: Id of the channel.
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            name:
                              example: Input 1
                              type: string
                              description: Name of the channel.
                            alarm_when:
                              example: open
                              type: string
                              enum:
                                - open
                                - close
                              description: Indicates when the channel should alarm.
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: Describes the input type of the channel.
                            alarmdelay:
                              example: 1
                              type: integer
                              description: Delay time after which an alarm is triggered.
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >
                                Describes if the status of external contacts
                                should be ignored during arming.

                                This is useful if e.g. a magnetic door contact
                                must be opened during the arming phase.
                            icon:
                              example: ethernet
                              type: string
                              enum:
                                - power-off
                                - times-circle
                                - plus-circle
                                - minus-circle
                                - cogs
                                - trash
                                - save
                                - ethernet
                                - chart-network
                                - network-wired
                                - sitemap
                                - server
                                - hdd
                                - router
                                - wifi
                                - signal
                                - sensor
                                - sensor-on
                                - sensor-alert
                                - thermometer-half
                                - lungs
                                - tint
                                - humidity
                                - dewpoint
                                - raindrops
                                - water
                                - air-conditioner
                                - braille
                                - fire
                                - fire-alt
                                - burn
                                - fire-smoke
                                - cloud
                                - sensor-fire
                                - lungs
                                - mask
                                - user-secret
                                - running
                                - hammer
                                - tools
                                - signal-stream
                                - house-damage
                                - key
                                - door-open
                                - door-closed
                                - garage
                                - cctv
                                - video
                                - fingerprint
                                - bolt
                                - plug
                                - lambda
                                - charging-station
                                - battery-full
                                - battery-empty
                                - car-battery
                              description: Icon of the sensor.
                            description_ok:
                              example: OK
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has no
                                errors.
                            description_alert:
                              example: Alert
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has
                                errors.
                            group_id:
                              example: 2
                              type: integer
                              description: The ID of the group the device is assigned to.
                        channel2:
                          type: object
                          properties:
                            id:
                              example: 37
                              type: integer
                              description: Id of the channel.
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            name:
                              example: Input 1
                              type: string
                              description: Name of the channel.
                            alarm_when:
                              example: open
                              type: string
                              enum:
                                - open
                                - close
                              description: Indicates when the channel should alarm.
                            input_type:
                              example: default
                              type: string
                              enum:
                                - default
                                - door
                                - leakage
                              description: Describes the input type of the channel.
                            alarmdelay:
                              example: 1
                              type: integer
                              description: Delay time after which an alarm is triggered.
                            can_alwaysarm:
                              example: false
                              type: boolean
                              description: >
                                Describes if the status of external contacts
                                should be ignored during arming.

                                This is useful if e.g. a magnetic door contact
                                must be opened during the arming phase.
                            icon:
                              example: ethernet
                              type: string
                              enum:
                                - power-off
                                - times-circle
                                - plus-circle
                                - minus-circle
                                - cogs
                                - trash
                                - save
                                - ethernet
                                - chart-network
                                - network-wired
                                - sitemap
                                - server
                                - hdd
                                - router
                                - wifi
                                - signal
                                - sensor
                                - sensor-on
                                - sensor-alert
                                - thermometer-half
                                - lungs
                                - tint
                                - humidity
                                - dewpoint
                                - raindrops
                                - water
                                - air-conditioner
                                - braille
                                - fire
                                - fire-alt
                                - burn
                                - fire-smoke
                                - cloud
                                - sensor-fire
                                - lungs
                                - mask
                                - user-secret
                                - running
                                - hammer
                                - tools
                                - signal-stream
                                - house-damage
                                - key
                                - door-open
                                - door-closed
                                - garage
                                - cctv
                                - video
                                - fingerprint
                                - bolt
                                - plug
                                - lambda
                                - charging-station
                                - battery-full
                                - battery-empty
                                - car-battery
                              description: Icon of the sensor.
                            description_ok:
                              example: OK
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has no
                                errors.
                            description_alert:
                              example: Alert
                              type: string
                              nullable: true
                              description: >-
                                This text will be showed if the channel has
                                errors.
                            group_id:
                              example: 2
                              type: integer
                              description: The ID of the group the device is assigned to.
                    output:
                      type: object
                      properties:
                        channel1:
                          type: object
                          properties:
                            id:
                              example: 37
                              type: integer
                              description: Id of the channel.
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            name:
                              example: Input 1
                              type: string
                              description: Name of the channel.
                            alarmdelay:
                              example: 1
                              type: integer
                              description: Delay time after which an alarm is triggered.
                            output_time:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - continuous
                                - '1'
                                - '3'
                                - '10'
                                - '20'
                                - '30'
                                - '60'
                                - '120'
                                - '300'
                                - '600'
                                - '1200'
                                - '1800'
                                - '3600'
                              description: >-
                                Determines how long this output will be opened
                                on alarm.
                            event_id:
                              example: 1
                              type: integer
                              nullable: true
                              description: >-
                                Describes the event that should be used. Must be
                                an Id of an existing event.
                            group_id:
                              example: 2
                              type: integer
                              description: The ID of the group the device is assigned to.
                        channel2:
                          type: object
                          properties:
                            id:
                              example: 37
                              type: integer
                              description: Id of the channel.
                            assignment:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            name:
                              example: Input 1
                              type: string
                              description: Name of the channel.
                            alarmdelay:
                              example: 1
                              type: integer
                              description: Delay time after which an alarm is triggered.
                            output_time:
                              example: 'off'
                              type: string
                              enum:
                                - 'off'
                                - continuous
                                - '1'
                                - '3'
                                - '10'
                                - '20'
                                - '30'
                                - '60'
                                - '120'
                                - '300'
                                - '600'
                                - '1200'
                                - '1800'
                                - '3600'
                              description: >-
                                Determines how long this output will be opened
                                on alarm.
                            event_id:
                              example: 1
                              type: integer
                              nullable: true
                              description: >-
                                Describes the event that should be used. Must be
                                an Id of an existing event.
                            group_id:
                              example: 2
                              type: integer
                              description: The ID of the group the device is assigned to.
                    connection:
                      type: object
                      properties:
                        assignment:
                          example: 'off'
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of the connection
                        warning:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: true
                              description: >-
                                Configures whether connection issues should be
                                displayed as a warning instead of an alarm
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/powermanagers/{kpmdu_id}/overview:
    get:
      description: Get the overview of the supply of a SmartPDU.
      summary: Get SmartPDU overview
      tags:
        - kmpdu-overview
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: kpmdu_id
          in: path
          description: ID of the KPM_PDU to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  width:
                    example: 2
                    type: integer
                    description: ''
                  height:
                    example: 27
                    type: integer
                    description: ''
                  pdu_subgroups:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 9
                          type: integer
                          description: Id of the PDU subgroup.
                        name:
                          example: '1'
                          type: string
                          description: Name of the PDU subgroup.
                        description:
                          example: ''
                          type: string
                          description: Description of the PDU subgroup
                  phases:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 3
                          type: integer
                          description: Id of the phase.
                        number:
                          example: 1
                          type: integer
                          description: Number of the phase.
                        name:
                          example: L1
                          type: string
                          description: Name of the phase.
                        status:
                          example: ok
                          type: string
                          enum:
                            - ok
                            - warning
                            - alarm
                            - inactive
                          description: Status of the phase.
                        voltage:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        current:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        frequency:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        activepower:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        apparentpower:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        reactivepower:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        powerfactor:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        consumption:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                        fuse:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                  fuses:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 18
                          type: integer
                          description: Id of the fuse.
                        value:
                          example: '1'
                          type: string
                          description: Value of the fuse.
                        status:
                          example: ok
                          type: string
                          enum:
                            - ok
                            - warning
                            - alarm
                            - inactive
                          description: Status of the fuse.
                        layout:
                          type: object
                          properties:
                            pos_x:
                              example: 2
                              type: integer
                              description: Describes the x-position of the fuse.
                            pos_y:
                              example: 9
                              type: integer
                              description: Describes the y-position of the fuse.
                            rotation:
                              example: 0
                              type: integer
                              description: Describes the rotation of the fuse.
                            mirror_x:
                              example: false
                              type: boolean
                              description: Describes if the fuse is mirrored.
                            type:
                              example: fuse
                              type: string
                              enum:
                                - fuse
                              description: Describes the type of the fuse.
                  outletblocks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 18
                          type: integer
                          description: Id of the outletblock.
                        phase_id:
                          example: 16
                          type: integer
                          description: Id of the phase.
                        fuse_id:
                          example: 18
                          type: integer
                          description: Id of the fuse
                        status:
                          example: ok
                          type: string
                          enum:
                            - ok
                            - warning
                            - alarm
                            - inactive
                          description: Status of the phase.
                        current:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                  outlets:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          example: 126
                          type: integer
                          description: Id of the outlet.
                        name:
                          example: 3-16
                          type: string
                          description: Name of the outlet.
                        status:
                          example: ok
                          type: string
                          enum:
                            - ok
                            - warning
                            - alarm
                            - inactive
                          description: Status of the outlets.
                        is_switchable:
                          example: true
                          type: boolean
                          description: Describes if the outlet is switchable.
                        pdu_subgroup_id:
                          example: 9
                          type: integer
                          description: Describes the marked section on the PDU.
                        outletblock_id:
                          example: 18
                          type: integer
                          description: Describes the block to which the output is assigned.
                        is_on:
                          example: false
                          type: boolean
                          description: Describes if the outlet is on.
                        switch_dual:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the associated outlet should be
                            switched as well.
                        layout:
                          type: object
                          properties:
                            pos_x:
                              example: 2
                              type: integer
                              description: Describes the x-position of the outlet.
                            pos_y:
                              example: 9
                              type: integer
                              description: Describes the y-position of the outlet.
                            rotation:
                              example: 0
                              type: integer
                              description: Describes the rotation of the outlet.
                            mirror_x:
                              example: false
                              type: boolean
                              description: Describes if the outlet is mirrored.
                            type:
                              example: c13
                              type: string
                              enum:
                                - c13
                                - c19
                              description: Describes the type of the outlet.
                        switchingstate:
                          type: object
                          properties:
                            assignment:
                              example: always-active
                              type: string
                              enum:
                                - 'off'
                                - always-active
                                - armed-active
                                - fire
                                - sabotage
                                - display
                                - system
                              description: The alarm assignment of this sensor.
                            value:
                              example: '50.02'
                              type: string
                              nullable: true
                              description: The value of this sensor
                            status:
                              example: ok
                              type: string
                              enum:
                                - ok
                                - warning
                                - alarm
                                - inactive
                              description: The status of this sensor
                  units:
                    type: object
                    description: A array for a the measurement units used in the response.
                    properties:
                      active_power:
                        example: W
                        type: string
                        description: Unit of active power
                      apparent_power:
                        example: VA
                        type: string
                        description: Unit of apparent power
                      co:
                        example: ppm
                        type: string
                        description: Unit of Co
                      co2:
                        example: ppm
                        type: string
                        description: Unit of Co2
                      consumption:
                        example: kWh
                        type: string
                        description: Unit of consumption
                      current:
                        example: A
                        type: string
                        description: Unit of current
                      dewpoint:
                        example: °C
                        type: string
                        description: Unit of dewpoint
                      fire_temperature:
                        example: °C
                        type: string
                        description: Unit of fire temperature
                      frequency:
                        example: Hz
                        type: string
                        description: Unit of frequency
                      heat:
                        example: °C
                        type: string
                        description: Unit of heat
                      humidity:
                        example: '%'
                        type: string
                        description: Unit of humidity
                      latency:
                        example: ms
                        type: string
                        description: Unit of latency
                      motion:
                        example: '%'
                        type: string
                        description: Unit of motion
                      people_distance:
                        example: cm
                        type: string
                        description: Unit of people distance
                      pressure:
                        example: hPa
                        type: string
                        description: Unit of pressure
                      rcm_ac:
                        example: mA
                        type: string
                        description: Unit of RCM AC
                      rcm_dc:
                        example: mA
                        type: string
                        description: Unit of RCM DC
                      reactive_power:
                        example: var
                        type: string
                        description: Unit of Reactive Power
                      signal_strength:
                        example: dBm
                        type: string
                        description: Unit of signal strength
                      synchronicity:
                        example: '%'
                        type: string
                        description: Unit of synchronicity
                      temperature:
                        example: °C
                        type: string
                        description: Unit of temperature
                      voltage:
                        example: V
                        type: string
                        description: Unit of voltage
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/outlets/{outlet_id}:
    get:
      description: Get a specific outlet via its ID.
      summary: Get outlet
      tags:
        - outlet
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: outlet_id
          in: path
          description: ID of the outlet to be queried
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Id of the outlet
                  name:
                    example: 1-1
                    type: string
                    description: Name of the outlet
                  switch_dual:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Describes if the associated outlet should be switched as
                      well.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update a specific outlet via its ID.
      summary: Update outlet
      tags:
        - outlet
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: outlet_id
          in: path
          description: ID of the outlet to be queried
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  example: 1
                  type: integer
                  readOnly: true
                  description: Id of the outlet
                name:
                  example: 1-1
                  type: string
                  description: Name of the outlet
                switch_dual:
                  example: false
                  type: boolean
                  nullable: true
                  description: >-
                    Describes if the associated outlet should be switched as
                    well.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    example: 1
                    type: integer
                    readOnly: true
                    description: Id of the outlet
                  name:
                    example: 1-1
                    type: string
                    description: Name of the outlet
                  switch_dual:
                    example: false
                    type: boolean
                    nullable: true
                    description: >-
                      Describes if the associated outlet should be switched as
                      well.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/outlets/{outlet_id}/switch:
    put:
      description: Switches an outlet.
      summary: Switch outlet
      tags:
        - outlet-switch
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: outlet_id
          in: path
          description: ID of the outlet to be queried
          required: true
          example: 1
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                required:
                  - mode
                properties:
                  mode:
                    example: 'on'
                    type: string
                    enum:
                      - 'on'
                      - 'off'
                      - toggle
                    description: Describes the target status of the outlet.
                  duration:
                    example: 5
                    type: number
                    default: null
                    nullable: true
                    description: >
                      Time in seconds for the outlet to be switched. After this
                      time has passed, the outlet will be switched back to it's
                      initial state. Omitting the attribute or a value of null
                      will be interpreted as permanent switching. A value of 0
                      will ignore the command.
                  delay:
                    example: 5
                    type: number
                    default: null
                    nullable: true
                    description: >
                      Time in seconds before the switching will be executed.
                      Omitting the attribute, a value of null or a value of 0
                      will switch with no delay.
                  dual:
                    example: false
                    type: boolean
                    default: false
                    nullable: true
                    description: >
                      If a dual SmartPDU or a rack unit with exactly 1 line a
                      device and exactly 1 lane b device is used, the mirrored
                      outlet can be switched synchronously. By setting this
                      attribute to true, the mirrored outlet of the addressed
                      one will be switched, too. If omitted or set to null, no
                      dual switching will be executed.
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/privacy:
    get:
      description: Requests the privacy settings of the device.
      summary: Privacy settings
      tags:
        - privacy
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    memorydepth:
                      example: 1
                      type: number
                      minimum: 0
                      maximum: 720
                      description: >-
                        Sets the number of days during which all user-related
                        data (bookings, images, etc) is stored. 0 = Unlimited,
                        must be between 0 and 720.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
      security:
        - bearer: []
    patch:
      description: Updates the privacy settings of the device.
      summary: Update privacy settings
      tags:
        - privacy
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                memorydepth:
                  example: 1
                  type: number
                  minimum: 0
                  maximum: 720
                  description: >-
                    Sets the number of days during which all user-related data
                    (bookings, images, etc) is stored. 0 = Unlimited, must be
                    between 0 and 720.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    memorydepth:
                      example: 1
                      type: number
                      minimum: 0
                      maximum: 720
                      description: >-
                        Sets the number of days during which all user-related
                        data (bookings, images, etc) is stored. 0 = Unlimited,
                        must be between 0 and 720.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/profile:
    get:
      description: Requests the profile of the currently authenticated user.
      summary: Get user profile
      tags:
        - profile
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  username:
                    type: string
                    description: The username of the currently authenticated user.
                    example: erika.schmidt
                  password:
                    type: string
                    description: A static replacement for the actual password.
                    example: pvg4HXvj9WG4KPnN
                  fullname:
                    type: string
                    description: The full name of the currently authenticated user.
                    example: Erika Schmidt
                  email:
                    type: string
                    description: The email address of the currently authenticated user.
                    example: erika.schmidt@example.com
                    nullable: true
                  autologout:
                    type: integer
                    enum:
                      - 5
                      - 15
                      - 30
                      - 60
                      - 120
                      - 360
                      - 720
                    description: The time in minutes for auto logout or null to disable it.
                    example: 120
                    nullable: true
                  is_admin:
                    type: boolean
                    description: >-
                      Describes if the currently authenticated user is an
                      administrator
                    example: false
                  usergroup:
                    type: object
                    properties:
                      id:
                        example: 1
                        type: integer
                        readOnly: true
                        description: Describes the ID of the Usergroup.
                      name:
                        example: Manager
                        type: string
                        description: Describes the name of the Usergroup.
                      permissions:
                        type: object
                        description: Describes the permissions the Usergroup have.
                        properties:
                          accessmanager-settings:
                            example: true
                            type: boolean
                            description: Describes the permission for general settings.
                          webhook:
                            example: true
                            type: boolean
                            description: Describes the permission for webhooks.
                          timedevents:
                            example: true
                            type: boolean
                            description: Describes the permission for eventprofiles.
                          system-event:
                            example: true
                            type: boolean
                            description: Describes the permission for system log.
                          snmp:
                            example: true
                            type: boolean
                            description: Describes the permission for SNMP.
                          report:
                            example: true
                            type: boolean
                            description: Describes the permission for reports.
                          invoice:
                            example: true
                            type: boolean
                            description: Describes the permission for metering.
                          info:
                            example: true
                            type: boolean
                            description: Describes the permission for device info.
                          cloud:
                            example: true
                            type: boolean
                            description: Describes the permission for Kentix-ONE GO.
                          blockingprofiles:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for manage exception
                              days.
                          alarm-event:
                            example: true
                            type: boolean
                            description: Describes the permission for event logbook.
                          satellites:
                            example: true
                            type: boolean
                            description: Describes the permission for updating satellites.
                          satellite-settings:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for Manager/Satellite
                              mode.
                          satellite+sync:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for synchronize
                              satellites.
                          timeprofile:
                            example: true
                            type: boolean
                            description: Describes the permission for time profiles.
                          levelprofile:
                            example: true
                            type: boolean
                            description: Describes the permission for access profiles.
                          doorlock+open:
                            example: true
                            type: boolean
                            description: Describes the permission for open DoorLocks.
                          backup:
                            example: true
                            type: boolean
                            description: Describes the permission for backup.
                          backup+restore:
                            example: true
                            type: boolean
                            description: Describes the permission for restore backups.
                          autobackup:
                            example: true
                            type: boolean
                            description: Describes the permission for automatic backup.
                          sd-card:
                            example: true
                            type: boolean
                            description: Describes the permission for SD-Card.
                          access-event:
                            example: true
                            type: boolean
                            description: Describes the permission for access logbook.
                          access-event+every:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for showing all users
                              access logbooks.
                          change-devicename:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for changing the device
                              name.
                          update:
                            example: true
                            type: boolean
                            description: Describes the permission for softwareupdate.
                          reset:
                            example: true
                            type: boolean
                            description: Describes the permission for resetting.
                          network-settings:
                            example: true
                            type: boolean
                            description: Describes the permission for network.
                          ssl-certificate:
                            example: true
                            type: boolean
                            description: Describes the permission for SSL certificate.
                          datetime:
                            example: true
                            type: boolean
                            description: Describes the permission for date and time.
                          security:
                            example: true
                            type: boolean
                            description: Describes the permission for security.
                          email:
                            example: true
                            type: boolean
                            description: Describes the permission for email.
                          gsm:
                            example: true
                            type: boolean
                            description: Describes the permission for SMS.
                          region:
                            example: true
                            type: boolean
                            description: Describes the permission for language and region.
                          systemmanagement:
                            example: true
                            type: boolean
                            description: Describes the permission for Detail View.
                          alarmgroup+every:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for showing all
                              alarmgroups.
                          alarmgroup+switch:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for arming/disarming
                              assigned alarmgroups.
                          alarmgroup+quit:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for quitting alarms of
                              assigned alarmgroups.
                          alarmgroup+manage:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing assigned
                              alarmgroups.
                          systemmanagement+monitoring:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing monitoring
                              devices.
                          systemmanagement+access:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing access
                              devices.
                          systemmanagement+power:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing power
                              devices.
                          systemmanagement+video:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing video
                              devices.
                          filterprofile:
                            example: true
                            type: boolean
                            description: Describes the permission for filter profiles.
                          personalization:
                            example: true
                            type: boolean
                            description: Describes the permission for personalization.
                          user:
                            example: true
                            type: boolean
                            description: Describes the permission for users.
                          usergroup:
                            example: true
                            type: boolean
                            description: Describes the permission for usergroups.
                          ldap:
                            example: true
                            type: boolean
                            description: Describes the permission for LDAP.
                          read-rfid:
                            example: true
                            type: boolean
                            description: Describes the permission for reading RFID-UID.
                          systemanalysis:
                            example: true
                            type: boolean
                            description: Describes the permission for system analysis.
                          vds:
                            example: true
                            type: boolean
                            description: Describes the permission for VdS settings.
                          metering:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for Modbus communication
                              settings.
                    nullable: false
                  filterprofile_id:
                    type: integer
                    description: Describes the ID of the personal default filter profile.
                    example: 4
                  tableview_id:
                    type: integer
                    description: Describes the ID of the personal default table view.
                    example: 3
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the profile of the currently authenticated user.
      summary: Update user profile
      tags:
        - profile
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                password:
                  type: string
                  description: >-
                    A new password or the static replacement to keep the
                    password.
                  example: top-secret
                fullname:
                  type: string
                  description: The full name of the currently authenticated user.
                  example: Erika Schmidt
                email:
                  type: string
                  description: The email address of the currently authenticated user.
                  example: erika.schmidt@example.com
                  nullable: true
                autologout:
                  type: integer
                  enum:
                    - 5
                    - 15
                    - 30
                    - 60
                    - 120
                    - 360
                    - 720
                  description: The time in minutes for auto logout or null to disable it.
                  example: 120
                  nullable: true
                filterprofile_id:
                  type: integer
                  description: Describes the ID of the personal default filter profile.
                  example: 4
                tableview_id:
                  type: integer
                  description: Describes the ID of the personal default table view.
                  example: 3
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  username:
                    type: string
                    description: The username of the currently authenticated user.
                    example: erika.schmidt
                  password:
                    type: string
                    description: A static replacement for the actual password.
                    example: pvg4HXvj9WG4KPnN
                  fullname:
                    type: string
                    description: The full name of the currently authenticated user.
                    example: Erika Schmidt
                  email:
                    type: string
                    description: The email address of the currently authenticated user.
                    example: erika.schmidt@example.com
                    nullable: true
                  autologout:
                    type: integer
                    enum:
                      - 5
                      - 15
                      - 30
                      - 60
                      - 120
                      - 360
                      - 720
                    description: The time in minutes for auto logout or null to disable it.
                    example: 120
                    nullable: true
                  is_admin:
                    type: boolean
                    description: >-
                      Describes if the currently authenticated user is an
                      administrator
                    example: false
                  usergroup:
                    type: object
                    properties:
                      id:
                        example: 1
                        type: integer
                        readOnly: true
                        description: Describes the ID of the Usergroup.
                      name:
                        example: Manager
                        type: string
                        description: Describes the name of the Usergroup.
                      permissions:
                        type: object
                        description: Describes the permissions the Usergroup have.
                        properties:
                          accessmanager-settings:
                            example: true
                            type: boolean
                            description: Describes the permission for general settings.
                          webhook:
                            example: true
                            type: boolean
                            description: Describes the permission for webhooks.
                          timedevents:
                            example: true
                            type: boolean
                            description: Describes the permission for eventprofiles.
                          system-event:
                            example: true
                            type: boolean
                            description: Describes the permission for system log.
                          snmp:
                            example: true
                            type: boolean
                            description: Describes the permission for SNMP.
                          report:
                            example: true
                            type: boolean
                            description: Describes the permission for reports.
                          invoice:
                            example: true
                            type: boolean
                            description: Describes the permission for metering.
                          info:
                            example: true
                            type: boolean
                            description: Describes the permission for device info.
                          cloud:
                            example: true
                            type: boolean
                            description: Describes the permission for Kentix-ONE GO.
                          blockingprofiles:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for manage exception
                              days.
                          alarm-event:
                            example: true
                            type: boolean
                            description: Describes the permission for event logbook.
                          satellites:
                            example: true
                            type: boolean
                            description: Describes the permission for updating satellites.
                          satellite-settings:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for Manager/Satellite
                              mode.
                          satellite+sync:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for synchronize
                              satellites.
                          timeprofile:
                            example: true
                            type: boolean
                            description: Describes the permission for time profiles.
                          levelprofile:
                            example: true
                            type: boolean
                            description: Describes the permission for access profiles.
                          doorlock+open:
                            example: true
                            type: boolean
                            description: Describes the permission for open DoorLocks.
                          backup:
                            example: true
                            type: boolean
                            description: Describes the permission for backup.
                          backup+restore:
                            example: true
                            type: boolean
                            description: Describes the permission for restore backups.
                          autobackup:
                            example: true
                            type: boolean
                            description: Describes the permission for automatic backup.
                          sd-card:
                            example: true
                            type: boolean
                            description: Describes the permission for SD-Card.
                          access-event:
                            example: true
                            type: boolean
                            description: Describes the permission for access logbook.
                          access-event+every:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for showing all users
                              access logbooks.
                          change-devicename:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for changing the device
                              name.
                          update:
                            example: true
                            type: boolean
                            description: Describes the permission for softwareupdate.
                          reset:
                            example: true
                            type: boolean
                            description: Describes the permission for resetting.
                          network-settings:
                            example: true
                            type: boolean
                            description: Describes the permission for network.
                          ssl-certificate:
                            example: true
                            type: boolean
                            description: Describes the permission for SSL certificate.
                          datetime:
                            example: true
                            type: boolean
                            description: Describes the permission for date and time.
                          security:
                            example: true
                            type: boolean
                            description: Describes the permission for security.
                          email:
                            example: true
                            type: boolean
                            description: Describes the permission for email.
                          gsm:
                            example: true
                            type: boolean
                            description: Describes the permission for SMS.
                          region:
                            example: true
                            type: boolean
                            description: Describes the permission for language and region.
                          systemmanagement:
                            example: true
                            type: boolean
                            description: Describes the permission for Detail View.
                          alarmgroup+every:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for showing all
                              alarmgroups.
                          alarmgroup+switch:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for arming/disarming
                              assigned alarmgroups.
                          alarmgroup+quit:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for quitting alarms of
                              assigned alarmgroups.
                          alarmgroup+manage:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing assigned
                              alarmgroups.
                          systemmanagement+monitoring:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing monitoring
                              devices.
                          systemmanagement+access:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing access
                              devices.
                          systemmanagement+power:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing power
                              devices.
                          systemmanagement+video:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for managing video
                              devices.
                          filterprofile:
                            example: true
                            type: boolean
                            description: Describes the permission for filter profiles.
                          personalization:
                            example: true
                            type: boolean
                            description: Describes the permission for personalization.
                          user:
                            example: true
                            type: boolean
                            description: Describes the permission for users.
                          usergroup:
                            example: true
                            type: boolean
                            description: Describes the permission for usergroups.
                          ldap:
                            example: true
                            type: boolean
                            description: Describes the permission for LDAP.
                          read-rfid:
                            example: true
                            type: boolean
                            description: Describes the permission for reading RFID-UID.
                          systemanalysis:
                            example: true
                            type: boolean
                            description: Describes the permission for system analysis.
                          vds:
                            example: true
                            type: boolean
                            description: Describes the permission for VdS settings.
                          metering:
                            example: true
                            type: boolean
                            description: >-
                              Describes the permission for Modbus communication
                              settings.
                    nullable: false
                  filterprofile_id:
                    type: integer
                    description: Describes the ID of the personal default filter profile.
                    example: 4
                  tableview_id:
                    type: integer
                    description: Describes the ID of the personal default table view.
                    example: 3
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/proxy:
    get:
      description: Requests the settings of the HTTP proxy.
      summary: Gets the HTTP proxy settings
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      tags:
        - proxy
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    http-proxy:
                      type: object
                      description: >-
                        These are the proxy setting for connecting your device
                        e.g. to the KentixONE online service or the Kentix
                        update server, i.e. an internet HTTP proxy.
                      properties:
                        is_active:
                          type: boolean
                          description: Enables HTTP proxy usage.
                        address:
                          type: string
                          description: FQHN (domain name, IP, etc.) of the HTTP proxy
                        port:
                          type: number
                          minimum: 1
                          maximum: 65535
                          description: Network port of the HTTP proxy
                        username:
                          type: string
                          description: >-
                            If your HTTP proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
                        password:
                          type: string
                          description: >-
                            If your HTTP proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
                    sensor-proxy:
                      type: object
                      description: >-
                        If your network is set up with a proxy between your main
                        and your satellite devices, use this settings.
                      properties:
                        is_active:
                          type: boolean
                          description: Enables sensor-proxy usage.
                        address:
                          type: string
                          description: FQHN (domain name, IP, etc) of the sensor proxy
                        port:
                          type: number
                          minimum: 1
                          maximum: 65535
                          description: Network port of the sensor proxy
                        username:
                          type: string
                          description: >-
                            If your sensor proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
                        password:
                          type: string
                          description: >-
                            If your sensor proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update the settings of your HTTP proxy server.
      summary: Updates the HTTP proxy.
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      tags:
        - proxy
      requestBody:
        description: Updated proxy settings
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                http-proxy:
                  type: object
                  description: >-
                    These are the proxy setting for connecting your device e.g.
                    to the KentixONE online service or the Kentix update server,
                    i.e. an internet HTTP proxy.
                  properties:
                    is_active:
                      type: boolean
                      description: Enables HTTP proxy usage.
                    address:
                      type: string
                      description: FQHN (domain name, IP, etc.) of the HTTP proxy
                    port:
                      type: number
                      minimum: 1
                      maximum: 65535
                      description: Network port of the HTTP proxy
                    username:
                      type: string
                      description: >-
                        If your HTTP proxy server needs authorization, you may
                        enter the credentials here. If no authorization is
                        needed, just leave it empty.
                    password:
                      type: string
                      description: >-
                        If your HTTP proxy server needs authorization, you may
                        enter the credentials here. If no authorization is
                        needed, just leave it empty.
                sensor-proxy:
                  type: object
                  description: >-
                    If your network is set up with a proxy between your main and
                    your satellite devices, use this settings.
                  properties:
                    is_active:
                      type: boolean
                      description: Enables sensor-proxy usage.
                    address:
                      type: string
                      description: FQHN (domain name, IP, etc) of the sensor proxy
                    port:
                      type: number
                      minimum: 1
                      maximum: 65535
                      description: Network port of the sensor proxy
                    username:
                      type: string
                      description: >-
                        If your sensor proxy server needs authorization, you may
                        enter the credentials here. If no authorization is
                        needed, just leave it empty.
                    password:
                      type: string
                      description: >-
                        If your sensor proxy server needs authorization, you may
                        enter the credentials here. If no authorization is
                        needed, just leave it empty.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    http-proxy:
                      type: object
                      description: >-
                        These are the proxy setting for connecting your device
                        e.g. to the KentixONE online service or the Kentix
                        update server, i.e. an internet HTTP proxy.
                      properties:
                        is_active:
                          type: boolean
                          description: Enables HTTP proxy usage.
                        address:
                          type: string
                          description: FQHN (domain name, IP, etc.) of the HTTP proxy
                        port:
                          type: number
                          minimum: 1
                          maximum: 65535
                          description: Network port of the HTTP proxy
                        username:
                          type: string
                          description: >-
                            If your HTTP proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
                        password:
                          type: string
                          description: >-
                            If your HTTP proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
                    sensor-proxy:
                      type: object
                      description: >-
                        If your network is set up with a proxy between your main
                        and your satellite devices, use this settings.
                      properties:
                        is_active:
                          type: boolean
                          description: Enables sensor-proxy usage.
                        address:
                          type: string
                          description: FQHN (domain name, IP, etc) of the sensor proxy
                        port:
                          type: number
                          minimum: 1
                          maximum: 65535
                          description: Network port of the sensor proxy
                        username:
                          type: string
                          description: >-
                            If your sensor proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
                        password:
                          type: string
                          description: >-
                            If your sensor proxy server needs authorization, you
                            may enter the credentials here. If no authorization
                            is needed, just leave it empty.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/quicklinks:
    get:
      description: Requests the shortcuts linked to the current user.
      summary: Get users shortcuts
      tags:
        - quicklinks
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: number
                      description: The id of the shortcut
                      example: 3
                    name:
                      type: string
                      description: The name of the shortcut
                      example: Dashboard
                    viewmode:
                      type: number
                      enum:
                        - 0
                        - 1
                        - 2
                      description: >-
                        The modus of the link. 0 => URL, 1=> Detail View (Grid),
                        2 => Detail View (Table)
                      example: 0
                    url:
                      type: string
                      nullable: true
                      description: The url the shortcut links to
                      example: /dashboard
                    filterprofile_id:
                      type: number
                      nullable: true
                      description: >-
                        The id of the linked filterprofile in the grid view of
                        the Detail View
                      example: null
                    tableview_id:
                      type: number
                      nullable: true
                      description: >-
                        The id of the linked tableview in the table view of the
                        Detail View
                      example: null
                    icon:
                      type: string
                      description: The icon to be shown for the shortcut
                      example: circle
                    default:
                      type: boolean
                      description: >-
                        The flag that determines, if this shortcut will be
                        linked to all new users
                      example: true
                    permission:
                      type: string
                      nullable: true
                      description: >-
                        The name of the permission needed to see/ use this
                        shortcut
                      example: null
                    pivot:
                      type: object
                      properties:
                        user_id:
                          type: number
                          description: The ID of the user
                          example: 1
                        quicklink_id:
                          type: number
                          description: The ID of the shortcut
                          example: 3
                        sort:
                          type: number
                          description: >-
                            The position in which it is displayed in the
                            KentixONE Layout
                          example: 4
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
    patch:
      description: Updates the list of linked shortcuts.
      summary: Update users shortcut list
      tags:
        - quicklinks
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: number
                    description: The id of the shortcut
                    example: 3
                  name:
                    type: string
                    description: The name of the shortcut
                    example: Dashboard
                  viewmode:
                    type: number
                    enum:
                      - 0
                      - 1
                      - 2
                    description: >-
                      The modus of the link. 0 => URL, 1=> Detail View (Grid), 2
                      => Detail View (Table)
                    example: 0
                  url:
                    type: string
                    nullable: true
                    description: The url the shortcut links to
                    example: /dashboard
                  filterprofile_id:
                    type: number
                    nullable: true
                    description: >-
                      The id of the linked filterprofile in the grid view of the
                      Detail View
                    example: null
                  tableview_id:
                    type: number
                    nullable: true
                    description: >-
                      The id of the linked tableview in the table view of the
                      Detail View
                    example: null
                  icon:
                    type: string
                    description: The icon to be shown for the shortcut
                    example: circle
                  default:
                    type: boolean
                    description: >-
                      The flag that determines, if this shortcut will be linked
                      to all new users
                    example: true
                  permission:
                    type: string
                    nullable: true
                    description: >-
                      The name of the permission needed to see/ use this
                      shortcut
                    example: null
                  pivot:
                    type: object
                    properties:
                      user_id:
                        type: number
                        description: The ID of the user
                        example: 1
                      quicklink_id:
                        type: number
                        description: The ID of the shortcut
                        example: 3
                      sort:
                        type: number
                        description: >-
                          The position in which it is displayed in the KentixONE
                          Layout
                        example: 4
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
    put:
      description: Sets or unsets the shortcut as default for new users
      summary: (Un)Set default shortcut
      tags:
        - quicklinks
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                quicklink_id:
                  type: number
                  description: The id of the shortcut to (un)set as default
                  example: 3
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
  /api/racks:
    get:
      tags:
        - rack
      description: Get a list of all racks.
      summary: Get racks
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: Rack
                      type: string
                      description: The name of the device
                    group_id:
                      example: 1
                      type: integer
                      description: The ID of the group the device is assigned to
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    post:
      tags:
        - rack
      description: Add a new rack.
      summary: Add Rack
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  example: Rack
                  type: string
                  description: The name to give the new Rack
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the alarmgroup this rack will belong to
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: Rack
                    type: string
                    description: The name of the device
                  description:
                    example: Rack Server1
                    type: string
                    description: The description of the device
                  devices:
                    type: array
                    description: >-
                      Contains an array of devices and their supplyline- and
                      synchronicity assignments. These are only relevant if the
                      devices are PDUs
                    items:
                      type: object
                      properties:
                        id:
                          example: 4
                          type: integer
                          description: Id of the device.
                        supplyline:
                          example: a
                          type: string
                          enum:
                            - a
                            - b
                            - ab
                            - none
                            - ''
                          description: The supplyline assignment of this device.
                        synchronicity_assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          nullable: true
                          description: The alarm assignment of this sensor.
                  ios:
                    type: array
                    items:
                      type: integer
                    description: Contains an array of IO-IDs that are assigned to this rack
                  synchronicity:
                    type: object
                    description: The configuration for the synchronicity sensor
                    properties:
                      assignment:
                        example: always-active
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of this sensor
                      threshold:
                        example: 20
                        type: integer
                        description: The max threshold where an alarm is triggered
                      max:
                        example: 5
                        type: integer
                        description: The max threshold where an alarm is triggered
                      units:
                        type: object
                        properties:
                          max:
                            example: '%'
                            type: string
                            description: The unit for the max field
                          threshold:
                            example: W
                            type: string
                            description: The unit for the threshold field
                      warning:
                        type: object
                        properties:
                          max:
                            example: 3
                            type: integer
                            description: The warning threshold for the max value
                          active:
                            example: true
                            type: boolean
                            description: >-
                              The flag to determine if warnings should be
                              triggered
                  activepower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      supply_b:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  apparentpower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  consumption:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/racks/names:
    get:
      tags:
        - rack-names
      description: Get a list of the names of all racks.
      summary: Get rack names
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      example: 1
                      type: integer
                      description: the ID of the device
                    name:
                      example: Rack
                      type: string
                      description: The name of the device
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/racks/{rack}:
    get:
      tags:
        - rack-id
      description: Get the configuration of the given rack.
      summary: Get details
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: rack
          in: path
          description: Rack ID
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: Rack
                    type: string
                    description: The name of the device
                  description:
                    example: Rack Server1
                    type: string
                    description: The description of the device
                  devices:
                    type: array
                    description: >-
                      Contains an array of devices and their supplyline- and
                      synchronicity assignments. These are only relevant if the
                      devices are PDUs
                    items:
                      type: object
                      properties:
                        id:
                          example: 4
                          type: integer
                          description: Id of the device.
                        supplyline:
                          example: a
                          type: string
                          enum:
                            - a
                            - b
                            - ab
                            - none
                            - ''
                          description: The supplyline assignment of this device.
                        synchronicity_assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          nullable: true
                          description: The alarm assignment of this sensor.
                  ios:
                    type: array
                    items:
                      type: integer
                    description: Contains an array of IO-IDs that are assigned to this rack
                  synchronicity:
                    type: object
                    description: The configuration for the synchronicity sensor
                    properties:
                      assignment:
                        example: always-active
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of this sensor
                      threshold:
                        example: 20
                        type: integer
                        description: The max threshold where an alarm is triggered
                      max:
                        example: 5
                        type: integer
                        description: The max threshold where an alarm is triggered
                      units:
                        type: object
                        properties:
                          max:
                            example: '%'
                            type: string
                            description: The unit for the max field
                          threshold:
                            example: W
                            type: string
                            description: The unit for the threshold field
                      warning:
                        type: object
                        properties:
                          max:
                            example: 3
                            type: integer
                            description: The warning threshold for the max value
                          active:
                            example: true
                            type: boolean
                            description: >-
                              The flag to determine if warnings should be
                              triggered
                  activepower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      supply_b:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  apparentpower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  consumption:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      tags:
        - rack-id
      description: Update the configuration of the given rack.
      summary: Update configuration
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: rack
          in: path
          description: Rack ID
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                is_active:
                  example: true
                  type: boolean
                  description: The flag to determine the status of the device
                name:
                  example: Rack
                  type: string
                  description: The name of the device
                description:
                  example: Rack Server1
                  type: string
                  description: The description of the device
                devices:
                  type: array
                  description: >-
                    Contains an array of devices and their supplyline- and
                    synchronicity assignments. These are only relevant if the
                    devices are PDUs
                  items:
                    type: object
                    properties:
                      id:
                        example: 4
                        type: integer
                        description: Id of the device.
                      supplyline:
                        example: a
                        type: string
                        enum:
                          - a
                          - b
                          - ab
                          - none
                          - ''
                        description: The supplyline assignment of this device.
                      synchronicity_assignment:
                        example: always-active
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        nullable: true
                        description: The alarm assignment of this sensor.
                ios:
                  type: array
                  items:
                    type: integer
                  description: Contains an array of IO-IDs that are assigned to this rack
                synchronicity:
                  type: object
                  description: The configuration for the synchronicity sensor
                  properties:
                    assignment:
                      example: always-active
                      type: string
                      enum:
                        - 'off'
                        - always-active
                        - armed-active
                        - fire
                        - sabotage
                        - display
                        - system
                      description: The alarm assignment of this sensor
                    threshold:
                      example: 20
                      type: integer
                      description: The max threshold where an alarm is triggered
                    max:
                      example: 5
                      type: integer
                      description: The max threshold where an alarm is triggered
                    units:
                      type: object
                      properties:
                        max:
                          example: '%'
                          type: string
                          description: The unit for the max field
                        threshold:
                          example: W
                          type: string
                          description: The unit for the threshold field
                    warning:
                      type: object
                      properties:
                        max:
                          example: 3
                          type: integer
                          description: The warning threshold for the max value
                        active:
                          example: true
                          type: boolean
                          description: >-
                            The flag to determine if warnings should be
                            triggered
                activepower:
                  type: object
                  properties:
                    supply_a:
                      type: object
                      description: The configuration for the activepower sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 20000
                          type: integer
                          description: The max threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            max:
                              example: W
                              type: string
                              description: The unit for the max field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15000
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                    supply_b:
                      type: object
                      description: The configuration for the activepower sensor
                      properties:
                        assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          description: The alarm assignment of this sensor
                        max:
                          example: 20000
                          type: integer
                          description: The max threshold where an alarm is triggered
                        units:
                          type: object
                          properties:
                            max:
                              example: W
                              type: string
                              description: The unit for the max field
                        warning:
                          type: object
                          properties:
                            max:
                              example: 15000
                              type: integer
                              description: The warning threshold for the max value
                            active:
                              example: true
                              type: boolean
                              description: >-
                                The flag to determine if warnings should be
                                triggered
                apparentpower:
                  type: object
                  properties:
                    supply_a:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                    supply_b:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                consumption:
                  type: object
                  properties:
                    supply_a:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                    supply_b:
                      type: object
                      properties:
                        assignment:
                          type: string
                          enum:
                            - 'off'
                            - display
                webhooks:
                  type: array
                  description: The webhook relations of this device
                  items:
                    type: object
                    properties:
                      id:
                        example: 0
                        type: integer
                        description: Must be an Id of an existing webhook.
                      event:
                        example: 0
                        type: integer
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                          - 5
                          - 51
                        description: Must be an Id of an existing webhook event type.
                      cycle_time:
                        example: 5
                        type: integer
                        nullable: true
                        enum:
                          - 5
                          - 10
                          - 15
                          - 30
                        description: >-
                          Describes how often the webhook should be executed.
                          Only required if event is 51.
                      trigger_on_alarm:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          an alarm.
                      trigger_on_warning:
                        example: false
                        type: boolean
                        nullable: true
                        description: >-
                          Describes if the webhook should be executed in case of
                          a warning.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  group_id:
                    example: 1
                    type: integer
                    description: The ID of the group the device is assigned to
                  id:
                    example: 2
                    type: integer
                    description: the ID of the device
                  is_active:
                    example: true
                    type: boolean
                    description: The flag to determine the status of the device
                  name:
                    example: Rack
                    type: string
                    description: The name of the device
                  description:
                    example: Rack Server1
                    type: string
                    description: The description of the device
                  devices:
                    type: array
                    description: >-
                      Contains an array of devices and their supplyline- and
                      synchronicity assignments. These are only relevant if the
                      devices are PDUs
                    items:
                      type: object
                      properties:
                        id:
                          example: 4
                          type: integer
                          description: Id of the device.
                        supplyline:
                          example: a
                          type: string
                          enum:
                            - a
                            - b
                            - ab
                            - none
                            - ''
                          description: The supplyline assignment of this device.
                        synchronicity_assignment:
                          example: always-active
                          type: string
                          enum:
                            - 'off'
                            - always-active
                            - armed-active
                            - fire
                            - sabotage
                            - display
                            - system
                          nullable: true
                          description: The alarm assignment of this sensor.
                  ios:
                    type: array
                    items:
                      type: integer
                    description: Contains an array of IO-IDs that are assigned to this rack
                  synchronicity:
                    type: object
                    description: The configuration for the synchronicity sensor
                    properties:
                      assignment:
                        example: always-active
                        type: string
                        enum:
                          - 'off'
                          - always-active
                          - armed-active
                          - fire
                          - sabotage
                          - display
                          - system
                        description: The alarm assignment of this sensor
                      threshold:
                        example: 20
                        type: integer
                        description: The max threshold where an alarm is triggered
                      max:
                        example: 5
                        type: integer
                        description: The max threshold where an alarm is triggered
                      units:
                        type: object
                        properties:
                          max:
                            example: '%'
                            type: string
                            description: The unit for the max field
                          threshold:
                            example: W
                            type: string
                            description: The unit for the threshold field
                      warning:
                        type: object
                        properties:
                          max:
                            example: 3
                            type: integer
                            description: The warning threshold for the max value
                          active:
                            example: true
                            type: boolean
                            description: >-
                              The flag to determine if warnings should be
                              triggered
                  activepower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                      supply_b:
                        type: object
                        description: The configuration for the activepower sensor
                        properties:
                          assignment:
                            example: always-active
                            type: string
                            enum:
                              - 'off'
                              - always-active
                              - armed-active
                              - fire
                              - sabotage
                              - display
                              - system
                            description: The alarm assignment of this sensor
                          max:
                            example: 20000
                            type: integer
                            description: The max threshold where an alarm is triggered
                          units:
                            type: object
                            properties:
                              max:
                                example: W
                                type: string
                                description: The unit for the max field
                          warning:
                            type: object
                            properties:
                              max:
                                example: 15000
                                type: integer
                                description: The warning threshold for the max value
                              active:
                                example: true
                                type: boolean
                                description: >-
                                  The flag to determine if warnings should be
                                  triggered
                  apparentpower:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  consumption:
                    type: object
                    properties:
                      supply_a:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                      supply_b:
                        type: object
                        properties:
                          assignment:
                            type: string
                            enum:
                              - 'off'
                              - display
                  webhooks:
                    type: array
                    description: The webhook relations of this device
                    items:
                      type: object
                      properties:
                        id:
                          example: 0
                          type: integer
                          description: Must be an Id of an existing webhook.
                        event:
                          example: 0
                          type: integer
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                            - 5
                            - 51
                          description: Must be an Id of an existing webhook event type.
                        cycle_time:
                          example: 5
                          type: integer
                          nullable: true
                          enum:
                            - 5
                            - 10
                            - 15
                            - 30
                          description: >-
                            Describes how often the webhook should be executed.
                            Only required if event is 51.
                        trigger_on_alarm:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of an alarm.
                        trigger_on_warning:
                          example: false
                          type: boolean
                          nullable: true
                          description: >-
                            Describes if the webhook should be executed in case
                            of a warning.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    delete:
      tags:
        - rack-id
      description: Delete the given rack.
      summary: Delete rack
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: rack
          in: path
          example: 1
          description: Rack ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/alarmgroups/{alarmgroup}/racks/{rack}:
    put:
      tags:
        - rack-attach
      description: Attach a rack to an alarmgroup.
      summary: Attach Rack
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: alarmgroup
          in: path
          description: Alarmgroup ID
          required: true
          example: 1
          schema:
            type: string
        - name: rack
          in: path
          example: 1
          description: Rack ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/region:
    get:
      description: Requests the language and temperature unit configuration of the device.
      summary: Locale settings
      tags:
        - region
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    language:
                      example: en
                      type: string
                      enum:
                        - en
                        - de
                        - fr
                        - it
                        - es
                        - pt
                        - jp
                      description: Language code
                    temperature_unit:
                      example: C
                      type: string
                      enum:
                        - C
                        - F
                      description: Temperature unit
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Updates the language and temperature unit configuration of the device.
      summary: Update locale settings
      tags:
        - region
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                language:
                  example: en
                  type: string
                  enum:
                    - en
                    - de
                    - fr
                    - it
                    - es
                    - pt
                    - jp
                  description: Language code
                temperature_unit:
                  example: C
                  type: string
                  enum:
                    - C
                    - F
                  description: Temperature unit
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    language:
                      example: en
                      type: string
                      enum:
                        - en
                        - de
                        - fr
                        - it
                        - es
                        - pt
                        - jp
                      description: Language code
                    temperature_unit:
                      example: C
                      type: string
                      enum:
                        - C
                        - F
                      description: Temperature unit
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/reboot:
    post:
      description: Reboot the device.
      summary: Reboot
      tags:
        - reboot
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Status of the reboot command.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/reset:
    post:
      description: >-
        Initiate a factory reset. This will delete all data on the device and
        restore it to its factory defaults.
      summary: Factory Reset
      tags:
        - reset
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: >-
          The device will reboot after the reset is complete. The device will
          not be reachable for a few minutes.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                reboot:
                  type: boolean
                  description: Reboot the Device.
                  example: true
                reset_network:
                  type: boolean
                  description: Reset the Network Settings.
                  example: true
      responses:
        '200':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/security:
    get:
      description: Get the communication key.
      summary: Get communication key
      tags:
        - security
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  communication_key:
                    type: string
                    description: The communication key of the device.
                    example: myCommunicationKey0123456789
                  pinlength:
                    type: integer
                    description: The length of the PIN.
                    example: 4
                    minimum: 4
                    maximum: 10
                  rfid_mode:
                    type: integer
                    description: >-
                      The RFID mode of the device. 0=disabled,
                      1=Kentix-Encryption, 2=Custom-Encryption.
                    example: 0
                    enum:
                      - 0
                      - 1
                      - 2
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    patch:
      description: Update the communication key.
      summary: Update communication key
      tags:
        - security
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                communication_key:
                  type: string
                  description: The communication key of the device.
                  example: myCommunicationKey0123456789
                pinlength:
                  type: integer
                  description: The length of the PIN.
                  example: 4
                  minimum: 4
                  maximum: 10
                rfid_mode:
                  type: integer
                  description: >-
                    The RFID mode of the device. 0=disabled,
                    1=Kentix-Encryption, 2=Custom-Encryption.
                  example: 0
                  enum:
                    - 0
                    - 1
                    - 2
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  communication_key:
                    type: string
                    description: The communication key of the device.
                    example: myCommunicationKey0123456789
                  pinlength:
                    type: integer
                    description: The length of the PIN.
                    example: 4
                    minimum: 4
                    maximum: 10
                  rfid_mode:
                    type: integer
                    description: >-
                      The RFID mode of the device. 0=disabled,
                      1=Kentix-Encryption, 2=Custom-Encryption.
                    example: 0
                    enum:
                      - 0
                      - 1
                      - 2
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/devices/{device_id}/signal:
    put:
      description: Switches a specific output of the device.
      summary: Switch output
      tags:
        - signal
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: device_id
          in: path
          description: ID of the device, whose output should be switched
          required: true
          example: 1
          schema:
            type: string
      requestBody:
        description: Specification of the switching process
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                required:
                  - output
                  - mode
                properties:
                  type:
                    type: string
                    description: >-
                      The output to be switched BUZZER: Accoustic signaling via
                      the internal buzzer. LEDRED: Internal red led, normally
                      used for alarm state signalization. LEDGREEN: Internal
                      green led, normally used to indicate the devices' running
                      status. DO: Digital output
                    example: BUZZER
                    enum:
                      - BUZZER
                      - LEDRED
                      - LEDGREEN
                      - DO
                      - buzzer
                      - ledred
                      - ledgreen
                      - do
                  channel:
                    type: number
                    description: >-
                      Only required for DO type. The channel number of the
                      output to be switched.
                    example: 1
                  mode:
                    type: string
                    description: >-
                      Defines the switching mode. ON: Switches the output
                      constantly on. OFF: Switches the output constantly off.
                      PULSE: Toggles the output between on and off in a one
                      second interval.
                    example: 'ON'
                    enum:
                      - 'ON'
                      - 'OFF'
                      - PULSE
                      - 'on'
                      - 'off'
                      - pulse
                  duration:
                    type: number
                    description: >-
                      Period of time in seconds to signal on the selected
                      output. Can be NULL or any integer number. Can be omitted,
                      which will be evaluated the same as NULL or 0. If omitted
                      or set to NULL, the signaling will be continuous.
                    example: 10
                    default: null
                    nullable: true
                  delay:
                    type: number
                    description: >-
                      Delay in seconds before this signaling command is
                      executed. Can be NULL or any integer number. Can be
                      omitted, which will be evaluated the same as NULL or 0. If
                      omitted or set to NULL, the signaling will start
                      instantly.
                    example: 10
                    default: null
                    nullable: true
      responses:
        '204':
          description: Successful operation
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/system:
    get:
      description: Gets the system name.
      summary: Get system name
      tags:
        - systemname
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: The name of the system.
                      example: My AlarmManager
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
    patch:
      description: Updates the system name.
      summary: Update system name
      tags:
        - systemname
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the system.
                  example: My AlarmManager
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    description: The name of the system.
                    example: My AlarmManager
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
  /api/teachin:
    post:
      description: Start to add device.
      summary: Add device
      tags:
        - teachin
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Request payload to add a new device
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  title: AccessManager
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: accessmanager
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: NetworkCamera
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: camera
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Door Lever
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                        properties:
                          type:
                            example: doorlock-dc-le
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Racklock
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - teachin_code
                        properties:
                          type:
                            example: doorlock-ra4-ip
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          teachin_code:
                            example: 001d025537
                            type: string
                            description: >-
                              Bus-id (previously teach in code) printed on the
                              ra4 doorlock
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Virtual DoorLock
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                        properties:
                          type:
                            example: doorlock-virtual
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Wallreader (Bus)
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                        properties:
                          type:
                            example: doorlock-wa
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Extension-Module 7017
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: io-module-7017
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Extension-Module 7052
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: io-module-7052
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Extension-Module 7053
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: io-module-7053
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: MultiSensor (Ethernet)
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: multisensor-lan
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: MultiSensor (RF)
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                        properties:
                          type:
                            example: multisensor-rf
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Network Sensor
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: network-sensor
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: PowerManager
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: powermanager
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Rack Unit
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - group_id
                        properties:
                          type:
                            example: rack-unit
                            type: string
                            description: Specification which device type should be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: Residual Current Meter (RCM)
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - address
                          - model
                        properties:
                          type:
                            example: smartmeter-rcm-rtu
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          address:
                            example: '1'
                            type: string
                            description: Modbus address of the device to be added
                          model:
                            example: rcm-b132
                            type: string
                            enum:
                              - rcm-b132
                              - custom
                            description: >-
                              SmartMeter model to preconfigure the modbus
                              registers and device settings. Custom will have no
                              preconfigured modbus registers and device
                              settings.
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: SmartMeter (Bus)
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                          - model
                        properties:
                          type:
                            example: smartmeter-value-rtu
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: '1'
                            type: string
                            description: Modbus address of the device to be added
                          model:
                            example: ''
                            type: string
                            enum:
                              - uem80
                              - uem40
                              - abb-b21
                              - abb-b23
                              - ezg-tcp
                              - abb-cs700
                              - abb-cs700-branch
                              - conto-d4
                              - finder-7m24
                              - finder-7m38
                              - custom
                            description: >-
                              SmartMeter model to preconfigure the modbus
                              registers and device settings. Custom will have no
                              preconfigured modbus registers and device
                              settings.
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: SmartMeter (Ethernet)
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                          - model
                        properties:
                          type:
                            example: smartmeter-value-tcp
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          teachin_port:
                            example: '502'
                            type: integer
                            description: >-
                              TCP port on which the communication will be
                              established
                          model:
                            example: uem80
                            type: string
                            enum:
                              - uem80
                              - ezg-tcp
                              - umg96rm
                              - abb-cs700
                              - abb-cs700-branch
                              - custom
                            description: >-
                              SmartMeter model to preconfigure the modbus
                              registers and device settings. Custom will have no
                              preconfigured modbus registers and device
                              settings.
                          name:
                            example: Device name
                            default: Default name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: SmartPDU
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - address
                        properties:
                          type:
                            example: smartpdu
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          address:
                            example: 192.168.100.224
                            type: string
                            description: >-
                              IP address or DNS address of the device to be
                              added
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                - type: object
                  title: SNMP Sensor
                  properties:
                    devices:
                      type: array
                      items:
                        type: object
                        required:
                          - type
                          - host_id
                          - group_id
                          - credential_id
                          - evaluation_type
                          - oid
                        properties:
                          type:
                            example: snmp-sensor
                            type: string
                            description: Specification which device type should be added
                          host_id:
                            example: '1'
                            type: integer
                            description: >-
                              Device identifier to which host the device should
                              be added
                          group_id:
                            example: '10'
                            type: integer
                            description: Group identifier in which the device will be added
                          credential_id:
                            example: '1'
                            type: integer
                            description: >-
                              Snmp credential identifier which the added device
                              uses. Be sure to use credentials with the type
                              'retrieve data'.
                          name:
                            example: Device name
                            type: string
                            description: Name of the device to be added
                          evaluation_type:
                            example: min
                            type: string
                            enum:
                              - none
                              - min
                              - max
                              - min-max
                              - logic
                              - alarm-when
                            description: Alarm evaluation type for the polled value
                          oid:
                            example: .1.3.6.1.4.1.37954.5.1.1.1.0
                            type: string
                            description: Oid which the snmp sensor polls
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: MultiSensor
                          type: string
                          description: Name of the device which is removed
                        state:
                          example: RUNNING
                          type: string
                          enum:
                            - SEARCHING
                            - CONFIGURING
                            - RUNNING
                            - SUCCESS
                            - ERROR
                            - AWAITING_CONFIRMATION
                            - VALIDATION_ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - DEVICE_IS_NOT_REACHABLE
                            - DEVICE_HAS_WRONG_COMMUNICATION_KEY
                            - DEVICE_IS_NOT_IN_SATELLITE_MODE
                            - DEVICE_IS_NOT_A_VALID_SATELLITE
                            - DEVICE_HAS_ANOTHER_MANAGER
                            - TEACHIN_IS_ALREADY_RUNNING
                            - DEVICE_NOT_FOUND
                            - DEVICE_CAN_NOT_BE_CONFIGURED
                            - DUPLICATE_REQUEST
                            - ADDRESS_CONFLICT
                            - SYNC_REQUIRED
                            - ABORTED
                            - TIMEOUT
                            - DEVICE_ALREADY_TEACHED_IN
                          description: Current state of the removal process
                        uuid:
                          type: string
                          description: identifier of this device's removal
                          example: 3cb6e0ba-daaf-40d9-83b9-a5c351f35fe9
                  racks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: RackUnit
                          type: string
                          description: Name of the rack which is removed
                        state:
                          example: SUCCESS
                          type: string
                          enum:
                            - SEARCHING
                            - CONFIGURING
                            - RUNNING
                            - SUCCESS
                            - ERROR
                            - AWAITING_CONFIRMATION
                            - VALIDATION_ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - DEVICE_IS_NOT_REACHABLE
                            - DEVICE_HAS_WRONG_COMMUNICATION_KEY
                            - DEVICE_IS_NOT_IN_SATELLITE_MODE
                            - DEVICE_IS_NOT_A_VALID_SATELLITE
                            - DEVICE_HAS_ANOTHER_MANAGER
                            - TEACHIN_IS_ALREADY_RUNNING
                            - DEVICE_NOT_FOUND
                            - DEVICE_CAN_NOT_BE_CONFIGURED
                            - DUPLICATE_REQUEST
                            - ADDRESS_CONFLICT
                            - SYNC_REQUIRED
                            - ABORTED
                            - TIMEOUT
                            - DEVICE_ALREADY_TEACHED_IN
                          description: Current state of the removal process
                        uuid:
                          example: 0136e0ba-daaf-40d9-472b-1d246b9e8d26
                          type: string
                          description: identifier of this rack's removal
                  uuid:
                    type: string
                    example: 3e2e7ee8-16ab-472b-9529-1d246b9e8d26
                    description: Identifier of whole removal process
        '400':
          description: Bad Request - Cannot or will not handle the request.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/teachin/{teachin_uuid}:
    get:
      description: Get processing state of device adding.
      summary: Get processing state of device adding
      tags:
        - teachin
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: teachin_uuid
          in: path
          description: Identifier of the adding process
          required: true
          example: 1
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: MultiSensor
                          type: string
                          description: Name of the device which is removed
                        state:
                          example: RUNNING
                          type: string
                          enum:
                            - SEARCHING
                            - CONFIGURING
                            - RUNNING
                            - SUCCESS
                            - ERROR
                            - AWAITING_CONFIRMATION
                            - VALIDATION_ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - DEVICE_IS_NOT_REACHABLE
                            - DEVICE_HAS_WRONG_COMMUNICATION_KEY
                            - DEVICE_IS_NOT_IN_SATELLITE_MODE
                            - DEVICE_IS_NOT_A_VALID_SATELLITE
                            - DEVICE_HAS_ANOTHER_MANAGER
                            - TEACHIN_IS_ALREADY_RUNNING
                            - DEVICE_NOT_FOUND
                            - DEVICE_CAN_NOT_BE_CONFIGURED
                            - DUPLICATE_REQUEST
                            - ADDRESS_CONFLICT
                            - SYNC_REQUIRED
                            - ABORTED
                            - TIMEOUT
                            - DEVICE_ALREADY_TEACHED_IN
                          description: Current state of the removal process
                        uuid:
                          type: string
                          description: identifier of this device's removal
                          example: 3cb6e0ba-daaf-40d9-83b9-a5c351f35fe9
                  racks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: RackUnit
                          type: string
                          description: Name of the rack which is removed
                        state:
                          example: SUCCESS
                          type: string
                          enum:
                            - SEARCHING
                            - CONFIGURING
                            - RUNNING
                            - SUCCESS
                            - ERROR
                            - AWAITING_CONFIRMATION
                            - VALIDATION_ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - DEVICE_IS_NOT_REACHABLE
                            - DEVICE_HAS_WRONG_COMMUNICATION_KEY
                            - DEVICE_IS_NOT_IN_SATELLITE_MODE
                            - DEVICE_IS_NOT_A_VALID_SATELLITE
                            - DEVICE_HAS_ANOTHER_MANAGER
                            - TEACHIN_IS_ALREADY_RUNNING
                            - DEVICE_NOT_FOUND
                            - DEVICE_CAN_NOT_BE_CONFIGURED
                            - DUPLICATE_REQUEST
                            - ADDRESS_CONFLICT
                            - SYNC_REQUIRED
                            - ABORTED
                            - TIMEOUT
                            - DEVICE_ALREADY_TEACHED_IN
                          description: Current state of the removal process
                        uuid:
                          example: 0136e0ba-daaf-40d9-472b-1d246b9e8d26
                          type: string
                          description: identifier of this rack's removal
                  uuid:
                    type: string
                    example: 3e2e7ee8-16ab-472b-9529-1d246b9e8d26
                    description: Identifier of whole removal process
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
    delete:
      description: Finish or abort device adding process
      summary: Finish or abort device adding process
      tags:
        - teachin
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: teachin_uuid
          in: path
          description: Identifier of the adding process
          required: true
          example: 1111-2222-3333-4444
          schema:
            type: string
      responses:
        '204':
          description: No Update available
        '400':
          description: Bad Request - Cannot or will not handle the request.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/teachout:
    post:
      description: Start to remove devices or racks.
      summary: Remove devices or racks
      tags:
        - teachout
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: Request payload for device or rack removal
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                devices:
                  type: array
                  items:
                    example: 4
                    type: number
                  description: List of device id's which should be removed
                racks:
                  type: array
                  items:
                    type: number
                  description: List of rack id's which should be removed
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: MultiSensor
                          type: string
                          description: Name of the device which is removed
                        state:
                          example: RUNNING
                          type: string
                          enum:
                            - RUNNING
                            - SUCCESS
                            - NO_PERMISSION
                            - DEVICE_NOT_FOUND
                            - ERROR_RACK_UNIT_HAS_DEVICES
                            - ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - TEACHOUT_IS_ALREADY_RUNNING
                          description: Current state of the removal process
                        uuid:
                          type: string
                          description: Identifier of this device's removal
                          example: 3cb6e0ba-daaf-40d9-83b9-a5c351f35fe9
                  racks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: RackUnit
                          type: string
                          description: Name of the rack which is removed
                        state:
                          example: SUCCESS
                          type: string
                          enum:
                            - RUNNING
                            - SUCCESS
                            - NO_PERMISSION
                            - DEVICE_NOT_FOUND
                            - ERROR_RACK_UNIT_HAS_DEVICES
                            - ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - TEACHOUT_IS_ALREADY_RUNNING
                          description: Current state of the removal process
                        uuid:
                          example: 0136e0ba-daaf-40d9-472b-1d246b9e8d26
                          type: string
                          description: Identifier of this rack's removal
                  uuid:
                    type: string
                    example: 3e2e7ee8-16ab-472b-9529-1d246b9e8d26
                    description: Identifier of whole removal process
        '400':
          description: Bad Request - Cannot or will not handle the request.
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '404':
          description: Not Found - The requested resource could not be found.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
      security:
        - bearer: []
  /api/teachout/{teachout_uuid}:
    get:
      description: Get processing state of device removal.
      summary: Get processing state of device removal
      tags:
        - teachout
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
        - name: teachout_uuid
          in: path
          description: Identifier of the removal process
          required: true
          example: 1111-2222-3333-4444
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: MultiSensor
                          type: string
                          description: Name of the device which is removed
                        state:
                          example: RUNNING
                          type: string
                          enum:
                            - RUNNING
                            - SUCCESS
                            - NO_PERMISSION
                            - DEVICE_NOT_FOUND
                            - ERROR_RACK_UNIT_HAS_DEVICES
                            - ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - TEACHOUT_IS_ALREADY_RUNNING
                          description: Current state of the removal process
                        uuid:
                          type: string
                          description: Identifier of this device's removal
                          example: 3cb6e0ba-daaf-40d9-83b9-a5c351f35fe9
                  racks:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          example: RackUnit
                          type: string
                          description: Name of the rack which is removed
                        state:
                          example: SUCCESS
                          type: string
                          enum:
                            - RUNNING
                            - SUCCESS
                            - NO_PERMISSION
                            - DEVICE_NOT_FOUND
                            - ERROR_RACK_UNIT_HAS_DEVICES
                            - ERROR
                            - TEACH_IN_HOST_NOT_REACHABLE
                            - TEACHOUT_IS_ALREADY_RUNNING
                          description: Current state of the removal process
                        uuid:
                          example: 0136e0ba-daaf-40d9-472b-1d246b9e8d26
                          type: string
                          description: Identifier of this rack's removal
                  uuid:
                    type: string
                    example: 3e2e7ee8-16ab-472b-9529-1d246b9e8d26
                    description: Identifier of whole removal process
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '404':
          description: Not Found - The requested resource could not be found.
      security:
        - bearer: []
  /api/update:
    get:
      description: Gets the update status.
      summary: Get update status
      tags:
        - update
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    example: Update finished
                    type: string
                    description: Detailed response
                  status:
                    type: object
                    properties:
                      code:
                        example: ready
                        type: string
                        enum:
                          - ready
                          - decrypt
                          - unpack
                          - validate
                          - cleanup
                          - reboot
                          - error_download
                          - error_no_file
                          - error_decrypt
                          - error_extract
                          - error_invalid_device
                          - error_invalid_revision
                          - error_invalid_file
                          - error_copy_files
                          - download
                          - store_firmware
                          - error_downgrade
                        description: The Status code
                      detail:
                        example: Ready
                        type: string
                        description: The detail of the status code
        '400':
          description: Error while updating
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    example: Update finished
                    type: string
                    description: Detailed response
                  status:
                    type: object
                    properties:
                      code:
                        example: ready
                        type: string
                        enum:
                          - ready
                          - decrypt
                          - unpack
                          - validate
                          - cleanup
                          - reboot
                          - error_download
                          - error_no_file
                          - error_decrypt
                          - error_extract
                          - error_invalid_device
                          - error_invalid_revision
                          - error_invalid_file
                          - error_copy_files
                          - download
                          - store_firmware
                          - error_downgrade
                        description: The Status code
                      detail:
                        example: Ready
                        type: string
                        description: The detail of the status code
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
    post:
      description: Starts the update process with the given file.
      summary: Perform Update
      tags:
        - update
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: The update file to upload.
        required: true
        content:
          application/json:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    example: true
                    type: boolean
                    description: >-
                      The status of the request. true = Update started, false =
                      Update failed
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
  /api/update-settings:
    get:
      description: Gets the update settings.
      summary: Get update settings
      tags:
        - update-settings
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  channel:
                    type: string
                    enum:
                      - stable
                      - latest
                    example: stable
                    description: The update channel
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
    put:
      description: Change update settings.
      summary: Change update settings
      tags:
        - update-settings
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        description: The update settings
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                channel:
                  type: string
                  enum:
                    - stable
                    - latest
                  example: stable
                  description: The update channel
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  channel:
                    type: string
                    enum:
                      - stable
                      - latest
                    example: stable
                    description: The update channel
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '403':
          description: Forbidden - Either no or invalid credentials were provided.
        '422':
          description: >-
            Unprocessable Entity - The request was well-formed but was unable to
            be followed due to semantic errors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
              example:
                message: The field must not be empty.
                errors:
                  field:
                    - The field must not be empty.
  /api/ota-update:
    get:
      description: Gets the update status.
      summary: Get update status
      tags:
        - ota-update
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  date:
                    example: '2023-02-20'
                    type: string
                    description: The date of the latest updates release
                  device_type:
                    example: 8
                    type: integer
                    description: The Board type of the device
                  os_revision:
                    example: 2
                    type: integer
                    description: The OS-Revision
                  releasenotes:
                    example: |-
                      <ul>
                      <li>Test</li></ul>
                    type: string
                    format: HTML
                    description: The Release notes of all updates (not installed)
                  version:
                    example: 08.01.03 B00950
                    type: string
                    description: The name of the latest version of KentixONE
        '204':
          description: No Update available
        '400':
          description: Error while updating
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
    post:
      description: Starts the update process.
      summary: Perform OTA-Update
      tags:
        - ota-update
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '204':
          description: Operation Successful
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
  /api/state/update:
    get:
      description: Get all information regarding the current update state of the system.
      summary: Get update state
      tags:
        - update-state
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
            enum:
              - application/json
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  info:
                    type: object
                    properties:
                      main:
                        type: object
                        properties:
                          download-pending:
                            type: boolean
                            description: >-
                              Indicates if a new update is available and can be
                              downloaded.
                            example: false
                          update-pending:
                            type: boolean
                            description: >-
                              Indicates if an update was downloaded and can be
                              installed.
                            example: false
                          version:
                            type: string
                            description: >-
                              Shows the firmware version that can be either
                              downloaded or installed.
                            example: 1.0.0
                          build:
                            type: string
                            description: >-
                              Shows the firmware build that can be either
                              downloaded or installed.
                            example: '00001'
                      satellite:
                        type: object
                        properties:
                          download-pending:
                            type: boolean
                            description: >-
                              Indicates if a new update is available and can be
                              downloaded.
                            example: false
                          update-pending:
                            type: boolean
                            description: >-
                              Indicates if an update was downloaded and can be
                              installed.
                            example: false
                          version:
                            type: string
                            description: >-
                              Shows the firmware version that can be either
                              downloaded or installed.
                            example: 1.0.0
                          build:
                            type: string
                            description: >-
                              Shows the firmware build that can be either
                              downloaded or installed.
                            example: '00001'
                  ota:
                    type: object
                    properties:
                      main:
                        type: object
                        properties:
                          pending:
                            type: integer
                            example: 0
                            description: >-
                              Number of queued jobs which are not yet in
                              progress.
                          finished:
                            type: integer
                            example: 0
                            description: Number of finished jobs.
                          error:
                            type: integer
                            example: 0
                            description: Number of jobs which failed.
                          time:
                            example: '2023-06-21T11:08:04.346677Z'
                            type: string
                            format: date-time
                            description: Time of the last update.
                          current:
                            type: array
                            description: >-
                              Show a list of jobs that are currently in progress
                              with their respective state.
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                  description: >-
                                    Present in all job types. The current status
                                    of the job.
                                  example: download
                                type:
                                  type: string
                                  description: >-
                                    Present in all job types. Shows the
                                    devicetype or firmware type, depending on
                                    the job (update/download)
                                  example: alarmmanager
                                id:
                                  type: integer
                                  description: >-
                                    Present only in update jobs. The id of the
                                    device the job is for.
                                  example: 1
                      satellite:
                        type: object
                        properties:
                          pending:
                            type: integer
                            example: 0
                            description: >-
                              Number of queued jobs which are not yet in
                              progress.
                          finished:
                            type: integer
                            example: 0
                            description: Number of finished jobs.
                          error:
                            type: integer
                            example: 0
                            description: Number of jobs which failed.
                          time:
                            example: '2023-06-21T11:08:04.346677Z'
                            type: string
                            format: date-time
                            description: Time of the last update.
                          current:
                            type: array
                            description: >-
                              Show a list of jobs that are currently in progress
                              with their respective state.
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                  description: >-
                                    Present in all job types. The current status
                                    of the job.
                                  example: download
                                type:
                                  type: string
                                  description: >-
                                    Present in all job types. Shows the
                                    devicetype or firmware type, depending on
                                    the job (update/download)
                                  example: alarmmanager
                                id:
                                  type: integer
                                  description: >-
                                    Present only in update jobs. The id of the
                                    device the job is for.
                                  example: 1
                  upload:
                    type: object
                    properties:
                      main:
                        type: object
                        properties:
                          pending:
                            type: integer
                            example: 0
                            description: >-
                              Number of queued jobs which are not yet in
                              progress.
                          finished:
                            type: integer
                            example: 0
                            description: Number of finished jobs.
                          error:
                            type: integer
                            example: 0
                            description: Number of jobs which failed.
                          time:
                            example: '2023-06-21T11:08:04.346677Z'
                            type: string
                            format: date-time
                            description: Time of the last update.
                          current:
                            type: array
                            description: >-
                              Show a list of jobs that are currently in progress
                              with their respective state.
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                  description: >-
                                    Present in all job types. The current status
                                    of the job.
                                  example: download
                                type:
                                  type: string
                                  description: >-
                                    Present in all job types. Shows the
                                    devicetype or firmware type, depending on
                                    the job (update/download)
                                  example: alarmmanager
                                id:
                                  type: integer
                                  description: >-
                                    Present only in update jobs. The id of the
                                    device the job is for.
                                  example: 1
                      satellite:
                        type: object
                        properties:
                          pending:
                            type: integer
                            example: 0
                            description: >-
                              Number of queued jobs which are not yet in
                              progress.
                          finished:
                            type: integer
                            example: 0
                            description: Number of finished jobs.
                          error:
                            type: integer
                            example: 0
                            description: Number of jobs which failed.
                          time:
                            example: '2023-06-21T11:08:04.346677Z'
                            type: string
                            format: date-time
                            description: Time of the last update.
                          current:
                            type: array
                            description: >-
                              Show a list of jobs that are currently in progress
                              with their respective state.
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                  description: >-
                                    Present in all job types. The current status
                                    of the job.
                                  example: download
                                type:
                                  type: string
                                  description: >-
                                    Present in all job types. Shows the
                                    devicetype or firmware type, depending on
                                    the job (update/download)
                                  example: alarmmanager
                                id:
                                  type: integer
                                  description: >-
                                    Present only in update jobs. The id of the
                                    device the job is for.
                                  example: 1
                  update:
                    type: object
                    properties:
                      main:
                        type: object
                        properties:
                          pending:
                            type: integer
                            example: 0
                            description: >-
                              Number of queued jobs which are not yet in
                              progress.
                          finished:
                            type: integer
                            example: 0
                            description: Number of finished jobs.
                          error:
                            type: integer
                            example: 0
                            description: Number of jobs which failed.
                          time:
                            example: '2023-06-21T11:08:04.346677Z'
                            type: string
                            format: date-time
                            description: Time of the last update.
                          current:
                            type: array
                            description: >-
                              Show a list of jobs that are currently in progress
                              with their respective state.
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                  description: >-
                                    Present in all job types. The current status
                                    of the job.
                                  example: download
                                type:
                                  type: string
                                  description: >-
                                    Present in all job types. Shows the
                                    devicetype or firmware type, depending on
                                    the job (update/download)
                                  example: alarmmanager
                                id:
                                  type: integer
                                  description: >-
                                    Present only in update jobs. The id of the
                                    device the job is for.
                                  example: 1
                      satellite:
                        type: object
                        properties:
                          pending:
                            type: integer
                            example: 0
                            description: >-
                              Number of queued jobs which are not yet in
                              progress.
                          finished:
                            type: integer
                            example: 0
                            description: Number of finished jobs.
                          error:
                            type: integer
                            example: 0
                            description: Number of jobs which failed.
                          time:
                            example: '2023-06-21T11:08:04.346677Z'
                            type: string
                            format: date-time
                            description: Time of the last update.
                          current:
                            type: array
                            description: >-
                              Show a list of jobs that are currently in progress
                              with their respective state.
                            items:
                              type: object
                              properties:
                                status:
                                  type: string
                                  description: >-
                                    Present in all job types. The current status
                                    of the job.
                                  example: download
                                type:
                                  type: string
                                  description: >-
                                    Present in all job types. Shows the
                                    devicetype or firmware type, depending on
                                    the job (update/download)
                                  example: alarmmanager
                                id:
                                  type: integer
                                  description: >-
                                    Present only in update jobs. The id of the
                                    device the job is for.
                                  example: 1
        '401':
          description: Unauthorized - Either no or an invalid token was provided.
        '404':
          description: Not Found - The requested resource could not be found.
components:
  securitySchemes:
    bearer:
      description: >-
        JWT Authorization header using the Bearer scheme. Example:
        "Authorization: Bearer {token}"
      type: http
      scheme: bearer
  schemas:
    access-event:
      type: object
      description: The data of an access-event
      properties:
        id:
          example: 1
          type: integer
          description: The ID of the event
        created_at:
          example: '2022-11-28T16:09:25+01:00'
          type: string
          description: The created timestamp
        door:
          example: DoorLock 1
          type: string
          description: The name of the DoorLock that triggered the event
        user:
          example: Mustermann
          type: string
          description: The name of the user that triggered the event
        alarmgroup:
          example: Group
          type: string
          description: Alarmgroup of the device which triggered this entry
        access_granted:
          example: false
          type: boolean
          description: The status of the booking (Was access granted?)
        detail:
          example: No permission
          type: string
          description: The detailed description of the event
        has_images:
          example: false
          type: boolean
          description: Flags if images are included in the event
    LinksResponse:
      type: object
      description: >-
        Attention: When using filters/query parameters, those must be appended
        to the given links.
      properties:
        first:
          example: https://example.com/api/example?page=1
          type: string
          description: The link to the first page
        last:
          example: https://example.com/api/example?page=10
          type: string
          description: The link to the last page
        prev:
          example: 'null'
          type: string
          description: The link to the previous page
        next:
          example: https://example.com/api/example?page=2
          type: string
          description: The link to the next page
    MetaResponse:
      type: object
      properties:
        current_page:
          example: 1
          type: integer
          description: The key of the current page
        from:
          example: 1
          type: integer
          description: The index of the first element on the current page
        last_page:
          example: 10
          type: integer
          description: The index of the last page
        path:
          example: https://example.com/api/timeprofiles
          type: string
          description: The route just called
        per_page:
          example: 25
          type: integer
          description: The amount of elements per page
        to:
          example: 25
          type: integer
          description: The index of the last element on the current page
        total:
          example: 245
          type: integer
          description: The total amount of elements
    event-image:
      type: array
      items:
        type: object
        properties:
          data:
            type: string
            format: base64
            description: The data of the image
          name:
            example: 000.jpg
            type: string
            description: The name of the image
    settings:
      type: object
      properties:
        external_evaluation:
          example: true
          type: boolean
          description: >-
            If true, the manager will not evaluate access permissions. Instead,
            upon bookings a webhook is sent and DoorLocks can only be
            remote-opened.
        pinlength:
          example: '1'
          type: string
          minimum: 4
          maximum: 10
          description: Sets the length of the user pin. Must be between 4 and 10.
        memorydepth:
          example: '1'
          type: string
          minimum: 0
          maximum: 720
          description: >-
            Sets the number of days during which all user-related data
            (bookings, images, etc) is stored. 0 = Unlimited, must be between 0
            and 720.
        mode:
          example: 1
          type: integer
          description: >-
            Sets the RFID security mode. 0=Off, 1=Kentix Token, 2=Custom
            security token.
        bus_protocol:
          example: v1
          type: string
          enum:
            - v1
            - v2
          description: >-
            Select what version of wallreaders are used with this device. V2
            devices are labeled with 'V2' next to their respective devicetype.
            V1 devices do not have a version label.
    accessmanagers:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of the AccessManager.
        name:
          example: AccessManager
          type: string
          description: Name of the Accessmanager
        type:
          example: 105
          type: integer
          description: Devicetype of the AccessManager.
        device_type:
          example: ''
          type: string
          description: Devicetype name of the AccessManager.
        address:
          example: 192.168.100.224
          type: string
          description: IP or DNS address of the AccessManager.
    accessmanagers-names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of the AccessManager.
        name:
          example: AccessManager
          type: string
          description: Name of the Accessmanager
        type:
          example: 105
          type: integer
          description: Devicetype of the AccessManager.
    external_channel_config:
      type: object
      properties:
        id:
          example: 37
          type: integer
          description: Id of the channel.
        assignment:
          example: 'off'
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        name:
          example: Input 1
          type: string
          description: Name of the channel.
        alarm_when:
          example: open
          type: string
          enum:
            - open
            - close
          description: Indicates when the channel should alarm.
        input_type:
          example: default
          type: string
          enum:
            - default
            - door
            - leakage
          description: Describes the input type of the channel.
        alarmdelay:
          example: 1
          type: integer
          description: Delay time after which an alarm is triggered.
        can_alwaysarm:
          example: false
          type: boolean
          description: >
            Describes if the status of external contacts should be ignored
            during arming.

            This is useful if e.g. a magnetic door contact must be opened during
            the arming phase.
        icon:
          example: ethernet
          type: string
          enum:
            - power-off
            - times-circle
            - plus-circle
            - minus-circle
            - cogs
            - trash
            - save
            - ethernet
            - chart-network
            - network-wired
            - sitemap
            - server
            - hdd
            - router
            - wifi
            - signal
            - sensor
            - sensor-on
            - sensor-alert
            - thermometer-half
            - lungs
            - tint
            - humidity
            - dewpoint
            - raindrops
            - water
            - air-conditioner
            - braille
            - fire
            - fire-alt
            - burn
            - fire-smoke
            - cloud
            - sensor-fire
            - lungs
            - mask
            - user-secret
            - running
            - hammer
            - tools
            - signal-stream
            - house-damage
            - key
            - door-open
            - door-closed
            - garage
            - cctv
            - video
            - fingerprint
            - bolt
            - plug
            - lambda
            - charging-station
            - battery-full
            - battery-empty
            - car-battery
          description: Icon of the sensor.
        description_ok:
          example: OK
          type: string
          nullable: true
          description: This text will be showed if the channel has no errors.
        description_alert:
          example: Alert
          type: string
          nullable: true
          description: This text will be showed if the channel has errors.
        group_id:
          example: 2
          type: integer
          description: The ID of the group the device is assigned to.
    external_config:
      type: object
      properties:
        channel1:
          type: object
          properties:
            id:
              example: 37
              type: integer
              description: Id of the channel.
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            name:
              example: Input 1
              type: string
              description: Name of the channel.
            alarm_when:
              example: open
              type: string
              enum:
                - open
                - close
              description: Indicates when the channel should alarm.
            input_type:
              example: default
              type: string
              enum:
                - default
                - door
                - leakage
              description: Describes the input type of the channel.
            alarmdelay:
              example: 1
              type: integer
              description: Delay time after which an alarm is triggered.
            can_alwaysarm:
              example: false
              type: boolean
              description: >
                Describes if the status of external contacts should be ignored
                during arming.

                This is useful if e.g. a magnetic door contact must be opened
                during the arming phase.
            icon:
              example: ethernet
              type: string
              enum:
                - power-off
                - times-circle
                - plus-circle
                - minus-circle
                - cogs
                - trash
                - save
                - ethernet
                - chart-network
                - network-wired
                - sitemap
                - server
                - hdd
                - router
                - wifi
                - signal
                - sensor
                - sensor-on
                - sensor-alert
                - thermometer-half
                - lungs
                - tint
                - humidity
                - dewpoint
                - raindrops
                - water
                - air-conditioner
                - braille
                - fire
                - fire-alt
                - burn
                - fire-smoke
                - cloud
                - sensor-fire
                - lungs
                - mask
                - user-secret
                - running
                - hammer
                - tools
                - signal-stream
                - house-damage
                - key
                - door-open
                - door-closed
                - garage
                - cctv
                - video
                - fingerprint
                - bolt
                - plug
                - lambda
                - charging-station
                - battery-full
                - battery-empty
                - car-battery
              description: Icon of the sensor.
            description_ok:
              example: OK
              type: string
              nullable: true
              description: This text will be showed if the channel has no errors.
            description_alert:
              example: Alert
              type: string
              nullable: true
              description: This text will be showed if the channel has errors.
            group_id:
              example: 2
              type: integer
              description: The ID of the group the device is assigned to.
        channel2:
          type: object
          properties:
            id:
              example: 37
              type: integer
              description: Id of the channel.
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            name:
              example: Input 1
              type: string
              description: Name of the channel.
            alarm_when:
              example: open
              type: string
              enum:
                - open
                - close
              description: Indicates when the channel should alarm.
            input_type:
              example: default
              type: string
              enum:
                - default
                - door
                - leakage
              description: Describes the input type of the channel.
            alarmdelay:
              example: 1
              type: integer
              description: Delay time after which an alarm is triggered.
            can_alwaysarm:
              example: false
              type: boolean
              description: >
                Describes if the status of external contacts should be ignored
                during arming.

                This is useful if e.g. a magnetic door contact must be opened
                during the arming phase.
            icon:
              example: ethernet
              type: string
              enum:
                - power-off
                - times-circle
                - plus-circle
                - minus-circle
                - cogs
                - trash
                - save
                - ethernet
                - chart-network
                - network-wired
                - sitemap
                - server
                - hdd
                - router
                - wifi
                - signal
                - sensor
                - sensor-on
                - sensor-alert
                - thermometer-half
                - lungs
                - tint
                - humidity
                - dewpoint
                - raindrops
                - water
                - air-conditioner
                - braille
                - fire
                - fire-alt
                - burn
                - fire-smoke
                - cloud
                - sensor-fire
                - lungs
                - mask
                - user-secret
                - running
                - hammer
                - tools
                - signal-stream
                - house-damage
                - key
                - door-open
                - door-closed
                - garage
                - cctv
                - video
                - fingerprint
                - bolt
                - plug
                - lambda
                - charging-station
                - battery-full
                - battery-empty
                - car-battery
              description: Icon of the sensor.
            description_ok:
              example: OK
              type: string
              nullable: true
              description: This text will be showed if the channel has no errors.
            description_alert:
              example: Alert
              type: string
              nullable: true
              description: This text will be showed if the channel has errors.
            group_id:
              example: 2
              type: integer
              description: The ID of the group the device is assigned to.
    connection_config:
      type: object
      properties:
        assignment:
          example: 'off'
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of the connection
        warning:
          type: object
          properties:
            active:
              type: boolean
              example: true
              description: >-
                Configures whether connection issues should be displayed as a
                warning instead of an alarm
    accessmanager-accessmanager_id:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: ID of the AccessManager.
        type:
          example: 105
          type: integer
          description: Devicetype of the AccessManager.
        is_active:
          example: true
          type: boolean
          description: >-
            True if the alarm evaluation and communication for this device is
            activated
        name:
          example: AccessManager
          type: string
          description: Name of the AccessManager.
        mac_adress:
          example: 70:82:0e:10:81:3d
          type: string
          description: MAC address of the AccessManager
        address:
          example: 192.168.100.224
          type: string
          description: IP or DNS address of the AccessManager.
        doorlocks:
          type: array
          items:
            type: object
            properties:
              id:
                example: 1
                type: integer
                description: ID of this DoorLock.
              name:
                example: Doorlock
                type: string
                description: Name of this DoorLock.
              relais_action:
                example: 0
                type: integer
                description: >-
                  Sets the output to be switched, when a booking happened.
                  1=DO1, 2=DO2.
        ios:
          type: array
          items:
            type: object
            properties:
              id:
                example: 1
                type: integer
                description: ID of this IO.
              device_id:
                example: 1
                type: integer
                description: ID of the IO-Device.
              type:
                example: 301
                type: integer
                description: Devicetype of the IO.
              number:
                example: 1
                type: integer
                description: Number of the IO.
              input_type:
                example: default
                type: string
                description: Type of the Input.
              group_id:
                example: 5
                type: integer
                description: ID of the group.
              sort_index:
                example: null
                type: integer
                description: Not used.
              name:
                example: Digital Input 1
                type: string
                description: Name of the IO.
              can_alwaysarm:
                example: false
                type: boolean
                description: >-
                  Describes if the status of external contacts should be ignored
                  during arming. This is useful if e.g. a magnetic door contact
                  must be opened during the arming phase.
              alarmdelay:
                example: 0
                type: integer
                description: Delay time after which an alarm is triggered.
              assignment:
                example: 'off'
                type: string
                enum:
                  - 'off'
                  - always-active
                  - armed-active
                  - fire
                  - sabotage
                  - display
                  - system
                description: The alarm assignment of this sensor
              logic:
                example: 0
                type: integer
                description: Alarm logic of the IO. 0=Normally open, 1=Normally closed.
              assigned_to_id:
                example: 0
                type: integer
                description: Id of the AccessManager to which the IO device is related
              icon:
                example: ethernet
                type: string
                enum:
                  - power-off
                  - times-circle
                  - plus-circle
                  - minus-circle
                  - cogs
                  - trash
                  - save
                  - ethernet
                  - chart-network
                  - network-wired
                  - sitemap
                  - server
                  - hdd
                  - router
                  - wifi
                  - signal
                  - sensor
                  - sensor-on
                  - sensor-alert
                  - thermometer-half
                  - lungs
                  - tint
                  - humidity
                  - dewpoint
                  - raindrops
                  - water
                  - air-conditioner
                  - braille
                  - fire
                  - fire-alt
                  - burn
                  - fire-smoke
                  - cloud
                  - sensor-fire
                  - lungs
                  - mask
                  - user-secret
                  - running
                  - hammer
                  - tools
                  - signal-stream
                  - house-damage
                  - key
                  - door-open
                  - door-closed
                  - garage
                  - cctv
                  - video
                  - fingerprint
                  - bolt
                  - plug
                  - lambda
                  - charging-station
                  - battery-full
                  - battery-empty
                  - car-battery
                description: name of the selected icon
              description_ok:
                example: Ok
                type: string
                description: This text will be showed if the IO device has no errors
              description_alert:
                example: Error
                type: string
                description: This text will be showed if the IO device has errors
              event_id:
                example: 8
                type: integer
                description: >-
                  Describes the event that should be used. Must be an Id of an
                  existing event.
              measurement:
                type: array
                items:
                  type: object
                  properties:
                    value:
                      example: 1
                      type: integer
                      description: Measured value of the IO.
                    alarm:
                      example: false
                      type: boolean
                      description: Alarmstate of the IO.
                    connection_sabotage:
                      example: false
                      type: boolean
                      description: Sabotage alarm state of the IO.
                    sabotage_count:
                      example: 0
                      type: integer
                      description: Number of failed connection checks.
                    assigned_to_id:
                      example: 0
                      type: integer
                      description: Id of the IO to which the measurement is related
        relais_action_arm:
          example: none
          type: string
          enum:
            - none
            - channel1
            - channel2
            - backchannel1
            - backchannel2
            - backchannel_inevitability
          description: Configures if an external system should be switched on bookings.
        ext_arm_doorlocks:
          example:
            - 1
            - 2
            - 3
          type: array
          items:
            type: integer
          description: >-
            List of all DoorLock IDs, which have been configured to switch an
            external alarmsystem.
        external:
          type: object
          properties:
            channel1:
              type: object
              properties:
                id:
                  example: 37
                  type: integer
                  description: Id of the channel.
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                name:
                  example: Input 1
                  type: string
                  description: Name of the channel.
                alarm_when:
                  example: open
                  type: string
                  enum:
                    - open
                    - close
                  description: Indicates when the channel should alarm.
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: Describes the input type of the channel.
                alarmdelay:
                  example: 1
                  type: integer
                  description: Delay time after which an alarm is triggered.
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >
                    Describes if the status of external contacts should be
                    ignored during arming.

                    This is useful if e.g. a magnetic door contact must be
                    opened during the arming phase.
                icon:
                  example: ethernet
                  type: string
                  enum:
                    - power-off
                    - times-circle
                    - plus-circle
                    - minus-circle
                    - cogs
                    - trash
                    - save
                    - ethernet
                    - chart-network
                    - network-wired
                    - sitemap
                    - server
                    - hdd
                    - router
                    - wifi
                    - signal
                    - sensor
                    - sensor-on
                    - sensor-alert
                    - thermometer-half
                    - lungs
                    - tint
                    - humidity
                    - dewpoint
                    - raindrops
                    - water
                    - air-conditioner
                    - braille
                    - fire
                    - fire-alt
                    - burn
                    - fire-smoke
                    - cloud
                    - sensor-fire
                    - lungs
                    - mask
                    - user-secret
                    - running
                    - hammer
                    - tools
                    - signal-stream
                    - house-damage
                    - key
                    - door-open
                    - door-closed
                    - garage
                    - cctv
                    - video
                    - fingerprint
                    - bolt
                    - plug
                    - lambda
                    - charging-station
                    - battery-full
                    - battery-empty
                    - car-battery
                  description: Icon of the sensor.
                description_ok:
                  example: OK
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has no errors.
                description_alert:
                  example: Alert
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has errors.
                group_id:
                  example: 2
                  type: integer
                  description: The ID of the group the device is assigned to.
            channel2:
              type: object
              properties:
                id:
                  example: 37
                  type: integer
                  description: Id of the channel.
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                name:
                  example: Input 1
                  type: string
                  description: Name of the channel.
                alarm_when:
                  example: open
                  type: string
                  enum:
                    - open
                    - close
                  description: Indicates when the channel should alarm.
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: Describes the input type of the channel.
                alarmdelay:
                  example: 1
                  type: integer
                  description: Delay time after which an alarm is triggered.
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >
                    Describes if the status of external contacts should be
                    ignored during arming.

                    This is useful if e.g. a magnetic door contact must be
                    opened during the arming phase.
                icon:
                  example: ethernet
                  type: string
                  enum:
                    - power-off
                    - times-circle
                    - plus-circle
                    - minus-circle
                    - cogs
                    - trash
                    - save
                    - ethernet
                    - chart-network
                    - network-wired
                    - sitemap
                    - server
                    - hdd
                    - router
                    - wifi
                    - signal
                    - sensor
                    - sensor-on
                    - sensor-alert
                    - thermometer-half
                    - lungs
                    - tint
                    - humidity
                    - dewpoint
                    - raindrops
                    - water
                    - air-conditioner
                    - braille
                    - fire
                    - fire-alt
                    - burn
                    - fire-smoke
                    - cloud
                    - sensor-fire
                    - lungs
                    - mask
                    - user-secret
                    - running
                    - hammer
                    - tools
                    - signal-stream
                    - house-damage
                    - key
                    - door-open
                    - door-closed
                    - garage
                    - cctv
                    - video
                    - fingerprint
                    - bolt
                    - plug
                    - lambda
                    - charging-station
                    - battery-full
                    - battery-empty
                    - car-battery
                  description: Icon of the sensor.
                description_ok:
                  example: OK
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has no errors.
                description_alert:
                  example: Alert
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has errors.
                group_id:
                  example: 2
                  type: integer
                  description: The ID of the group the device is assigned to.
        group_id:
          example: 89
          type: integer
          description: Id of the group the AccessManager beolongs to
        rack_id:
          example: 50
          type: integer
          description: Id of the rack the AccessManager belongs to
        webhooks:
          example:
            - 1
            - 2
          type: array
          items:
            type: integer
          description: Integer Array of the webhooks
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    alarm-event:
      type: object
      description: The data of an access-event
      properties:
        id:
          example: 1
          type: integer
          description: The ID of the event
        created_at:
          example: '2022-11-28T16:09:25+01:00'
          type: string
          description: The created timestamp
        function:
          example: Alarm
          type: string
          description: The type of event
        user:
          example: Mustermann
          type: string
          description: The name of the user that triggered the event
        detail:
          example: No permission
          type: string
          description: The detailed description of the event
        has_images:
          example: false
          type: boolean
          description: Flags if images are included in the event
        status:
          example: 0
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 5
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
          description: The status of the event
        filter_type:
          example: 23
          type: integer
          description: Kentix internal type. Please disregard
        device:
          type: array
          items:
            type: object
            properties:
              address:
                example: 192.168.0.1
                type: string
                format: IPv4
                description: The address of the device
              id:
                example: 2
                type: integer
                description: the ID of the device
              name:
                example: AlarmManager
                type: string
                description: The name of the device
              type:
                example: 101
                type: integer
                description: The type of the device
              group_id:
                example: 1
                type: integer
                description: The ID of the group the device is assigned to
              uuid:
                example: 943dc5e6-155b-4aaa-89e3-5d31cd3a6f37
                type: string
                description: The UUID of the device
        subevents:
          type: array
          items:
            type: object
            properties:
              id:
                example: 6
                type: integer
                description: The ID of the event
              created_at:
                example: '2022-11-28T16:09:25+01:00'
                type: string
                description: The created timestamp
              function:
                example: Alarm
                type: string
                description: The type of event
              user:
                example: Mustermann
                type: string
                description: The name of the user that triggered the event
              detail:
                example: No permission
                type: string
                description: The detailed description of the event
              has_images:
                example: false
                type: boolean
                description: Flags if images are included in the event
              filter_type:
                example: 23
                type: integer
                description: Kentix internal type. Please disregard
    alarmgroups:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: Id of the alarmgroup.
        name:
          example: Kentix HQ
          type: string
          description: Name of the alarmgroup.
        sort_index:
          example: 1
          type: integer
          description: Describes the sorting order.
        group_id:
          example: 1
          type: integer
          nullable: true
          description: >-
            Indicates the parent alarm group. Null if the alarmgroup has no
            parent group
        created_at:
          example: '2023-01-05T16:24:46.000000Z'
          type: string
          format: ISO 8601
          description: ISO 8601 when the alarmgroup was created.
        updated_at:
          example: '2023-01-05T16:47:27.000000Z'
          type: string
          format: ISO 8601
          description: ISO 8601 when the alarmgroup was updated.
    alarmgroup-activepower:
      type: object
      properties:
        supply_a:
          type: object
          properties:
            assignment:
              type: string
              enum:
                - 'off'
                - display
        supply_b:
          type: object
          properties:
            assignment:
              type: string
              enum:
                - 'off'
                - display
    alarmgroup-apparentpower:
      type: object
      properties:
        supply_a:
          type: object
          properties:
            assignment:
              type: string
              enum:
                - 'off'
                - display
        supply_b:
          type: object
          properties:
            assignment:
              type: string
              enum:
                - 'off'
                - display
    alarmgroup-consumption:
      type: object
      properties:
        supply_a:
          type: object
          properties:
            assignment:
              type: string
              enum:
                - 'off'
                - display
        supply_b:
          type: object
          properties:
            assignment:
              type: string
              enum:
                - 'off'
                - display
    external-alarm-settings:
      type: object
      description: Settings for assigning this alarmgroup to an external alarmsystem.
      properties:
        device_id:
          type: integer
          example: 1
          description: >-
            ID of the device whose inputs and outputs shall be used for the
            external alarmsystem
          nullable: true
        channel_returnchannel:
          type: integer
          example: 1
          description: >-
            Channel number of the external input on which the external
            alarmsystem will signal its arming state.
          nullable: true
        channel_armready:
          type: integer
          example: 2
          description: >-
            Channel number of the external input on which the external
            alarmsystem will signal wether it can be armed or not. Not every
            alarmsystem does support this feature.
          nullable: true
        channel_armsignal:
          type: integer
          example: 1
          description: >-
            Channel number of the digital output on which the Kentix device will
            send an arm command to the external alarmsystem.
    alarmgroup:
      type: object
      properties:
        id:
          example: 1
          type: integer
          readOnly: true
          description: Id of the alarmgroup.
        created_at:
          example: '2023-01-07T18:08:44.000000Z'
          type: string
          format: ISO 8601
          readOnly: true
          description: Indicates when the alarmgroup was created.
        updated_at:
          example: '2023-01-07T18:08:44.000000Z'
          type: string
          format: ISO 8601
          readOnly: true
          description: Indicates when the alarmgroup was updated.
        name:
          example: Kentix HQ
          type: string
          description: Describes the name of the alarmgroup.
        group_id:
          example: 1
          type: integer
          description: >-
            Indicates the parent alarm group. Must be an Id of an existing
            group.
        sort_index:
          example: 1
          type: integer
          readOnly: true
          description: Describes the sorting order.
        in_stealthmode:
          example: false
          type: boolean
          description: >-
            Describes if the internal status LED of all devices in this
            alarmgroup should be activated.
        signaling_group:
          example: 1
          type: integer
          nullable: true
          description: >-
            Describes the range in which a signaling is triggered, if an alarm
            occurs within this alarmgroup. Must be an Id of an parent group.
        maintenance:
          example: inactive
          type: string
          enum:
            - active
            - inactive
          description: Describes if the alarmgroup is in maintenance mode.
        maintenance_start:
          example: '2023-02-17T01:00:00.000Z'
          type: string
          format: ISO 8601
          nullable: true
          description: >-
            Describes when the alarmgroup automatically switches to maintenance
            mode.
        maintenance_stop:
          example: '2023-02-17T23:59:00.000Z'
          type: string
          format: ISO 8601
          nullable: true
          description: Describes until when the alarmgroup remains in maintenance mode.
        inherit_notification:
          example: false
          type: boolean
          description: >-
            Describes if the notification settings should be inherited from the
            parent group.
        is_alarmrepetition_active:
          example: false
          type: boolean
          description: >-
            Describes if active alarms should be repeated by it's configured
            interval. Acknowledgment of the alarm stops the repetition.
        alarmrepetition_interval:
          example: 1
          type: integer
          minimum: 1
          maximum: 999
          description: >-
            Describes how alarms are sent to all users configured for alarms,
            depending on the configured time and repetitions.
        alarmrepetition_count:
          example: 0
          type: integer
          minimum: 0
          maximum: 100
          description: >-
            Describes the number of alarm repetitions with the interval of the
            configured time.
        send_quitable_notifications:
          example: false
          type: boolean
          description: >-
            Describes if a notification should be sent as soon as an alarm is
            quitable.
        limit_notifications_always:
          example: true
          type: boolean
          description: >-
            Limits the always-active notifications per hour. Manual
            acknowledgement resets the counter, repeated alarms do not count.
        notification_count_always_alarm:
          example: 1
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of always-active alarm notifications. 0
            deactivates the notifications. Only required if
            limit_notifications_always is true.
        notification_count_always_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of always-active warnings. Only required if
            limit_notifications_always is true.
        limit_notifications_armed:
          example: true
          type: boolean
          description: >-
            Limits the armed-active notifications per hour. Manual
            acknowledgement resets the counter, repeated alarms do not count.
        notification_count_armed_alarm:
          example: 1
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of armed-active alarm notifications. 0
            deactivates the notifications. Only required if
            limit_notifications_armed is true.
        notification_count_armed_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of armed-active warnings. Only required if
            limit_notifications_armed is true.
        limit_notifications_fire:
          example: false
          type: boolean
          description: >-
            Limits the fire notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_fire_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of fire alarm notifications. 0 deactivates the
            notifications. Only required if limit_notifications_fire is true.
        notification_count_fire_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of fire warnings. Only required if
            limit_notifications_fire is true.
        limit_notifications_sabotage:
          example: false
          type: boolean
          description: >-
            Limits the sabotage notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_sabotage_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of sabotage alarm notifications. 0 deactivates
            the notifications. Only required if limit_notifications_sabotage is
            true.
        notification_count_sabotage_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of sabotage warnings. Only required if
            limit_notifications_sabotage is true.
        limit_notifications_system:
          example: false
          type: boolean
          description: >-
            Limits the system notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_system_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of system alarm notifications. 0 deactivates the
            notifications. Only required if limit_notifications_system is true.
        notification_count_system_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of system warnings. Only required if
            limit_notifications_system is true.
        inherit_arm:
          example: false
          type: boolean
          description: >-
            Describes if the arm settings should be inherited from the parent
            group.
        arm_delay:
          example: 0
          type: integer
          enum:
            - 0
            - 10
            - 30
            - 60
            - 120
            - 180
            - 240
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: Describes the arm delay. Only required if inherit_arm is false.
        buzzer_arm_duration:
          example: 0
          type: integer
          enum:
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the arm buzzer duration. Only required if inherit_arm is
            false.
        can_alwaysarm:
          example: false
          type: boolean
          description: >-
            Describes if the status of external contacts should be ignored
            during arming. This is useful if e.g. a magnetic door contact must
            be opened during the arming phase.
        inherit_autoquit:
          example: false
          type: boolean
          description: >-
            Describes if the autoquit settings should be inherited from the
            parent group.
        can_autoquit_always_alarm:
          example: false
          type: boolean
          description: >-
            Describes if always-active alarms should be automatically
            acknowledged after the given interval. Only required if
            inherit_autoquit is false.
        can_autoquit_armed_alarm:
          example: false
          type: boolean
          description: >-
            Describes if armed-active alarms should be automatically
            acknowledged after the given interval. Only required if
            inherit_autoquit is false.
        can_autoquit_fire_alarm:
          example: false
          type: boolean
          description: >-
            Describes if fire alarms should be automatically acknowledged after
            the given interval. Only required if inherit_autoquit is false.
        can_autoquit_sabotage_alarm:
          example: false
          type: boolean
          description: >-
            Describes if sabotage alarms should be automatically acknowledged
            after the given interval. Only required if inherit_autoquit is
            false.
        can_autoquit_system_notification_alarm:
          example: false
          type: boolean
          description: >-
            Describes if system alarms should be automatically acknowledged
            after the given interval. Only required if inherit_autoquit is
            false.
        autoquit_duration:
          example: 0
          type: integer
          enum:
            - 0
            - 30
            - 60
            - 180
            - 600
            - 1800
          description: >-
            Describes the time after which automatic quitting is executed. Only
            required if inherit_autoquit is false.
        inherit_alarm:
          example: false
          type: boolean
          description: >-
            Describes if the alarm settings should be inherited from the parent
            group.
        has_prealarm:
          example: false
          type: boolean
          description: Describes if the Prealarm is en-/disabled.
        buzzer_alwaysalarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for always-active alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        buzzer_armedalarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for armed-active alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        buzzer_firealarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for fire alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        buzzer_sabotagealarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for sabotage alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        inherit_sabotagesignal:
          example: false
          type: boolean
          description: >-
            Describes if the signaling sabotage settings should be inherited
            from the parent group.
        sabotage_powerdevice_duration:
          example: 300
          type: integer
          enum:
            - 300
            - 600
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a plugged device should wait, until it fires a
            tampering alarm. Only required if inherit_sabotagesignal is false.
        sabotage_batterydevice_duration:
          example: 900
          type: integer
          enum:
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a battery device should wait, until it fires a
            tampering alarm. Only required if inherit_sabotagesignal is false.
        sabotage_service_duration:
          example: 600
          type: integer
          enum:
            - 600
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a service should wait, until it fires a tampering
            alarm. Only required if inherit_sabotagesignal is false.
        event_id:
          example: 0
          type: integer
          nullable: true
          description: >-
            Describes the event that should be used. Must be an Id of an
            existing event.
        webhooks:
          type: array
          description: Describes the webhooks that should be fired when an event happens
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
        assigned_doorlock:
          example: 3
          type: integer
          nullable: true
          description: The ID of the doorlock directly assigned to the alarmgroup.
        activepower:
          type: object
          properties:
            supply_a:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
            supply_b:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
        apparentpower:
          type: object
          properties:
            supply_a:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
            supply_b:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
        consumption:
          type: object
          properties:
            supply_a:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
            supply_b:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
        arm_if_empty:
          type: boolean
          example: false
          description: >-
            Requires Anti-Passback functionality, therefore KentixONE plan
            "Large" and all it's entrances configured as passages. If this
            alarmgroup is considered empty, i.e. no user is currently booked in
            through a passage, it will automatically be armed.
        external_alarmsystem:
          type: object
          description: Settings for assigning this alarmgroup to an external alarmsystem.
          properties:
            device_id:
              type: integer
              example: 1
              description: >-
                ID of the device whose inputs and outputs shall be used for the
                external alarmsystem
              nullable: true
            channel_returnchannel:
              type: integer
              example: 1
              description: >-
                Channel number of the external input on which the external
                alarmsystem will signal its arming state.
              nullable: true
            channel_armready:
              type: integer
              example: 2
              description: >-
                Channel number of the external input on which the external
                alarmsystem will signal wether it can be armed or not. Not every
                alarmsystem does support this feature.
              nullable: true
            channel_armsignal:
              type: integer
              example: 1
              description: >-
                Channel number of the digital output on which the Kentix device
                will send an arm command to the external alarmsystem.
    system-alarmgroup-update:
      type: object
      properties:
        sort_index:
          example: 1
          type: integer
          description: Describes the sorting order.
        in_stealthmode:
          example: false
          type: boolean
          description: >-
            Describes if the internal status LED of all devices in this
            alarmgroup should be activated.
        maintenance:
          example: inactive
          type: string
          enum:
            - active
            - inactive
          description: Describes if the alarmgroup is in maintenance mode.
        maintenance_start:
          example: '2023-02-17T01:00:00.000Z'
          type: string
          format: ISO 8601
          nullable: true
          description: >-
            Describes when the alarmgroup automatically switches to maintenance
            mode.
        maintenance_stop:
          example: '2023-02-17T23:59:00.000Z'
          type: string
          format: ISO 8601
          nullable: true
          description: Describes until when the alarmgroup remains in maintenance mode.
        is_alarmrepetition_active:
          example: false
          type: boolean
          description: >-
            Describes if active alarms should be repeated by it's configured
            interval. Acknowledgment of the alarm stops the repetition.
        alarmrepetition_interval:
          example: 1
          type: integer
          minimum: 1
          maximum: 999
          description: >-
            Describes how alarms are sent to all users configured for alarms,
            depending on the configured time and repetitions.
        alarmrepetition_count:
          example: 0
          type: integer
          minimum: 0
          maximum: 100
          description: >-
            Describes the number of alarm repetitions with the interval of the
            configured time.
        send_quitable_notifications:
          example: false
          type: boolean
          description: >-
            Describes if a notification should be sent as soon as an alarm is
            quitable.
        limit_notifications_always:
          example: true
          type: boolean
          description: >-
            Limits the always-active notifications per hour. Manual
            acknowledgement resets the counter, repeated alarms do not count.
        notification_count_always_alarm:
          example: 1
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of always-active alarm notifications. 0
            deactivates the notifications. Only required if
            limit_notifications_always is true.
        notification_count_always_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of always-active warnings. Only required if
            limit_notifications_always is true.
        limit_notifications_armed:
          example: true
          type: boolean
          description: >-
            Limits the armed-active notifications per hour. Manual
            acknowledgement resets the counter, repeated alarms do not count.
        notification_count_armed_alarm:
          example: 1
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of armed-active alarm notifications. 0
            deactivates the notifications. Only required if
            limit_notifications_armed is true.
        notification_count_armed_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of armed-active warnings. Only required if
            limit_notifications_armed is true.
        limit_notifications_fire:
          example: false
          type: boolean
          description: >-
            Limits the fire notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_fire_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of fire alarm notifications. 0 deactivates the
            notifications. Only required if limit_notifications_fire is true.
        notification_count_fire_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of fire warnings. Only required if
            limit_notifications_fire is true.
        limit_notifications_sabotage:
          example: false
          type: boolean
          description: >-
            Limits the sabotage notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_sabotage_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of sabotage alarm notifications. 0 deactivates
            the notifications. Only required if limit_notifications_sabotage is
            true.
        notification_count_sabotage_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of sabotage warnings. Only required if
            limit_notifications_sabotage is true.
        limit_notifications_system:
          example: false
          type: boolean
          description: >-
            Limits the system notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_system_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of system alarm notifications. 0 deactivates the
            notifications. Only required if limit_notifications_system is true.
        notification_count_system_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of system warnings. Only required if
            limit_notifications_system is true.
        arm_delay:
          example: 0
          type: integer
          enum:
            - 0
            - 10
            - 30
            - 60
            - 120
            - 180
            - 240
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: Describes the arm delay.
        buzzer_arm_duration:
          example: 0
          type: integer
          enum:
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: Describes the arm buzzer duration.
        can_alwaysarm:
          example: false
          type: boolean
          description: >-
            Describes if the status of external contacts should be ignored
            during arming. This is useful if e.g. a magnetic door contact must
            be opened during the arming phase.
        can_autoquit_always_alarm:
          example: false
          type: boolean
          description: >-
            Describes if always-active alarms should be automatically
            acknowledged after the given interval.
        can_autoquit_armed_alarm:
          example: false
          type: boolean
          description: >-
            Describes if armed-active alarms should be automatically
            acknowledged after the given interval.
        can_autoquit_fire_alarm:
          example: false
          type: boolean
          description: >-
            Describes if fire alarms should be automatically acknowledged after
            the given interval.
        can_autoquit_sabotage_alarm:
          example: false
          type: boolean
          description: >-
            Describes if sabotage alarms should be automatically acknowledged
            after the given interval.
        can_autoquit_system_notification_alarm:
          example: false
          type: boolean
          description: >-
            Describes if system alarms should be automatically acknowledged
            after the given interval.
        autoquit_duration:
          example: 0
          type: integer
          enum:
            - 0
            - 30
            - 60
            - 180
            - 600
            - 1800
          description: Describes the time after which automatic quitting is executed.
        has_prealarm:
          example: false
          type: boolean
          description: Describes if the Prealarm is en-/disabled.
        buzzer_alwaysalarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for always-active alarms (-1 stands for
            permanent).
        buzzer_armedalarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for armed-active alarms (-1 stands for
            permanent).
        buzzer_firealarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for fire alarms (-1 stands for
            permanent).
        buzzer_sabotagealarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for sabotage alarms (-1 stands for
            permanent).
        sabotage_powerdevice_duration:
          example: 300
          type: integer
          enum:
            - 300
            - 600
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a plugged device should wait, until it fires a
            tampering alarm.
        sabotage_batterydevice_duration:
          example: 900
          type: integer
          enum:
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a battery device should wait, until it fires a
            tampering alarm.
        sabotage_service_duration:
          example: 600
          type: integer
          enum:
            - 600
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a service should wait, until it fires a tampering
            alarm.
        event_id:
          example: 0
          type: integer
          nullable: true
          description: >-
            Describes the event that should be used. Must be an Id of an
            existing event.
        webhooks:
          type: array
          description: Describes the webhooks that should be fired when an event happens
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
        assigned_doorlock:
          example: 3
          type: integer
          nullable: true
          description: The ID of the doorlock directly assigned to the alarmgroup.
    other-alarmgroup-update:
      type: object
      properties:
        name:
          example: Kentix HQ
          type: string
          description: Describes the name of the alarmgroup.
        group_id:
          example: 1
          type: integer
          description: >-
            Indicates the parent alarm group. Must be an Id of an existing
            group.
        sort_index:
          example: 1
          type: integer
          description: Describes the sorting order.
        in_stealthmode:
          example: false
          type: boolean
          description: >-
            Describes if the internal status LED of all devices in this
            alarmgroup should be activated.
        signaling_group:
          example: 1
          type: integer
          nullable: true
          description: >-
            Describes the range in which a signaling is triggered, if an alarm
            occurs within this alarmgroup. Must be an Id of an parent group.
        maintenance:
          example: inactive
          type: string
          enum:
            - active
            - inactive
          description: Describes if the alarmgroup is in maintenance mode.
        maintenance_start:
          example: '2023-02-17T01:00:00.000Z'
          type: string
          format: ISO 8601
          nullable: true
          description: >-
            Describes when the alarmgroup automatically switches to maintenance
            mode.
        maintenance_stop:
          example: '2023-02-17T23:59:00.000Z'
          type: string
          format: ISO 8601
          nullable: true
          description: Describes until when the alarmgroup remains in maintenance mode.
        inherit_notification:
          example: false
          type: boolean
          description: >-
            Describes if the notification settings should be inherited from the
            parent group.
        is_alarmrepetition_active:
          example: false
          type: boolean
          description: >-
            Describes if active alarms should be repeated by it's configured
            interval. Acknowledgment of the alarm stops the repetition.
        alarmrepetition_interval:
          example: 1
          type: integer
          minimum: 1
          maximum: 999
          description: >-
            Describes how alarms are sent to all users configured for alarms,
            depending on the configured time and repetitions.
        alarmrepetition_count:
          example: 0
          type: integer
          minimum: 0
          maximum: 100
          description: >-
            Describes the number of alarm repetitions with the interval of the
            configured time.
        send_quitable_notifications:
          example: false
          type: boolean
          description: >-
            Describes if a notification should be sent as soon as an alarm is
            quitable.
        limit_notifications_always:
          example: true
          type: boolean
          description: >-
            Limits the always-active notifications per hour. Manual
            acknowledgement resets the counter, repeated alarms do not count.
        notification_count_always_alarm:
          example: 1
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of always-active alarm notifications. 0
            deactivates the notifications. Only required if
            limit_notifications_always is true.
        notification_count_always_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of always-active warnings. Only required if
            limit_notifications_always is true.
        limit_notifications_armed:
          example: true
          type: boolean
          description: >-
            Limits the armed-active notifications per hour. Manual
            acknowledgement resets the counter, repeated alarms do not count.
        notification_count_armed_alarm:
          example: 1
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of armed-active alarm notifications. 0
            deactivates the notifications. Only required if
            limit_notifications_armed is true.
        notification_count_armed_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of armed-active warnings. Only required if
            limit_notifications_armed is true.
        limit_notifications_fire:
          example: false
          type: boolean
          description: >-
            Limits the fire notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_fire_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of fire alarm notifications. 0 deactivates the
            notifications. Only required if limit_notifications_fire is true.
        notification_count_fire_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of fire warnings. Only required if
            limit_notifications_fire is true.
        limit_notifications_sabotage:
          example: false
          type: boolean
          description: >-
            Limits the sabotage notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_sabotage_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of sabotage alarm notifications. 0 deactivates
            the notifications. Only required if limit_notifications_sabotage is
            true.
        notification_count_sabotage_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of sabotage warnings. Only required if
            limit_notifications_sabotage is true.
        limit_notifications_system:
          example: false
          type: boolean
          description: >-
            Limits the system notifications per hour. Manual acknowledgement
            resets the counter, repeated alarms do not count.
        notification_count_system_alarm:
          example: 0
          type: integer
          nullable: true
          minimum: 0
          maximum: 1000
          description: >-
            Describes the limit of system alarm notifications. 0 deactivates the
            notifications. Only required if limit_notifications_system is true.
        notification_count_system_warning:
          example: false
          type: boolean
          nullable: true
          description: >-
            Notify in case of system warnings. Only required if
            limit_notifications_system is true.
        inherit_arm:
          example: false
          type: boolean
          description: >-
            Describes if the arm settings should be inherited from the parent
            group.
        arm_delay:
          example: 0
          type: integer
          enum:
            - 0
            - 10
            - 30
            - 60
            - 120
            - 180
            - 240
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: Describes the arm delay. Only required if inherit_arm is false.
        buzzer_arm_duration:
          example: 0
          type: integer
          enum:
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the arm buzzer duration. Only required if inherit_arm is
            false.
        can_alwaysarm:
          example: false
          type: boolean
          description: >-
            Describes if the status of external contacts should be ignored
            during arming. This is useful if e.g. a magnetic door contact must
            be opened during the arming phase.
        inherit_autoquit:
          example: false
          type: boolean
          description: >-
            Describes if the autoquit settings should be inherited from the
            parent group.
        can_autoquit_always_alarm:
          example: false
          type: boolean
          description: >-
            Describes if always-active alarms should be automatically
            acknowledged after the given interval. Only required if
            inherit_autoquit is false.
        can_autoquit_armed_alarm:
          example: false
          type: boolean
          description: >-
            Describes if armed-active alarms should be automatically
            acknowledged after the given interval. Only required if
            inherit_autoquit is false.
        can_autoquit_fire_alarm:
          example: false
          type: boolean
          description: >-
            Describes if fire alarms should be automatically acknowledged after
            the given interval. Only required if inherit_autoquit is false.
        can_autoquit_sabotage_alarm:
          example: false
          type: boolean
          description: >-
            Describes if sabotage alarms should be automatically acknowledged
            after the given interval. Only required if inherit_autoquit is
            false.
        can_autoquit_system_notification_alarm:
          example: false
          type: boolean
          description: >-
            Describes if system alarms should be automatically acknowledged
            after the given interval. Only required if inherit_autoquit is
            false.
        autoquit_duration:
          example: 0
          type: integer
          enum:
            - 0
            - 30
            - 60
            - 180
            - 600
            - 1800
          description: >-
            Describes the time after which automatic quitting is executed. Only
            required if inherit_autoquit is false.
        inherit_alarm:
          example: false
          type: boolean
          description: >-
            Describes if the alarm settings should be inherited from the parent
            group.
        has_prealarm:
          example: false
          type: boolean
          description: Describes if the Prealarm is en-/disabled.
        buzzer_alwaysalarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for always-active alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        buzzer_armedalarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for armed-active alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        buzzer_firealarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for fire alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        buzzer_sabotagealarm_duration:
          example: 0
          type: integer
          enum:
            - -1
            - 0
            - 1
            - 3
            - 10
            - 30
            - 60
            - 120
            - 180
            - 300
            - 600
            - 1200
            - 1800
            - 3600
          description: >-
            Describes the buzzer length for sabotage alarms (-1 stands for
            permanent). Only required if inherit_alarm is false.
        inherit_sabotagesignal:
          example: false
          type: boolean
          description: >-
            Describes if the signaling sabotage settings should be inherited
            from the parent group.
        sabotage_powerdevice_duration:
          example: 300
          type: integer
          enum:
            - 300
            - 600
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a plugged device should wait, until it fires a
            tampering alarm. Only required if inherit_sabotagesignal is false.
        sabotage_batterydevice_duration:
          example: 900
          type: integer
          enum:
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a battery device should wait, until it fires a
            tampering alarm. Only required if inherit_sabotagesignal is false.
        sabotage_service_duration:
          example: 600
          type: integer
          enum:
            - 600
            - 900
            - 1200
            - 1500
            - 1800
            - 2100
            - 2400
            - 2700
            - 3000
            - 3300
            - 3600
          description: >-
            Describes how long a service should wait, until it fires a tampering
            alarm. Only required if inherit_sabotagesignal is false.
        event_id:
          example: 0
          type: integer
          nullable: true
          description: >-
            Describes the event that should be used. Must be an Id of an
            existing event.
        webhooks:
          type: array
          description: Describes the webhooks that should be fired when an event happens
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
        assigned_doorlock:
          example: 3
          type: integer
          nullable: true
          description: The ID of the doorlock directly assigned to the alarmgroup.
    alarmgroup-oid:
      type: object
      properties:
        group:
          type: object
          properties:
            '{ID}':
              type: array
              description: Describes the ID of the queried alarmgroup.
              items:
                type: object
                properties:
                  label:
                    example: General
                    type: string
                    description: Describes the node in the OID tree.
                  attributes:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          example: Name
                          type: string
                          description: Describes the node in the OID tree.
                        oid:
                          example: .1.3.6.1.4.1.37954.5.3.1.1.2.2
                          type: string
                          description: Describes the OID path of the node.
    alarmgroup-state:
      type: object
      properties:
        id:
          example: 0
          type: integer
          description: Id of the alarmgroup.
        name:
          example: Kentix HQ
          type: string
          description: Name of the alarmgroup.
    alarmhorn:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: Kentix Alarm Siren (Ethernet)
          type: string
          description: The name of the device
        type:
          example: 124
          type: integer
          description: The type of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        port:
          example: 502
          type: integer
          description: The port of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        signalprofile_id:
          example: 3
          type: integer
          description: The ID of the Signalprofile the device is assigned to
    alarmhorns_names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: Kentix Alarm Siren (Ethernet)
          type: string
          description: The name of the device
    alarmmanagers:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: AlarmManager
          type: string
          description: The name of the device
        type:
          example: 101
          type: integer
          description: The type of the device
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        type_name:
          example: Alarmmanager
          type: string
          description: The name of the type
    alarmmanagers_names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: AlarmManager
          type: string
          description: The name of the device
    temperature_config:
      type: object
      description: The configuration for the temperature sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        min:
          example: 15
          type: integer
          description: The minimal threshold before an alarm is triggered
        max:
          example: 25
          type: integer
          description: The maximum threshold before an alarm is triggered
        offset:
          example: 2
          type: integer
          description: The offset applied to the value
        units:
          type: object
          properties:
            min:
              example: °C
              type: string
              description: The unit for the min field
            max:
              example: °C
              type: string
              description: The unit for the max field
            offset:
              example: °C
              type: string
              description: The unit for the offset field
        warning:
          type: object
          properties:
            min:
              example: 17
              type: integer
              description: The warning threshold for the min value
            max:
              example: 23
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    humidity_config:
      type: object
      description: The configuration for the humidity sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        min:
          example: 40
          type: integer
          description: The minimal threshold before an alarm is triggered
        max:
          example: 60
          type: integer
          description: The maximum threshold before an alarm is triggered
        units:
          type: object
          properties:
            min:
              example: '%'
              type: string
              description: The unit for the min field
            max:
              example: '%'
              type: string
              description: The unit for the max field
        warning:
          type: object
          properties:
            min:
              example: 45
              type: integer
              description: The warning threshold for the min value
            max:
              example: 55
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    dewpoint_config:
      type: object
      description: The configuration for the dewpoint sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        hysteresis:
          example: 2
          type: integer
          description: The hysteresis threshold where an alarm is triggered
        units:
          type: object
          properties:
            hysteresis:
              example: °C
              type: string
              description: The unit for the hysteresis field
        warning:
          type: object
          properties:
            max:
              example: 1
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    heat_config:
      type: object
      description: The configuration for the heat sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        threshold:
          example: 4
          type: integer
          description: The threshold where an alarm is triggered
        units:
          type: object
          properties:
            threshold:
              example: °C/min
              type: string
              description: The unit for the threshold field
        warning:
          type: object
          properties:
            max:
              example: 2
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    vibration_config:
      type: object
      description: The configuration for the vibration sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        sensitivity:
          example: medium
          type: string
          description: The sensitivity threshold where an alarm is triggered
    digital_input_config:
      type: object
      description: The configuration for an digital input
      properties:
        alarm_when:
          example: close
          type: string
          enum:
            - close
            - open
          description: Configures on which state an alarm will be triggered
        alarmdelay:
          example: 10
          type: integer
          description: The amount of seconds an alarm will be delayed
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
            - arm-disarm
            - arm
            - disarm
          description: The alarm assignment
        can_alwaysarm:
          example: false
          type: boolean
          description: Determines if the alarmstate of this device is ignored during arming
        description_alert:
          example: Alarm
          type: string
          description: The description to be displayed when an alarm occurs
        description_ok:
          example: OK
          type: string
          description: The description to be displayed when no alarm occurs
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        icon:
          example: ethernet
          type: string
          description: The icon to be displayed
        id:
          example: 2
          type: integer
          description: the ID of the device
        name:
          example: External Input
          type: string
          description: The name of the device
        input_type:
          example: default
          type: string
          enum:
            - default
            - door
            - leakage
          description: The type of input
    digital_output_config:
      type: object
      description: The configuration for an digital output
      properties:
        alarmdelay:
          example: 10
          type: integer
          description: The amount of seconds an alarm will be delayed
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        id:
          example: 2
          type: integer
          description: the ID of the device
        name:
          example: External Input
          type: string
          description: The name of the device
        event_id:
          example: 1
          type: integer
          description: The ID of the Eventprofile applied to this device
        output_time:
          example: 1
          type: integer
          description: Determines how long this output will be opened on alarm
    alarmmanagers_id:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: AlarmManager
          type: string
          description: The name of the device
        description:
          example: Alarmmanager main hall
          type: string
          description: The description of the device
        type:
          example: 101
          type: integer
          description: The type of the device
        type_name:
          example: Alarmmanager
          type: string
          description: The name of the type
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        alarmdelay:
          example: 10
          type: integer
          description: The amount of seconds an alarm will be delayed
        monitoring:
          type: object
          properties:
            temperature:
              type: object
              description: The configuration for the temperature sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                min:
                  example: 15
                  type: integer
                  description: The minimal threshold before an alarm is triggered
                max:
                  example: 25
                  type: integer
                  description: The maximum threshold before an alarm is triggered
                offset:
                  example: 2
                  type: integer
                  description: The offset applied to the value
                units:
                  type: object
                  properties:
                    min:
                      example: °C
                      type: string
                      description: The unit for the min field
                    max:
                      example: °C
                      type: string
                      description: The unit for the max field
                    offset:
                      example: °C
                      type: string
                      description: The unit for the offset field
                warning:
                  type: object
                  properties:
                    min:
                      example: 17
                      type: integer
                      description: The warning threshold for the min value
                    max:
                      example: 23
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            humidity:
              type: object
              description: The configuration for the humidity sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                min:
                  example: 40
                  type: integer
                  description: The minimal threshold before an alarm is triggered
                max:
                  example: 60
                  type: integer
                  description: The maximum threshold before an alarm is triggered
                units:
                  type: object
                  properties:
                    min:
                      example: '%'
                      type: string
                      description: The unit for the min field
                    max:
                      example: '%'
                      type: string
                      description: The unit for the max field
                warning:
                  type: object
                  properties:
                    min:
                      example: 45
                      type: integer
                      description: The warning threshold for the min value
                    max:
                      example: 55
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            dewpoint:
              type: object
              description: The configuration for the dewpoint sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                hysteresis:
                  example: 2
                  type: integer
                  description: The hysteresis threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    hysteresis:
                      example: °C
                      type: string
                      description: The unit for the hysteresis field
                warning:
                  type: object
                  properties:
                    max:
                      example: 1
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
        fire:
          type: object
          properties:
            heat:
              type: object
              description: The configuration for the heat sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 4
                  type: integer
                  description: The threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    threshold:
                      example: °C/min
                      type: string
                      description: The unit for the threshold field
                warning:
                  type: object
                  properties:
                    max:
                      example: 2
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
        intrusion:
          type: object
          properties:
            vibration:
              type: object
              description: The configuration for the vibration sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                sensitivity:
                  example: medium
                  type: string
                  description: The sensitivity threshold where an alarm is triggered
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        rack_id:
          example: null
          type: integer
          description: The ID of the rack the device is assigned to
        external:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel2:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel3:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel4:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
        output:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel2:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel3:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel4:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
        webhooks:
          type: array
          description: The webhook relations of this device
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    anti-passback-settings:
      type: object
      properties:
        is_active:
          type: boolean
          example: false
          description: >-
            Enables the anti-passback module. This will prevent a user
            (pin/rfid-token) from entering the same alarmgroup multiple times in
            short succession. After the configured timeout a booked in user will
            be able to enter again.
        timeout:
          type: string
          example: '30'
          enum:
            - 'off'
            - '10'
            - '15'
            - '30'
            - '60'
            - '120'
            - '480'
            - '720'
            - '1440'
          description: >-
            Configures the time after which a user will be able to enter an
            alarmgroup again. The value is given in minutes.
    anti-passback-user:
      type: object
      properties:
        id:
          type: number
          example: 1
          description: API/SNMP-ID of the user
        username:
          type: string
          example: exmpl_usr
          description: Username of the user
        fullname:
          type: string
          example: Example User
          description: Full name of the user
        location:
          type: number
          example: 1
          description: API/SNMP-ID of the alarmgroup the user entered last
        entered_at:
          type: string
          format: date-time
          example: '2024-10-03T10:00:00Z'
          description: Timestamp of when the user entered the alarmgroup
    backup:
      type: object
      properties:
        latest:
          type: object
          readOnly: true
          properties:
            status:
              example: true
              type: boolean
              description: Describes if the last backup succeeded.
            message:
              type: object
              nullable: true
              description: Describes if there is a message about the last backup.
              properties:
                status:
                  example: ok
                  type: string
                  enum:
                    - ok
                    - error
                  description: Status of the last backup.
                address:
                  example: 192.188.100.224
                  type: string
                  description: |
                    New IP address of the device.

                    Exist only when status is `ok`.
                type:
                  example: >-
                    Another system process is already running. Please try again
                    later.
                  type: string
                  description: |
                    Type of the error that occurred.

                    Exist only when status is `error`.
            destination:
              example: download
              type: string
              nullable: true
              description: Describes the location where the last backup was stored.
            event:
              example: manual
              type: string
              nullable: true
              description: Describes the event of the latest backup.
            created_at:
              example: '1675340108'
              type: string
              nullable: true
              description: >-
                Describes the Unix timestamp (seconds) when the last backup was
                created.
            is_uptodate:
              example: false
              type: boolean
              description: Describes if the last backup was less than 15 minutes ago.
            human_diff:
              example: 2 weeks ago
              type: string
              nullable: true
              description: Describes when a backup was last created.
        available_destinations:
          type: object
          readOnly: true
          properties:
            sd_card:
              example: false
              type: boolean
              description: Describes if an SD card is available.
            internal:
              example: false
              type: boolean
              description: >-
                Describes if an SD card is not available but an internal
                storage.
            network_drives:
              type: object
              properties:
                label:
                  example: ''
                  type: string
                  description: Describes an available network drive.
        password:
          example: password
          type: string
          writeOnly: true
          nullable: true
          maximum: 250
          description: Password for encryption of the backup.
        destination:
          example: download
          type: string
          writeOnly: true
          description: Destination for the backup.
    backup-restore-request:
      type: object
      required:
        - backup
      properties:
        backup:
          type: string
          format: base64
          description: Backup as binary file
        password:
          type: string
          description: Password of the encrypted backup.
    backup-restore-response:
      type: object
      properties:
        status:
          example: ok
          type: string
          enum:
            - ok
            - error
          description: Status of the backup restore.
        address:
          example: 192.188.100.224
          type: string
          description: New IP address of the device. Exist only when status is `ok`.
        type:
          example: The backup file is not compatible with this device.
          type: string
          description: Type of the error that occurred. Exist only when status is `error`.
    autobackup:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: Describes it automatic backup is en-/disabled.
        time:
          example: '00:00'
          type: string
          format: HH:mm
          description: Describes at which time the backup should be created.
        type:
          example: 2
          type: integer
          minimum: 1
          maximum: 2
          description: >-
            Describes the selected Storage Drive [1 => SD-Card; 2 => Network
            Drive (SMB)]
        delete_after_days:
          example: 1
          type: integer
          minimum: 0
          maximum: 7
          description: |
            Describes how long Backups should be stored.

            0 (never) is only for type 2 allowed.
        address:
          example: 0.0.0.0
          type: string
          nullable: true
          description: |
            Describes the IP-Address of the Network Drive.

            Needed when type is 2.
        share:
          example: SMB Rack
          type: string
          nullable: true
          description: |
            Describes the share name.

            Needed when type is 2.
        path:
          example: /home/kentix/backup
          type: string
          nullable: true
          description: Describes the storage path.
        username:
          example: root
          type: string
          nullable: true
          description: Describes the username for the SMB share.
        password:
          example: password
          type: string
          nullable: true
          description: Describes the password for the SMB share.
        send_notification:
          example: true
          type: boolean
          description: >-
            Describes if a notification should be send after a backup was
            created.
    autobackup-test:
      type: object
      properties:
        has_response:
          example: true
          type: boolean
          readOnly: true
          description: Describes whether the check has been handled.
        response_code:
          example: 0
          type: integer
          readOnly: true
          description: |
            1 => Network Drive not mounted<br>
            2 => Path is invalid<br>
            3 => No permissions granted
        address:
          example: 0.0.0.0
          type: string
          writeOnly: true
          description: Describes the IP-Address of the Network Drive.
        share:
          example: SMB Rack
          type: string
          writeOnly: true
          description: |
            Describes the share name.

            Needed when type is 2.
        path:
          example: /home/kentix/backup
          type: string
          nullable: true
          writeOnly: true
          description: Describes the storage path.
        username:
          example: root
          type: string
          nullable: true
          writeOnly: true
          description: Describes the username for the SMB share.
        password:
          example: password
          type: string
          nullable: true
          writeOnly: true
          description: Describes the password for the SMB share.
    cameras:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of the camera
        is_active:
          example: true
          type: boolean
          description: True if the camera is active
        name:
          example: Camera
          type: string
          description: Name of the camera
        address:
          example: address
          type: string
          description: IP Address of the camera
        group_id:
          example: 1
          type: integer
          description: The group id to which the camera belongs to
    cameras-names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of the camera
        name:
          example: Camera
          type: string
          description: Name of the camera
    cameras-camera_id:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of the camera.
        is_active:
          example: true
          type: boolean
          description: True if the camera is active.
        name:
          example: Camera
          type: string
          description: Name of the camera.
        camera_location:
          example: outdoor
          type: string
          description: >-
            Mounting area of the camera, can be: indoor, outdoor. Outdoor
            cameras use a prebuffer to capture persons before the actual
            booking.
        protocol:
          example: http
          type: string
          description: 'Communication protocol, can be: http, https.'
        address:
          example: 192.168.100.2
          type: string
          description: Network address of the camera.
        profile:
          example: ipro
          type: string
          description: Manufacturer of the camera.
        capture_path:
          example: /image/picture.png
          type: string
          description: Path/URL to get the images of the camera.
        stream_path:
          example: /video/
          type: string
          description: Path/URL to get the livestream of the camera.
        username:
          example: user
          type: string
          description: Username for logging in on the camera, if needed.
        passsword:
          example: password
          type: string
          description: Password for logging in on the camera, if needed.
        append_mail:
          example: false
          type: boolean
          description: If true the system appends an image to the alarm e-mail
        alarm_assignments:
          example:
            - armed-active
            - always-active
          type: array
          items:
            type: string
            enum:
              - 'off'
              - always-active
              - armed-active
              - fire
              - sabotage
              - display
              - system
          description: Array of all alarm assignments of the specific camera
        group_id:
          example: 1
          type: integer
          description: Group Id which the camera belongs to.
        rack_id:
          example: 1
          type: integer
          description: Rack Id which the camera belongs to.
        webhooks:
          example:
            - 1
            - 2
          type: array
          items:
            type: integer
          description: Integer Array of the webhooks
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    cameras-camera_id-request:
      type: object
      properties:
        name:
          example: Camera
          type: string
          description: Name of the camera.
        camera_location:
          example: outdoor
          type: string
          description: >-
            Mounting area of the camera, can be: indoor, outdoor. Outdoor
            cameras use a prebuffer to capture persons before the actual
            booking.
        protocol:
          example: http
          type: string
          description: 'Communication protocol, can be: http, https.'
        address:
          example: 192.168.100.2
          type: string
          description: Network address of the camera.
        profile:
          example: ipro
          type: string
          description: Manufacturer of the camera.
        capture_path:
          example: /image/picture.png
          type: string
          description: Path/URL to get the images of the camera.
        username:
          example: user
          type: string
          description: Username for logging in on the camera, if needed.
        passsword:
          example: password
          type: string
          description: Password for logging in on the camera, if needed.
        append_mail:
          example: false
          type: boolean
          description: If true the system appends an image to the alarm e-mail
        image_count:
          example: 10
          type: integer
          description: Sets the number of images to be stored for every booking.
        prebuffer_count:
          example: 4
          type: integer
          description: >-
            Sets the number of images BEFORE the actual booking to be stored,
            outdoor cameras only. Counts to the actual image_count, e.g. if 10
            images should be stored and prebuffer is 4, only 6 additional imaged
            AFTER the booking are stored.
    cloud-new-state:
      type: object
      properties:
        has_token:
          example: true
          type: boolean
          description: >-
            Describes if a KentixONE Onlineservice bearer token is available on
            the device to authenticate in KentixONE Onlineservice.
        is_active:
          example: false
          type: boolean
          description: Describes if KentixONE Onlineservice service is active.
        licence_type:
          example: 1
          type: integer
          description: >-
            Describes the type of the license. (0 - no license, 1 - S, 3 - M, 4
            - L, 5 - XL)
    cloud-new-managers-get:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: License ID
        licence:
          example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
          type: string
          description: Shows the current activated KentixONE Onlineservice License.
        type:
          example: 4
          type: integer
          description: >-
            Describes the type of the license. (0 - no license, 1 - S, 3 - M, 4
            - L, 5 - XL).
        start_at:
          example: '2022-03-31T07:29:20.000000Z'
          type: string
          description: Date when the license starts.
          nullable: true
        stop_at:
          example: '2022-03-31T07:29:20.000000Z'
          type: string
          description: Date when the license expires.
          nullable: true
        is_active:
          example: true
          type: boolean
          description: Describes if the KentixONE Onlineservice license is active.
        is_canceled:
          example: false
          type: boolean
          description: Describes if the KentixONE Onlineservice license is canceled.
        serialnumber:
          example: '1337000011234'
          type: string
          description: Describes the serialnumber registered to the license.
        physical_devices:
          example: 250
          type: integer
          description: >-
            Describes the amount of possible physical devices with the
            registered license.
        virtual_devices:
          example: 500
          type: integer
          description: >-
            Describes the amount of possible virtual devices with the registered
            license.
    cloud-new-managers-details:
      type: object
      properties:
        uuid:
          example: 1
          type: integer
          description: License ID
        name:
          example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
          type: string
          description: Shows the current activated KentixONE Onlineservice License.
        type:
          example: 4
          type: integer
          description: >-
            Describes the type of the license. (0 - no license, 1 - S, 3 - M, 4
            - L, 5 - XL).
        serialnumber:
          example: '1337000011234'
          type: string
          description: Describes the serialnumber registered to the license.
        otp_required:
          example: '2022-03-31T07:29:20.000000Z'
          type: boolean
          description: Date when the license expires.
          nullable: true
        licence:
          type: object
          properties:
            id:
              example: 1
              type: integer
              description: License ID
            licence:
              example: ABCDEF-GHIJKL-MNOPQR-STUVWX-YZ1234-567890
              type: string
              description: Shows the current activated KentixONE Onlineservice License.
            type:
              example: 4
              type: integer
              description: >-
                Describes the type of the license. (0 - no license, 1 - S, 3 -
                M, 4 - L, 5 - XL).
            start_at:
              example: '2022-03-31T07:29:20.000000Z'
              type: string
              description: Date when the license starts.
              nullable: true
            stop_at:
              example: '2022-03-31T07:29:20.000000Z'
              type: string
              description: Date when the license expires.
              nullable: true
            is_active:
              example: true
              type: boolean
              description: Describes if the KentixONE Onlineservice license is active.
            is_canceled:
              example: false
              type: boolean
              description: Describes if the KentixONE Onlineservice license is canceled.
            serialnumber:
              example: '1337000011234'
              type: string
              description: Describes the serialnumber registered to the license.
            physical_devices:
              example: 250
              type: integer
              description: >-
                Describes the amount of possible physical devices with the
                registered license.
            virtual_devices:
              example: 500
              type: integer
              description: >-
                Describes the amount of possible virtual devices with the
                registered license.
        license:
          example: >-
            U2FsdGVkX19u+BENt371XUqleug+Ug3wn3+1TBrcpv5OQWekz7Bd844+K2Uk63UpQ8KBnCTmKm2e059l7AV3bA==
          type: string
          description: >-
            Describes the current activated KentixONE Onlineservice License
            encrypted.
        subdomain:
          example: auth.cloud.kentixone.com
          type: string
          description: >-
            Describes the subdomain where the Manager connects to KentixONE
            Onlineservice.
        token:
          example: iXJFjObE9UeAxmzhR188EEfncn6yu3YUv1jFoAe1Nv
          type: string
          description: >-
            Describes the token for Manager to authenticate with KentixONE
            Onlineservice.
    cloud-new-users-invite:
      type: object
      required:
        - email
        - user_id
        - nfc_only
      properties:
        email:
          example: mail@example.org
          type: string
          description: Email address of the user to be invited/revoked.
        user_id:
          example: 10
          type: integer
          description: Id of the user to be invited/revoked.
        nfc_only:
          example: false
          type: boolean
          description: Remote open permission only via NFC
        overwrite_existing_user:
          example: false
          type: boolean
          description: Force overwrite existing user with another email.
    cloud-new-users-details:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: User ID
        email:
          example: mail@example.com
          type: string
          description: Shows the email address of the user.
        otp_active:
          example: true
          type: boolean
          description: Shows if the user has otp active.
          nullable: true
        activation:
          example: 1
          type: integer
          description: Shows the activation status of the user.
        nfc_only:
          example: true
          type: boolean
          description: Shows if the user can only remote open via NFC.
    cloud-new-share-access:
      type: object
      required:
        - doorlocks
        - timeprofile
      properties:
        doorlocks:
          type: array
          items:
            example: 5
            type: integer
            description: Doorlock IDs to share access with.
        timeprofile:
          example: 10
          type: integer
          description: Timeprofile ID for doorlock access.
        user_uuid:
          example: 7faa0e2d-2ba6-43d8-bbbf-9e20593f3e95
          type: string
          description: User UUID to share access with.
        user_email:
          example: test@kentix.com
          type: string
          description: User email to share access with.
        user_unlock_at:
          example: '2025-03-21T11:00:00.000Z'
          type: string
          description: Unlock user at specific time.
        user_lock_at:
          example: '2025-03-21T11:00:00.000Z'
          type: string
          description: Lock user at specific time.
    dashboard:
      type: object
      properties:
        status:
          description: The status of the system displayed in current alarm stats.
          type: object
          properties:
            alarms:
              example: 5
              type: integer
              description: The amount of current alarms
            quitable_alarms:
              example: 3
              type: integer
              description: The amount of current alarms ready to be quit
            warnings:
              example: 10
              type: integer
              description: The amount of current warnings
            quitable_warnings:
              example: 3
              type: integer
              description: The amount of current warnings ready to be quit
            pre_alarms:
              example: 1
              type: integer
              description: The amount of alarms currently in idle due to alarm_delay
            inactive:
              example: 2
              type: integer
              description: The amount of inactive devices in the system
        events:
          description: The last 10 events logged in the system
          type: array
          items:
            type: object
            properties:
              id:
                example: 135927
                type: integer
                description: The ID of the event
              timestamp:
                example: 2023-03-03T08:11:27+0100
                type: string
                description: The time the event occurred
              device:
                example: MultiSensor Room 1
                type: string
                description: The name of the device the event occurred on
              user:
                example: null
                type: string
                description: >-
                  The name of the user that triggered the event. null if no user
                  was involved
              function:
                example: Alarm
                type: string
                description: The function of the event
              detail:
                example: Serverroom 1, MultiSensor Room 1, Room Temperature
                type: string
                description: The detail on the event
              status:
                example: alarm
                type: string
                description: >-
                  The status of the event. If the event is an alarm the status
                  "ok" indicates that the alarm was quit.
              type:
                example: alarm
                type: string
                enum:
                  - alarm
                  - access
                description: The type of the event, indicating which logbook it belongs to.
        active_alarms:
          description: The last 5 alarms
          type: array
          items:
            type: object
            properties:
              id:
                example: 269
                type: integer
                description: The ID of the alarm
              alarmgroup_id:
                example: 21
                type: integer
                description: The ID of the alarmgroup in which the alarm was triggered
              alarmgroup:
                example: Room 1
                type: integer
                description: The name of the alarmgroup in which the alarm was triggered
              device_id:
                example: 214
                type: integer
                description: The ID of the device which triggered the alarm
              rack_id:
                example: 43
                type: integer
                description: The ID of the rack in which the alarm was triggered
              alarm_event_id:
                example: 135927
                type: integer
                description: The ID of the event for the alarm
              device:
                example: MultiSensor Room 1
                type: string
                description: The name of the device the event occurred on
              timestamp:
                example: 2023-03-03T08:11:27+0100
                type: string
                description: The time the event occurred
              value:
                example: '30'
                type: string
                description: The value of the sensor that triggered the alarm
              unit:
                example: °C
                type: string
                description: The unit for the value
              name:
                example: Room Temperature
                type: string
                description: The name of the sensor that triggered the alarm
              type:
                example: '1'
                type: string
                description: The type of the alarm
              assignment:
                example: 5
                type: integer
                description: The assignment of the sensor
              is_quitable:
                example: false
                type: boolean
                description: Flag if the alarm is quitable
        key_figures:
          type: array
          items:
            type: object
            properties:
              category_name:
                example: access
                type: string
                description: The name of the category
              measurements:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      example: access_granted
                      type: string
                      description: The name of the measurement
                    value:
                      type: object
                      example:
                        lastMonth: '77'
                        currentMonth: '10'
                      description: The values of the measurement
    datetime:
      type: object
      properties:
        auto:
          type: boolean
          description: >-
            If true, the device will automatically set the date and time using
            the configured NTP server.
          example: true
        ntp1:
          type: string
          description: >-
            The first NTP server to use for automatic date and time
            configuration.
          example: 0.pool.ntp.org
        ntp2:
          type: string
          description: >-
            The second NTP server to use for automatic date and time
            configuration.
          example: 1.pool.ntp.org
        timezone:
          type: string
          description: The timezone to use for automatic date and time configuration.
          example: Europe/Berlin
    device-info:
      type: object
      properties:
        name:
          example: Manager
          type: string
          description: The name of the device
        type:
          example: KSM
          type: string
          description: The type code of the device type of the device
        version:
          example: 8.1.3 (Build 946)
          type: string
          description: The KentixONE version running on the device
        serialnumber:
          example: 1234567890987
          type: integer
          description: The serialnumber of the device
        address:
          example: 192.168.0.1
          type: integer
          description: The current address of the device
        mac_address:
          example: 12:34:56:78:90:ab
          type: string
          description: The MAC-Address of the device
        mode:
          example: Main Device
          type: string
          enum:
            - Main Device
            - Satellite Device
            - Standalone Device
        manager_address:
          example: null
          type: string
          nullable: true
          description: The address of the managing device this device reports to
        mail_active:
          example: 1
          type: integer
          description: The active status of the mailing function
    doorlockItem:
      type: object
      properties:
        id:
          type: number
          description: ID of the DoorLock
          example: 2
        device_id:
          type: number
          description: >-
            ID of the DoorLock's host device, i.e. the device on which is has
            been teached-in.
          example: 1
        name:
          type: string
          description: Name of the DoorLock
          example: Frontdoor
        is_active:
          type: boolean
          description: Describes if the DoorLock is active or inactive.
          example: true
        type:
          type: number
          description: Numerical devicetype
          example: 21
        group_id:
          type: number
          description: ID of the DoorLock's assigned alarmgroup
          example: 2
        batterylevel:
          type: string
          description: Battery level of the DoorLock
          example: full
          enum:
            - full
            - half
            - low
            - critical
            - wired
    doorlockModel:
      type: object
      properties:
        id:
          type: number
          description: ID of the DoorLock
          example: 2
        device_id:
          type: number
          description: >-
            ID of the DoorLock's host device, i.e. the device on which is has
            been teached-in.
          example: 1
        is_active:
          type: boolean
          description: Describes if the DoorLock is active or inactive.
          example: true
        is_teachin_default:
          type: boolean
          description: >-
            Describes if this DoorLock is preselected, when a RFID token will be
            teached-id.
          example: false
        name:
          type: string
          description: Name of the DoorLock
          example: Frontdoor
        type:
          type: number
          description: Numerical devicetype
          example: 21
        signal_zonestate:
          type: boolean
          description: >-
            Set true, if the DoorLock should show the current arm state of the
            assigned alarmzone.
          example: false
        coupletime:
          example: 3
          type: number
          description: Time in seconds after the booking while the door can be opened.
        doubleauth_mode:
          example: 0
          type: number
          nullable: true
          description: >-
            Mode for double authentication. 0=Off, 1=On, 2=Only when
            arming/disarming, 3=time controlled via timeprofile.
        doubleauth_timeprofile_id:
          example: 0
          type: number
          nullable: true
          description: >-
            ID of the timeprofile which shall be used to enable and disable the
            double authentication on specific times.
        log_level:
          example: 1
          type: number
          description: >-
            Sets the logbook logging mode for this DoorLock. 1=Default, 2=No
            user-related data (names, pictures), 3=Only unauthorized bookings,
            4=No logging.
        timeprofile_mode:
          example: 0
          type: number
          enum:
            - 0
            - 1
            - 2
          description: >-
            Mode for timeprofile usage. 0=Off, 1=On, 2=Open after first booking
            within the time profile.
        timeprofile_id:
          type: number
          description: ID of the DoorLock's assigned timeprofile
          example: 2
        group_id:
          type: number
          description: ID of the DoorLock's assigned alarmgroup
          example: 2
        armlevel:
          example: 0
          type: number
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
          description: >-
            Set the arming level of this DoorLock. 0=Off, 1=Assigned Alarmzone,
            2=Building containing the assigned Alarmzone, 3=System, 4=External
            Alarmsystem.
        webhooks:
          type: array
          items:
            type: integer
          description: IDs of all assigned webhooks.
        cameras:
          type: array
          items:
            type: integer
          description: IDs of all assigned cameras.
        batterylevel:
          type: string
          description: Battery level of the DoorLock
          example: full
          enum:
            - full
            - half
            - low
            - critical
            - wired
        reed_bypass_time:
          type: number
          description: >-
            Time in seconds after the booking while the door can be opened
            without reed contact alarming.
          example: 30
          enum:
            - 0
            - 5
            - 10
            - 15
            - 30
            - 45
            - 60
            - 90
            - 120
        reed_bypass_buzzer_time:
          type: number
          description: >-
            Time in seconds to buzzer after the bypass time and before
            triggering the door contact alarm.
          example: 30
          enum:
            - 0
            - 5
            - 10
            - 15
            - 30
            - 45
            - 60
            - 90
            - 120
        sabotage:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the disassembly alarm.
        reed_source_id:
          type: number
          example: 'off'
          description: >-
            API-ID of the external sensor, which is assigned to be the
            doorlock's reed sensor.
        reed_assignment:
          type: string
          example: 'off'
          description: Alarm-Assignment for the assigned reed sensor.
        reed_delay:
          type: number
          example: 3600
          description: >-
            If the reed sensor triggers an alarm, it will be delayed by this
            time (in seconds).
        reed_warning_active:
          type: boolean
          example: true
          description: >-
            Enables signaling on the DoorLock if the door is open for the set
            time (in seconds). The signaling will stop when the door is closed
            again.
        reed_warning_delay:
          type: number
          example: 1800
          description: The door must stay open for the set time to start the signalization.
    doorlockInfo:
      type: object
      properties:
        name:
          example: DoorLock
          type: string
          description: Name of the DoorLock
        type:
          example: '20'
          type: string
          description: Devicetype of the DoorLock.
        device_type:
          example: DoorLock
          type: string
          description: Devicetype name of the DoorLock.
        serial:
          example: 123456789012
          type: string
          description: Serial number of the DoorLock.
        version:
          example: 01.00.00
          type: string
          description: Firmware Version of the DoorLock.
        device_id:
          example: 1
          type: number
          description: AccessManager, to which the DoorLock was teached-in.
        batterylevel:
          example: full
          type: string
          enum:
            - full
            - half
            - low
            - critical
            - wired
          description: Current batterylevel of the DoorLock.
        switches_ext_system:
          example: false
          type: boolean
          description: >-
            Describes if the DoorLock is configured to switch an external
            alarmsystem.
        armlevel:
          example: 0
          type: string
          default: 0
          enum:
            - '0'
            - '1'
            - '2'
            - '3'
            - '4'
          description: >-
            Set the arming level of this DoorLock. 0=Off, 1=Assigned Alarmzone,
            2=Building containing the assigned Alarmzone, 3=System, 4=External
            Alarmsystem.
        group_id:
          example: 1
          type: number
          description: ID of the alarmgroup, to which this DoorLock was assigned.
        log_level:
          example: 1
          type: number
          enum:
            - 1
            - 2
            - 3
            - 4
          description: >-
            Sets the logbook logging mode for this DoorLock. 1=Default, 2=No
            user-related data (names, pictures), 3=Only unauthorized bookings,
            4=No logging.
        latch_logic:
          example: false
          type: boolean
          nullable: true
          description: DoorLock RA4 Only. Configures if the latch logic should be inverted.
        reed_logic:
          example: false
          type: boolean
          nullable: true
          description: DoorLock RA4 Only. Configures if the reed logic should be inverted.
    doorlockName:
      type: object
      properties:
        id:
          type: number
          description: ID of the DoorLock
          example: 2
        name:
          type: string
          description: Name of the DoorLock
          example: Frontdoor
        device_id:
          type: number
          description: >-
            ID of the DoorLock's host device, i.e. the device on which is has
            been teached-in.
          example: 1
        is_teachin_default:
          type: boolean
          description: >-
            Describes if this DoorLock is preselected, when a RFID token will be
            teached-id.
          example: false
    doorlockLock:
      type: array
      items:
        type: integer
        description: ID of the DoorLock
    blockingprofiles_list:
      type: object
      properties:
        data:
          description: The list of Exceptionday-profiles
          type: array
          items:
            type: object
            properties:
              id:
                example: 1
                type: integer
                description: Id of the Exceptionday-profile.
              name:
                example: Holidays
                type: string
                description: Name of the Exceptionday-profile.
        meta:
          type: object
          properties:
            current_page:
              example: 1
              type: integer
              description: The key of the current page
            from:
              example: 1
              type: integer
              description: The index of the first element on the current page
            last_page:
              example: 10
              type: integer
              description: The index of the last page
            path:
              example: https://example.com/api/timeprofiles
              type: string
              description: The route just called
            per_page:
              example: 25
              type: integer
              description: The amount of elements per page
            to:
              example: 25
              type: integer
              description: The index of the last element on the current page
            total:
              example: 245
              type: integer
              description: The total amount of elements
        links:
          type: object
          description: >-
            Attention: When using filters/query parameters, those must be
            appended to the given links.
          properties:
            first:
              example: https://example.com/api/example?page=1
              type: string
              description: The link to the first page
            last:
              example: https://example.com/api/example?page=10
              type: string
              description: The link to the last page
            prev:
              example: 'null'
              type: string
              description: The link to the previous page
            next:
              example: https://example.com/api/example?page=2
              type: string
              description: The link to the next page
    blockingprofile:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: >-
            The ID of the profile (if not included a new profile with the given
            data will be created)
        name:
          example: Holidays
          type: string
          description: The name of the profile
        days:
          type: array
          description: The days, on which the exception occures
          items:
            properties:
              name:
                example: Christmas Eve
                type: string
                description: Name of the exception
              date:
                example: 20231224
                type: integer
                format: YYYYMMDD
                description: Date of the exception
              is_repeatable:
                example: false
                type: boolean
                description: If the exception is repeatable
    di_assignments:
      type: object
      description: The configuration for an digital input
      properties:
        name:
          example: External Input
          type: string
          description: The name of the input
        channel:
          example: 1
          type: number
          description: The channel number of this input.
        external_alarmsystem:
          nullable: true
          example: Alarmgroup 1
          type: string
          description: >-
            If the input was assigned to an external alarmsystem, the name of
            the assigned alarmgroup will be printed here. Otherwise it will be
            null.
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
            - arm-disarm
            - arm
            - disarm
          description: The alarm assignment of the input.
    do_assignments:
      type: object
      description: The configuration for an digital output
      properties:
        name:
          example: Digital Output
          type: string
          description: The name of the output
        channel:
          example: 1
          type: number
          description: The channel number of this output.
        external_alarmsystem:
          nullable: true
          example: Alarmgroup 1
          type: string
          description: >-
            If the output was assigned to an external alarmsystem, the name of
            the assigned alarmgroup will be printed here. Otherwise it will be
            null.
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment
    assigned-ios:
      type: object
      properties:
        id:
          example: 1
          type: number
          description: The extension module's API/SNMP-ID
        name:
          example: KIO7052
          type: string
          description: Name of the extension module
        type:
          example: '121'
          type: string
          description: Devicetype of the extension module.
        external:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel2:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel3:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel4:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel5:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel6:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel7:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
            channel8:
              type: object
              description: The configuration for an digital input
              properties:
                name:
                  example: External Input
                  type: string
                  description: The name of the input
                channel:
                  example: 1
                  type: number
                  description: The channel number of this input.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the input was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment of the input.
        output:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel2:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel3:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel4:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel5:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel6:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel7:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
            channel8:
              type: object
              description: The configuration for an digital output
              properties:
                name:
                  example: Digital Output
                  type: string
                  description: The name of the output
                channel:
                  example: 1
                  type: number
                  description: The channel number of this output.
                external_alarmsystem:
                  nullable: true
                  example: Alarmgroup 1
                  type: string
                  description: >-
                    If the output was assigned to an external alarmsystem, the
                    name of the assigned alarmgroup will be printed here.
                    Otherwise it will be null.
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
    gsm:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: Describes if GSM/cell service is active or not.
        authentication:
          example: false
          type: boolean
          description: Describes if the SIM uses PIN protection.
        state:
          type: object
          properties:
            iccid:
              example: '1234567890123456789'
              type: string
              description: The ICCID of the SIM card.
            modem_state:
              example: 1
              type: integer
              description: The state of the modem.
            operator:
              example: TelekomDE
              type: string
              description: The name of the operator.
        gateway:
          type: object
          properties:
            is_active:
              example: true
              type: boolean
              description: Describes if the SMS gateway is active or not.
            password:
              example: password
              type: string
              description: The password of the SMS gateway.
        forwarding:
          type: object
          description: >-
            Only for SiteManagers without GSM modem. If enabled, all SMS will be
            forwarded to the AlarmManager IP and sent via it's modem.
          properties:
            is_active:
              example: true
              type: boolean
              description: Describes if the SMS forwarding is active or not.
            address:
              example: 192.168.100.222
              type: string
              description: The IP address of the AlarmManager.
    gsm-request:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: Describes if GSM/cell service is active or not.
        gateway:
          type: object
          properties:
            is_active:
              example: true
              type: boolean
              description: Describes if the SMS gateway is active or not.
            password:
              example: password
              type: string
              description: The password of the SMS gateway.
        forwarding:
          type: object
          description: >-
            Only for SiteManagers without GSM modem. If enabled, all SMS will be
            forwarded to the AlarmManager IP and sent via it's modem.
          properties:
            is_active:
              example: true
              type: boolean
              description: Describes if the SMS forwarding is active or not.
            address:
              example: 192.168.100.222
              type: string
              description: The IP address of the AlarmManager.
    gsm-cell-state:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: Describes if GSM/cell service is active or not.
        state:
          example: ready
          type: string
          enum:
            - initializing
            - no-sim
            - pin1
            - pin2
            - puk1
            - puk2
            - ready
            - error
          description: Describes the state of the modem.
        signal_strength:
          example: medium
          type: string
          nullable: true
          enum:
            - no-signal
            - bad
            - medium
            - good
            - very-good
          description: Describes the mobile radio signal strength.
    test-phone:
      type: object
      properties:
        phone:
          example: '+123456789'
          type: string
          description: Phone number to which the test SMS should be sent.
    sim-pin:
      type: object
      properties:
        pin:
          example: '1234'
          type: string
          description: SIM cards current PIN.
    sim-unlock:
      type: object
      properties:
        puk:
          example: '12345678'
          type: string
          description: SIM cards PUK.
        pin:
          example: '1234'
          type: string
          description: SIM cards new PIN.
    sim-pin-change:
      type: object
      properties:
        old_pin:
          example: '1234'
          type: string
          description: SIM cards current PIN.
        new_pin:
          example: '1234'
          type: string
          description: SIM cards new PIN.
    sim-pin-protection:
      type: object
      properties:
        active:
          example: true
          type: boolean
          description: Describes if SIM protection should be active or not.
        pin:
          example: '1234'
          type: string
          description: SIM cards current PIN.
    sms-gateway:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: Describes if SMS gateway is active or not.
        password:
          example: password
          type: string
          nullable: true
          description: Password for the SMS-Gateway.
    sms-gateway-put:
      type: object
      properties:
        key:
          example: password
          type: string
          description: Password for the SMS-Gateway.
        recipients:
          example:
            - '+123456789'
          type: array
          items:
            type: string
          description: Persons to whom the SMS is to be sent.
        body:
          example: This is an example
          type: string
          description: Body of the SMS.
        alarm_event_id:
          example: 0
          type: integer
          nullable: true
          description: The ID of the alarm event
        retries:
          example: 0
          type: integer
          nullable: true
          description: Attempts to send SMS
    history_json:
      type: object
      title: History of the queried measurements
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                example: voltage
                description: The type of the measurement
              channel:
                type: string
                description: >-
                  The channel of the measurement, if applicable. Can be a phase
                  number or a supply line
                example: 1
              unit:
                type: string
                description: The unit of the measurement
                example: V
              timestamps:
                type: array
                items:
                  type: string
                  format: date-time
                  example: '2021-01-01T00:00:00Z'
                description: The timestamps of the measurements
              values:
                type: array
                items:
                  type: string
                  description: Can be a string or a number.
                  example: 230
    integration:
      type: object
      properties:
        address:
          example: 192.168.100.224
          type: string
          description: The address of the device.
        apikey:
          example: mfyLv9Y263tOd6xTMM94yzBHtVID7rvQCcEbQXaI
          type: string
          description: The apikey of an admin of the device to be integrated.
    iomodule:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: MultiSensor
          type: string
          description: The name of the device
        type:
          example: 1
          type: integer
          description: The type of the device
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
    iomodules_names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: Kentix I/O Module 7052
          type: string
          description: The name of the device
    analog_input_config:
      type: object
      description: The configuration for an analog input
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment
        name:
          example: External Input
          type: string
          description: The name of the device
        alarmdelay:
          example: 10
          type: integer
          description: The amount of seconds an alarm will be delayed
        decimal:
          example: 1
          type: integer
          enum:
            - 1
            - 2
            - 3
            - 4
          description: The amount of decimals
        min:
          example: 10
          type: integer
          description: The lower threshold where an alarm is triggered
        max:
          example: 10
          type: integer
          description: The upper threshold where an alarm is triggered
        offset:
          example: 1
          type: integer
          description: The offset to be applied on the value
        physical_min:
          example: -50
          type: integer
          description: The lower end on the measurement scale
        physical_max:
          example: -50
          type: integer
          description: The upper end on the measurement scale
        unit:
          example: °C
          type: string
          description: The unit corresponding to the value
        electrical_min:
          example: 0
          type: integer
          description: Minimal electrical value of the sensor
        electrical_max:
          example: 10
          type: integer
          description: Maximal electrical value of the sensor
        measuring_mode:
          example: voltage
          type: string
          enum:
            - voltage
            - current
          description: The type of measurement
        description_alert:
          example: Alarm
          type: string
          description: The description to be displayed when an alarm occurs
        description_ok:
          example: OK
          type: string
          description: The description to be displayed when no alarm occurs
        icon:
          example: ethernet
          type: string
          description: The icon to be displayed
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
    iomodule7017:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: Kentix I/O Module 7017
          type: string
          description: The name of the device
        type:
          example: 123
          type: integer
          description: The type of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        port:
          example: 502
          type: integer
          description: The port of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        rack_id:
          example: null
          type: integer
          description: The ID of the rack the device is assigned to
        external:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel2:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel3:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel4:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel5:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel6:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel7:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
            channel8:
              type: object
              description: The configuration for an analog input
              properties:
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                decimal:
                  example: 1
                  type: integer
                  enum:
                    - 1
                    - 2
                    - 3
                    - 4
                  description: The amount of decimals
                min:
                  example: 10
                  type: integer
                  description: The lower threshold where an alarm is triggered
                max:
                  example: 10
                  type: integer
                  description: The upper threshold where an alarm is triggered
                offset:
                  example: 1
                  type: integer
                  description: The offset to be applied on the value
                physical_min:
                  example: -50
                  type: integer
                  description: The lower end on the measurement scale
                physical_max:
                  example: -50
                  type: integer
                  description: The upper end on the measurement scale
                unit:
                  example: °C
                  type: string
                  description: The unit corresponding to the value
                electrical_min:
                  example: 0
                  type: integer
                  description: Minimal electrical value of the sensor
                electrical_max:
                  example: 10
                  type: integer
                  description: Maximal electrical value of the sensor
                measuring_mode:
                  example: voltage
                  type: string
                  enum:
                    - voltage
                    - current
                  description: The type of measurement
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
        output:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel2:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel3:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel4:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
        webhooks:
          example:
            - webhook_id: 1
              event: 0
              trigger_on_alarm: true
              trigger_on_warning: false
              cycle_time: null
          type: array
          description: The webhook relations of this device
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    iomodule7052:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: Kentix I/O Module 7052
          type: string
          description: The name of the device
        type:
          example: 121
          type: integer
          description: The type of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        port:
          example: 502
          type: integer
          description: The port of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        rack_id:
          example: null
          type: integer
          description: The ID of the rack the device is assigned to
        external:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel2:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel3:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel4:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel5:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel6:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel7:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel8:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
        output:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel2:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel3:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel4:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel5:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel6:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel7:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel8:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
        webhooks:
          example:
            - webhook_id: 1
              event: 0
              trigger_on_alarm: true
              trigger_on_warning: false
              cycle_time: null
          type: array
          description: The webhook relations of this device
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    iomodule7053:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: Kentix I/O Module 7053
          type: string
          description: The name of the device
        type:
          example: 122
          type: integer
          description: The type of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        port:
          example: 502
          type: integer
          description: The port of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        rack_id:
          example: null
          type: integer
          description: The ID of the rack the device is assigned to
        external:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel2:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel3:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel4:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel5:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel6:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel7:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel8:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel9:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel10:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel11:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel12:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel13:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel14:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel15:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel16:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
        webhooks:
          example:
            - webhook_id: 1
              event: 0
              trigger_on_alarm: true
              trigger_on_warning: false
              cycle_time: null
          type: array
          description: The webhook relations of this device
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    iostate:
      type: object
      properties:
        data:
          type: object
          properties:
            ids:
              type: array
              description: Array of the ids to check as string
              items:
                type: string
                example: '1'
    iostateresponse:
      type: object
      properties:
        id:
          example: 5
          type: integer
          description: The ID of the io
        value:
          example: 1
          type: integer
          description: The value of the io
    kai:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: >-
            If set to true KAI, the Kentix AI will be useable by every user with
            the corresponding permissions set in their respective usergroup.
    kpiconfig_id:
      type: object
      properties:
        user_id:
          example: 1
          type: integer
          description: The ID of the user related to the configuration
        config:
          type: object
          properties:
            access_denied:
              type: array
              items:
                type: object
                properties:
                  comparedto:
                    example: none
                    type: string
                    description: Value to be compared with.
                  label:
                    example: Access denied
                    type: string
                    description: Name of the KPI.
                  order:
                    example: 1
                    type: integer
                    description: Describes the position.
                  uuid:
                    example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                    type: string
                    format: UUID
                    description: UUID of the KPI.
                  value:
                    example: currentMonth
                    type: string
            access_granted:
              type: array
              items:
                type: object
                properties:
                  comparedto:
                    example: none
                    type: string
                    description: Value to be compared with.
                  label:
                    example: Access granted
                    type: string
                    description: Name of the KPI.
                  order:
                    example: 1
                    type: integer
                    description: Describes the position.
                  uuid:
                    example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                    type: string
                    format: UUID
                    description: UUID of the KPI.
                  value:
                    example: currentMonth
                    type: string
            active_power:
              type: array
              items:
                type: object
                properties:
                  comparedto:
                    example: total
                    type: string
                    description: Value to be compared with.
                  label:
                    example: Active power
                    type: string
                    description: Name of the KPI.
                  order:
                    example: 2
                    type: integer
                    description: Describes the position.
                  uuid:
                    example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                    type: string
                    format: UUID
                    description: UUID of the KPI.
                  value:
                    example: lastMonth
                    type: string
            alarms:
              type: array
              items:
                type: object
                properties:
                  comparedto:
                    example: none
                    type: string
                    description: Value to be compared with.
                  label:
                    example: Alarms
                    type: string
                    description: Name of the KPI.
                  order:
                    example: 1
                    type: integer
                    description: Describes the position.
                  uuid:
                    example: 3f263f3f-be94-49b7-b3c7-ab79567f8145
                    type: string
                    format: UUID
                    description: UUID of the KPI.
                  value:
                    example: currentMonth
                    type: string
            consumption:
              type: array
              items:
                type: object
                properties:
                  comparedto:
                    example: none
                    type: string
                    description: Value to be compared with.
                  label:
                    example: Consumption
                    type: string
                    description: Name of the KPI.
                  order:
                    example: 1
                    type: integer
                    description: Describes the position.
                  uuid:
                    example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                    type: string
                    format: UUID
                    description: UUID of the KPI.
                  value:
                    example: currentMonth
                    type: string
            pue:
              type: array
              items:
                type: object
                properties:
                  comparedto:
                    example: none
                    type: string
                    description: Value to be compared with.
                  label:
                    example: Power Usage Effectivenes
                    type: string
                    description: Name of the KPI.
                  order:
                    example: 1
                    type: integer
                    description: Describes the position.
                  uuid:
                    example: 1a109a74-be94-49b7-b3c7-ab79567f81ab
                    type: string
                    format: UUID
                    description: UUID of the KPI.
                  value:
                    example: currentMonth
                    type: string
    ldapModel:
      type: object
      properties:
        is_active:
          type: boolean
          description: Is LDAP active
          example: true
        soft_deletes:
          type: boolean
          description: >-
            Describes, if deleted users should be disabled or deleted. If true,
            the user will be disabled.
          example: false
        server_type:
          type: string
          description: >-
            Select the type of LDAP server you are using. If the wrong type is
            selected, issue may occur when requesting groups.
          enum:
            - active_directory
            - openldap
          example: active_directory
        use_range:
          type: boolean
          example: false
          description: >-
            If you are importing huge numbers of users, you should enable this
            function to import them in chunks. Be aware, that this function must
            be enabled on your server.
        range_size:
          type: number
          example: 900
          description: >-
            Sets the range size for chunk-requesting users. If not neccessary,
            do not change this setting.
        security:
          type: integer
          description: >-
            Describes the security level of the LDAP connection. 0 = None 1 =
            SSL (LDAPS)
          enum:
            - 0
            - 1
          example: 1
        address:
          type: string
          description: LDAP server address
          example: ldap.example.com
        port:
          type: integer
          description: LDAP server port
          example: 389
        basedn:
          type: string
          description: LDAP base DN
          example: dc=example,dc=com
        binddn:
          type: string
          description: LDAP bind DN
          example: cn=admin,dc=example,dc=com
        binddn_password:
          type: string
          nullable: true
          description: LDAP bind DN password
          example: password
        usergroup_1:
          type: integer
          description: >-
            ID of the Kentix system usergroup, which should be used for LDAP
            usergroup 1
          example: 1
        usergroup_1_path:
          type: string
          description: LDAP usergroup 1 path
          example: cn=users,ou=groups,dc=example,dc=com
        usergroup_2:
          type: integer
          description: >-
            ID of the Kentix system usergroup, which should be used for LDAP
            usergroup 2
          example: 2
        usergroup_2_path:
          type: string
          description: LDAP usergroup 2 path
          example: cn=admins,ou=groups,dc=example,dc=com
        admin_group:
          type: string
          description: LDAP admin group
          example: cn=admins,ou=groups,dc=example,dc=com
        user_active:
          type: string
          description: LDAP user active attribute
          example: active
        username:
          type: string
          description: LDAP username attribute
          example: sAMAccountName
        fullname:
          type: string
          description: LDAP fullname attribute
          example: name
        email:
          type: string
          description: LDAP email attribute
          example: mail
        phone:
          type: string
          description: LDAP phone attribute, only required for AlarmManagers
          example: telephoneNumber
        pin:
          type: string
          description: LDAP pin attribute
          example: pin
        rfid:
          type: string
          description: LDAP rfid attribute
          example: rfid
        description:
          type: string
          description: LDAP description attribute
          example: description
        emergency_access:
          type: string
          description: LDAP emergency access attribute
          example: emergency
        notifications:
          type: string
          description: LDAP attribute to describe if a user may receive notifications
          example: receives_notifications
        levelprofiles:
          type: string
          description: LDAP attribute to describe the accessprofiles of a user
          example: accessprofiles
        sync_interval:
          type: integer
          description: LDAP sync interval in seconds
          example: 3600
          enum:
            - 3600
            - 10800
            - 21600
            - 43200
            - 86400
    ldapModelPatch:
      type: object
      properties:
        is_active:
          type: boolean
          description: Is LDAP active
          example: true
        soft_deletes:
          type: boolean
          description: >-
            Describes, if deleted users should be disabled or deleted. If true,
            the user will be disabled.
          example: false
        server_type:
          type: string
          description: >-
            Select the type of LDAP server you are using. If the wrong type is
            selected, issue may occur when requesting groups.
          enum:
            - active_directory
            - openldap
          example: active_directory
        use_range:
          type: boolean
          example: false
          description: >-
            If you are importing huge numbers of users, you should enable this
            function to import them in chunks. Be aware, that this function must
            be enabled on your server.
        range_size:
          type: number
          example: 900
          description: >-
            Sets the range size for chunk-requesting users. If not neccessary,
            do not change this setting.
        security:
          type: integer
          description: >-
            Describes the security level of the LDAP connection. 0 = None 1 =
            SSL (LDAPS)
          enum:
            - 0
            - 1
          example: 1
        address:
          type: string
          description: LDAP server address
          example: ldap.example.com
        port:
          type: integer
          description: LDAP server port
          example: 389
        basedn:
          type: string
          description: LDAP base DN
          example: dc=example,dc=com
        binddn:
          type: string
          description: LDAP bind DN
          example: cn=admin,dc=example,dc=com
        binddn_password:
          type: string
          description: LDAP bind DN password
          example: password
        password_confirmation:
          type: string
          description: >-
            If you want to change LDAP settings and a password is already
            stored, you need to submit the stored binddn_password in this
            attribute
          example: password
        usergroup_1:
          type: integer
          description: >-
            ID of the Kentix system usergroup, which should be used for LDAP
            usergroup 1
          example: 1
        usergroup_1_path:
          type: string
          description: LDAP usergroup 1 path
          example: cn=users,ou=groups,dc=example,dc=com
        usergroup_2:
          type: integer
          description: >-
            ID of the Kentix system usergroup, which should be used for LDAP
            usergroup 2
          example: 2
        usergroup_2_path:
          type: string
          description: LDAP usergroup 2 path
          example: cn=admins,ou=groups,dc=example,dc=com
        admin_group:
          type: string
          description: LDAP admin group
          example: cn=admins,ou=groups,dc=example,dc=com
        user_active:
          type: string
          description: LDAP user active attribute
          example: active
        username:
          type: string
          description: LDAP username attribute
          example: sAMAccountName
        fullname:
          type: string
          description: LDAP fullname attribute
          example: name
        email:
          type: string
          description: LDAP email attribute
          example: mail
        phone:
          type: string
          description: LDAP phone attribute, only required for AlarmManagers
          example: telephoneNumber
        pin:
          type: string
          description: LDAP pin attribute
          example: pin
        rfid:
          type: string
          description: LDAP rfid attribute
          example: rfid
        description:
          type: string
          description: LDAP description attribute
          example: description
        emergency_access:
          type: string
          description: LDAP emergency access attribute
          example: emergency
        notifications:
          type: string
          description: LDAP attribute to describe if a user may receive notifications
          example: receives_notifications
        levelprofiles:
          type: string
          description: LDAP attribute to describe the accessprofiles of a user
          example: accessprofiles
        sync_interval:
          type: integer
          description: LDAP sync interval in seconds
          example: 3600
          enum:
            - 3600
            - 10800
            - 21600
            - 43200
            - 86400
    levelprofiles-names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of levelprofile name
        name:
          example: Levelprofile
          type: string
          description: Name of the levelprofile
    levelprofiles:
      type: object
      required:
        - id
        - name
      properties:
        id:
          example: 1
          type: integer
          description: Id of the levelprofile
        name:
          example: Levelprofile
          type: string
          description: Name of the levelprofile
        timeprofile:
          example: Timeprofile
          type: string
          description: Name of the timeprofile
    levelprofile-create:
      type: object
      properties:
        name:
          example: Levelprofile
          type: string
          description: Name of the levelprofile
        timeprofile_id:
          example: 1
          type: integer
          description: Id of the assigned timeprofile
        doorlocks:
          type: array
          description: Ids of the doorlocks
          items:
            type: integer
    levelprofile-get:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: Id of levelprofile
        name:
          example: Levelprofile
          type: string
          description: Name of the levelprofile
        timeprofile_id:
          example: 1
          type: integer
          description: Id of the assigned timeprofile
        doorlocks:
          type: array
          description: Id of the doorlocks
          items:
            type: integer
    levelprofile-model:
      type: object
      properties:
        name:
          example: Levelprofile
          type: string
          description: Name of the timeprofile
        timeprofile_id:
          example: 1
          type: integer
          description: Id of the timeprofile connected to the levelprofile
        doorlocks:
          type: array
          description: Id of the doorlocks
          items:
            type: integer
    email:
      type: object
      properties:
        is_active:
          example: true
          type: boolean
          description: Describes if mailing is active or not.
        sender:
          example: sender@mail.test
          type: string
          description: Sender email address
        address:
          example: smtp.mail.test
          type: string
          description: SMTP server address
        port:
          example: 587
          type: integer
          description: SMTP server port
        security:
          example: starttls
          type: string
          enum:
            - 'off'
            - starttls
            - ssl
          description: SMTP server security
        username:
          example: myusername
          type: string
          description: SMTP server username
        password:
          example: mypassword
          type: string
          description: SMTP server password
        signature:
          example: My signature
          type: string
          description: Email signature
    email-test:
      type: object
      properties:
        sender:
          example: sender@mail.test
          type: string
          description: Sender email address
        address:
          example: smtp.mail.test
          type: string
          description: SMTP server address
        port:
          example: 587
          type: integer
          description: SMTP server port
        security:
          example: starttls
          type: string
          enum:
            - 'off'
            - starttls
            - ssl
          description: SMTP server security
        username:
          example: myusername
          type: string
          description: SMTP server username
        password:
          example: mypassword
          type: string
          description: SMTP server password
        signature:
          example: My signature
          type: string
          description: Email signature
    massedit:
      type: object
      description: The data to massedit
      properties:
        ids:
          type: object
          description: An Object that contains all ids of the devices to be edited
          properties:
            devices:
              type: object
              description: >-
                An object that holds the device_id as key and the devicetype as
                value
              example:
                '1': 113
                '43': 110
                '69': 109
            phases:
              type: array
              description: An array that holds the ids of the phases to be edited
              items:
                type: integer
            ios:
              type: array
              description: An array that holds the ids of the ios to be edited
              items:
                type: integer
            racks:
              type: array
              description: An array that holds the ids of the racks to be edited
              items:
                type: integer
        fields:
          type: object
          description: >-
            An Object that contains all the fields and their values to be edited
            (Remember to properly layer the fields e.g. temerature and dewpoint
            have to be inside of monitoring)
          example:
            is_active: true
            monitoring:
              temperature:
                min: '3'
                max: '4'
            phases:
              voltage:
                assignment: armed-active
                min: '1'
                max: '2'
    multisensors:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: MultiSensor
          type: string
          description: The name of the device
        type:
          example: 1
          type: integer
          description: The type of the device
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        type_name:
          example: MultiSensor-RF
          type: string
          description: The name of the type
    multisensors_names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: MultiSensor
          type: string
          description: The name of the device
        type:
          example: 1
          type: integer
          description: The type of the device
    air_quality_config:
      type: object
      description: The configuration for the air_quality sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        max:
          example: 20
          type: integer
          description: The max threshold where an alarm is triggered
        warning:
          type: object
          properties:
            max:
              example: 15
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    co_config:
      type: object
      description: The configuration for the CO sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        threshold:
          example: 20
          type: integer
          description: The threshold where an alarm is triggered
        units:
          type: object
          properties:
            threshold:
              example: '%'
              type: string
              description: The unit for the threshold field
        warning:
          type: object
          properties:
            max:
              example: 15
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    motion_config:
      type: object
      description: The configuration for the motion sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        threshold:
          example: 30
          type: integer
          description: The threshold where an alarm is triggered
        units:
          type: object
          properties:
            threshold:
              example: '%'
              type: string
              description: The unit for the threshold field
    multisensors_id:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        device_id:
          example: 1
          type: integer
          description: the ID of the device this device is assigned to
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: MultiSensor
          type: string
          description: The name of the device
        description:
          example: MultiSensor main hall
          type: string
          description: The description of the device
        type:
          example: 1
          type: integer
          description: The type of the device
        type_name:
          example: MultiSensor-RF
          type: string
          description: The name of the type
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        alarmdelay:
          example: 10
          type: integer
          description: The amount of seconds an alarm will be delayed
        monitoring:
          type: object
          properties:
            temperature:
              type: object
              description: The configuration for the temperature sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                min:
                  example: 15
                  type: integer
                  description: The minimal threshold before an alarm is triggered
                max:
                  example: 25
                  type: integer
                  description: The maximum threshold before an alarm is triggered
                offset:
                  example: 2
                  type: integer
                  description: The offset applied to the value
                units:
                  type: object
                  properties:
                    min:
                      example: °C
                      type: string
                      description: The unit for the min field
                    max:
                      example: °C
                      type: string
                      description: The unit for the max field
                    offset:
                      example: °C
                      type: string
                      description: The unit for the offset field
                warning:
                  type: object
                  properties:
                    min:
                      example: 17
                      type: integer
                      description: The warning threshold for the min value
                    max:
                      example: 23
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            humidity:
              type: object
              description: The configuration for the humidity sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                min:
                  example: 40
                  type: integer
                  description: The minimal threshold before an alarm is triggered
                max:
                  example: 60
                  type: integer
                  description: The maximum threshold before an alarm is triggered
                units:
                  type: object
                  properties:
                    min:
                      example: '%'
                      type: string
                      description: The unit for the min field
                    max:
                      example: '%'
                      type: string
                      description: The unit for the max field
                warning:
                  type: object
                  properties:
                    min:
                      example: 45
                      type: integer
                      description: The warning threshold for the min value
                    max:
                      example: 55
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            dewpoint:
              type: object
              description: The configuration for the dewpoint sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                hysteresis:
                  example: 2
                  type: integer
                  description: The hysteresis threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    hysteresis:
                      example: °C
                      type: string
                      description: The unit for the hysteresis field
                warning:
                  type: object
                  properties:
                    max:
                      example: 1
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            air_quality:
              type: object
              description: The configuration for the air_quality sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 20
                  type: integer
                  description: The max threshold where an alarm is triggered
                warning:
                  type: object
                  properties:
                    max:
                      example: 15
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
          description: co2 and air_quality MultiSensorTI only
        fire:
          type: object
          properties:
            heat:
              type: object
              description: The configuration for the heat sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 4
                  type: integer
                  description: The threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    threshold:
                      example: °C/min
                      type: string
                      description: The unit for the threshold field
                warning:
                  type: object
                  properties:
                    max:
                      example: 2
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            co:
              type: object
              description: The configuration for the CO sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 20
                  type: integer
                  description: The threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    threshold:
                      example: '%'
                      type: string
                      description: The unit for the threshold field
                warning:
                  type: object
                  properties:
                    max:
                      example: 15
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            air_quality:
              type: object
              description: The configuration for the air_quality sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 20
                  type: integer
                  description: The max threshold where an alarm is triggered
                warning:
                  type: object
                  properties:
                    max:
                      example: 15
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
          description: air_quality MultiSensorTI only
        intrusion:
          type: object
          properties:
            vibration:
              type: object
              description: The configuration for the vibration sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                sensitivity:
                  example: medium
                  type: string
                  description: The sensitivity threshold where an alarm is triggered
            motion:
              type: object
              description: The configuration for the motion sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 30
                  type: integer
                  description: The threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    threshold:
                      example: '%'
                      type: string
                      description: The unit for the threshold field
            door_contact:
              type: object
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
              description: '[MultiSensor-Door only]'
        ir_color_mode:
          example: color
          type: string
          enum:
            - color
            - gray
          description: '[MultiSensor-TI only] The mode in which the data is given'
        ir_custom_range:
          example: true
          type: boolean
          description: '[MultiSensor-TI only] The flag, if a custom range is active'
        ir_distance:
          example: 250
          type: integer
          description: >-
            [MultiSensor-TI only] The distance between the device and the ground
            (in cm)
        ir_emissivity:
          example: '0.9499999999999999996'
          type: string
          description: '[MultiSensor-TI only] The emissivity'
        ir_max_value:
          example: 1500
          type: integer
          description: '[MultiSensor-TI only] The max value for scaling the temperature'
        ir_min_value:
          example: 1000
          type: integer
          description: '[MultiSensor-TI only] The min value for scaling the temperature'
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        rack_id:
          example: null
          type: integer
          description: The ID of the rack the device is assigned to
        external:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
            channel2:
              type: object
              description: The configuration for an digital input
              properties:
                alarm_when:
                  example: close
                  type: string
                  enum:
                    - close
                    - open
                  description: Configures on which state an alarm will be triggered
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                    - arm-disarm
                    - arm
                    - disarm
                  description: The alarm assignment
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >-
                    Determines if the alarmstate of this device is ignored
                    during arming
                description_alert:
                  example: Alarm
                  type: string
                  description: The description to be displayed when an alarm occurs
                description_ok:
                  example: OK
                  type: string
                  description: The description to be displayed when no alarm occurs
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                icon:
                  example: ethernet
                  type: string
                  description: The icon to be displayed
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: The type of input
        output:
          type: object
          properties:
            channel1:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
            channel2:
              type: object
              description: The configuration for an digital output
              properties:
                alarmdelay:
                  example: 10
                  type: integer
                  description: The amount of seconds an alarm will be delayed
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment
                group_id:
                  example: 1
                  type: integer
                  description: The ID of the group the device is assigned to
                id:
                  example: 2
                  type: integer
                  description: the ID of the device
                name:
                  example: External Input
                  type: string
                  description: The name of the device
                event_id:
                  example: 1
                  type: integer
                  description: The ID of the Eventprofile applied to this device
                output_time:
                  example: 1
                  type: integer
                  description: Determines how long this output will be opened on alarm
        webhooks:
          type: array
          description: The webhook relations of this device
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    network-sensors:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: Network-Sensor
          type: string
          description: The name of the device
        type:
          example: 142
          type: integer
          description: The type of the device
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
    network-sensors_names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: Network-Sensor
          type: string
          description: The name of the device
        type:
          example: 142
          type: integer
          description: The type of the device
    network-sensors_id:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: the ID of the device
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        type:
          example: 142
          type: integer
          description: The type of the device
        name:
          example: Network-Sensor
          type: string
          description: The name of the device
        address:
          example: 192.168.0.1
          type: string
          description: The address of the device
        port:
          example: 8080
          type: integer
          description: If service_type is port the monitored port is set here
        description:
          example: Network-Sensor Server1
          type: string
          description: The description of the device
        service_type:
          example: ping
          type: string
          enum:
            - ping
            - port
          description: The type of sensor
        service_interval:
          example: 180
          type: integer
          description: Interval in which the given server is checked
        protocol:
          example: http
          type: string
          enum:
            - http
            - https
          description: The protocol to be used
        alarmvalue:
          type: object
          properties:
            latency:
              type: object
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 100
                  type: integer
                  description: The max threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    max:
                      example: null
                      type: string
                      description: The unit for the max field
                warning:
                  type: object
                  properties:
                    max:
                      example: 80
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        rack_id:
          example: null
          type: integer
          description: The ID of the rack the device is assigned to
        webhooks:
          type: array
          description: The webhook relations of this device
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    network:
      type: object
      properties:
        dhcp_active:
          example: true
          type: boolean
          description: Describes if DHCP is active or not.
        dhcp_address:
          example: 192.168.100.224
          type: string
          description: DHCP IP address of the device.
        dhcp_netmask:
          example: 255.255.255.0
          type: string
          description: DHCP netmask of the device.
        static_active:
          example: false
          type: boolean
          description: Describes if static IP is active or not.
        static_address:
          example: 192.168.100.224
          type: string
          nullable: true
          description: Static IP address of the device.
        static_netmask:
          example: 255.255.255.0
          type: string
          description: Static netmask of the device.
        gateway:
          example: 192.168.100.1
          type: string
          description: Network gateway of the device.
        dns1:
          example: 192.168.100.1
          type: string
          description: Primary DNS server of the device.
        dns2:
          example: 192.168.100.2
          type: string
          description: Secondary DNS server of the device.
        dyndns_address:
          example: my-alarmmanager.internal.mycompany.com
          type: string
          description: Dynymic DNS address of the device.
        port_auth:
          description: IEEE 802.1X port authentication settings.
          type: object
          properties:
            is_active:
              example: true
              type: boolean
              description: Describes if IEEE 802.1X port authentication is enabled or not.
            method:
              example: eap-peap
              type: string
              enum:
                - eap-peap
              description: IEEE 802.1X port authentication method.
            identity:
              example: myusername
              type: string
              description: IEEE 802.1X port authentication identity.
            password:
              example: mypassword
              type: string
              description: IEEE 802.1X port authentication password.
            is_password_hashed:
              example: false
              type: boolean
              description: Describes if the given password is already hashed.
    passage-names:
      type: object
      properties:
        id:
          type: string
          description: The ID of the passage
        name:
          type: string
          description: The name of the passage.
        doorlocks:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the doorlock
              name:
                type: string
                description: The name of the doorlock.
        external:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the external input
              name:
                type: string
                description: The name of the external input.
    passage-get:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: ID of the passage
        name:
          type: string
          example: Passage Name
          description: Name of the passage
        doorlocks:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
                description: ID of the DoorLock
                example: 2
              device_id:
                type: number
                description: >-
                  ID of the DoorLock's host device, i.e. the device on which is
                  has been teached-in.
                example: 1
              is_active:
                type: boolean
                description: Describes if the DoorLock is active or inactive.
                example: true
              is_teachin_default:
                type: boolean
                description: >-
                  Describes if this DoorLock is preselected, when a RFID token
                  will be teached-id.
                example: false
              name:
                type: string
                description: Name of the DoorLock
                example: Frontdoor
              type:
                type: number
                description: Numerical devicetype
                example: 21
              signal_zonestate:
                type: boolean
                description: >-
                  Set true, if the DoorLock should show the current arm state of
                  the assigned alarmzone.
                example: false
              coupletime:
                example: 3
                type: number
                description: >-
                  Time in seconds after the booking while the door can be
                  opened.
              doubleauth_mode:
                example: 0
                type: number
                nullable: true
                description: >-
                  Mode for double authentication. 0=Off, 1=On, 2=Only when
                  arming/disarming, 3=time controlled via timeprofile.
              doubleauth_timeprofile_id:
                example: 0
                type: number
                nullable: true
                description: >-
                  ID of the timeprofile which shall be used to enable and
                  disable the double authentication on specific times.
              log_level:
                example: 1
                type: number
                description: >-
                  Sets the logbook logging mode for this DoorLock. 1=Default,
                  2=No user-related data (names, pictures), 3=Only unauthorized
                  bookings, 4=No logging.
              timeprofile_mode:
                example: 0
                type: number
                enum:
                  - 0
                  - 1
                  - 2
                description: >-
                  Mode for timeprofile usage. 0=Off, 1=On, 2=Open after first
                  booking within the time profile.
              timeprofile_id:
                type: number
                description: ID of the DoorLock's assigned timeprofile
                example: 2
              group_id:
                type: number
                description: ID of the DoorLock's assigned alarmgroup
                example: 2
              armlevel:
                example: 0
                type: number
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                description: >-
                  Set the arming level of this DoorLock. 0=Off, 1=Assigned
                  Alarmzone, 2=Building containing the assigned Alarmzone,
                  3=System, 4=External Alarmsystem.
              webhooks:
                type: array
                items:
                  type: integer
                description: IDs of all assigned webhooks.
              cameras:
                type: array
                items:
                  type: integer
                description: IDs of all assigned cameras.
              batterylevel:
                type: string
                description: Battery level of the DoorLock
                example: full
                enum:
                  - full
                  - half
                  - low
                  - critical
                  - wired
              reed_bypass_time:
                type: number
                description: >-
                  Time in seconds after the booking while the door can be opened
                  without reed contact alarming.
                example: 30
                enum:
                  - 0
                  - 5
                  - 10
                  - 15
                  - 30
                  - 45
                  - 60
                  - 90
                  - 120
              reed_bypass_buzzer_time:
                type: number
                description: >-
                  Time in seconds to buzzer after the bypass time and before
                  triggering the door contact alarm.
                example: 30
                enum:
                  - 0
                  - 5
                  - 10
                  - 15
                  - 30
                  - 45
                  - 60
                  - 90
                  - 120
              sabotage:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of the disassembly alarm.
              reed_source_id:
                type: number
                example: 'off'
                description: >-
                  API-ID of the external sensor, which is assigned to be the
                  doorlock's reed sensor.
              reed_assignment:
                type: string
                example: 'off'
                description: Alarm-Assignment for the assigned reed sensor.
              reed_delay:
                type: number
                example: 3600
                description: >-
                  If the reed sensor triggers an alarm, it will be delayed by
                  this time (in seconds).
              reed_warning_active:
                type: boolean
                example: true
                description: >-
                  Enables signaling on the DoorLock if the door is open for the
                  set time (in seconds). The signaling will stop when the door
                  is closed again.
              reed_warning_delay:
                type: number
                example: 1800
                description: >-
                  The door must stay open for the set time to start the
                  signalization.
        external:
          type: array
          items:
            type: object
            description: The configuration for an digital input
            properties:
              alarm_when:
                example: close
                type: string
                enum:
                  - close
                  - open
                description: Configures on which state an alarm will be triggered
              alarmdelay:
                example: 10
                type: integer
                description: The amount of seconds an alarm will be delayed
              assignment:
                example: always-active
                type: string
                enum:
                  - 'off'
                  - always-active
                  - armed-active
                  - fire
                  - sabotage
                  - display
                  - system
                  - arm-disarm
                  - arm
                  - disarm
                description: The alarm assignment
              can_alwaysarm:
                example: false
                type: boolean
                description: >-
                  Determines if the alarmstate of this device is ignored during
                  arming
              description_alert:
                example: Alarm
                type: string
                description: The description to be displayed when an alarm occurs
              description_ok:
                example: OK
                type: string
                description: The description to be displayed when no alarm occurs
              group_id:
                example: 1
                type: integer
                description: The ID of the group the device is assigned to
              icon:
                example: ethernet
                type: string
                description: The icon to be displayed
              id:
                example: 2
                type: integer
                description: the ID of the device
              name:
                example: External Input
                type: string
                description: The name of the device
              input_type:
                example: default
                type: string
                enum:
                  - default
                  - door
                  - leakage
                description: The type of input
    passage-patch:
      type: object
      properties:
        name:
          type: string
          example: Passage Name
          description: Name of the passage
        doorlocks:
          type: array
          items:
            type: integer
            description: ID of an assigned doorlock
        external:
          type: array
          items:
            type: integer
            description: ID of an assigned external input
    passage-list:
      type: object
      properties:
        id:
          type: integer
          description: ID of the passage
        name:
          type: string
          description: Name of the passage
    powermanagers-names:
      type: object
      properties:
        id:
          example: 0
          type: integer
          description: Id of the Powermanager.
        name:
          example: KentixPDU
          type: string
          description: Name of the Powermanager.
        type:
          example: 109
          type: integer
          description: Type of the Powermanager.
    powermanagers:
      type: object
      properties:
        id:
          example: 2
          type: integer
          description: Describes the ID of the Powermanager.
        name:
          example: KentixPDU
          type: string
          description: Describes the name of the Powermanager.
        type:
          example: 109
          type: integer
          description: Type of the Powermanager.
        is_active:
          example: true
          type: boolean
          description: Describes if the Powermanager is active.
        address:
          example: 192.168.100.226
          type: string
          description: IP address of the Powermanager.
        group_id:
          example: 1
          type: integer
          description: Indicates the alarmgroup of the Powermanager.
    synchronicity_config:
      type: object
      description: The configuration for the synchronicity sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        threshold:
          example: 20
          type: integer
          description: The max threshold where an alarm is triggered
        max:
          example: 5
          type: integer
          description: The max threshold where an alarm is triggered
        units:
          type: object
          properties:
            max:
              example: '%'
              type: string
              description: The unit for the max field
            threshold:
              example: W
              type: string
              description: The unit for the threshold field
        warning:
          type: object
          properties:
            max:
              example: 3
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    monitoring_powermanager:
      type: object
      description: Only for kmpdu
      properties:
        temperature:
          type: object
          description: The configuration for the temperature sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            min:
              example: 15
              type: integer
              description: The minimal threshold before an alarm is triggered
            max:
              example: 25
              type: integer
              description: The maximum threshold before an alarm is triggered
            offset:
              example: 2
              type: integer
              description: The offset applied to the value
            units:
              type: object
              properties:
                min:
                  example: °C
                  type: string
                  description: The unit for the min field
                max:
                  example: °C
                  type: string
                  description: The unit for the max field
                offset:
                  example: °C
                  type: string
                  description: The unit for the offset field
            warning:
              type: object
              properties:
                min:
                  example: 17
                  type: integer
                  description: The warning threshold for the min value
                max:
                  example: 23
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        humidity:
          type: object
          description: The configuration for the humidity sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            min:
              example: 40
              type: integer
              description: The minimal threshold before an alarm is triggered
            max:
              example: 60
              type: integer
              description: The maximum threshold before an alarm is triggered
            units:
              type: object
              properties:
                min:
                  example: '%'
                  type: string
                  description: The unit for the min field
                max:
                  example: '%'
                  type: string
                  description: The unit for the max field
            warning:
              type: object
              properties:
                min:
                  example: 45
                  type: integer
                  description: The warning threshold for the min value
                max:
                  example: 55
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        dewpoint:
          type: object
          description: The configuration for the dewpoint sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            hysteresis:
              example: 2
              type: integer
              description: The hysteresis threshold where an alarm is triggered
            units:
              type: object
              properties:
                hysteresis:
                  example: °C
                  type: string
                  description: The unit for the hysteresis field
            warning:
              type: object
              properties:
                max:
                  example: 1
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        air_quality:
          type: object
          description: The configuration for the air_quality sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            max:
              example: 20
              type: integer
              description: The max threshold where an alarm is triggered
            warning:
              type: object
              properties:
                max:
                  example: 15
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
    fire_powermanager:
      type: object
      description: Only for kmpdu
      properties:
        heat:
          type: object
          description: The configuration for the heat sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            threshold:
              example: 4
              type: integer
              description: The threshold where an alarm is triggered
            units:
              type: object
              properties:
                threshold:
                  example: °C/min
                  type: string
                  description: The unit for the threshold field
            warning:
              type: object
              properties:
                max:
                  example: 2
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        co:
          type: object
          description: The configuration for the CO sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            threshold:
              example: 20
              type: integer
              description: The threshold where an alarm is triggered
            units:
              type: object
              properties:
                threshold:
                  example: '%'
                  type: string
                  description: The unit for the threshold field
            warning:
              type: object
              properties:
                max:
                  example: 15
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        air_quality:
          type: object
          description: The configuration for the air_quality sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            max:
              example: 20
              type: integer
              description: The max threshold where an alarm is triggered
            warning:
              type: object
              properties:
                max:
                  example: 15
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
    rcm_powermanager:
      type: object
      description: Only for kmpdu
      properties:
        ac:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 30
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                max:
                  example: mA
                  type: string
                  description: The unit for the max field.
            warning:
              type: object
              properties:
                active:
                  example: false
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
                max:
                  example: 20
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
        dc:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 30
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                max:
                  example: mA
                  type: string
                  description: The unit for the max field.
            warning:
              type: object
              properties:
                active:
                  example: false
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
                max:
                  example: 20
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
    modbus_config:
      type: object
      properties:
        active:
          example: true
          type: boolean
          description: If the modbus is active.
        register:
          example: '2530'
          type: string
          description: >-
            Address of the register from which the respective value should be
            read.
        factor:
          example: '1.0'
          type: string
          description: Conversion factor for the respective value.
        datatype:
          example: float_be
          type: string
          enum:
            - int8
            - int16
            - int32
            - int64
            - uint8
            - uint16
            - uint32
            - uint64
            - float_le
            - float_be
          description: Type and size of the respective value.
    voltage_modbus_config:
      type: object
      description: The configuration for the voltage sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        min:
          example: 0
          type: integer
          description: The min threshold where an alarm is triggered.
        max:
          example: 240
          type: integer
          description: The max threshold where an alarm is triggered.
        units:
          type: object
          properties:
            min:
              example: V
              type: string
              description: The unit for the min field.
            max:
              example: V
              type: string
              description: The unit for the max field.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
        warning:
          type: object
          properties:
            min:
              example: 100
              type: integer
              nullable: true
              description: The warning threshold for the min value.
            max:
              example: 200
              type: integer
              nullable: true
              description: The warning threshold for the max value.
            active:
              example: false
              type: boolean
              description: The flag to determine if warnings should be triggered.
    current_modbus_config:
      type: object
      description: The configuration for the current sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        min:
          example: 0
          type: integer
          description: The min threshold where an alarm is triggered.
        max:
          example: 10
          type: integer
          description: The max threshold where an alarm is triggered.
        units:
          type: object
          properties:
            min:
              example: A
              type: string
              description: The unit for the min field.
            max:
              example: A
              type: string
              description: The unit for the max field.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
        warning:
          type: object
          properties:
            min:
              example: 100
              type: integer
              nullable: true
              description: The warning threshold for the min value.
            max:
              example: 200
              type: integer
              nullable: true
              description: The warning threshold for the max value.
            active:
              example: false
              type: boolean
              description: The flag to determine if warnings should be triggered.
    frequency_modbus_config:
      type: object
      description: The configuration for the frequency sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        max:
          example: 1
          type: integer
          description: The max threshold where an alarm is triggered.
        refernce:
          example: 50
          type: integer
          description: ''
        units:
          type: object
          properties:
            max:
              example: Hz
              type: string
              description: The unit for the max field.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
        warning:
          type: object
          properties:
            max:
              example: 15000
              type: integer
              nullable: true
              description: The warning threshold for the max value.
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered.
    activepower_modbus_config:
      type: object
      description: The configuration for the activepower sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        max:
          example: 20000
          type: integer
          description: The max threshold where an alarm is triggered.
        units:
          type: object
          properties:
            max:
              example: W
              type: string
              description: The unit for the max field.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
        warning:
          type: object
          properties:
            max:
              example: 15000
              type: integer
              nullable: true
              description: The warning threshold for the max value.
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered.
    apparentpower_modbus_config:
      type: object
      description: The configuration for the apparentpower sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        max:
          example: 2300
          type: integer
          description: The max threshold where an alarm is triggered.
        units:
          type: object
          properties:
            max:
              example: VA
              type: string
              description: The unit for the max field.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
        warning:
          type: object
          properties:
            max:
              example: 1500
              type: integer
              nullable: true
              description: The warning threshold for the max value.
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered.
    reactivepower_modbus_config:
      type: object
      description: The configuration for the reactivepower sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        max:
          example: 2300
          type: integer
          description: The max threshold where an alarm is triggered.
        units:
          type: object
          properties:
            max:
              example: var
              type: string
              description: The unit for the max field.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
        warning:
          type: object
          properties:
            max:
              example: 1500
              type: integer
              nullable: true
              description: The warning threshold for the max value.
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered.
    assignment_modbus_config:
      type: object
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
    fuse_modbus_config:
      type: object
      description: The configuration for the fuse
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        max:
          example: 1
          type: integer
          nullable: true
          description: The max threshold where an alarm is triggered.
        modbus:
          type: object
          properties:
            active:
              example: true
              type: boolean
              description: If the modbus is active.
            register:
              example: '2530'
              type: string
              description: >-
                Address of the register from which the respective value should
                be read.
            factor:
              example: '1.0'
              type: string
              description: Conversion factor for the respective value.
            datatype:
              example: float_be
              type: string
              enum:
                - int8
                - int16
                - int32
                - int64
                - uint8
                - uint16
                - uint32
                - uint64
                - float_le
                - float_be
              description: Type and size of the respective value.
    phases_config:
      type: object
      properties:
        id:
          example: 3
          type: integer
          description: Id of the phase.
        number:
          example: 1
          type: integer
          description: Number of the phase.
        name:
          example: L1
          type: string
          description: Name of the phase.
        address:
          example: 1
          type: integer
          nullable: true
          description: Address of the phase.
        invoice_group_id:
          example: null
          type: integer
          nullable: true
          description: Connected invoice.
        voltage:
          type: object
          description: The configuration for the voltage sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            min:
              example: 0
              type: integer
              description: The min threshold where an alarm is triggered.
            max:
              example: 240
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                min:
                  example: V
                  type: string
                  description: The unit for the min field.
                max:
                  example: V
                  type: string
                  description: The unit for the max field.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
            warning:
              type: object
              properties:
                min:
                  example: 100
                  type: integer
                  nullable: true
                  description: The warning threshold for the min value.
                max:
                  example: 200
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
                active:
                  example: false
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
        current:
          type: object
          description: The configuration for the current sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            min:
              example: 0
              type: integer
              description: The min threshold where an alarm is triggered.
            max:
              example: 10
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                min:
                  example: A
                  type: string
                  description: The unit for the min field.
                max:
                  example: A
                  type: string
                  description: The unit for the max field.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
            warning:
              type: object
              properties:
                min:
                  example: 100
                  type: integer
                  nullable: true
                  description: The warning threshold for the min value.
                max:
                  example: 200
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
                active:
                  example: false
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
        frequency:
          type: object
          description: The configuration for the frequency sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 1
              type: integer
              description: The max threshold where an alarm is triggered.
            refernce:
              example: 50
              type: integer
              description: ''
            units:
              type: object
              properties:
                max:
                  example: Hz
                  type: string
                  description: The unit for the max field.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
            warning:
              type: object
              properties:
                max:
                  example: 15000
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
        activepower:
          type: object
          description: The configuration for the activepower sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 20000
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                max:
                  example: W
                  type: string
                  description: The unit for the max field.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
            warning:
              type: object
              properties:
                max:
                  example: 15000
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
        apparentpower:
          type: object
          description: The configuration for the apparentpower sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 2300
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                max:
                  example: VA
                  type: string
                  description: The unit for the max field.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
            warning:
              type: object
              properties:
                max:
                  example: 1500
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
        reactivepower:
          type: object
          description: The configuration for the reactivepower sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 2300
              type: integer
              description: The max threshold where an alarm is triggered.
            units:
              type: object
              properties:
                max:
                  example: var
                  type: string
                  description: The unit for the max field.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
            warning:
              type: object
              properties:
                max:
                  example: 1500
                  type: integer
                  nullable: true
                  description: The warning threshold for the max value.
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered.
        powerfactor:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
        consumption:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
        fuse:
          type: object
          description: The configuration for the fuse
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            max:
              example: 1
              type: integer
              nullable: true
              description: The max threshold where an alarm is triggered.
            modbus:
              type: object
              properties:
                active:
                  example: true
                  type: boolean
                  description: If the modbus is active.
                register:
                  example: '2530'
                  type: string
                  description: >-
                    Address of the register from which the respective value
                    should be read.
                factor:
                  example: '1.0'
                  type: string
                  description: Conversion factor for the respective value.
                datatype:
                  example: float_be
                  type: string
                  enum:
                    - int8
                    - int16
                    - int32
                    - int64
                    - uint8
                    - uint16
                    - uint32
                    - uint64
                    - float_le
                    - float_be
                  description: Type and size of the respective value.
    output_channel_powermanager:
      type: object
      properties:
        id:
          example: 37
          type: integer
          description: Id of the channel.
        assignment:
          example: 'off'
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        name:
          example: Input 1
          type: string
          description: Name of the channel.
        alarmdelay:
          example: 1
          type: integer
          description: Delay time after which an alarm is triggered.
        output_time:
          example: 'off'
          type: string
          enum:
            - 'off'
            - continuous
            - '1'
            - '3'
            - '10'
            - '20'
            - '30'
            - '60'
            - '120'
            - '300'
            - '600'
            - '1200'
            - '1800'
            - '3600'
          description: Determines how long this output will be opened on alarm.
        event_id:
          example: 1
          type: integer
          nullable: true
          description: >-
            Describes the event that should be used. Must be an Id of an
            existing event.
        group_id:
          example: 2
          type: integer
          description: The ID of the group the device is assigned to.
    output_powermanager:
      type: object
      properties:
        channel1:
          type: object
          properties:
            id:
              example: 37
              type: integer
              description: Id of the channel.
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            name:
              example: Input 1
              type: string
              description: Name of the channel.
            alarmdelay:
              example: 1
              type: integer
              description: Delay time after which an alarm is triggered.
            output_time:
              example: 'off'
              type: string
              enum:
                - 'off'
                - continuous
                - '1'
                - '3'
                - '10'
                - '20'
                - '30'
                - '60'
                - '120'
                - '300'
                - '600'
                - '1200'
                - '1800'
                - '3600'
              description: Determines how long this output will be opened on alarm.
            event_id:
              example: 1
              type: integer
              nullable: true
              description: >-
                Describes the event that should be used. Must be an Id of an
                existing event.
            group_id:
              example: 2
              type: integer
              description: The ID of the group the device is assigned to.
        channel2:
          type: object
          properties:
            id:
              example: 37
              type: integer
              description: Id of the channel.
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            name:
              example: Input 1
              type: string
              description: Name of the channel.
            alarmdelay:
              example: 1
              type: integer
              description: Delay time after which an alarm is triggered.
            output_time:
              example: 'off'
              type: string
              enum:
                - 'off'
                - continuous
                - '1'
                - '3'
                - '10'
                - '20'
                - '30'
                - '60'
                - '120'
                - '300'
                - '600'
                - '1200'
                - '1800'
                - '3600'
              description: Determines how long this output will be opened on alarm.
            event_id:
              example: 1
              type: integer
              nullable: true
              description: >-
                Describes the event that should be used. Must be an Id of an
                existing event.
            group_id:
              example: 2
              type: integer
              description: The ID of the group the device is assigned to.
    powermanager:
      type: object
      properties:
        id:
          example: 2
          type: integer
          readOnly: true
          description: Id of the Powermanager.
        name:
          example: KentixPDU
          type: string
          description: Name of the Powermanager.
        type:
          example: 109
          type: integer
          description: Type of the Powermanager.
        group_id:
          example: 1
          type: integer
          nullable: true
          description: Indicates the alarmgroup of the Powermanager.
        is_active:
          example: true
          type: boolean
          description: Describes if the Powermanager is active.
        address:
          example: 192.168.100.226
          type: string
          description: IP address of the Powermanager.
        synchronicity:
          allOf:
            - type: object
              description: The configuration for the synchronicity sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 20
                  type: integer
                  description: The max threshold where an alarm is triggered
                max:
                  example: 5
                  type: integer
                  description: The max threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    max:
                      example: '%'
                      type: string
                      description: The unit for the max field
                    threshold:
                      example: W
                      type: string
                      description: The unit for the threshold field
                warning:
                  type: object
                  properties:
                    max:
                      example: 3
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            - description: Only for SmartPDU
        supplyline:
          description: Configures to which supplyline the device is connected.
          type: string
          oneOf:
            - title: a
              description: Device is connected to supplyline A.
            - title: b
              description: Device is connected to supplyline B.
            - title: ab
              description: Device is connected to both supplylines A and B.
        monitoring:
          type: object
          description: Only for kmpdu
          properties:
            temperature:
              type: object
              description: The configuration for the temperature sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                min:
                  example: 15
                  type: integer
                  description: The minimal threshold before an alarm is triggered
                max:
                  example: 25
                  type: integer
                  description: The maximum threshold before an alarm is triggered
                offset:
                  example: 2
                  type: integer
                  description: The offset applied to the value
                units:
                  type: object
                  properties:
                    min:
                      example: °C
                      type: string
                      description: The unit for the min field
                    max:
                      example: °C
                      type: string
                      description: The unit for the max field
                    offset:
                      example: °C
                      type: string
                      description: The unit for the offset field
                warning:
                  type: object
                  properties:
                    min:
                      example: 17
                      type: integer
                      description: The warning threshold for the min value
                    max:
                      example: 23
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            humidity:
              type: object
              description: The configuration for the humidity sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                min:
                  example: 40
                  type: integer
                  description: The minimal threshold before an alarm is triggered
                max:
                  example: 60
                  type: integer
                  description: The maximum threshold before an alarm is triggered
                units:
                  type: object
                  properties:
                    min:
                      example: '%'
                      type: string
                      description: The unit for the min field
                    max:
                      example: '%'
                      type: string
                      description: The unit for the max field
                warning:
                  type: object
                  properties:
                    min:
                      example: 45
                      type: integer
                      description: The warning threshold for the min value
                    max:
                      example: 55
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            dewpoint:
              type: object
              description: The configuration for the dewpoint sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                hysteresis:
                  example: 2
                  type: integer
                  description: The hysteresis threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    hysteresis:
                      example: °C
                      type: string
                      description: The unit for the hysteresis field
                warning:
                  type: object
                  properties:
                    max:
                      example: 1
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            air_quality:
              type: object
              description: The configuration for the air_quality sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 20
                  type: integer
                  description: The max threshold where an alarm is triggered
                warning:
                  type: object
                  properties:
                    max:
                      example: 15
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
        fire:
          type: object
          description: Only for kmpdu
          properties:
            heat:
              type: object
              description: The configuration for the heat sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 4
                  type: integer
                  description: The threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    threshold:
                      example: °C/min
                      type: string
                      description: The unit for the threshold field
                warning:
                  type: object
                  properties:
                    max:
                      example: 2
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            co:
              type: object
              description: The configuration for the CO sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                threshold:
                  example: 20
                  type: integer
                  description: The threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    threshold:
                      example: '%'
                      type: string
                      description: The unit for the threshold field
                warning:
                  type: object
                  properties:
                    max:
                      example: 15
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            air_quality:
              type: object
              description: The configuration for the air_quality sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 20
                  type: integer
                  description: The max threshold where an alarm is triggered
                warning:
                  type: object
                  properties:
                    max:
                      example: 15
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
        intrusion:
          type: object
          description: Only for kmpdu
          properties:
            vibration:
              type: object
              description: The configuration for the vibration sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                sensitivity:
                  example: medium
                  type: string
                  description: The sensitivity threshold where an alarm is triggered
        meter_type:
          example: '0'
          type: integer
          description: >-
            Configures if and how the device will be taken into account on PUE
            calculation and summation.
          oneOf:
            - title: '0'
              description: No PUE measurement or summation.
            - title: '1'
              description: >-
                Device is a Sub meter and will be taken into account for PUE and
                summation
            - title: '2'
              description: >-
                Device is a Main meter. Main meters will be ignored on
                summations.
        uses_signed_integers:
          example: 1
          type: integer
          description: Determines the prefix display. Only for SmartPDU
        rcm_serial:
          example: ''
          type: string
          nullable: true
          description: Describes the serial of the RCM. Only for SmartPDU
        rcm_address:
          example: '100'
          type: string
          description: Describes the address of the RCM. Only for SmartPDU
        rcm:
          type: object
          description: Only for kmpdu
          properties:
            ac:
              type: object
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                max:
                  example: 30
                  type: integer
                  description: The max threshold where an alarm is triggered.
                units:
                  type: object
                  properties:
                    max:
                      example: mA
                      type: string
                      description: The unit for the max field.
                warning:
                  type: object
                  properties:
                    active:
                      example: false
                      type: boolean
                      description: The flag to determine if warnings should be triggered.
                    max:
                      example: 20
                      type: integer
                      nullable: true
                      description: The warning threshold for the max value.
            dc:
              type: object
              properties:
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                max:
                  example: 30
                  type: integer
                  description: The max threshold where an alarm is triggered.
                units:
                  type: object
                  properties:
                    max:
                      example: mA
                      type: string
                      description: The unit for the max field.
                warning:
                  type: object
                  properties:
                    active:
                      example: false
                      type: boolean
                      description: The flag to determine if warnings should be triggered.
                    max:
                      example: 20
                      type: integer
                      nullable: true
                      description: The warning threshold for the max value.
        phases:
          type: array
          description: Only for SmartPDU
          items:
            type: object
            properties:
              id:
                example: 3
                type: integer
                description: Id of the phase.
              number:
                example: 1
                type: integer
                description: Number of the phase.
              name:
                example: L1
                type: string
                description: Name of the phase.
              address:
                example: 1
                type: integer
                nullable: true
                description: Address of the phase.
              invoice_group_id:
                example: null
                type: integer
                nullable: true
                description: Connected invoice.
              voltage:
                type: object
                description: The configuration for the voltage sensor
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  min:
                    example: 0
                    type: integer
                    description: The min threshold where an alarm is triggered.
                  max:
                    example: 240
                    type: integer
                    description: The max threshold where an alarm is triggered.
                  units:
                    type: object
                    properties:
                      min:
                        example: V
                        type: string
                        description: The unit for the min field.
                      max:
                        example: V
                        type: string
                        description: The unit for the max field.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
                  warning:
                    type: object
                    properties:
                      min:
                        example: 100
                        type: integer
                        nullable: true
                        description: The warning threshold for the min value.
                      max:
                        example: 200
                        type: integer
                        nullable: true
                        description: The warning threshold for the max value.
                      active:
                        example: false
                        type: boolean
                        description: The flag to determine if warnings should be triggered.
              current:
                type: object
                description: The configuration for the current sensor
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  min:
                    example: 0
                    type: integer
                    description: The min threshold where an alarm is triggered.
                  max:
                    example: 10
                    type: integer
                    description: The max threshold where an alarm is triggered.
                  units:
                    type: object
                    properties:
                      min:
                        example: A
                        type: string
                        description: The unit for the min field.
                      max:
                        example: A
                        type: string
                        description: The unit for the max field.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
                  warning:
                    type: object
                    properties:
                      min:
                        example: 100
                        type: integer
                        nullable: true
                        description: The warning threshold for the min value.
                      max:
                        example: 200
                        type: integer
                        nullable: true
                        description: The warning threshold for the max value.
                      active:
                        example: false
                        type: boolean
                        description: The flag to determine if warnings should be triggered.
              frequency:
                type: object
                description: The configuration for the frequency sensor
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  max:
                    example: 1
                    type: integer
                    description: The max threshold where an alarm is triggered.
                  refernce:
                    example: 50
                    type: integer
                    description: ''
                  units:
                    type: object
                    properties:
                      max:
                        example: Hz
                        type: string
                        description: The unit for the max field.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
                  warning:
                    type: object
                    properties:
                      max:
                        example: 15000
                        type: integer
                        nullable: true
                        description: The warning threshold for the max value.
                      active:
                        example: true
                        type: boolean
                        description: The flag to determine if warnings should be triggered.
              activepower:
                type: object
                description: The configuration for the activepower sensor
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  max:
                    example: 20000
                    type: integer
                    description: The max threshold where an alarm is triggered.
                  units:
                    type: object
                    properties:
                      max:
                        example: W
                        type: string
                        description: The unit for the max field.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
                  warning:
                    type: object
                    properties:
                      max:
                        example: 15000
                        type: integer
                        nullable: true
                        description: The warning threshold for the max value.
                      active:
                        example: true
                        type: boolean
                        description: The flag to determine if warnings should be triggered.
              apparentpower:
                type: object
                description: The configuration for the apparentpower sensor
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  max:
                    example: 2300
                    type: integer
                    description: The max threshold where an alarm is triggered.
                  units:
                    type: object
                    properties:
                      max:
                        example: VA
                        type: string
                        description: The unit for the max field.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
                  warning:
                    type: object
                    properties:
                      max:
                        example: 1500
                        type: integer
                        nullable: true
                        description: The warning threshold for the max value.
                      active:
                        example: true
                        type: boolean
                        description: The flag to determine if warnings should be triggered.
              reactivepower:
                type: object
                description: The configuration for the reactivepower sensor
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  max:
                    example: 2300
                    type: integer
                    description: The max threshold where an alarm is triggered.
                  units:
                    type: object
                    properties:
                      max:
                        example: var
                        type: string
                        description: The unit for the max field.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
                  warning:
                    type: object
                    properties:
                      max:
                        example: 1500
                        type: integer
                        nullable: true
                        description: The warning threshold for the max value.
                      active:
                        example: true
                        type: boolean
                        description: The flag to determine if warnings should be triggered.
              powerfactor:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
              consumption:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
              fuse:
                type: object
                description: The configuration for the fuse
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  max:
                    example: 1
                    type: integer
                    nullable: true
                    description: The max threshold where an alarm is triggered.
                  modbus:
                    type: object
                    properties:
                      active:
                        example: true
                        type: boolean
                        description: If the modbus is active.
                      register:
                        example: '2530'
                        type: string
                        description: >-
                          Address of the register from which the respective
                          value should be read.
                      factor:
                        example: '1.0'
                        type: string
                        description: Conversion factor for the respective value.
                      datatype:
                        example: float_be
                        type: string
                        enum:
                          - int8
                          - int16
                          - int32
                          - int64
                          - uint8
                          - uint16
                          - uint32
                          - uint64
                          - float_le
                          - float_be
                        description: Type and size of the respective value.
        rack_id:
          example: 1
          type: integer
          description: Rack Id which the Powermanager belongs to.
        webhooks:
          type: array
          items:
            type: integer
          description: IDs of all assigned webhooks.
        external:
          type: object
          properties:
            channel1:
              type: object
              properties:
                id:
                  example: 37
                  type: integer
                  description: Id of the channel.
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                name:
                  example: Input 1
                  type: string
                  description: Name of the channel.
                alarm_when:
                  example: open
                  type: string
                  enum:
                    - open
                    - close
                  description: Indicates when the channel should alarm.
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: Describes the input type of the channel.
                alarmdelay:
                  example: 1
                  type: integer
                  description: Delay time after which an alarm is triggered.
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >
                    Describes if the status of external contacts should be
                    ignored during arming.

                    This is useful if e.g. a magnetic door contact must be
                    opened during the arming phase.
                icon:
                  example: ethernet
                  type: string
                  enum:
                    - power-off
                    - times-circle
                    - plus-circle
                    - minus-circle
                    - cogs
                    - trash
                    - save
                    - ethernet
                    - chart-network
                    - network-wired
                    - sitemap
                    - server
                    - hdd
                    - router
                    - wifi
                    - signal
                    - sensor
                    - sensor-on
                    - sensor-alert
                    - thermometer-half
                    - lungs
                    - tint
                    - humidity
                    - dewpoint
                    - raindrops
                    - water
                    - air-conditioner
                    - braille
                    - fire
                    - fire-alt
                    - burn
                    - fire-smoke
                    - cloud
                    - sensor-fire
                    - lungs
                    - mask
                    - user-secret
                    - running
                    - hammer
                    - tools
                    - signal-stream
                    - house-damage
                    - key
                    - door-open
                    - door-closed
                    - garage
                    - cctv
                    - video
                    - fingerprint
                    - bolt
                    - plug
                    - lambda
                    - charging-station
                    - battery-full
                    - battery-empty
                    - car-battery
                  description: Icon of the sensor.
                description_ok:
                  example: OK
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has no errors.
                description_alert:
                  example: Alert
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has errors.
                group_id:
                  example: 2
                  type: integer
                  description: The ID of the group the device is assigned to.
            channel2:
              type: object
              properties:
                id:
                  example: 37
                  type: integer
                  description: Id of the channel.
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                name:
                  example: Input 1
                  type: string
                  description: Name of the channel.
                alarm_when:
                  example: open
                  type: string
                  enum:
                    - open
                    - close
                  description: Indicates when the channel should alarm.
                input_type:
                  example: default
                  type: string
                  enum:
                    - default
                    - door
                    - leakage
                  description: Describes the input type of the channel.
                alarmdelay:
                  example: 1
                  type: integer
                  description: Delay time after which an alarm is triggered.
                can_alwaysarm:
                  example: false
                  type: boolean
                  description: >
                    Describes if the status of external contacts should be
                    ignored during arming.

                    This is useful if e.g. a magnetic door contact must be
                    opened during the arming phase.
                icon:
                  example: ethernet
                  type: string
                  enum:
                    - power-off
                    - times-circle
                    - plus-circle
                    - minus-circle
                    - cogs
                    - trash
                    - save
                    - ethernet
                    - chart-network
                    - network-wired
                    - sitemap
                    - server
                    - hdd
                    - router
                    - wifi
                    - signal
                    - sensor
                    - sensor-on
                    - sensor-alert
                    - thermometer-half
                    - lungs
                    - tint
                    - humidity
                    - dewpoint
                    - raindrops
                    - water
                    - air-conditioner
                    - braille
                    - fire
                    - fire-alt
                    - burn
                    - fire-smoke
                    - cloud
                    - sensor-fire
                    - lungs
                    - mask
                    - user-secret
                    - running
                    - hammer
                    - tools
                    - signal-stream
                    - house-damage
                    - key
                    - door-open
                    - door-closed
                    - garage
                    - cctv
                    - video
                    - fingerprint
                    - bolt
                    - plug
                    - lambda
                    - charging-station
                    - battery-full
                    - battery-empty
                    - car-battery
                  description: Icon of the sensor.
                description_ok:
                  example: OK
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has no errors.
                description_alert:
                  example: Alert
                  type: string
                  nullable: true
                  description: This text will be showed if the channel has errors.
                group_id:
                  example: 2
                  type: integer
                  description: The ID of the group the device is assigned to.
        output:
          type: object
          properties:
            channel1:
              type: object
              properties:
                id:
                  example: 37
                  type: integer
                  description: Id of the channel.
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                name:
                  example: Input 1
                  type: string
                  description: Name of the channel.
                alarmdelay:
                  example: 1
                  type: integer
                  description: Delay time after which an alarm is triggered.
                output_time:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - continuous
                    - '1'
                    - '3'
                    - '10'
                    - '20'
                    - '30'
                    - '60'
                    - '120'
                    - '300'
                    - '600'
                    - '1200'
                    - '1800'
                    - '3600'
                  description: Determines how long this output will be opened on alarm.
                event_id:
                  example: 1
                  type: integer
                  nullable: true
                  description: >-
                    Describes the event that should be used. Must be an Id of an
                    existing event.
                group_id:
                  example: 2
                  type: integer
                  description: The ID of the group the device is assigned to.
            channel2:
              type: object
              properties:
                id:
                  example: 37
                  type: integer
                  description: Id of the channel.
                assignment:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor.
                name:
                  example: Input 1
                  type: string
                  description: Name of the channel.
                alarmdelay:
                  example: 1
                  type: integer
                  description: Delay time after which an alarm is triggered.
                output_time:
                  example: 'off'
                  type: string
                  enum:
                    - 'off'
                    - continuous
                    - '1'
                    - '3'
                    - '10'
                    - '20'
                    - '30'
                    - '60'
                    - '120'
                    - '300'
                    - '600'
                    - '1200'
                    - '1800'
                    - '3600'
                  description: Determines how long this output will be opened on alarm.
                event_id:
                  example: 1
                  type: integer
                  nullable: true
                  description: >-
                    Describes the event that should be used. Must be an Id of an
                    existing event.
                group_id:
                  example: 2
                  type: integer
                  description: The ID of the group the device is assigned to.
        connection:
          type: object
          properties:
            assignment:
              example: 'off'
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of the connection
            warning:
              type: object
              properties:
                active:
                  type: boolean
                  example: true
                  description: >-
                    Configures whether connection issues should be displayed as
                    a warning instead of an alarm
    pdu_subgroup_powermanager:
      type: object
      properties:
        id:
          example: 9
          type: integer
          description: Id of the PDU subgroup.
        name:
          example: '1'
          type: string
          description: Name of the PDU subgroup.
        description:
          example: ''
          type: string
          description: Description of the PDU subgroup
    assignment_value_status_config:
      type: object
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor.
        value:
          example: '50.02'
          type: string
          nullable: true
          description: The value of this sensor
        status:
          example: ok
          type: string
          enum:
            - ok
            - warning
            - alarm
            - inactive
          description: The status of this sensor
    phase_powermanager:
      type: object
      properties:
        id:
          example: 3
          type: integer
          description: Id of the phase.
        number:
          example: 1
          type: integer
          description: Number of the phase.
        name:
          example: L1
          type: string
          description: Name of the phase.
        status:
          example: ok
          type: string
          enum:
            - ok
            - warning
            - alarm
            - inactive
          description: Status of the phase.
        voltage:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        current:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        frequency:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        activepower:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        apparentpower:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        reactivepower:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        powerfactor:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        consumption:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
        fuse:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
    fuse_powermanager:
      type: object
      properties:
        id:
          example: 18
          type: integer
          description: Id of the fuse.
        value:
          example: '1'
          type: string
          description: Value of the fuse.
        status:
          example: ok
          type: string
          enum:
            - ok
            - warning
            - alarm
            - inactive
          description: Status of the fuse.
        layout:
          type: object
          properties:
            pos_x:
              example: 2
              type: integer
              description: Describes the x-position of the fuse.
            pos_y:
              example: 9
              type: integer
              description: Describes the y-position of the fuse.
            rotation:
              example: 0
              type: integer
              description: Describes the rotation of the fuse.
            mirror_x:
              example: false
              type: boolean
              description: Describes if the fuse is mirrored.
            type:
              example: fuse
              type: string
              enum:
                - fuse
              description: Describes the type of the fuse.
    outletblock_powermanager:
      type: object
      properties:
        id:
          example: 18
          type: integer
          description: Id of the outletblock.
        phase_id:
          example: 16
          type: integer
          description: Id of the phase.
        fuse_id:
          example: 18
          type: integer
          description: Id of the fuse
        status:
          example: ok
          type: string
          enum:
            - ok
            - warning
            - alarm
            - inactive
          description: Status of the phase.
        current:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
    outlet_powermanager:
      type: object
      properties:
        id:
          example: 126
          type: integer
          description: Id of the outlet.
        name:
          example: 3-16
          type: string
          description: Name of the outlet.
        status:
          example: ok
          type: string
          enum:
            - ok
            - warning
            - alarm
            - inactive
          description: Status of the outlets.
        is_switchable:
          example: true
          type: boolean
          description: Describes if the outlet is switchable.
        pdu_subgroup_id:
          example: 9
          type: integer
          description: Describes the marked section on the PDU.
        outletblock_id:
          example: 18
          type: integer
          description: Describes the block to which the output is assigned.
        is_on:
          example: false
          type: boolean
          description: Describes if the outlet is on.
        switch_dual:
          example: false
          type: boolean
          nullable: true
          description: Describes if the associated outlet should be switched as well.
        layout:
          type: object
          properties:
            pos_x:
              example: 2
              type: integer
              description: Describes the x-position of the outlet.
            pos_y:
              example: 9
              type: integer
              description: Describes the y-position of the outlet.
            rotation:
              example: 0
              type: integer
              description: Describes the rotation of the outlet.
            mirror_x:
              example: false
              type: boolean
              description: Describes if the outlet is mirrored.
            type:
              example: c13
              type: string
              enum:
                - c13
                - c19
              description: Describes the type of the outlet.
        switchingstate:
          type: object
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor.
            value:
              example: '50.02'
              type: string
              nullable: true
              description: The value of this sensor
            status:
              example: ok
              type: string
              enum:
                - ok
                - warning
                - alarm
                - inactive
              description: The status of this sensor
    units_config:
      type: object
      description: A array for a the measurement units used in the response.
      properties:
        active_power:
          example: W
          type: string
          description: Unit of active power
        apparent_power:
          example: VA
          type: string
          description: Unit of apparent power
        co:
          example: ppm
          type: string
          description: Unit of Co
        co2:
          example: ppm
          type: string
          description: Unit of Co2
        consumption:
          example: kWh
          type: string
          description: Unit of consumption
        current:
          example: A
          type: string
          description: Unit of current
        dewpoint:
          example: °C
          type: string
          description: Unit of dewpoint
        fire_temperature:
          example: °C
          type: string
          description: Unit of fire temperature
        frequency:
          example: Hz
          type: string
          description: Unit of frequency
        heat:
          example: °C
          type: string
          description: Unit of heat
        humidity:
          example: '%'
          type: string
          description: Unit of humidity
        latency:
          example: ms
          type: string
          description: Unit of latency
        motion:
          example: '%'
          type: string
          description: Unit of motion
        people_distance:
          example: cm
          type: string
          description: Unit of people distance
        pressure:
          example: hPa
          type: string
          description: Unit of pressure
        rcm_ac:
          example: mA
          type: string
          description: Unit of RCM AC
        rcm_dc:
          example: mA
          type: string
          description: Unit of RCM DC
        reactive_power:
          example: var
          type: string
          description: Unit of Reactive Power
        signal_strength:
          example: dBm
          type: string
          description: Unit of signal strength
        synchronicity:
          example: '%'
          type: string
          description: Unit of synchronicity
        temperature:
          example: °C
          type: string
          description: Unit of temperature
        voltage:
          example: V
          type: string
          description: Unit of voltage
    powermanager-kpm-overview:
      type: object
      properties:
        width:
          example: 2
          type: integer
          description: ''
        height:
          example: 27
          type: integer
          description: ''
        pdu_subgroups:
          type: array
          items:
            type: object
            properties:
              id:
                example: 9
                type: integer
                description: Id of the PDU subgroup.
              name:
                example: '1'
                type: string
                description: Name of the PDU subgroup.
              description:
                example: ''
                type: string
                description: Description of the PDU subgroup
        phases:
          type: array
          items:
            type: object
            properties:
              id:
                example: 3
                type: integer
                description: Id of the phase.
              number:
                example: 1
                type: integer
                description: Number of the phase.
              name:
                example: L1
                type: string
                description: Name of the phase.
              status:
                example: ok
                type: string
                enum:
                  - ok
                  - warning
                  - alarm
                  - inactive
                description: Status of the phase.
              voltage:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              current:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              frequency:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              activepower:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              apparentpower:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              reactivepower:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              powerfactor:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              consumption:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
              fuse:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
        fuses:
          type: array
          items:
            type: object
            properties:
              id:
                example: 18
                type: integer
                description: Id of the fuse.
              value:
                example: '1'
                type: string
                description: Value of the fuse.
              status:
                example: ok
                type: string
                enum:
                  - ok
                  - warning
                  - alarm
                  - inactive
                description: Status of the fuse.
              layout:
                type: object
                properties:
                  pos_x:
                    example: 2
                    type: integer
                    description: Describes the x-position of the fuse.
                  pos_y:
                    example: 9
                    type: integer
                    description: Describes the y-position of the fuse.
                  rotation:
                    example: 0
                    type: integer
                    description: Describes the rotation of the fuse.
                  mirror_x:
                    example: false
                    type: boolean
                    description: Describes if the fuse is mirrored.
                  type:
                    example: fuse
                    type: string
                    enum:
                      - fuse
                    description: Describes the type of the fuse.
        outletblocks:
          type: array
          items:
            type: object
            properties:
              id:
                example: 18
                type: integer
                description: Id of the outletblock.
              phase_id:
                example: 16
                type: integer
                description: Id of the phase.
              fuse_id:
                example: 18
                type: integer
                description: Id of the fuse
              status:
                example: ok
                type: string
                enum:
                  - ok
                  - warning
                  - alarm
                  - inactive
                description: Status of the phase.
              current:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
        outlets:
          type: array
          items:
            type: object
            properties:
              id:
                example: 126
                type: integer
                description: Id of the outlet.
              name:
                example: 3-16
                type: string
                description: Name of the outlet.
              status:
                example: ok
                type: string
                enum:
                  - ok
                  - warning
                  - alarm
                  - inactive
                description: Status of the outlets.
              is_switchable:
                example: true
                type: boolean
                description: Describes if the outlet is switchable.
              pdu_subgroup_id:
                example: 9
                type: integer
                description: Describes the marked section on the PDU.
              outletblock_id:
                example: 18
                type: integer
                description: Describes the block to which the output is assigned.
              is_on:
                example: false
                type: boolean
                description: Describes if the outlet is on.
              switch_dual:
                example: false
                type: boolean
                nullable: true
                description: Describes if the associated outlet should be switched as well.
              layout:
                type: object
                properties:
                  pos_x:
                    example: 2
                    type: integer
                    description: Describes the x-position of the outlet.
                  pos_y:
                    example: 9
                    type: integer
                    description: Describes the y-position of the outlet.
                  rotation:
                    example: 0
                    type: integer
                    description: Describes the rotation of the outlet.
                  mirror_x:
                    example: false
                    type: boolean
                    description: Describes if the outlet is mirrored.
                  type:
                    example: c13
                    type: string
                    enum:
                      - c13
                      - c19
                    description: Describes the type of the outlet.
              switchingstate:
                type: object
                properties:
                  assignment:
                    example: always-active
                    type: string
                    enum:
                      - 'off'
                      - always-active
                      - armed-active
                      - fire
                      - sabotage
                      - display
                      - system
                    description: The alarm assignment of this sensor.
                  value:
                    example: '50.02'
                    type: string
                    nullable: true
                    description: The value of this sensor
                  status:
                    example: ok
                    type: string
                    enum:
                      - ok
                      - warning
                      - alarm
                      - inactive
                    description: The status of this sensor
        units:
          type: object
          description: A array for a the measurement units used in the response.
          properties:
            active_power:
              example: W
              type: string
              description: Unit of active power
            apparent_power:
              example: VA
              type: string
              description: Unit of apparent power
            co:
              example: ppm
              type: string
              description: Unit of Co
            co2:
              example: ppm
              type: string
              description: Unit of Co2
            consumption:
              example: kWh
              type: string
              description: Unit of consumption
            current:
              example: A
              type: string
              description: Unit of current
            dewpoint:
              example: °C
              type: string
              description: Unit of dewpoint
            fire_temperature:
              example: °C
              type: string
              description: Unit of fire temperature
            frequency:
              example: Hz
              type: string
              description: Unit of frequency
            heat:
              example: °C
              type: string
              description: Unit of heat
            humidity:
              example: '%'
              type: string
              description: Unit of humidity
            latency:
              example: ms
              type: string
              description: Unit of latency
            motion:
              example: '%'
              type: string
              description: Unit of motion
            people_distance:
              example: cm
              type: string
              description: Unit of people distance
            pressure:
              example: hPa
              type: string
              description: Unit of pressure
            rcm_ac:
              example: mA
              type: string
              description: Unit of RCM AC
            rcm_dc:
              example: mA
              type: string
              description: Unit of RCM DC
            reactive_power:
              example: var
              type: string
              description: Unit of Reactive Power
            signal_strength:
              example: dBm
              type: string
              description: Unit of signal strength
            synchronicity:
              example: '%'
              type: string
              description: Unit of synchronicity
            temperature:
              example: °C
              type: string
              description: Unit of temperature
            voltage:
              example: V
              type: string
              description: Unit of voltage
    outlet:
      type: object
      properties:
        id:
          example: 1
          type: integer
          readOnly: true
          description: Id of the outlet
        name:
          example: 1-1
          type: string
          description: Name of the outlet
        switch_dual:
          example: false
          type: boolean
          nullable: true
          description: Describes if the associated outlet should be switched as well.
    powermanager-socket-switch:
      type: object
      required:
        - mode
      properties:
        mode:
          example: 'on'
          type: string
          enum:
            - 'on'
            - 'off'
            - toggle
          description: Describes the target status of the outlet.
        duration:
          example: 5
          type: number
          default: null
          nullable: true
          description: >
            Time in seconds for the outlet to be switched. After this time has
            passed, the outlet will be switched back to it's initial state.
            Omitting the attribute or a value of null will be interpreted as
            permanent switching. A value of 0 will ignore the command.
        delay:
          example: 5
          type: number
          default: null
          nullable: true
          description: >
            Time in seconds before the switching will be executed. Omitting the
            attribute, a value of null or a value of 0 will switch with no
            delay.
        dual:
          example: false
          type: boolean
          default: false
          nullable: true
          description: >
            If a dual SmartPDU or a rack unit with exactly 1 line a device and
            exactly 1 lane b device is used, the mirrored outlet can be switched
            synchronously. By setting this attribute to true, the mirrored
            outlet of the addressed one will be switched, too. If omitted or set
            to null, no dual switching will be executed.
    privacy:
      type: object
      properties:
        memorydepth:
          example: 1
          type: number
          minimum: 0
          maximum: 720
          description: >-
            Sets the number of days during which all user-related data
            (bookings, images, etc) is stored. 0 = Unlimited, must be between 0
            and 720.
    permissions:
      type: object
      description: Describes the permissions the Usergroup have.
      properties:
        accessmanager-settings:
          example: true
          type: boolean
          description: Describes the permission for general settings.
        webhook:
          example: true
          type: boolean
          description: Describes the permission for webhooks.
        timedevents:
          example: true
          type: boolean
          description: Describes the permission for eventprofiles.
        system-event:
          example: true
          type: boolean
          description: Describes the permission for system log.
        snmp:
          example: true
          type: boolean
          description: Describes the permission for SNMP.
        report:
          example: true
          type: boolean
          description: Describes the permission for reports.
        invoice:
          example: true
          type: boolean
          description: Describes the permission for metering.
        info:
          example: true
          type: boolean
          description: Describes the permission for device info.
        cloud:
          example: true
          type: boolean
          description: Describes the permission for Kentix-ONE GO.
        blockingprofiles:
          example: true
          type: boolean
          description: Describes the permission for manage exception days.
        alarm-event:
          example: true
          type: boolean
          description: Describes the permission for event logbook.
        satellites:
          example: true
          type: boolean
          description: Describes the permission for updating satellites.
        satellite-settings:
          example: true
          type: boolean
          description: Describes the permission for Manager/Satellite mode.
        satellite+sync:
          example: true
          type: boolean
          description: Describes the permission for synchronize satellites.
        timeprofile:
          example: true
          type: boolean
          description: Describes the permission for time profiles.
        levelprofile:
          example: true
          type: boolean
          description: Describes the permission for access profiles.
        doorlock+open:
          example: true
          type: boolean
          description: Describes the permission for open DoorLocks.
        backup:
          example: true
          type: boolean
          description: Describes the permission for backup.
        backup+restore:
          example: true
          type: boolean
          description: Describes the permission for restore backups.
        autobackup:
          example: true
          type: boolean
          description: Describes the permission for automatic backup.
        sd-card:
          example: true
          type: boolean
          description: Describes the permission for SD-Card.
        access-event:
          example: true
          type: boolean
          description: Describes the permission for access logbook.
        access-event+every:
          example: true
          type: boolean
          description: Describes the permission for showing all users access logbooks.
        change-devicename:
          example: true
          type: boolean
          description: Describes the permission for changing the device name.
        update:
          example: true
          type: boolean
          description: Describes the permission for softwareupdate.
        reset:
          example: true
          type: boolean
          description: Describes the permission for resetting.
        network-settings:
          example: true
          type: boolean
          description: Describes the permission for network.
        ssl-certificate:
          example: true
          type: boolean
          description: Describes the permission for SSL certificate.
        datetime:
          example: true
          type: boolean
          description: Describes the permission for date and time.
        security:
          example: true
          type: boolean
          description: Describes the permission for security.
        email:
          example: true
          type: boolean
          description: Describes the permission for email.
        gsm:
          example: true
          type: boolean
          description: Describes the permission for SMS.
        region:
          example: true
          type: boolean
          description: Describes the permission for language and region.
        systemmanagement:
          example: true
          type: boolean
          description: Describes the permission for Detail View.
        alarmgroup+every:
          example: true
          type: boolean
          description: Describes the permission for showing all alarmgroups.
        alarmgroup+switch:
          example: true
          type: boolean
          description: Describes the permission for arming/disarming assigned alarmgroups.
        alarmgroup+quit:
          example: true
          type: boolean
          description: >-
            Describes the permission for quitting alarms of assigned
            alarmgroups.
        alarmgroup+manage:
          example: true
          type: boolean
          description: Describes the permission for managing assigned alarmgroups.
        systemmanagement+monitoring:
          example: true
          type: boolean
          description: Describes the permission for managing monitoring devices.
        systemmanagement+access:
          example: true
          type: boolean
          description: Describes the permission for managing access devices.
        systemmanagement+power:
          example: true
          type: boolean
          description: Describes the permission for managing power devices.
        systemmanagement+video:
          example: true
          type: boolean
          description: Describes the permission for managing video devices.
        filterprofile:
          example: true
          type: boolean
          description: Describes the permission for filter profiles.
        personalization:
          example: true
          type: boolean
          description: Describes the permission for personalization.
        user:
          example: true
          type: boolean
          description: Describes the permission for users.
        usergroup:
          example: true
          type: boolean
          description: Describes the permission for usergroups.
        ldap:
          example: true
          type: boolean
          description: Describes the permission for LDAP.
        read-rfid:
          example: true
          type: boolean
          description: Describes the permission for reading RFID-UID.
        systemanalysis:
          example: true
          type: boolean
          description: Describes the permission for system analysis.
        vds:
          example: true
          type: boolean
          description: Describes the permission for VdS settings.
        metering:
          example: true
          type: boolean
          description: Describes the permission for Modbus communication settings.
    profile-response:
      type: object
      properties:
        username:
          type: string
          description: The username of the currently authenticated user.
          example: erika.schmidt
        password:
          type: string
          description: A static replacement for the actual password.
          example: pvg4HXvj9WG4KPnN
        fullname:
          type: string
          description: The full name of the currently authenticated user.
          example: Erika Schmidt
        email:
          type: string
          description: The email address of the currently authenticated user.
          example: erika.schmidt@example.com
          nullable: true
        autologout:
          type: integer
          enum:
            - 5
            - 15
            - 30
            - 60
            - 120
            - 360
            - 720
          description: The time in minutes for auto logout or null to disable it.
          example: 120
          nullable: true
        is_admin:
          type: boolean
          description: Describes if the currently authenticated user is an administrator
          example: false
        usergroup:
          type: object
          properties:
            id:
              example: 1
              type: integer
              readOnly: true
              description: Describes the ID of the Usergroup.
            name:
              example: Manager
              type: string
              description: Describes the name of the Usergroup.
            permissions:
              type: object
              description: Describes the permissions the Usergroup have.
              properties:
                accessmanager-settings:
                  example: true
                  type: boolean
                  description: Describes the permission for general settings.
                webhook:
                  example: true
                  type: boolean
                  description: Describes the permission for webhooks.
                timedevents:
                  example: true
                  type: boolean
                  description: Describes the permission for eventprofiles.
                system-event:
                  example: true
                  type: boolean
                  description: Describes the permission for system log.
                snmp:
                  example: true
                  type: boolean
                  description: Describes the permission for SNMP.
                report:
                  example: true
                  type: boolean
                  description: Describes the permission for reports.
                invoice:
                  example: true
                  type: boolean
                  description: Describes the permission for metering.
                info:
                  example: true
                  type: boolean
                  description: Describes the permission for device info.
                cloud:
                  example: true
                  type: boolean
                  description: Describes the permission for Kentix-ONE GO.
                blockingprofiles:
                  example: true
                  type: boolean
                  description: Describes the permission for manage exception days.
                alarm-event:
                  example: true
                  type: boolean
                  description: Describes the permission for event logbook.
                satellites:
                  example: true
                  type: boolean
                  description: Describes the permission for updating satellites.
                satellite-settings:
                  example: true
                  type: boolean
                  description: Describes the permission for Manager/Satellite mode.
                satellite+sync:
                  example: true
                  type: boolean
                  description: Describes the permission for synchronize satellites.
                timeprofile:
                  example: true
                  type: boolean
                  description: Describes the permission for time profiles.
                levelprofile:
                  example: true
                  type: boolean
                  description: Describes the permission for access profiles.
                doorlock+open:
                  example: true
                  type: boolean
                  description: Describes the permission for open DoorLocks.
                backup:
                  example: true
                  type: boolean
                  description: Describes the permission for backup.
                backup+restore:
                  example: true
                  type: boolean
                  description: Describes the permission for restore backups.
                autobackup:
                  example: true
                  type: boolean
                  description: Describes the permission for automatic backup.
                sd-card:
                  example: true
                  type: boolean
                  description: Describes the permission for SD-Card.
                access-event:
                  example: true
                  type: boolean
                  description: Describes the permission for access logbook.
                access-event+every:
                  example: true
                  type: boolean
                  description: >-
                    Describes the permission for showing all users access
                    logbooks.
                change-devicename:
                  example: true
                  type: boolean
                  description: Describes the permission for changing the device name.
                update:
                  example: true
                  type: boolean
                  description: Describes the permission for softwareupdate.
                reset:
                  example: true
                  type: boolean
                  description: Describes the permission for resetting.
                network-settings:
                  example: true
                  type: boolean
                  description: Describes the permission for network.
                ssl-certificate:
                  example: true
                  type: boolean
                  description: Describes the permission for SSL certificate.
                datetime:
                  example: true
                  type: boolean
                  description: Describes the permission for date and time.
                security:
                  example: true
                  type: boolean
                  description: Describes the permission for security.
                email:
                  example: true
                  type: boolean
                  description: Describes the permission for email.
                gsm:
                  example: true
                  type: boolean
                  description: Describes the permission for SMS.
                region:
                  example: true
                  type: boolean
                  description: Describes the permission for language and region.
                systemmanagement:
                  example: true
                  type: boolean
                  description: Describes the permission for Detail View.
                alarmgroup+every:
                  example: true
                  type: boolean
                  description: Describes the permission for showing all alarmgroups.
                alarmgroup+switch:
                  example: true
                  type: boolean
                  description: >-
                    Describes the permission for arming/disarming assigned
                    alarmgroups.
                alarmgroup+quit:
                  example: true
                  type: boolean
                  description: >-
                    Describes the permission for quitting alarms of assigned
                    alarmgroups.
                alarmgroup+manage:
                  example: true
                  type: boolean
                  description: Describes the permission for managing assigned alarmgroups.
                systemmanagement+monitoring:
                  example: true
                  type: boolean
                  description: Describes the permission for managing monitoring devices.
                systemmanagement+access:
                  example: true
                  type: boolean
                  description: Describes the permission for managing access devices.
                systemmanagement+power:
                  example: true
                  type: boolean
                  description: Describes the permission for managing power devices.
                systemmanagement+video:
                  example: true
                  type: boolean
                  description: Describes the permission for managing video devices.
                filterprofile:
                  example: true
                  type: boolean
                  description: Describes the permission for filter profiles.
                personalization:
                  example: true
                  type: boolean
                  description: Describes the permission for personalization.
                user:
                  example: true
                  type: boolean
                  description: Describes the permission for users.
                usergroup:
                  example: true
                  type: boolean
                  description: Describes the permission for usergroups.
                ldap:
                  example: true
                  type: boolean
                  description: Describes the permission for LDAP.
                read-rfid:
                  example: true
                  type: boolean
                  description: Describes the permission for reading RFID-UID.
                systemanalysis:
                  example: true
                  type: boolean
                  description: Describes the permission for system analysis.
                vds:
                  example: true
                  type: boolean
                  description: Describes the permission for VdS settings.
                metering:
                  example: true
                  type: boolean
                  description: Describes the permission for Modbus communication settings.
          nullable: false
        filterprofile_id:
          type: integer
          description: Describes the ID of the personal default filter profile.
          example: 4
        tableview_id:
          type: integer
          description: Describes the ID of the personal default table view.
          example: 3
    profile-request:
      type: object
      properties:
        password:
          type: string
          description: A new password or the static replacement to keep the password.
          example: top-secret
        fullname:
          type: string
          description: The full name of the currently authenticated user.
          example: Erika Schmidt
        email:
          type: string
          description: The email address of the currently authenticated user.
          example: erika.schmidt@example.com
          nullable: true
        autologout:
          type: integer
          enum:
            - 5
            - 15
            - 30
            - 60
            - 120
            - 360
            - 720
          description: The time in minutes for auto logout or null to disable it.
          example: 120
          nullable: true
        filterprofile_id:
          type: integer
          description: Describes the ID of the personal default filter profile.
          example: 4
        tableview_id:
          type: integer
          description: Describes the ID of the personal default table view.
          example: 3
    proxy:
      type: object
      properties:
        http-proxy:
          type: object
          description: >-
            These are the proxy setting for connecting your device e.g. to the
            KentixONE online service or the Kentix update server, i.e. an
            internet HTTP proxy.
          properties:
            is_active:
              type: boolean
              description: Enables HTTP proxy usage.
            address:
              type: string
              description: FQHN (domain name, IP, etc.) of the HTTP proxy
            port:
              type: number
              minimum: 1
              maximum: 65535
              description: Network port of the HTTP proxy
            username:
              type: string
              description: >-
                If your HTTP proxy server needs authorization, you may enter the
                credentials here. If no authorization is needed, just leave it
                empty.
            password:
              type: string
              description: >-
                If your HTTP proxy server needs authorization, you may enter the
                credentials here. If no authorization is needed, just leave it
                empty.
        sensor-proxy:
          type: object
          description: >-
            If your network is set up with a proxy between your main and your
            satellite devices, use this settings.
          properties:
            is_active:
              type: boolean
              description: Enables sensor-proxy usage.
            address:
              type: string
              description: FQHN (domain name, IP, etc) of the sensor proxy
            port:
              type: number
              minimum: 1
              maximum: 65535
              description: Network port of the sensor proxy
            username:
              type: string
              description: >-
                If your sensor proxy server needs authorization, you may enter
                the credentials here. If no authorization is needed, just leave
                it empty.
            password:
              type: string
              description: >-
                If your sensor proxy server needs authorization, you may enter
                the credentials here. If no authorization is needed, just leave
                it empty.
    quicklinks:
      type: array
      items:
        type: object
        properties:
          id:
            type: number
            description: The id of the shortcut
            example: 3
          name:
            type: string
            description: The name of the shortcut
            example: Dashboard
          viewmode:
            type: number
            enum:
              - 0
              - 1
              - 2
            description: >-
              The modus of the link. 0 => URL, 1=> Detail View (Grid), 2 =>
              Detail View (Table)
            example: 0
          url:
            type: string
            nullable: true
            description: The url the shortcut links to
            example: /dashboard
          filterprofile_id:
            type: number
            nullable: true
            description: >-
              The id of the linked filterprofile in the grid view of the Detail
              View
            example: null
          tableview_id:
            type: number
            nullable: true
            description: >-
              The id of the linked tableview in the table view of the Detail
              View
            example: null
          icon:
            type: string
            description: The icon to be shown for the shortcut
            example: circle
          default:
            type: boolean
            description: >-
              The flag that determines, if this shortcut will be linked to all
              new users
            example: true
          permission:
            type: string
            nullable: true
            description: The name of the permission needed to see/ use this shortcut
            example: null
          pivot:
            type: object
            properties:
              user_id:
                type: number
                description: The ID of the user
                example: 1
              quicklink_id:
                type: number
                description: The ID of the shortcut
                example: 3
              sort:
                type: number
                description: The position in which it is displayed in the KentixONE Layout
                example: 4
    racks:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: Rack
          type: string
          description: The name of the device
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
    activepower_config:
      type: object
      description: The configuration for the activepower sensor
      properties:
        assignment:
          example: always-active
          type: string
          enum:
            - 'off'
            - always-active
            - armed-active
            - fire
            - sabotage
            - display
            - system
          description: The alarm assignment of this sensor
        max:
          example: 20000
          type: integer
          description: The max threshold where an alarm is triggered
        units:
          type: object
          properties:
            max:
              example: W
              type: string
              description: The unit for the max field
        warning:
          type: object
          properties:
            max:
              example: 15000
              type: integer
              description: The warning threshold for the max value
            active:
              example: true
              type: boolean
              description: The flag to determine if warnings should be triggered
    rack-activepower:
      type: object
      properties:
        supply_a:
          type: object
          description: The configuration for the activepower sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            max:
              example: 20000
              type: integer
              description: The max threshold where an alarm is triggered
            units:
              type: object
              properties:
                max:
                  example: W
                  type: string
                  description: The unit for the max field
            warning:
              type: object
              properties:
                max:
                  example: 15000
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        supply_b:
          type: object
          description: The configuration for the activepower sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            max:
              example: 20000
              type: integer
              description: The max threshold where an alarm is triggered
            units:
              type: object
              properties:
                max:
                  example: W
                  type: string
                  description: The unit for the max field
            warning:
              type: object
              properties:
                max:
                  example: 15000
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
    racks_id:
      type: object
      properties:
        group_id:
          example: 1
          type: integer
          description: The ID of the group the device is assigned to
        id:
          example: 2
          type: integer
          description: the ID of the device
        is_active:
          example: true
          type: boolean
          description: The flag to determine the status of the device
        name:
          example: Rack
          type: string
          description: The name of the device
        description:
          example: Rack Server1
          type: string
          description: The description of the device
        devices:
          type: array
          description: >-
            Contains an array of devices and their supplyline- and synchronicity
            assignments. These are only relevant if the devices are PDUs
          items:
            type: object
            properties:
              id:
                example: 4
                type: integer
                description: Id of the device.
              supplyline:
                example: a
                type: string
                enum:
                  - a
                  - b
                  - ab
                  - none
                  - ''
                description: The supplyline assignment of this device.
              synchronicity_assignment:
                example: always-active
                type: string
                enum:
                  - 'off'
                  - always-active
                  - armed-active
                  - fire
                  - sabotage
                  - display
                  - system
                nullable: true
                description: The alarm assignment of this sensor.
        ios:
          type: array
          items:
            type: integer
          description: Contains an array of IO-IDs that are assigned to this rack
        synchronicity:
          type: object
          description: The configuration for the synchronicity sensor
          properties:
            assignment:
              example: always-active
              type: string
              enum:
                - 'off'
                - always-active
                - armed-active
                - fire
                - sabotage
                - display
                - system
              description: The alarm assignment of this sensor
            threshold:
              example: 20
              type: integer
              description: The max threshold where an alarm is triggered
            max:
              example: 5
              type: integer
              description: The max threshold where an alarm is triggered
            units:
              type: object
              properties:
                max:
                  example: '%'
                  type: string
                  description: The unit for the max field
                threshold:
                  example: W
                  type: string
                  description: The unit for the threshold field
            warning:
              type: object
              properties:
                max:
                  example: 3
                  type: integer
                  description: The warning threshold for the max value
                active:
                  example: true
                  type: boolean
                  description: The flag to determine if warnings should be triggered
        activepower:
          type: object
          properties:
            supply_a:
              type: object
              description: The configuration for the activepower sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 20000
                  type: integer
                  description: The max threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    max:
                      example: W
                      type: string
                      description: The unit for the max field
                warning:
                  type: object
                  properties:
                    max:
                      example: 15000
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
            supply_b:
              type: object
              description: The configuration for the activepower sensor
              properties:
                assignment:
                  example: always-active
                  type: string
                  enum:
                    - 'off'
                    - always-active
                    - armed-active
                    - fire
                    - sabotage
                    - display
                    - system
                  description: The alarm assignment of this sensor
                max:
                  example: 20000
                  type: integer
                  description: The max threshold where an alarm is triggered
                units:
                  type: object
                  properties:
                    max:
                      example: W
                      type: string
                      description: The unit for the max field
                warning:
                  type: object
                  properties:
                    max:
                      example: 15000
                      type: integer
                      description: The warning threshold for the max value
                    active:
                      example: true
                      type: boolean
                      description: The flag to determine if warnings should be triggered
        apparentpower:
          type: object
          properties:
            supply_a:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
            supply_b:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
        consumption:
          type: object
          properties:
            supply_a:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
            supply_b:
              type: object
              properties:
                assignment:
                  type: string
                  enum:
                    - 'off'
                    - display
        webhooks:
          type: array
          description: The webhook relations of this device
          items:
            type: object
            properties:
              id:
                example: 0
                type: integer
                description: Must be an Id of an existing webhook.
              event:
                example: 0
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 51
                description: Must be an Id of an existing webhook event type.
              cycle_time:
                example: 5
                type: integer
                nullable: true
                enum:
                  - 5
                  - 10
                  - 15
                  - 30
                description: >-
                  Describes how often the webhook should be executed. Only
                  required if event is 51.
              trigger_on_alarm:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of an
                  alarm.
              trigger_on_warning:
                example: false
                type: boolean
                nullable: true
                description: >-
                  Describes if the webhook should be executed in case of a
                  warning.
    racks_names:
      type: object
      properties:
        id:
          example: 1
          type: integer
          description: the ID of the device
        name:
          example: Rack
          type: string
          description: The name of the device
    region:
      type: object
      properties:
        language:
          example: en
          type: string
          enum:
            - en
            - de
            - fr
            - it
            - es
            - pt
            - jp
          description: Language code
        temperature_unit:
          example: C
          type: string
          enum:
            - C
            - F
          description: Temperature unit
    reboot:
      type: object
      properties:
        status:
          type: string
          description: Status of the reboot command.
    reset:
      type: object
      properties:
        reboot:
          type: boolean
          description: Reboot the Device.
          example: true
        reset_network:
          type: boolean
          description: Reset the Network Settings.
          example: true
    security:
      type: object
      properties:
        communication_key:
          type: string
          description: The communication key of the device.
          example: myCommunicationKey0123456789
        pinlength:
          type: integer
          description: The length of the PIN.
          example: 4
          minimum: 4
          maximum: 10
        rfid_mode:
          type: integer
          description: >-
            The RFID mode of the device. 0=disabled, 1=Kentix-Encryption,
            2=Custom-Encryption.
          example: 0
          enum:
            - 0
            - 1
            - 2
    switching:
      type: array
      items:
        type: object
        required:
          - output
          - mode
        properties:
          type:
            type: string
            description: >-
              The output to be switched BUZZER: Accoustic signaling via the
              internal buzzer. LEDRED: Internal red led, normally used for alarm
              state signalization. LEDGREEN: Internal green led, normally used
              to indicate the devices' running status. DO: Digital output
            example: BUZZER
            enum:
              - BUZZER
              - LEDRED
              - LEDGREEN
              - DO
              - buzzer
              - ledred
              - ledgreen
              - do
          channel:
            type: number
            description: >-
              Only required for DO type. The channel number of the output to be
              switched.
            example: 1
          mode:
            type: string
            description: >-
              Defines the switching mode. ON: Switches the output constantly on.
              OFF: Switches the output constantly off. PULSE: Toggles the output
              between on and off in a one second interval.
            example: 'ON'
            enum:
              - 'ON'
              - 'OFF'
              - PULSE
              - 'on'
              - 'off'
              - pulse
          duration:
            type: number
            description: >-
              Period of time in seconds to signal on the selected output. Can be
              NULL or any integer number. Can be omitted, which will be
              evaluated the same as NULL or 0. If omitted or set to NULL, the
              signaling will be continuous.
            example: 10
            default: null
            nullable: true
          delay:
            type: number
            description: >-
              Delay in seconds before this signaling command is executed. Can be
              NULL or any integer number. Can be omitted, which will be
              evaluated the same as NULL or 0. If omitted or set to NULL, the
              signaling will start instantly.
            example: 10
            default: null
            nullable: true
    system:
      type: object
      properties:
        name:
          type: string
          description: The name of the system.
          example: My AlarmManager
    teachin_accessmanager:
      type: object
      title: AccessManager
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: accessmanager
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_camera:
      type: object
      title: NetworkCamera
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: camera
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_doorlock_dc_le:
      type: object
      title: Door Lever
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
            properties:
              type:
                example: doorlock-dc-le
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_doorlock_ra4_ip:
      type: object
      title: Racklock
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - teachin_code
            properties:
              type:
                example: doorlock-ra4-ip
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              teachin_code:
                example: 001d025537
                type: string
                description: Bus-id (previously teach in code) printed on the ra4 doorlock
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_doorlock_virtual:
      type: object
      title: Virtual DoorLock
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
            properties:
              type:
                example: doorlock-virtual
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_doorlock_wa:
      type: object
      title: Wallreader (Bus)
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
            properties:
              type:
                example: doorlock-wa
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_io_module_7017:
      type: object
      title: Extension-Module 7017
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: io-module-7017
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_io_module_7052:
      type: object
      title: Extension-Module 7052
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: io-module-7052
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_io_module_7053:
      type: object
      title: Extension-Module 7053
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: io-module-7053
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_multisensor_lan:
      type: object
      title: MultiSensor (Ethernet)
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: multisensor-lan
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_multisensor_rf:
      type: object
      title: MultiSensor (RF)
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
            properties:
              type:
                example: multisensor-rf
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_network_sensor:
      type: object
      title: Network Sensor
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: network-sensor
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_powermanager:
      type: object
      title: PowerManager
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: powermanager
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_rack_unit:
      type: object
      title: Rack Unit
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - group_id
            properties:
              type:
                example: rack-unit
                type: string
                description: Specification which device type should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_smartmeter_rcm_rtu:
      type: object
      title: Residual Current Meter (RCM)
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - address
              - model
            properties:
              type:
                example: smartmeter-rcm-rtu
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              address:
                example: '1'
                type: string
                description: Modbus address of the device to be added
              model:
                example: rcm-b132
                type: string
                enum:
                  - rcm-b132
                  - custom
                description: >-
                  SmartMeter model to preconfigure the modbus registers and
                  device settings. Custom will have no preconfigured modbus
                  registers and device settings.
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_smartmeter_value_rtu:
      type: object
      title: SmartMeter (Bus)
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
              - model
            properties:
              type:
                example: smartmeter-value-rtu
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: '1'
                type: string
                description: Modbus address of the device to be added
              model:
                example: ''
                type: string
                enum:
                  - uem80
                  - uem40
                  - abb-b21
                  - abb-b23
                  - ezg-tcp
                  - abb-cs700
                  - abb-cs700-branch
                  - conto-d4
                  - finder-7m24
                  - finder-7m38
                  - custom
                description: >-
                  SmartMeter model to preconfigure the modbus registers and
                  device settings. Custom will have no preconfigured modbus
                  registers and device settings.
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_smartmeter_value_tcp:
      type: object
      title: SmartMeter (Ethernet)
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
              - model
            properties:
              type:
                example: smartmeter-value-tcp
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              teachin_port:
                example: '502'
                type: integer
                description: TCP port on which the communication will be established
              model:
                example: uem80
                type: string
                enum:
                  - uem80
                  - ezg-tcp
                  - umg96rm
                  - abb-cs700
                  - abb-cs700-branch
                  - custom
                description: >-
                  SmartMeter model to preconfigure the modbus registers and
                  device settings. Custom will have no preconfigured modbus
                  registers and device settings.
              name:
                example: Device name
                default: Default name
                type: string
                description: Name of the device to be added
    teachin_smartpdu:
      type: object
      title: SmartPDU
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - address
            properties:
              type:
                example: smartpdu
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              address:
                example: 192.168.100.224
                type: string
                description: IP address or DNS address of the device to be added
              name:
                example: Device name
                type: string
                description: Name of the device to be added
    teachin_snmp_sensor:
      type: object
      title: SNMP Sensor
      properties:
        devices:
          type: array
          items:
            type: object
            required:
              - type
              - host_id
              - group_id
              - credential_id
              - evaluation_type
              - oid
            properties:
              type:
                example: snmp-sensor
                type: string
                description: Specification which device type should be added
              host_id:
                example: '1'
                type: integer
                description: Device identifier to which host the device should be added
              group_id:
                example: '10'
                type: integer
                description: Group identifier in which the device will be added
              credential_id:
                example: '1'
                type: integer
                description: >-
                  Snmp credential identifier which the added device uses. Be
                  sure to use credentials with the type 'retrieve data'.
              name:
                example: Device name
                type: string
                description: Name of the device to be added
              evaluation_type:
                example: min
                type: string
                enum:
                  - none
                  - min
                  - max
                  - min-max
                  - logic
                  - alarm-when
                description: Alarm evaluation type for the polled value
              oid:
                example: .1.3.6.1.4.1.37954.5.1.1.1.0
                type: string
                description: Oid which the snmp sensor polls
    teachin_response:
      type: object
      properties:
        devices:
          type: array
          items:
            type: object
            properties:
              name:
                example: MultiSensor
                type: string
                description: Name of the device which is removed
              state:
                example: RUNNING
                type: string
                enum:
                  - SEARCHING
                  - CONFIGURING
                  - RUNNING
                  - SUCCESS
                  - ERROR
                  - AWAITING_CONFIRMATION
                  - VALIDATION_ERROR
                  - TEACH_IN_HOST_NOT_REACHABLE
                  - DEVICE_IS_NOT_REACHABLE
                  - DEVICE_HAS_WRONG_COMMUNICATION_KEY
                  - DEVICE_IS_NOT_IN_SATELLITE_MODE
                  - DEVICE_IS_NOT_A_VALID_SATELLITE
                  - DEVICE_HAS_ANOTHER_MANAGER
                  - TEACHIN_IS_ALREADY_RUNNING
                  - DEVICE_NOT_FOUND
                  - DEVICE_CAN_NOT_BE_CONFIGURED
                  - DUPLICATE_REQUEST
                  - ADDRESS_CONFLICT
                  - SYNC_REQUIRED
                  - ABORTED
                  - TIMEOUT
                  - DEVICE_ALREADY_TEACHED_IN
                description: Current state of the removal process
              uuid:
                type: string
                description: identifier of this device's removal
                example: 3cb6e0ba-daaf-40d9-83b9-a5c351f35fe9
        racks:
          type: array
          items:
            type: object
            properties:
              name:
                example: RackUnit
                type: string
                description: Name of the rack which is removed
              state:
                example: SUCCESS
                type: string
                enum:
                  - SEARCHING
                  - CONFIGURING
                  - RUNNING
                  - SUCCESS
                  - ERROR
                  - AWAITING_CONFIRMATION
                  - VALIDATION_ERROR
                  - TEACH_IN_HOST_NOT_REACHABLE
                  - DEVICE_IS_NOT_REACHABLE
                  - DEVICE_HAS_WRONG_COMMUNICATION_KEY
                  - DEVICE_IS_NOT_IN_SATELLITE_MODE
                  - DEVICE_IS_NOT_A_VALID_SATELLITE
                  - DEVICE_HAS_ANOTHER_MANAGER
                  - TEACHIN_IS_ALREADY_RUNNING
                  - DEVICE_NOT_FOUND
                  - DEVICE_CAN_NOT_BE_CONFIGURED
                  - DUPLICATE_REQUEST
                  - ADDRESS_CONFLICT
                  - SYNC_REQUIRED
                  - ABORTED
                  - TIMEOUT
                  - DEVICE_ALREADY_TEACHED_IN
                description: Current state of the removal process
              uuid:
                example: 0136e0ba-daaf-40d9-472b-1d246b9e8d26
                type: string
                description: identifier of this rack's removal
        uuid:
          type: string
          example: 3e2e7ee8-16ab-472b-9529-1d246b9e8d26
          description: Identifier of whole removal process
    teachout_request:
      type: object
      properties:
        devices:
          type: array
          items:
            example: 4
            type: number
          description: List of device id's which should be removed
        racks:
          type: array
          items:
            type: number
          description: List of rack id's which should be removed
    teachout_response:
      type: object
      properties:
        devices:
          type: array
          items:
            type: object
            properties:
              name:
                example: MultiSensor
                type: string
                description: Name of the device which is removed
              state:
                example: RUNNING
                type: string
                enum:
                  - RUNNING
                  - SUCCESS
                  - NO_PERMISSION
                  - DEVICE_NOT_FOUND
                  - ERROR_RACK_UNIT_HAS_DEVICES
                  - ERROR
                  - TEACH_IN_HOST_NOT_REACHABLE
                  - TEACHOUT_IS_ALREADY_RUNNING
                description: Current state of the removal process
              uuid:
                type: string
                description: Identifier of this device's removal
                example: 3cb6e0ba-daaf-40d9-83b9-a5c351f35fe9
        racks:
          type: array
          items:
            type: object
            properties:
              name:
                example: RackUnit
                type: string
                description: Name of the rack which is removed
              state:
                example: SUCCESS
                type: string
                enum:
                  - RUNNING
                  - SUCCESS
                  - NO_PERMISSION
                  - DEVICE_NOT_FOUND
                  - ERROR_RACK_UNIT_HAS_DEVICES
                  - ERROR
                  - TEACH_IN_HOST_NOT_REACHABLE
                  - TEACHOUT_IS_ALREADY_RUNNING
                description: Current state of the removal process
              uuid:
                example: 0136e0ba-daaf-40d9-472b-1d246b9e8d26
                type: string
                description: Identifier of this rack's removal
        uuid:
          type: string
          example: 3e2e7ee8-16ab-472b-9529-1d246b9e8d26
          description: Identifier of whole removal process
    update:
      type: object
      properties:
        message:
          example: Update finished
          type: string
          description: Detailed response
        status:
          type: object
          properties:
            code:
              example: ready
              type: string
              enum:
                - ready
                - decrypt
                - unpack
                - validate
                - cleanup
                - reboot
                - error_download
                - error_no_file
                - error_decrypt
                - error_extract
                - error_invalid_device
                - error_invalid_revision
                - error_invalid_file
                - error_copy_files
                - download
                - store_firmware
                - error_downgrade
              description: The Status code
            detail:
              example: Ready
              type: string
              description: The detail of the status code
    update-settings:
      type: object
      properties:
        channel:
          type: string
          enum:
            - stable
            - latest
          example: stable
          description: The update channel
    ota-update:
      type: object
      properties:
        date:
          example: '2023-02-20'
          type: string
          description: The date of the latest updates release
        device_type:
          example: 8
          type: integer
          description: The Board type of the device
        os_revision:
          example: 2
          type: integer
          description: The OS-Revision
        releasenotes:
          example: |-
            <ul>
            <li>Test</li></ul>
          type: string
          format: HTML
          description: The Release notes of all updates (not installed)
        version:
          example: 08.01.03 B00950
          type: string
          description: The name of the latest version of KentixONE
    update-info-object:
      type: object
      properties:
        download-pending:
          type: boolean
          description: Indicates if a new update is available and can be downloaded.
          example: false
        update-pending:
          type: boolean
          description: Indicates if an update was downloaded and can be installed.
          example: false
        version:
          type: string
          description: >-
            Shows the firmware version that can be either downloaded or
            installed.
          example: 1.0.0
        build:
          type: string
          description: Shows the firmware build that can be either downloaded or installed.
          example: '00001'
    update-info:
      type: object
      properties:
        main:
          type: object
          properties:
            download-pending:
              type: boolean
              description: Indicates if a new update is available and can be downloaded.
              example: false
            update-pending:
              type: boolean
              description: Indicates if an update was downloaded and can be installed.
              example: false
            version:
              type: string
              description: >-
                Shows the firmware version that can be either downloaded or
                installed.
              example: 1.0.0
            build:
              type: string
              description: >-
                Shows the firmware build that can be either downloaded or
                installed.
              example: '00001'
        satellite:
          type: object
          properties:
            download-pending:
              type: boolean
              description: Indicates if a new update is available and can be downloaded.
              example: false
            update-pending:
              type: boolean
              description: Indicates if an update was downloaded and can be installed.
              example: false
            version:
              type: string
              description: >-
                Shows the firmware version that can be either downloaded or
                installed.
              example: 1.0.0
            build:
              type: string
              description: >-
                Shows the firmware build that can be either downloaded or
                installed.
              example: '00001'
    update-status-object:
      type: object
      properties:
        pending:
          type: integer
          example: 0
          description: Number of queued jobs which are not yet in progress.
        finished:
          type: integer
          example: 0
          description: Number of finished jobs.
        error:
          type: integer
          example: 0
          description: Number of jobs which failed.
        time:
          example: '2023-06-21T11:08:04.346677Z'
          type: string
          format: date-time
          description: Time of the last update.
        current:
          type: array
          description: >-
            Show a list of jobs that are currently in progress with their
            respective state.
          items:
            type: object
            properties:
              status:
                type: string
                description: Present in all job types. The current status of the job.
                example: download
              type:
                type: string
                description: >-
                  Present in all job types. Shows the devicetype or firmware
                  type, depending on the job (update/download)
                example: alarmmanager
              id:
                type: integer
                description: >-
                  Present only in update jobs. The id of the device the job is
                  for.
                example: 1
    ota-download:
      type: object
      properties:
        main:
          type: object
          properties:
            pending:
              type: integer
              example: 0
              description: Number of queued jobs which are not yet in progress.
            finished:
              type: integer
              example: 0
              description: Number of finished jobs.
            error:
              type: integer
              example: 0
              description: Number of jobs which failed.
            time:
              example: '2023-06-21T11:08:04.346677Z'
              type: string
              format: date-time
              description: Time of the last update.
            current:
              type: array
              description: >-
                Show a list of jobs that are currently in progress with their
                respective state.
              items:
                type: object
                properties:
                  status:
                    type: string
                    description: Present in all job types. The current status of the job.
                    example: download
                  type:
                    type: string
                    description: >-
                      Present in all job types. Shows the devicetype or firmware
                      type, depending on the job (update/download)
                    example: alarmmanager
                  id:
                    type: integer
                    description: >-
                      Present only in update jobs. The id of the device the job
                      is for.
                    example: 1
        satellite:
          type: object
          properties:
            pending:
              type: integer
              example: 0
              description: Number of queued jobs which are not yet in progress.
            finished:
              type: integer
              example: 0
              description: Number of finished jobs.
            error:
              type: integer
              example: 0
              description: Number of jobs which failed.
            time:
              example: '2023-06-21T11:08:04.346677Z'
              type: string
              format: date-time
              description: Time of the last update.
            current:
              type: array
              description: >-
                Show a list of jobs that are currently in progress with their
                respective state.
              items:
                type: object
                properties:
                  status:
                    type: string
                    description: Present in all job types. The current status of the job.
                    example: download
                  type:
                    type: string
                    description: >-
                      Present in all job types. Shows the devicetype or firmware
                      type, depending on the job (update/download)
                    example: alarmmanager
                  id:
                    type: integer
                    description: >-
                      Present only in update jobs. The id of the device the job
                      is for.
                    example: 1
    update-upload:
      type: object
      properties:
        main:
          type: object
          properties:
            pending:
              type: integer
              example: 0
              description: Number of queued jobs which are not yet in progress.
            finished:
              type: integer
              example: 0
              description: Number of finished jobs.
            error:
              type: integer
              example: 0
              description: Number of jobs which failed.
            time:
              example: '2023-06-21T11:08:04.346677Z'
              type: string
              format: date-time
              description: Time of the last update.
            current:
              type: array
              description: >-
                Show a list of jobs that are currently in progress with their
                respective state.
              items:
                type: object
                properties:
                  status:
                    type: string
                    description: Present in all job types. The current status of the job.
                    example: download
                  type:
                    type: string
                    description: >-
                      Present in all job types. Shows the devicetype or firmware
                      type, depending on the job (update/download)
                    example: alarmmanager
                  id:
                    type: integer
                    description: >-
                      Present only in update jobs. The id of the device the job
                      is for.
                    example: 1
        satellite:
          type: object
          properties:
            pending:
              type: integer
              example: 0
              description: Number of queued jobs which are not yet in progress.
            finished:
              type: integer
              example: 0
              description: Number of finished jobs.
            error:
              type: integer
              example: 0
              description: Number of jobs which failed.
            time:
              example: '2023-06-21T11:08:04.346677Z'
              type: string
              format: date-time
              description: Time of the last update.
            current:
              type: array
              description: >-
                Show a list of jobs that are currently in progress with their
                respective state.
              items:
                type: object
                properties:
                  status:
                    type: string
                    description: Present in all job types. The current status of the job.
                    example: download
                  type:
                    type: string
                    description: >-
                      Present in all job types. Shows the devicetype or firmware
                      type, depending on the job (update/download)
                    example: alarmmanager
                  id:
                    type: integer
                    description: >-
                      Present only in update jobs. The id of the device the job
                      is for.
                    example: 1
    update-update:
      type: object
      properties:
        main:
          type: object
          properties:
            pending:
              type: integer
              example: 0
              description: Number of queued jobs which are not yet in progress.
            finished:
              type: integer
              example: 0
              description: Number of finished jobs.
            error:
              type: integer
              example: 0
              description: Number of jobs which failed.
            time:
              example: '2023-06-21T11:08:04.346677Z'
              type: string
              format: date-time
              description: Time of the last update.
            current:
              type: array
              description: >-
                Show a list of jobs that are currently in progress with their
                respective state.
              items:
                type: object
                properties:
                  status:
                    type: string
                    description: Present in all job types. The current status of the job.
                    example: download
                  type:
                    type: string
                    description: >-
                      Present in all job types. Shows the devicetype or firmware
                      type, depending on the job (update/download)
                    example: alarmmanager
                  id:
                    type: integer
                    description: >-
                      Present only in update jobs. The id of the device the job
                      is for.
                    example: 1
        satellite:
          type: object
          properties:
            pending:
              type: integer
              example: 0
              description: Number of queued jobs which are not yet in progress.
            finished:
              type: integer
              example: 0
              description: Number of finished jobs.
            error:
              type: integer
              example: 0
              description: Number of jobs which failed.
            time:
              example: '2023-06-21T11:08:04.346677Z'
              type: string
              format: date-time
              description: Time of the last update.
            current:
              type: array
              description: >-
                Show a list of jobs that are currently in progress with their
                respective state.
              items:
                type: object
                properties:
                  status:
                    type: string
                    description: Present in all job types. The current status of the job.
                    example: download
                  type:
                    type: string
                    description: >-
                      Present in all job types. Shows the devicetype or firmware
                      type, depending on the job (update/download)
                    example: alarmmanager
                  id:
                    type: integer
                    description: >-
                      Present only in update jobs. The id of the device the job
                      is for.
                    example: 1
    update-state:
      type: object
      properties:
        info:
          type: object
          properties:
            main:
              type: object
              properties:
                download-pending:
                  type: boolean
                  description: >-
                    Indicates if a new update is available and can be
                    downloaded.
                  example: false
                update-pending:
                  type: boolean
                  description: Indicates if an update was downloaded and can be installed.
                  example: false
                version:
                  type: string
                  description: >-
                    Shows the firmware version that can be either downloaded or
                    installed.
                  example: 1.0.0
                build:
                  type: string
                  description: >-
                    Shows the firmware build that can be either downloaded or
                    installed.
                  example: '00001'
            satellite:
              type: object
              properties:
                download-pending:
                  type: boolean
                  description: >-
                    Indicates if a new update is available and can be
                    downloaded.
                  example: false
                update-pending:
                  type: boolean
                  description: Indicates if an update was downloaded and can be installed.
                  example: false
                version:
                  type: string
                  description: >-
                    Shows the firmware version that can be either downloaded or
                    installed.
                  example: 1.0.0
                build:
                  type: string
                  description: >-
                    Shows the firmware build that can be either downloaded or
                    installed.
                  example: '00001'
        ota:
          type: object
          properties:
            main:
              type: object
              properties:
                pending:
                  type: integer
                  example: 0
                  description: Number of queued jobs which are not yet in progress.
                finished:
                  type: integer
                  example: 0
                  description: Number of finished jobs.
                error:
                  type: integer
                  example: 0
                  description: Number of jobs which failed.
                time:
                  example: '2023-06-21T11:08:04.346677Z'
                  type: string
                  format: date-time
                  description: Time of the last update.
                current:
                  type: array
                  description: >-
                    Show a list of jobs that are currently in progress with
                    their respective state.
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: >-
                          Present in all job types. The current status of the
                          job.
                        example: download
                      type:
                        type: string
                        description: >-
                          Present in all job types. Shows the devicetype or
                          firmware type, depending on the job (update/download)
                        example: alarmmanager
                      id:
                        type: integer
                        description: >-
                          Present only in update jobs. The id of the device the
                          job is for.
                        example: 1
            satellite:
              type: object
              properties:
                pending:
                  type: integer
                  example: 0
                  description: Number of queued jobs which are not yet in progress.
                finished:
                  type: integer
                  example: 0
                  description: Number of finished jobs.
                error:
                  type: integer
                  example: 0
                  description: Number of jobs which failed.
                time:
                  example: '2023-06-21T11:08:04.346677Z'
                  type: string
                  format: date-time
                  description: Time of the last update.
                current:
                  type: array
                  description: >-
                    Show a list of jobs that are currently in progress with
                    their respective state.
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: >-
                          Present in all job types. The current status of the
                          job.
                        example: download
                      type:
                        type: string
                        description: >-
                          Present in all job types. Shows the devicetype or
                          firmware type, depending on the job (update/download)
                        example: alarmmanager
                      id:
                        type: integer
                        description: >-
                          Present only in update jobs. The id of the device the
                          job is for.
                        example: 1
        upload:
          type: object
          properties:
            main:
              type: object
              properties:
                pending:
                  type: integer
                  example: 0
                  description: Number of queued jobs which are not yet in progress.
                finished:
                  type: integer
                  example: 0
                  description: Number of finished jobs.
                error:
                  type: integer
                  example: 0
                  description: Number of jobs which failed.
                time:
                  example: '2023-06-21T11:08:04.346677Z'
                  type: string
                  format: date-time
                  description: Time of the last update.
                current:
                  type: array
                  description: >-
                    Show a list of jobs that are currently in progress with
                    their respective state.
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: >-
                          Present in all job types. The current status of the
                          job.
                        example: download
                      type:
                        type: string
                        description: >-
                          Present in all job types. Shows the devicetype or
                          firmware type, depending on the job (update/download)
                        example: alarmmanager
                      id:
                        type: integer
                        description: >-
                          Present only in update jobs. The id of the device the
                          job is for.
                        example: 1
            satellite:
              type: object
              properties:
                pending:
                  type: integer
                  example: 0
                  description: Number of queued jobs which are not yet in progress.
                finished:
                  type: integer
                  example: 0
                  description: Number of finished jobs.
                error:
                  type: integer
                  example: 0
                  description: Number of jobs which failed.
                time:
                  example: '2023-06-21T11:08:04.346677Z'
                  type: string
                  format: date-time
                  description: Time of the last update.
                current:
                  type: array
                  description: >-
                    Show a list of jobs that are currently in progress with
                    their respective state.
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: >-
                          Present in all job types. The current status of the
                          job.
                        example: download
                      type:
                        type: string
                        description: >-
                          Present in all job types. Shows the devicetype or
                          firmware type, depending on the job (update/download)
                        example: alarmmanager
                      id:
                        type: integer
                        description: >-
                          Present only in update jobs. The id of the device the
                          job is for.
                        example: 1
        update:
          type: object
          properties:
            main:
              type: object
              properties:
                pending:
                  type: integer
                  example: 0
                  description: Number of queued jobs which are not yet in progress.
                finished:
                  type: integer
                  example: 0
                  description: Number of finished jobs.
                error:
                  type: integer
                  example: 0
                  description: Number of jobs which failed.
                time:
                  example: '2023-06-21T11:08:04.346677Z'
                  type: string
                  format: date-time
                  description: Time of the last update.
                current:
                  type: array
                  description: >-
                    Show a list of jobs that are currently in progress with
                    their respective state.
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: >-
                          Present in all job types. The current status of the
                          job.
                        example: download
                      type:
                        type: string
                        description: >-
                          Present in all job types. Shows the devicetype or
                          firmware type, depending on the job (update/download)
                        example: alarmmanager
                      id:
                        type: integer
                        description: >-
                          Present only in update jobs. The id of the device the
                          job is for.
                        example: 1
            satellite:
              type: object
              properties:
                pending:
                  type: integer
                  example: 0
                  description: Number of queued jobs which are not yet in progress.
                finished:
                  type: integer
                  example: 0
                  description: Number of finished jobs.
                error:
                  type: integer
                  example: 0
                  description: Number of jobs which failed.
                time:
                  example: '2023-06-21T11:08:04.346677Z'
                  type: string
                  format: date-time
                  description: Time of the last update.
                current:
                  type: array
                  description: >-
                    Show a list of jobs that are currently in progress with
                    their respective state.
                  items:
                    type: object
                    properties:
                      status:
                        type: string
                        description: >-
                          Present in all job types. The current status of the
                          job.
                        example: download
                      type:
                        type: string
                        description: >-
                          Present in all job types. Shows the devicetype or
                          firmware type, depending on the job (update/download)
                        example: alarmmanager
                      id:
                        type: integer
                        description: >-
                          Present only in update jobs. The id of the device the
                          job is for.
                        example: 1
  responses:
    Unauthorized:
      description: Unauthorized - Either no or an invalid token was provided.
    NotFound:
      description: Not Found - The requested resource could not be found.
    UnprocessableEntity:
      description: >-
        Unprocessable Entity - The request was well-formed but was unable to be
        followed due to semantic errors.
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              errors:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
          example:
            message: The field must not be empty.
            errors:
              field:
                - The field must not be empty.
    BadRequest:
      description: Bad Request - Cannot or will not handle the request.
    MethodNotAllowed:
      description: Method Not Allowed - Used HTTP method is not allowed for this route.
    Forbidden:
      description: Forbidden - Either no or invalid credentials were provided.
    ServiceUnavailable:
      description: Service Unavailable - Not ready to handle the request.
x-tagGroups:
  - name: Access-Event
    tags:
      - access-event
      - access-event-export
      - access-event-images
  - name: Access-Settings
    tags:
      - access
  - name: Accessmanager
    tags:
      - accessmanagers
      - accessmanagers-names
      - accessmanager-accessmanager_id
  - name: Alarm-Event
    tags:
      - alarm-event
      - alarm-event-export
      - alarm-event-images
  - name: Alarmgroup Arm/Disarm
    tags:
      - alarmgroups
      - alarmgroup
      - alarmgroup-arm
      - alarmgroup-disarm
      - alarmgroup-quit
      - alarmgroup-state
  - name: Alarm Siren (Ethernet)
    tags:
      - alarmhorn
      - alarmhorn-names
      - alarmhorn-id
  - name: Alarmmanager
    tags:
      - alarmmanager
      - alarmmanager-names
      - alarmmanager-id
  - name: Anti-Passback
    tags:
      - anti-passback-settings
      - anti-passback-users
      - anti-passback
  - name: Backup
    tags:
      - backup
      - autobackup
  - name: Cameras
    tags:
      - cameras
      - cameras-names
      - camera_id
      - camera_live_image
  - name: KentixONE Onlineservice
    tags:
      - cloud
  - name: Dashboard Data
    tags:
      - dashboard
  - name: Date & Time
    tags:
      - datetimeconfig
      - mail
      - mailtest
      - region
  - name: Device-Info
    tags:
      - device-info
  - name: Doorlocks
    tags:
      - doorlocklist
      - doorlocksingle
      - doorlockopen
      - doorlockinfo
      - doorlocknames
      - doorlocklock
      - doorlockunlock
  - name: Exceptionday Profiles
    tags:
      - blockingprofiles
      - blockingprofiles-id
      - blockingprofiles-import
  - name: Extension Module Assignments
    tags:
      - extmodassignment
  - name: GSM
    tags:
      - gsm
      - sim
      - sms-gateway
  - name: Measurement history
    tags:
      - history
  - name: Integration
    tags:
      - integration
  - name: IO-Module
    tags:
      - iomodule
      - iomodule-names
      - iomodule-id
  - name: Io-States
    tags:
      - iostates
  - name: Kentix AI settings
    tags:
      - kentix-ai
  - name: KPIs
    tags:
      - kpiconfig
  - name: LDAP
    tags:
      - ldap
      - ldapsync
  - name: Levelprofile
    tags:
      - levelprofile
      - levelprofile-id
      - levelprofile-names
  - name: Massedit
    tags:
      - massedit
  - name: MultiSensor
    tags:
      - multisensor
      - multisensor-names
      - multisensor-id
  - name: Network-Sensor
    tags:
      - network-sensor
      - network-sensor-names
      - network-sensor-id
  - name: Network
    tags:
      - networkconfig
      - sslcertificate
  - name: Passages
    tags:
      - passage
      - passage-id
      - passage-names
  - name: Powermanager
    tags:
      - powermanagers-name
      - powermanagers
      - powermanager
      - kmpdu-overview
      - outlet
      - outlet-switch
  - name: Privacy
    tags:
      - privacy
  - name: Profile
    tags:
      - profile
  - name: Proxy
    tags:
      - proxy
  - name: shortcuts
    tags:
      - quicklinks
  - name: Rack
    tags:
      - rack
      - rack-names
      - rack-id
      - rack-attach
  - name: Reset
    tags:
      - reset
      - reboot
  - name: Security
    tags:
      - security
  - name: Outputs
    tags:
      - signal
  - name: systemname
    tags:
      - systemname
  - name: Teachin
    tags:
      - teachin
  - name: Teachout
    tags:
      - teachout
  - name: systemupdate
    tags:
      - update
      - update-settings
      - ota-update
      - update-state
