UNPKG

@itentialopensource/adapter-sevone_v2

Version:

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

1,406 lines 8.49 MB
{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/reports/attachments/objects/{id}": { "get": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "getObjectAttachment", "description": "The parameters and request body are for method: getObjectAttachment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "resource": { "type": "object", "properties": { "deviceId": { "type": "number" }, "ids": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" } } }, "settings": { "type": "object", "properties": { "resultLimit": { "type": "object", "properties": { "resultLimit": { "type": "number" } } } } }, "visualization": { "type": "object", "properties": { "table": { "type": "object", "properties": { "column": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "dataPresentation": { "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "number" } } }, "table": { "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } }, "example": { "name": "string", "resource": { "deviceId": 6, "ids": [ 5, 4, 7, 3, 2, 10, 2, 5, 8, 2 ], "type": "Object" }, "settings": { "resultLimit": { "resultLimit": 4 } }, "visualization": { "table": { "column": { "exclude": [ "string", "string", "string", "string", "string" ], "include": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, "dataPresentation": { "formatNumbers": true, "precision": 10 }, "table": { "blockVis": true, "hideHeaders": false, "wrapCells": false } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/reports/attachments/objects/{id}/resources": { "get": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "getObjectAttachmentResources", "description": "The parameters and request body are for method: getObjectAttachmentResources. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "number" }, "ids": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" } } }, "example": { "deviceId": 7, "ids": [ 10, 8, 10, 2 ], "type": "Device" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "updateObjectAttachmentResources", "description": "The parameters and request body are for method: updateObjectAttachmentResources. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "number" }, "ids": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" } } }, "example": { "deviceId": 2, "ids": [ 8, 1, 1, 9, 1 ], "type": "Device" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/reports/attachments/objects/{id}/settings": { "get": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "getObjectAttachmentSettings", "description": "The parameters and request body are for method: getObjectAttachmentSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resultLimit": { "type": "object", "properties": { "resultLimit": { "type": "number" } } } } }, "example": { "resultLimit": { "resultLimit": 8 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "updateObjectAttachmentSettings", "description": "The parameters and request body are for method: updateObjectAttachmentSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resultLimit": { "type": "object", "properties": { "resultLimit": { "type": "number" } } } } }, "example": { "resultLimit": { "resultLimit": 10 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/reports/attachments/objects/{id}/visualizations": { "get": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "getObjectAttachmentVisualizationSettings", "description": "The parameters and request body are for method: getObjectAttachmentVisualizationSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "table": { "type": "object", "properties": { "column": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "dataPresentation": { "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "number" } } }, "table": { "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } }, "example": { "table": { "column": { "exclude": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "include": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, "dataPresentation": { "formatNumbers": false, "precision": 4 }, "table": { "blockVis": true, "hideHeaders": true, "wrapCells": false } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "updateObjectAttachmentVisualizationSettings", "description": "The parameters and request body are for method: updateObjectAttachmentVisualizationSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "table": { "type": "object", "properties": { "column": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "dataPresentation": { "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "number" } } }, "table": { "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } }, "example": { "table": { "column": { "exclude": [ "string" ], "include": [ "string", "string", "string" ] }, "dataPresentation": { "formatNumbers": false, "precision": 10 }, "table": { "blockVis": false, "hideHeaders": true, "wrapCells": false } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "partiallyUpdateObjectAttachmentVisualizationSettings", "description": "The parameters and request body are for method: partiallyUpdateObjectAttachmentVisualizationSettings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "table": { "type": "object", "properties": { "column": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "dataPresentation": { "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "number" } } }, "table": { "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } }, "example": { "table": { "column": { "exclude": [ "string", "string", "string" ], "include": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, "dataPresentation": { "formatNumbers": true, "precision": 5 }, "table": { "blockVis": true, "hideHeaders": false, "wrapCells": false } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/reports/{id}/attachments/objects": { "post": { "tags": [ "ReportAttachmentsObjects" ], "operationId": "createObjectAttachment", "description": "The parameters and request body are for method: createObjectAttachment. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "resource": { "type": "object", "properties": { "deviceId": { "type": "number" }, "ids": { "type": "array", "items": { "type": "number" } }, "type": { "type": "string" } } }, "settings": { "type": "object", "properties": { "resultLimit": { "type": "object", "properties": { "resultLimit": { "type": "number" } } } } }, "visualization": { "type": "object", "properties": { "table": { "type": "object", "properties": { "column": { "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" } }, "include": { "type": "array", "items": { "type": "string" } } } }, "dataPresentation": { "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "number" } } }, "table": { "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } }, "example": { "name": "string", "resource": { "deviceId": 6, "ids": [ 8 ], "type": "Object" }, "settings": { "resultLimit": { "resultLimit": 2 } }, "visualization": { "table": { "column": { "exclude": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ], "include": [ "string", "string", "string", "string" ] }, "dataPresentation": { "formatNumbers": false, "precision": 10 }, "table": { "blockVis": true, "hideHeaders": false, "wrapCells": false } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devicetypes": { "get": { "tags": [ "DeviceTypes" ], "operationId": "getDeviceTypes", "description": "The parameters and request body are for method: getDeviceTypes. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "array", "items": { "type": "object", "properties": { "deviceType": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "parentId": { "type": "number" } } }, "devices": { "type": "array", "items": { "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "number" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "number" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "number" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "number" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "number" }, "description": { "type": "string" }, "deviceId": { "type": "number" }, "enabled": { "type": "object" }, "extendedInfo": { "type": "object" }, "id": { "type": "number" }, "indicators": { "type": "array", "items": { "type": "object" } }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "number" }, "pluginObjectTypeId": { "type": "number" }, "subtypeId": { "type": "number" } } } }, "peerId": { "type": "number" }, "pluginInfo": { "type": "object" }, "pluginManagerId": { "type": "number" }, "pollFrequency": { "type": "number" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "number" } } } }, "objectTypes": { "type": "array", "items": { "type": "object", "properties": { "extendedInfo": { "type": "object" }, "id": { "type": "number" }, "indicatorTypes": { "type": "array", "items": { "type": "object", "properties": { "allowMaximumValue": { "type": "object" }, "dataUnits": { "type": "object" }, "description": { "type": "object" }, "displayUnits": { "type": "object" }, "extendedInfo": { "type": "object" }, "format": { "type": "object" }, "id": { "type": "object" }, "isDefault": { "type": "object" }, "isEnabled": { "type": "object" }, "name": { "type": "object" }, "pluginId": { "type": "object" }, "pluginObjectTypeId": { "type": "object" }, "syntheticExpression": { "type": "object" }, "syntheticMaximumExpression": { "type": "object" } } } }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "objectTypes": { "type": "array", "items": { "type": "object", "properties": { "extendedInfo": { "type": "object" }, "id": { "type": "object" }, "indicatorTypes": { "type": "object" }, "isEditable": { "type": "object" }, "isEnabled": { "type": "object" }, "name": { "type": "object" }, "objectTypes": { "type": "object" }, "parentObjectTypeId": { "type": "object" }, "pluginId": { "type": "object" } } } }, "parentObjectTypeId": { "type": "number" }, "pluginId": { "type": "number" } } } } } } }, "pageNumber": { "type": "number" }, "pageSize": { "type": "number" }, "totalElements": { "type": "number" }, "totalPages": { "type": "number" } } }, "example": { "content": [ { "deviceType": { "id": 9, "name": "string", "parentId": 8 }, "devices": [ { "allowDelete": false, "alternateName": "string", "dateAdded": 6, "description": "string", "disableConcurrentPolling": true, "disablePolling": true, "disableThresholding": false, "id": 8, "ipAddress": "string", "isDeleted": true, "isNew": true, "lastDiscovery": 9, "manualIP": true, "name": "string", "numElements": 6, "objects": [ { "alternateName": "string", "dateAdded": 8, "description": "string", "deviceId": 2, "enabled": {}, "extendedInfo": {}, "id": 10, "indicators": [ {}, {}, {}, {}, {} ], "isDeleted": true, "isEnabled": false, "isVisible": false, "name": "string", "pluginId": 5, "pluginObjectTypeId": 7, "subtypeId": 1 }, { "alternateName": "string", "dateAdded": 1, "description": "string", "deviceId": 4, "enabled": {}, "extendedInfo": {}, "id": 4, "indicators": [ {}, {}, {}, {}, {}, {} ], "isDeleted": false, "isEnabled": false, "isVisible": false, "name": "string", "pluginId": 7, "pluginObjectTypeId": 7, "subtypeId": 1 }, { "alternateName": "string", "dateAdded": 9, "description": "string", "deviceId": 10, "enabled": {}, "extendedInfo": {}, "id": 6, "indicators": [ {}, {}, {}, {}, {}, {}, {}, {} ], "isDeleted": true, "isEnabled": true, "isVisible": true, "name": "string", "pluginId": 2, "pluginObjectTypeId": 6, "subtypeId": 4 }, { "alternateName": "string", "dateAdded": 2, "description": "string", "deviceId": 9, "enabled": {}, "extendedInfo": {}, "id": 2, "indicators": [ {}, {} ], "isDeleted": true, "isEnabled": false, "isVisible": true, "name": "string", "pluginId": 2, "pluginObjectTypeId": 10, "subtypeId": 10 }, { "alternateName": "string", "dateAdded": 9, "description": "string", "deviceId": 9, "enabled": {}, "extendedInfo": {}, "id": 7, "indicators": [ {} ], "isDeleted": true, "isEnabled": false, "isVisible": true, "name": "string", "pluginId": 10, "pluginObjectTypeId": 6, "subtypeId": 2 }, { "alternateName": "string", "dateAdded": 10, "description": "string", "deviceId": 3, "e