@itentialopensource/adapter-sevone_v2/report/adapter-openapi.yaml

This adapter integrates with system described as: SevOne v2 api.

openapi: 3.0.0
info:
  title: SevOne API Documentation
  description: Supported endpoints by the new RESTful API
  contact: {}
  version: '2.1.28, Hash: 4224c54'
servers:
- url: http://10.133.179.186/
  variables: {}
paths:
  /api/v2/reports/attachments/objects/{id}:
    get:
      tags:
      - Report Attachments Objects
      summary: getObjectAttachment
      description: Get an existing object attachment
      operationId: getObjectAttachment
      parameters:
      - name: id
        in: path
        description: Object attachment id
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentResponseDto'
      deprecated: false
  /api/v2/reports/attachments/objects/{id}/resources:
    get:
      tags:
      - Report Attachments Objects
      summary: getObjectAttachmentResources
      description: Get Objects resources
      operationId: getObjectAttachmentResources
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentResource'
      deprecated: false
    put:
      tags:
      - Report Attachments Objects
      summary: updateObjectAttachmentResources
      description: Update Objects resources
      operationId: updateObjectAttachmentResources
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object attachment resources
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ObjectAttachmentResource'
              - description: Object attachment resources
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentResource'
      deprecated: false
  /api/v2/reports/attachments/objects/{id}/settings:
    get:
      tags:
      - Report Attachments Objects
      summary: getObjectAttachmentSettings
      description: Get Objects attachment settings
      operationId: getObjectAttachmentSettings
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentSettings'
      deprecated: false
    put:
      tags:
      - Report Attachments Objects
      summary: updateObjectAttachmentSettings
      description: Update Object attachment settings
      operationId: updateObjectAttachmentSettings
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object attachment settings
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ObjectAttachmentSettings'
              - description: Object attachment settings
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentSettings'
      deprecated: false
  /api/v2/reports/attachments/objects/{id}/visualizations:
    get:
      tags:
      - Report Attachments Objects
      summary: getObjectAttachmentVisualizationSettings
      description: Get objects attachment visualization settings
      operationId: getObjectAttachmentVisualizationSettings
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentVisualization'
      deprecated: false
    put:
      tags:
      - Report Attachments Objects
      summary: updateObjectAttachmentVisualizationSettings
      description: Update Objects visualization settings
      operationId: updateObjectAttachmentVisualizationSettings
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object attachment visualization settings
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ObjectAttachmentVisualization'
              - description: Object attachment visualization settings
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentVisualization'
      deprecated: false
    patch:
      tags:
      - Report Attachments Objects
      summary: partiallyUpdateObjectAttachmentVisualizationSettings
      description: Partially update objects visualization settings
      operationId: partiallyUpdateObjectAttachmentVisualizationSettings
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object attachment visualization settings
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ObjectAttachmentVisualization'
              - description: Object attachment visualization settings
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentVisualization'
      deprecated: false
  /api/v2/reports/{id}/attachments/objects:
    post:
      tags:
      - Report Attachments Objects
      summary: createObjectAttachment
      description: Create a new objects attachment
      operationId: createObjectAttachment
      parameters:
      - name: id
        in: path
        description: The id of the report where the report attachment will be created
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object report attachment
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ObjectAttachmentRequestDto'
              - description: Object report attachment
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectAttachmentResponseDto'
      deprecated: false
  /api/v2/devicetypes:
    get:
      tags:
      - DeviceTypes
      summary: getDeviceTypes
      description: Endpoint for retrieving all device types that supports pagination
      operationId: getDeviceTypes
      parameters:
      - name: page
        in: query
        description: The number of the requested page, defaults to 0
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The size of the requested page, defaults to 20; limited to a configurable maximum (10000 by default)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: includeCount
        in: query
        description: Whether to query for total elements count; defaults to true, set to false for performance boost
        style: form
        explode: true
        schema:
          type: boolean
      - name: sortBy
        in: query
        description: String array of format "parameter, -parameter, natural\*parameter, -natural\*parameter", where minus is for descending, natural* is for natural sort
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: String array of format "id,name,objects(id,pluginId)"; Defines which fields are returned
        style: form
        explode: true
        schema:
          type: string
      - name: includeObjectTypes
        in: query
        description: Determines whether to include object type members of device types
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagerOfDeviceTypeResponseDto'
      deprecated: false
    post:
      tags:
      - DeviceTypes
      summary: createDeviceType
      description: Create new device type
      operationId: createDeviceType
      parameters: []
      requestBody:
        description: Device request object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeviceTypeRequestDto'
              - description: Device request object
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTypeResponseDto'
      deprecated: false
  /api/v2/devicetypes/ancestors/{ids}:
    get:
      tags:
      - DeviceTypes
      summary: getAncestorsForDeviceTypes
      description: Gets a list of ancestors for each type id in the input list
      operationId: getAncestorsForDeviceTypes
      parameters:
      - name: ids
        in: path
        description: The ids of the device types
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/DeviceTypeDto'
      deprecated: false
  /api/v2/devicetypes/filter:
    post:
      tags:
      - DeviceTypes
      summary: filterDeviceTypes
      description: Find all device types that match the criteria
      operationId: filterDeviceTypes
      parameters:
      - name: includeDevices
        in: query
        description: Determines whether to include device members of device types
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeObjectTypes
        in: query
        description: Determines whether to include object type members of device types
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: page
        in: query
        description: The number of the requested page, defaults to 0
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The size of the requested page, defaults to 20; limited to a configurable maximum (10000 by default)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: includeCount
        in: query
        description: Whether to query for total elements count; defaults to true, set to false for performance boost
        style: form
        explode: true
        schema:
          type: boolean
      - name: sortBy
        in: query
        description: String array of format "parameter, -parameter, natural\*parameter, -natural\*parameter", where minus is for descending, natural* is for natural sort
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: String array of format "id,name,objects(id,pluginId)"; Defines which fields are returned
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Device group filter that will be used for filtering
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeviceGroupFilter'
              - description: Device group filter that will be used for filtering
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagerOfDeviceTypeResponseDto'
      deprecated: false
  /api/v2/devicetypes/members/{deviceId}:
    get:
      tags:
      - DeviceTypes
      summary: getDeviceTypeForDeviceById
      description: Get devices types for device
      operationId: getDeviceTypeForDeviceById
      parameters:
      - name: deviceId
        in: path
        description: Device id
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: sortBy
        in: query
        description: String array of format "property, -property", where minus is for descending
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeviceTypeDto'
                description: ''
      deprecated: false
  /api/v2/devicetypes/{id}:
    get:
      tags:
      - DeviceTypes
      summary: getDeviceTypeById
      description: Get device type by device id.
      operationId: getDeviceTypeById
      parameters:
      - name: id
        in: path
        description: Device type id
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceTypeResponseDto'
      deprecated: false
    delete:
      tags:
      - DeviceTypes
      summary: deleteDeviceTypeById
      description: Deletes an existing device type
      operationId: deleteDeviceTypeById
      parameters:
      - name: id
        in: path
        description: The id of the device type to be deleted
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
      deprecated: false
  /api/v2/devicetypes/{id}/ancestors:
    get:
      tags:
      - DeviceTypes
      summary: getAncestorsForDeviceType
      description: Gets a list of ancestors for each type id in the input list
      operationId: getAncestorsForDeviceType
      parameters:
      - name: id
        in: path
        description: The id of the device type
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/DeviceTypeDto'
      deprecated: false
  /api/v2/devicetypes/{id}/members/{deviceId}:
    post:
      tags:
      - DeviceTypes
      summary: addMemberByIdToType
      description: Adds an existing device to a device type
      operationId: addMemberByIdToType
      parameters:
      - name: id
        in: path
        description: The id of the device type
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: deviceId
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - DeviceTypes
      summary: deleteDeviceTypeMemberById
      description: Removes a single device from a device type
      operationId: deleteDeviceTypeMemberById
      parameters:
      - name: id
        in: path
        description: The id of the device type
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: deviceId
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
      deprecated: false
  /api/v2/devices/objects/filter:
    post:
      tags:
      - Objects
      summary: filterObjects
      description: Filter the entire object collection with provided filter
      operationId: filterObjects
      parameters:
      - name: includeIndicators
        in: query
        description: Determines whether to include indicators or not
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeExtendedInfo
        in: query
        description: Determines whether to include extendedInfo or not
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: page
        in: query
        description: The number of the requested page, defaults to 0
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The size of the requested page, defaults to 20; limited to a configurable maximum (10000 by default)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: includeCount
        in: query
        description: Whether to query for total elements count; defaults to true, set to false for performance boost
        style: form
        explode: true
        schema:
          type: boolean
      - name: sortBy
        in: query
        description: String array of format "parameter, -parameter, natural\*parameter, -natural\*parameter", where minus is for descending, natural* is for natural sort
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: String array of format "id,name,objects(id,pluginId)"; Defines which fields are returned
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: ObjectFilter will be used for applying filtering to the set of objects.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ObjectFilter'
              - description: ObjectFilter will be used for applying filtering to the set of objects.
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagerOfDeviceObjectDto'
      deprecated: false
  /api/v2/devices/{deviceId}/objects:
    get:
      tags:
      - Objects
      summary: getObjects
      description: Endpoint for retrieving all objects for a specific device
      operationId: getObjects
      parameters:
      - name: deviceId
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: includeIndicators
        in: query
        description: Determines whether to include indicators
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeIndicatorMetadata
        in: query
        description: Determines whether to include indicator metadata
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeExtendedInfo
        in: query
        description: Determines whether to include extendedInfo or not
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      - name: page
        in: query
        description: The number of the requested page, defaults to 0
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The size of the requested page, defaults to 20; limited to a configurable maximum (10000 by default)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: includeCount
        in: query
        description: Whether to query for total elements count; defaults to true, set to false for performance boost
        style: form
        explode: true
        schema:
          type: boolean
      - name: sortBy
        in: query
        description: String array of format "parameter, -parameter, natural\*parameter, -natural\*parameter", where minus is for descending, natural* is for natural sort
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: String array of format "id,name,objects(id,pluginId)"; Defines which fields are returned
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagerOfDeviceObjectDto'
      deprecated: false
    post:
      tags:
      - Objects
      summary: createObject
      description: Creates a new object for a specific device
      operationId: createObject
      parameters:
      - name: deviceId
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object that will be created
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeviceObjectRequestDto'
              - description: Object that will be created
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceObjectDto'
      deprecated: false
  /api/v2/devices/{deviceId}/objects/{id}:
    get:
      tags:
      - Objects
      summary: getObjectById
      description: Gets a single object object by provided Id if it exists
      operationId: getObjectById
      parameters:
      - name: deviceId
        in: path
        description: The id of the device this object belongs to
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: The id of the object
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: includeIndicators
        in: query
        description: Determines whether to include indicators
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeIndicatorMetadata
        in: query
        description: Determines whether to include indicator metadata
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeExtendedInfo
        in: query
        description: Determines whether to include extendedInfo or not
        style: form
        explode: true
        schema:
          type: boolean
          default: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceObjectDto'
      deprecated: false
    put:
      tags:
      - Objects
      summary: updateObjectById
      description: Updates an existing object
      operationId: updateObjectById
      parameters:
      - name: deviceId
        in: path
        description: The id of the device this object belongs to
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: The id of the object to be updated
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: DeviceObjectDto to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeviceObjectUpdateRequestDto'
              - description: DeviceObjectDto to be updated
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceObjectDto'
      deprecated: false
    delete:
      tags:
      - Objects
      summary: deleteObjectById
      description: Deletes an existing object
      operationId: deleteObjectById
      parameters:
      - name: deviceId
        in: path
        description: The id of the device this object belongs to
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: The id of the object to be deleted
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
      deprecated: false
    patch:
      tags:
      - Objects
      summary: partiallyUpdateObjectById
      description: Partially updates an existing object
      operationId: partiallyUpdateObjectById
      parameters:
      - name: deviceId
        in: path
        description: The id of the device this object belongs to
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: id
        in: path
        description: The id of the object to be updated
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Object to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeviceObjectUpdateRequestDto'
              - description: Object to be updated
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceObjectDto'
      deprecated: false
  /api/v2/reports/attachments/statusmap/{id}:
    get:
      tags:
      - Report Attachments StatusMap
      summary: getStatusAttachment
      description: Get an existing status map attachment
      operationId: getStatusAttachment
      parameters:
      - name: id
        in: path
        description: StatusMap attachment id
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusMapAttachmentResponseDto'
      deprecated: false
  /api/v2/reports/attachments/statusmap/{id}/resources:
    get:
      tags:
      - Report Attachments StatusMap
      summary: getStatusMapAttachmentResources
      description: Get statusmap resources
      operationId: getStatusMapAttachmentResources
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusMapAttachmentResource'
      deprecated: false
    put:
      tags:
      - Report Attachments StatusMap
      summary: updateStatusMapAttachmentResources
      description: Update statusmap resources
      operationId: updateStatusMapAttachmentResources
      parameters:
      - name: id
        in: path
        description: The id of the report attachment
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: StatusMap attachment resources
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/StatusMapAttachmentResource'
              - description: StatusMap attachment resources
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusMapAttachmentResource'
      deprecated: false
  /api/v2/reports/{id}/attachments/statusmap:
    post:
      tags:
      - Report Attachments StatusMap
      summary: createStatusMapAttachment
      description: Create a new statusmap attachment
      operationId: createStatusMapAttachment
      parameters:
      - name: id
        in: path
        description: The id of the report where the report attachment will be created
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: StatusMap attachment object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/StatusMapAttachmentRequestDto'
              - description: StatusMap attachment object
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusMapAttachmentResponseDto'
      deprecated: false
  /api/v2/users/api-keys:
    get:
      tags:
      - Api Keys
      summary: getApiKeys
      description: View your api keys
      operationId: getApiKeys
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiKeyDto'
                description: ''
      deprecated: false
    post:
      tags:
      - Api Keys
      summary: createApiKey
      description: Generate api key
      operationId: createApiKey
      parameters: []
      requestBody:
        description: Api key request object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiKeyRequestDto'
              - description: Api key request object
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDto'
      deprecated: false
    delete:
      tags:
      - Api Keys
      summary: deleteApiKeys
      description: Delete all your api keys
      operationId: deleteApiKeys
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int64
      deprecated: false
  /api/v2/users/api-keys/{apiKey}:
    put:
      tags:
      - Api Keys
      summary: updateApiKey
      description: Update your api key
      operationId: updateApiKey
      parameters:
      - name: apiKey
        in: path
        description: Api key as string
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Api key request object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiKeyRequestDto'
              - description: Api key request object
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDto'
      deprecated: false
    delete:
      tags:
      - Api Keys
      summary: deleteApiKey
      description: Delete your api key
      operationId: deleteApiKey
      parameters:
      - name: apiKey
        in: path
        description: Api key as string
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int64
      deprecated: false
  /api/v2/users/{id}/api-keys:
    get:
      tags:
      - Api Keys
      summary: getApiKeysForUser
      description: View api keys for user
      operationId: getApiKeysForUser
      parameters:
      - name: id
        in: path
        description: User for which api keys will be returned
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiKeyDto'
                description: ''
      deprecated: false
    post:
      tags:
      - Api Keys
      summary: createApiKeyForUser
      description: Generate api key for user
      operationId: createApiKeyForUser
      parameters:
      - name: id
        in: path
        description: User for which api key will be created
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Api key request object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiKeyRequestDto'
              - description: Api key request object
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDto'
      deprecated: false
    delete:
      tags:
      - Api Keys
      summary: deleteApiKeysForUser
      description: Delete api keys for user
      operationId: deleteApiKeysForUser
      parameters:
      - name: id
        in: path
        description: User for which api keys will be deleted
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int64
      deprecated: false
  /api/v2/users/{id}/api-keys/{apiKey}:
    put:
      tags:
      - Api Keys
      summary: updateApiKeyForUser
      description: Update api key for user
      operationId: updateApiKeyForUser
      parameters:
      - name: id
        in: path
        description: User for which api key will be updated
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: apiKey
        in: path
        description: Api key for which meta data will be updated
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Api key request object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApiKeyRequestDto'
              - description: Api key request object
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDto'
      deprecated: false
    delete:
      tags:
      - Api Keys
      summary: deleteApiKeyForUser
      description: Delete api key for user
      operationId: deleteApiKeyForUser
      parameters:
      - name: apiKey
        in: path
        description: Api key as string
        required: true
        style: simple
        schema:
          type: string
      - name: id
        in: path
        description: User for which api key will be deleted
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: integer
                format: int64
      deprecated: false
  /api/v2/discovery:
    get:
      tags:
      - Discovery
      summary: getDevicesInDiscovery
      description: Endpoint for retrieving all devices currently in the discovery queue that supports pagination
      operationId: getDevicesInDiscovery
      parameters:
      - name: includeMembers
        in: query
        description: Determines whether to include devices in the response
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: page
        in: query
        description: The number of the requested page, defaults to 0
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The size of the requested page, defaults to 20; limited to a configurable maximum (10000 by default)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: includeCount
        in: query
        description: Whether to query for total elements count; defaults to true, set to false for performance boost
        style: form
        explode: true
        schema:
          type: boolean
      - name: sortBy
        in: query
        description: String array of format "parameter, -parameter, natural\*parameter, -natural\*parameter", where minus is for descending, natural* is for natural sort
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: String array of format "id,name,objects(id,pluginId)"; Defines which fields are returned
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagerOfDeviceDiscoveryDto'
      deprecated: false
  /api/v2/discovery/filter:
    post:
      tags:
      - Discovery
      summary: filterDevicesInDiscovery
      description: Find all devices that match the criteria
      operationId: filterDevicesInDiscovery
      parameters:
      - name: includeMembers
        in: query
        description: Determines whether to include devices
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeObjects
        in: query
        description: Determines whether to include objects
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: includeIndicators
        in: query
        description: Determines whether to include indicators
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      - name: page
        in: query
        description: The number of the requested page, defaults to 0
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: The size of the requested page, defaults to 20; limited to a configurable maximum (10000 by default)
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: includeCount
        in: query
        description: Whether to query for total elements count; defaults to true, set to false for performance boost
        style: form
        explode: true
        schema:
          type: boolean
      - name: sortBy
        in: query
        description: String array of format "parameter, -parameter, natural\*parameter, -natural\*parameter", where minus is for descending, natural* is for natural sort
        style: form
        explode: true
        schema:
          type: string
      - name: fields
        in: query
        description: String array of format "id,name,objects(id,pluginId)"; Defines which fields are returned
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        description: Device discovery object that will be used for filtering
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DeviceDiscoveryFilter'
              - description: Device discovery object that will be used for filtering
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagerOfDeviceDiscoveryDto'
      deprecated: false
  /api/v2/discovery/run:
    post:
      tags:
      - Discovery
      summary: runDiscoveryAllDevices
      description: Can be executed only from system administrators
      operationId: runDiscoveryAllDevices
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
      deprecated: false
  /api/v2/discovery/{id}:
    get:
      tags:
      - Discovery
      summary: getDeviceStatusById
      description: Gets a single device status object by provided Id from the discovery queue
      operationId: getDeviceStatusById
      parameters:
      - name: id
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      - name: includeMembers
        in: query
        description: Determines whether to include devices in the response
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceDiscoveryDto'
      deprecated: false
    patch:
      tags:
      - Discovery
      summary: updateDevicePriority
      description: Updates an existing task for this device in the discovery queue
      operationId: updateDevicePriority
      parameters:
      - name: id
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      requestBody:
        description: Discovery request object to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DiscoveryRequestDto'
              - description: Discovery request object to be updated
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceDiscoveryDto'
      deprecated: false
  /api/v2/discovery/{id}/run:
    post:
      tags:
      - Discovery
      summary: runDiscoverDevice
      description: Needed Edit access to the concrete device
      operationId: runDiscoverDevice
      parameters:
      - name: id
        in: path
        description: The id of the device
        required: true
        style: simple
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEntity'
      deprecated: false
  /api/v2/topnviews:
    get:
      tags:
      - TopNViews
      summary: getTopNViews
      description: Endpoint for retrieving all views that supports pagination
      operationId: getTopNViews
      parameters:
      - name: name
        in: query
        description: Filter by TopNView name
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: