@itentialopensource/adapter-sevone

openapi: 3.0.0 info: title: adapter-sevone contact: {} version: '1.0.0' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com paths: /alerts/{pathv1}: get: summary: getAlerts description: '' operationId: getAlerts parameters: - name: alertId in: path description: '' required: true style: simple schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: updateAlert description: '' operationId: updateAlert parameters: - name: alertId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteAlert description: '' operationId: deleteAlert parameters: - name: alertId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /alerts/filter: post: summary: getAlertsFiltered description: '' operationId: getAlertsFiltered parameters: - name: uriOptions in: query description: '' style: form explode: true schema: type: object requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /alerts/devices/{pathv1}: get: summary: getAlertsForDevice description: '' operationId: getAlertsForDevice parameters: - name: deviceId in: path description: '' required: true style: simple schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}/connection/{pathv2}/alerts: get: summary: getAlertsForMapConnection description: '' operationId: getAlertsForMapConnection parameters: - name: mapId in: path description: '' required: true style: simple schema: type: string - name: connectionId in: path description: '' required: true style: simple schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}/node/{pathv2}/alerts: get: summary: getAlertsForMapNode description: '' operationId: getAlertsForMapNode parameters: - name: mapId in: path description: '' required: true style: simple schema: type: string - name: nodeId in: path description: '' required: true style: simple schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /alerts: post: summary: createAlert description: '' operationId: createAlert parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /alerts/{pathv1}/assign/{pathv2}: patch: summary: assignAlert description: '' operationId: assignAlert parameters: - name: alertId in: path description: '' required: true style: simple schema: type: string - name: username in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /alerts/{pathv1}/ignore/{pathv2}: patch: summary: ignoreAlert description: '' operationId: ignoreAlert parameters: - name: alertId in: query description: '' style: form explode: true schema: type: string - name: ignoreUntil in: query description: '' style: form explode: true schema: type: integer format: int32 - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /alerts/{pathv1}/clear: patch: summary: clearAlert description: '' operationId: clearAlert parameters: - name: alertId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/{pathv1}: get: summary: getDevices description: '' operationId: getDevices parameters: - name: deviceId in: path description: '' required: true style: simple schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: updateDevice description: '' operationId: updateDevice parameters: - name: deviceId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/filter: post: summary: getDevicesFiltered description: '' operationId: getDevicesFiltered parameters: - name: uriOptions in: query description: '' style: form explode: true schema: type: object requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices: post: summary: createDevice description: '' operationId: createDevice parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devicegroups/{pathv1}: get: summary: getDeviceGroups description: '' operationId: getDeviceGroups parameters: - name: groupId in: path description: '' required: true style: simple schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: updateDeviceGroup description: '' operationId: updateDeviceGroup parameters: - name: groupId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteDeviceGroup description: '' operationId: deleteDeviceGroup parameters: - name: groupId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devicegroups: post: summary: createDeviceGroup description: '' operationId: createDeviceGroup parameters: [] requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devicegroups/{pathv1}/members/{pathv2}: post: summary: addDeviceToGroup description: '' operationId: addDeviceToGroup parameters: - name: deviceId in: path description: '' required: true style: simple schema: type: string - name: groupId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: removeDeviceFromGroup description: '' operationId: removeDeviceFromGroup parameters: - name: deviceId in: path description: '' required: true style: simple schema: type: string - name: groupId in: path description: '' required: true style: simple schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/{pathv1}/objects/{pathv2}: get: summary: getDeviceComponents description: '' operationId: getDeviceComponents parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: deviceName in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: componentName in: query description: '' style: form explode: true schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: updateDeviceComponent description: '' operationId: updateDeviceComponent parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: componentObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteDeviceComponent description: '' operationId: deleteDeviceComponent parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/objects/filter: post: summary: getDeviceComponentsFiltered description: '' operationId: getDeviceComponentsFiltered parameters: - name: filterObj in: query description: '' style: form explode: true schema: type: object - name: uriOptions in: query description: '' style: form explode: true schema: type: object requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/{pathv1}/objects: post: summary: createDeviceComponent description: '' operationId: createDeviceComponent parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: componentObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /objectgroups/{pathv1}: get: summary: getComponentGroups description: '' operationId: getComponentGroups parameters: - name: groupId in: query description: '' style: form explode: true schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: updateComponentGroup description: '' operationId: updateComponentGroup parameters: - name: groupId in: query description: '' style: form explode: true schema: type: string - name: groupObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteComponentGroup description: '' operationId: deleteComponentGroup parameters: - name: groupId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /objectgroups: post: summary: createComponentGroup description: '' operationId: createComponentGroup parameters: - name: groupObj in: query description: '' style: form explode: true schema: type: object requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /objectgroups/{pathv1}/members: post: summary: addDeviceComponentToGroup description: '' operationId: addDeviceComponentToGroup parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: groupId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: removeDeviceComponentFromGroup description: '' operationId: removeDeviceComponentFromGroup parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: groupId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/{pathv1}/objects/{pathv2}/indicators/{pathv3}: get: summary: getIndicators description: '' operationId: getIndicators parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: deviceName in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: componentName in: query description: '' style: form explode: true schema: type: string - name: indicatorId in: query description: '' style: form explode: true schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string - name: pathv3 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /devices/{pathv1}/objects/{pathv2}/indicators/{pathv3}/data: get: summary: getIndicatorData description: '' operationId: getIndicatorData parameters: - name: deviceId in: query description: '' style: form explode: true schema: type: string - name: deviceName in: query description: '' style: form explode: true schema: type: string - name: componentId in: query description: '' style: form explode: true schema: type: string - name: componentName in: query description: '' style: form explode: true schema: type: string - name: indicatorId in: query description: '' style: form explode: true schema: type: string - name: startTime in: query description: '' style: form explode: true schema: type: integer format: int32 - name: endTime in: query description: '' style: form explode: true schema: type: integer format: int32 - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string - name: pathv3 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /device-indicators/data: post: summary: createIndicatorData description: '' operationId: createIndicatorData parameters: - name: indicatorObj in: query description: '' style: form explode: true schema: type: object requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}: get: summary: getMaps description: '' operationId: getMaps parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false put: summary: updateMap description: '' operationId: updateMap parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: mapObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteMap description: '' operationId: deleteMap parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps: post: summary: createMap description: '' operationId: createMap parameters: - name: mapObj in: query description: '' style: form explode: true schema: type: object requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}/connections: get: summary: getMapConnections description: '' operationId: getMapConnections parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false post: summary: createMapConnection description: '' operationId: createMapConnection parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: connectionObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}/connections/{pathv2}: put: summary: updateMapConnection description: '' operationId: updateMapConnection parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: connectionId in: query description: '' style: form explode: true schema: type: string - name: connectionObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteMapConnection description: '' operationId: deleteMapConnection parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: connectionId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}/nodes: get: summary: getMapNodes description: '' operationId: getMapNodes parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: uriOptions in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false post: summary: createMapNode description: '' operationId: createMapNode parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: nodeObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /maps/{pathv1}/nodes/{pathv2}: put: summary: updateMapNode description: '' operationId: updateMapNode parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: nodeId in: query description: '' style: form explode: true schema: type: string - name: nodeObj in: query description: '' style: form explode: true schema: type: object - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false delete: summary: deleteMapNode description: '' operationId: deleteMapNode parameters: - name: mapId in: query description: '' style: form explode: true schema: type: string - name: nodeId in: query description: '' style: form explode: true schema: type: string - name: pathv1 in: path description: '' required: true style: simple schema: type: string - name: pathv2 in: path description: '' required: true style: simple schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /api/v1/reports/attachments/objects/{id}/resources: get: summary: getObjectAttachmentResources description: '' operationId: getObjectAttachmentResources parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentResourceV1' deprecated: false put: summary: updateObjectAttachmentResources description: '' operationId: updateObjectAttachmentResources parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentResourceV1' deprecated: false /api/v1/reports/attachments/objects/{id}/settings: get: summary: getObjectAttachmentSettings description: '' operationId: getObjectAttachmentSettings parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentSettingsV1' deprecated: false put: summary: updateObjectAttachmentSettings description: '' operationId: updateObjectAttachmentSettings parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentSettingsV1' deprecated: false /api/v1/reports/attachments/objects/{id}/visualizations: get: summary: getObjectAttachmentVisualizationSettings description: '' operationId: getObjectAttachmentVisualizationSettings parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentVisualizationV1' deprecated: false put: summary: updateObjectAttachmentVisualizationSettings description: '' operationId: updateObjectAttachmentVisualizationSettings parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentVisualizationV1' deprecated: false patch: summary: partiallyUpdateObjectAttachmentVisualizationSettings description: '' operationId: partiallyUpdateObjectAttachmentVisualizationSettings parameters: - name: id in: path description: '' required: true style: simple schema: type: number format: double requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ObjectAttachmentVisualizationV1' deprecated: false /api/v1/reports/{id}/attachments/objects: post: summary: createObjectAttachment description: '' operationId: createObjectAttachment parameters: