{ "openapi": "3.0.2", "info": { "title": "adapter-sevone", "version": "1.0.0" }, "paths": { "/alerts/{pathv1}": { "get": { "operationId": "getAlerts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "title": "alertId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "put": { "operationId": "updateAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "title": "alertId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": true, "schema": { "title": "alertId", "type": "string" } } ] } }, "/alerts/filter": { "post": { "operationId": "getAlertsFiltered", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/alerts/devices/{pathv1}": { "get": { "operationId": "getAlertsForDevice", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] } }, "/maps/{pathv1}/connection/{pathv2}/alerts": { "get": { "operationId": "getAlertsForMapConnection", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "path", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "connectionId", "in": "path", "required": false, "schema": { "title": "connectionId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] } }, "/maps/{pathv1}/node/{pathv2}/alerts": { "get": { "operationId": "getAlertsForMapNode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "path", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "nodeId", "in": "path", "required": false, "schema": { "title": "nodeId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] } }, "/alerts": { "post": { "operationId": "createAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/alerts/{pathv1}/assign/{pathv2}": { "patch": { "operationId": "assignAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": false, "schema": { "title": "alertId", "type": "string" } }, { "name": "username", "in": "path", "required": false, "schema": { "title": "username", "type": "string" } } ] } }, "/alerts/{pathv1}/ignore/{pathv2}": { "patch": { "operationId": "ignoreAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "query", "required": false, "schema": { "title": "alertId", "type": "string" } }, { "name": "ignoreUntil", "in": "query", "required": false, "schema": { "title": "ignoreUntil", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/alerts/{pathv1}/clear": { "patch": { "operationId": "clearAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "alertId", "in": "path", "required": false, "schema": { "title": "alertId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devices/{pathv1}": { "get": { "operationId": "getDevices", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "put": { "operationId": "updateDevice", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": false, "schema": { "title": "deviceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devices/filter": { "post": { "operationId": "getDevicesFiltered", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devices": { "post": { "operationId": "createDevice", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devicegroups/{pathv1}": { "get": { "operationId": "getDeviceGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "put": { "operationId": "updateDeviceGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "required": false, "schema": { "title": "groupId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteDeviceGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "required": false, "schema": { "title": "groupId", "type": "string" } } ] } }, "/devicegroups": { "post": { "operationId": "createDeviceGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devicegroups/{pathv1}/members/{pathv2}": { "post": { "operationId": "addDeviceToGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "groupId", "in": "path", "required": false, "schema": { "title": "groupId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "removeDeviceFromGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "groupId", "in": "path", "required": false, "schema": { "title": "groupId", "type": "string" } } ] } }, "/devices/{pathv1}/objects/{pathv2}": { "get": { "operationId": "getDeviceComponents", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "deviceName", "in": "query", "required": false, "schema": { "title": "deviceName", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "componentName", "in": "query", "required": false, "schema": { "title": "componentName", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "put": { "operationId": "updateDeviceComponent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "componentObj", "in": "query", "required": false, "schema": { "title": "componentObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteDeviceComponent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } } ] } }, "/devices/objects/filter": { "post": { "operationId": "getDeviceComponentsFiltered", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filterObj", "in": "query", "required": false, "schema": { "title": "filterObj", "type": "object" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/devices/{pathv1}/objects": { "post": { "operationId": "createDeviceComponent", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "componentObj", "in": "query", "required": false, "schema": { "title": "componentObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/objectgroups/{pathv1}": { "get": { "operationId": "getComponentGroups", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "put": { "operationId": "updateComponentGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": false, "schema": { "title": "groupId", "type": "string" } }, { "name": "groupObj", "in": "query", "required": false, "schema": { "title": "groupObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteComponentGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupId", "in": "query", "required": false, "schema": { "title": "groupId", "type": "string" } } ] } }, "/objectgroups": { "post": { "operationId": "createComponentGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "groupObj", "in": "query", "required": false, "schema": { "title": "groupObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/objectgroups/{pathv1}/members": { "post": { "operationId": "addDeviceComponentToGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "groupId", "in": "query", "required": false, "schema": { "title": "groupId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "removeDeviceComponentFromGroup", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "groupId", "in": "query", "required": false, "schema": { "title": "groupId", "type": "string" } } ] } }, "/devices/{pathv1}/objects/{pathv2}/indicators/{pathv3}": { "get": { "operationId": "getIndicators", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "deviceName", "in": "query", "required": false, "schema": { "title": "deviceName", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "componentName", "in": "query", "required": false, "schema": { "title": "componentName", "type": "string" } }, { "name": "indicatorId", "in": "query", "required": false, "schema": { "title": "indicatorId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] } }, "/devices/{pathv1}/objects/{pathv2}/indicators/{pathv3}/data": { "get": { "operationId": "getIndicatorData", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "deviceId", "in": "query", "required": false, "schema": { "title": "deviceId", "type": "string" } }, { "name": "deviceName", "in": "query", "required": false, "schema": { "title": "deviceName", "type": "string" } }, { "name": "componentId", "in": "query", "required": false, "schema": { "title": "componentId", "type": "string" } }, { "name": "componentName", "in": "query", "required": false, "schema": { "title": "componentName", "type": "string" } }, { "name": "indicatorId", "in": "query", "required": false, "schema": { "title": "indicatorId", "type": "string" } }, { "name": "startTime", "in": "query", "required": false, "schema": { "title": "startTime", "type": "integer" } }, { "name": "endTime", "in": "query", "required": false, "schema": { "title": "endTime", "type": "integer" } } ] } }, "/device-indicators/data": { "post": { "operationId": "createIndicatorData", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "indicatorObj", "in": "query", "required": false, "schema": { "title": "indicatorObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/maps/{pathv1}": { "get": { "operationId": "getMaps", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "put": { "operationId": "updateMap", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "mapObj", "in": "query", "required": false, "schema": { "title": "mapObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteMap", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } } ] } }, "/maps": { "post": { "operationId": "createMap", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapObj", "in": "query", "required": false, "schema": { "title": "mapObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/maps/{pathv1}/connections": { "get": { "operationId": "getMapConnections", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "post": { "operationId": "createMapConnection", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "connectionObj", "in": "query", "required": false, "schema": { "title": "connectionObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/maps/{pathv1}/connections/{pathv2}": { "put": { "operationId": "updateMapConnection", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "connectionId", "in": "query", "required": false, "schema": { "title": "connectionId", "type": "string" } }, { "name": "connectionObj", "in": "query", "required": false, "schema": { "title": "connectionObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteMapConnection", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "connectionId", "in": "query", "required": false, "schema": { "title": "connectionId", "type": "string" } } ] } }, "/maps/{pathv1}/nodes": { "get": { "operationId": "getMapNodes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "uriOptions", "in": "query", "required": false, "schema": { "title": "uriOptions", "type": "object" } } ] }, "post": { "operationId": "createMapNode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "nodeObj", "in": "query", "required": false, "schema": { "title": "nodeObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/maps/{pathv1}/nodes/{pathv2}": { "put": { "operationId": "updateMapNode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "nodeId", "in": "query", "required": false, "schema": { "title": "nodeId", "type": "string" } }, { "name": "nodeObj", "in": "query", "required": false, "schema": { "title": "nodeObj", "type": "object" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteMapNode", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "mapId", "in": "query", "required": false, "schema": { "title": "mapId", "type": "string" } }, { "name": "nodeId", "in": "query", "required": false, "schema": { "title": "nodeId", "type": "string" } } ] } }, "/api/v1/reports/attachments/objects/{id}/resources": { "get": { "operationId": "getObjectAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentResourceV1", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type60", "enum": [ "Object", "Device", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateObjectAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentResourceV1", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type60", "enum": [ "Object", "Device", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/objects/{id}/settings": { "get": { "operationId": "getObjectAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateObjectAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/objects/{id}/visualizations": { "get": { "operationId": "getObjectAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateObjectAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateObjectAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/objects": { "post": { "operationId": "createObjectAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectAttachmentResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "ObjectAttachmentResource", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type60", "enum": [ "Object", "Device", "ObjectGroup", "Everything" ], "type": "string" } } }, "settings": { "title": "ObjectAttachmentSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/devicetypes": { "get": { "operationId": "getDeviceTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfDeviceTypeResponseDtoV1", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "DeviceTypeResponseDtoV1", "type": "object", "properties": { "deviceType": { "title": "DeviceTagDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } }, "objectTypes": { "type": "array", "items": { "title": "ObjectType2", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicatorTypes": { "type": "array", "items": { "title": "IndicatorType1", "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" } } }, "description": "" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "objectTypes": { "type": "array", "items": { "title": "ObjectType1", "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" } } }, "description": "" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeMembers", "in": "query", "required": false, "schema": { "title": "includeMembers", "type": "boolean" } } ] }, "post": { "operationId": "createDeviceType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceTypeResponseDtoV1", "type": "object", "properties": { "deviceType": { "title": "DeviceTagDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } }, "objectTypes": { "type": "array", "items": { "title": "ObjectType2", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicatorTypes": { "type": "array", "items": { "title": "IndicatorType1", "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" } } }, "description": "" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "objectTypes": { "type": "array", "items": { "title": "ObjectType1", "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" } } }, "description": "" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/devicetypes/members/{deviceId}": { "get": { "operationId": "getDeviceTypeForDeviceById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "DeviceTypeDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } }, "description": "" } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "number" } } ] } }, "/api/v1/devicetypes/{id}": { "get": { "operationId": "getDeviceTypeById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceTypeResponseDtoV1", "type": "object", "properties": { "deviceType": { "title": "DeviceTagDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } }, "objectTypes": { "type": "array", "items": { "title": "ObjectType2", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicatorTypes": { "type": "array", "items": { "title": "IndicatorType1", "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" } } }, "description": "" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "objectTypes": { "type": "array", "items": { "title": "ObjectType1", "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" } } }, "description": "" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "delete": { "operationId": "deleteDeviceTypeById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/devicetypes/{id}/members/{deviceId}": { "post": { "operationId": "addMemberByIdToType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteDeviceTypeMemberById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "number" } } ] } }, "/api/v1/devices/{deviceId}/objects/{id}": { "patch": { "operationId": "partiallyUpdateObjectById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceObjectDto", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "title": "Enabled", "enum": [ "ENABLED", "DISABLED", "AUTO" ], "type": "string" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "title": "IndicatorDto", "type": "object", "properties": { "dataUnits": { "type": "string" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "displayUnits": { "type": "string" }, "evaluationOrder": { "type": "integer" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "firstSeen": { "type": "integer" }, "format": { "title": "Format", "enum": [ "GAUGE", "COUNTER32", "COUNTER64" ], "type": "string" }, "id": { "type": "integer" }, "isBaselining": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "lastInvalidationTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "lastSeen": { "type": "integer" }, "maxValue": { "type": "number" }, "name": { "type": "string" }, "objectId": { "type": "integer" }, "pluginId": { "type": "integer" }, "pluginIndicatorTypeId": { "type": "integer" }, "syntheticExpression": { "type": "string" }, "systemIsBaselining": { "type": "boolean" }, "systemIsEnabled": { "type": "boolean" }, "systemMaxValue": { "type": "number" } } }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "title": "deviceId", "type": "number" } }, { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/statusmap/{id}/resources": { "get": { "operationId": "getStatusMapAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "StatusMapAttachmentResourceV1", "type": "object", "properties": { "mapId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateStatusMapAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "StatusMapAttachmentResourceV1", "type": "object", "properties": { "mapId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/statusmap": { "post": { "operationId": "createStatusMapAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "StatusMapAttachmentResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "StatusMapAttachmentResource", "type": "object", "properties": { "mapId": { "type": "integer" } } }, "visualization": { "title": "StatusMapAttachmentVisualization", "type": "object", "properties": { "map": { "type": "object" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/users/api-keys": { "get": { "operationId": "getApiKeys", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "ApiKeyDto", "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationName": { "type": "string" }, "creationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "user": { "type": "string" } } }, "description": "" } } } } } }, "post": { "operationId": "createApiKey", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ApiKeyDto", "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationName": { "type": "string" }, "creationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "user": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteApiKeys", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/api/v1/users/api-keys/{apiKey}": { "put": { "operationId": "updateApiKey", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ApiKeyDto", "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationName": { "type": "string" }, "creationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "user": { "type": "string" } } } } } } }, "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "title": "apiKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteApiKey", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "title": "apiKey", "type": "string" } } ] } }, "/api/v1/users/{id}/api-keys": { "get": { "operationId": "getApiKeysForUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "ApiKeyDto", "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationName": { "type": "string" }, "creationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "user": { "type": "string" } } }, "description": "" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "post": { "operationId": "createApiKeyForUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ApiKeyDto", "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationName": { "type": "string" }, "creationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "user": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteApiKeysForUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/users/{id}/api-keys/{apiKey}": { "put": { "operationId": "updateApiKeyForUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ApiKeyDto", "type": "object", "properties": { "apiKey": { "type": "string" }, "applicationName": { "type": "string" }, "creationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "user": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "apiKey", "in": "path", "required": true, "schema": { "title": "apiKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/users/{apiKey}/api-keys/{id}": { "delete": { "operationId": "deleteApiKeyForUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "apiKey", "in": "path", "required": true, "schema": { "title": "apiKey", "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/discovery": { "get": { "operationId": "getDevicesInDiscovery", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfDeviceDiscoveryDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "DeviceDiscoveryDto", "type": "object", "properties": { "allowAutomatic": { "type": "boolean" }, "allowManual": { "type": "boolean" }, "device": { "title": "Device", "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "integer" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "integer" }, "objects": { "type": "array", "items": { "title": "Object3", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "type": "object", "description": "" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object" }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "peerId": { "type": "integer" }, "pluginInfo": { "type": "object", "additionalProperties": { "title": "PluginInfo", "type": "object", "properties": { "enabled": { "type": "boolean" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "working": { "type": "boolean" } } } }, "pluginManagerId": { "type": "integer" }, "pollFrequency": { "type": "integer" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "integer" } } }, "deviceId": { "type": "integer" }, "isWorking": { "type": "boolean" }, "queue": { "title": "Queue", "enum": [ "BLANK", "high", "low", "cancel" ], "type": "string" }, "timeCompleted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeQueued": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeStarted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeUpdated": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timesDiscovered": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeMembers", "in": "query", "required": false, "schema": { "title": "includeMembers", "type": "boolean" } } ] } }, "/api/v1/discovery/filter": { "post": { "operationId": "filterDevicesInDiscovery", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfDeviceDiscoveryDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "DeviceDiscoveryDto", "type": "object", "properties": { "allowAutomatic": { "type": "boolean" }, "allowManual": { "type": "boolean" }, "device": { "title": "Device", "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "integer" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "integer" }, "objects": { "type": "array", "items": { "title": "Object3", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "type": "object", "description": "" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object" }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "peerId": { "type": "integer" }, "pluginInfo": { "type": "object", "additionalProperties": { "title": "PluginInfo", "type": "object", "properties": { "enabled": { "type": "boolean" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "working": { "type": "boolean" } } } }, "pluginManagerId": { "type": "integer" }, "pollFrequency": { "type": "integer" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "integer" } } }, "deviceId": { "type": "integer" }, "isWorking": { "type": "boolean" }, "queue": { "title": "Queue", "enum": [ "BLANK", "high", "low", "cancel" ], "type": "string" }, "timeCompleted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeQueued": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeStarted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeUpdated": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timesDiscovered": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeMembers", "in": "query", "required": false, "schema": { "title": "includeMembers", "type": "boolean" } }, { "name": "includeObjects", "in": "query", "required": false, "schema": { "title": "includeObjects", "type": "boolean" } }, { "name": "includeIndicators", "in": "query", "required": false, "schema": { "title": "includeIndicators", "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/discovery/{id}": { "get": { "operationId": "getDeviceStatusById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceDiscoveryDto", "type": "object", "properties": { "allowAutomatic": { "type": "boolean" }, "allowManual": { "type": "boolean" }, "device": { "title": "Device", "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "integer" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "integer" }, "objects": { "type": "array", "items": { "title": "Object3", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "type": "object", "description": "" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object" }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "peerId": { "type": "integer" }, "pluginInfo": { "type": "object", "additionalProperties": { "title": "PluginInfo", "type": "object", "properties": { "enabled": { "type": "boolean" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "working": { "type": "boolean" } } } }, "pluginManagerId": { "type": "integer" }, "pollFrequency": { "type": "integer" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "integer" } } }, "deviceId": { "type": "integer" }, "isWorking": { "type": "boolean" }, "queue": { "title": "Queue", "enum": [ "BLANK", "high", "low", "cancel" ], "type": "string" }, "timeCompleted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeQueued": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeStarted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeUpdated": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timesDiscovered": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "includeMembers", "in": "query", "required": false, "schema": { "title": "includeMembers", "type": "boolean" } } ] }, "patch": { "operationId": "updateDevicePriority", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceDiscoveryDto", "type": "object", "properties": { "allowAutomatic": { "type": "boolean" }, "allowManual": { "type": "boolean" }, "device": { "title": "Device", "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "integer" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "integer" }, "objects": { "type": "array", "items": { "title": "Object3", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "type": "object", "description": "" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object" }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "peerId": { "type": "integer" }, "pluginInfo": { "type": "object", "additionalProperties": { "title": "PluginInfo", "type": "object", "properties": { "enabled": { "type": "boolean" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "working": { "type": "boolean" } } } }, "pluginManagerId": { "type": "integer" }, "pollFrequency": { "type": "integer" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "integer" } } }, "deviceId": { "type": "integer" }, "isWorking": { "type": "boolean" }, "queue": { "title": "Queue", "enum": [ "BLANK", "high", "low", "cancel" ], "type": "string" }, "timeCompleted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeQueued": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeStarted": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timeUpdated": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "timesDiscovered": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/flow-falcon/filters/schema": { "get": { "operationId": "getFlowFalconAttachmentFilterSchema", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconAttachmentFiltersSchema", "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } } }, "operations": { "type": "object", "additionalProperties": { "title": "FilterOperationDetails", "type": "object", "properties": { "arity": { "type": "integer" }, "name": { "type": "string" } } } } } } } } } } } }, "/api/v1/reports/attachments/flow-falcon/{id}/filters": { "get": { "operationId": "getFlowFalconAttachmentFilters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentFilters", "type": "object", "properties": { "empty": { "type": "boolean" }, "expression": { "type": "string" }, "filters": { "type": "array", "items": { "title": "AttachmentFilterDetails", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateFlowFalconAttachmentFilters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentFilters", "type": "object", "properties": { "empty": { "type": "boolean" }, "expression": { "type": "string" }, "filters": { "type": "array", "items": { "title": "AttachmentFilterDetails", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/flow-falcon/{id}/resources": { "get": { "operationId": "getFlowFalconAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconResource", "type": "object", "properties": { "groups": { "title": "FlowFalconGroup", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type29", "enum": [ "DeviceGroup", "ObjectGroup" ], "type": "string" } } }, "interfaces": { "type": "array", "items": { "title": "FlowFalconInterface", "type": "object", "properties": { "direction": { "type": "integer" }, "interfaceNum": { "type": "integer" }, "sourceIp": { "type": "string" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateFlowFalconAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconResource", "type": "object", "properties": { "groups": { "title": "FlowFalconGroup", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type29", "enum": [ "DeviceGroup", "ObjectGroup" ], "type": "string" } } }, "interfaces": { "type": "array", "items": { "title": "FlowFalconInterface", "type": "object", "properties": { "direction": { "type": "integer" }, "interfaceNum": { "type": "integer" }, "sourceIp": { "type": "string" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/flow-falcon/{id}/settings": { "get": { "operationId": "getFlowFalconAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconSettingsV1", "type": "object", "properties": { "flowFalconResolutionSettings": { "title": "FlowFalconResolutionSetting", "type": "object", "properties": { "showAs": { "type": "string" }, "showDns": { "type": "string" }, "showDscp": { "type": "string" }, "showPort": { "type": "string" }, "showProtocol": { "type": "string" } } }, "flowFalconSetting": { "title": "FlowFalconSettingV1", "type": "object", "properties": { "canZoomInCb": { "type": "string" }, "granularity": { "type": "integer" }, "graphOther": { "type": "boolean" }, "isRate": { "type": "boolean" }, "split": { "type": "integer" }, "subnetCategoryId": { "type": "integer" } } }, "flowFalconTemplateSetting": { "title": "FlowFalconTemplateSettingV1", "type": "object", "properties": { "isAggregated": { "type": "boolean" }, "metricId": { "type": "integer" }, "templateId": { "type": "integer" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateFlowFalconAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconSettingsV1", "type": "object", "properties": { "flowFalconResolutionSettings": { "title": "FlowFalconResolutionSetting", "type": "object", "properties": { "showAs": { "type": "string" }, "showDns": { "type": "string" }, "showDscp": { "type": "string" }, "showPort": { "type": "string" }, "showProtocol": { "type": "string" } } }, "flowFalconSetting": { "title": "FlowFalconSettingV1", "type": "object", "properties": { "canZoomInCb": { "type": "string" }, "granularity": { "type": "integer" }, "graphOther": { "type": "boolean" }, "isRate": { "type": "boolean" }, "split": { "type": "integer" }, "subnetCategoryId": { "type": "integer" } } }, "flowFalconTemplateSetting": { "title": "FlowFalconTemplateSettingV1", "type": "object", "properties": { "isAggregated": { "type": "boolean" }, "metricId": { "type": "integer" }, "templateId": { "type": "integer" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateFlowFalconAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconSettingsV1", "type": "object", "properties": { "flowFalconResolutionSettings": { "title": "FlowFalconResolutionSetting", "type": "object", "properties": { "showAs": { "type": "string" }, "showDns": { "type": "string" }, "showDscp": { "type": "string" }, "showPort": { "type": "string" }, "showProtocol": { "type": "string" } } }, "flowFalconSetting": { "title": "FlowFalconSettingV1", "type": "object", "properties": { "canZoomInCb": { "type": "string" }, "granularity": { "type": "integer" }, "graphOther": { "type": "boolean" }, "isRate": { "type": "boolean" }, "split": { "type": "integer" }, "subnetCategoryId": { "type": "integer" } } }, "flowFalconTemplateSetting": { "title": "FlowFalconTemplateSettingV1", "type": "object", "properties": { "isAggregated": { "type": "boolean" }, "metricId": { "type": "integer" }, "templateId": { "type": "integer" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/flow-falcon/{id}/time": { "get": { "operationId": "getFlowFalconAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateFlowFalconAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/flow-falcon/{id}/visualizations": { "get": { "operationId": "getFlowFalconAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateFlowFalconAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateFlowFalconAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/flow-falcon": { "post": { "operationId": "createFlowFalconAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "FlowFalconResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "FlowFalconResource", "type": "object", "properties": { "groups": { "title": "FlowFalconGroup", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type29", "enum": [ "DeviceGroup", "ObjectGroup" ], "type": "string" } } }, "interfaces": { "type": "array", "items": { "title": "FlowFalconInterface", "type": "object", "properties": { "direction": { "type": "integer" }, "interfaceNum": { "type": "integer" }, "sourceIp": { "type": "string" } } }, "description": "" } } }, "settings": { "title": "FlowFalconSettingsV1", "type": "object", "properties": { "flowFalconResolutionSettings": { "title": "FlowFalconResolutionSetting", "type": "object", "properties": { "showAs": { "type": "string" }, "showDns": { "type": "string" }, "showDscp": { "type": "string" }, "showPort": { "type": "string" }, "showProtocol": { "type": "string" } } }, "flowFalconSetting": { "title": "FlowFalconSettingV1", "type": "object", "properties": { "canZoomInCb": { "type": "string" }, "granularity": { "type": "integer" }, "graphOther": { "type": "boolean" }, "isRate": { "type": "boolean" }, "split": { "type": "integer" }, "subnetCategoryId": { "type": "integer" } } }, "flowFalconTemplateSetting": { "title": "FlowFalconTemplateSettingV1", "type": "object", "properties": { "isAggregated": { "type": "boolean" }, "metricId": { "type": "integer" }, "templateId": { "type": "integer" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } } } }, "timeSettings": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } }, "visualization": { "title": "FlowFalconVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/topn/{id}/resources": { "get": { "operationId": "getTopNAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type4", "enum": [ "Device", "DeviceGroup", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTopNAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type4", "enum": [ "Device", "DeviceGroup", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/topn/{id}/settings": { "get": { "operationId": "getTopNAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNSettingsV1", "type": "object", "properties": { "aggregationSelectionSetting": { "title": "AggregationSelectionSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType", "enum": [ "average", "maximum" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits", "enum": [ "auto", "hourly", "sixhourly", "daily", "weekly", "monthly", "quarterly", "yearly" ], "type": "string" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "topNSetting": { "title": "TopNSettingV1", "type": "object", "properties": { "capacityThreshold": { "type": "string" }, "displayOnlyExceedingObjects": { "type": "boolean" }, "displayRValues": { "type": "boolean" }, "objectDescriptions": { "type": "string" }, "sortBy": { "type": "integer" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" }, "templateId": { "type": "integer" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkHour", "type": "object", "properties": { "days": { "type": "array", "items": { "title": "Day", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string" }, "description": "[monday, tuesday, wednesday, thursday, friday, saturday, sunday]" }, "startHour": { "type": "integer", "description": "Accepted values from 0 to 23" }, "startMin": { "type": "integer", "description": "Accepted values from 0 to 59" }, "endHour": { "type": "integer", "description": "Accepted values from 0 to 23" }, "endMin": { "type": "integer", "description": "Accepted values from 0 to 59" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTopNAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNSettingsV1", "type": "object", "properties": { "aggregationSelectionSetting": { "title": "AggregationSelectionSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType", "enum": [ "average", "maximum" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits", "enum": [ "auto", "hourly", "sixhourly", "daily", "weekly", "monthly", "quarterly", "yearly" ], "type": "string" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "topNSetting": { "title": "TopNSettingV1", "type": "object", "properties": { "capacityThreshold": { "type": "string" }, "displayOnlyExceedingObjects": { "type": "boolean" }, "displayRValues": { "type": "boolean" }, "objectDescriptions": { "type": "string" }, "sortBy": { "type": "integer" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" }, "templateId": { "type": "integer" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkHour", "type": "object", "properties": { "days": { "type": "array", "items": { "title": "Day", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string" }, "description": "[monday, tuesday, wednesday, thursday, friday, saturday, sunday]" }, "startHour": { "type": "integer", "description": "Accepted values from 0 to 23" }, "startMin": { "type": "integer", "description": "Accepted values from 0 to 59" }, "endHour": { "type": "integer", "description": "Accepted values from 0 to 23" }, "endMin": { "type": "integer", "description": "Accepted values from 0 to 59" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateTopNAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNSettingsV1", "type": "object", "properties": { "aggregationSelectionSetting": { "title": "AggregationSelectionSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType", "enum": [ "average", "maximum" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits", "enum": [ "auto", "hourly", "sixhourly", "daily", "weekly", "monthly", "quarterly", "yearly" ], "type": "string" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "topNSetting": { "title": "TopNSettingV1", "type": "object", "properties": { "capacityThreshold": { "type": "string" }, "displayOnlyExceedingObjects": { "type": "boolean" }, "displayRValues": { "type": "boolean" }, "objectDescriptions": { "type": "string" }, "sortBy": { "type": "integer" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" }, "templateId": { "type": "integer" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkHour", "type": "object", "properties": { "days": { "type": "array", "items": { "title": "Day", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string" }, "description": "[monday, tuesday, wednesday, thursday, friday, saturday, sunday]" }, "startHour": { "type": "integer", "description": "Accepted values from 0 to 23" }, "startMin": { "type": "integer", "description": "Accepted values from 0 to 59" }, "endHour": { "type": "integer", "description": "Accepted values from 0 to 23" }, "endMin": { "type": "integer", "description": "Accepted values from 0 to 59" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/topn/{id}/time": { "get": { "operationId": "getTopNAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTopNAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/topn/{id}/visualizations": { "get": { "operationId": "getTopNAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTopNAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateTopNAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/topn": { "post": { "operationId": "createTopNAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TopNResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "AlertAttachmentResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type4", "enum": [ "Device", "DeviceGroup", "ObjectGroup", "Everything" ], "type": "string" } } }, "settings": { "title": "Settings25", "type": "object", "properties": { "aggregationSelectionSetting": { "title": "AggregationSelectionSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType", "enum": [ "average", "maximum" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits", "enum": [ "auto", "hourly", "sixhourly", "daily", "weekly", "monthly", "quarterly", "yearly" ], "type": "string" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "topNSetting": { "title": "TopNSettingV1", "type": "object", "properties": { "capacityThreshold": { "type": "string" }, "displayOnlyExceedingObjects": { "type": "boolean" }, "displayRValues": { "type": "boolean" }, "objectDescriptions": { "type": "string" }, "sortBy": { "type": "integer" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" }, "templateId": { "type": "integer" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting1", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkhour1", "type": "object", "properties": { "days": { "type": "object" }, "startHour": { "type": "object" }, "startMin": { "type": "object" }, "endHour": { "type": "object" }, "endMin": { "type": "object" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } }, "timeSettings": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } }, "visualization": { "title": "TopNVisualizationV1", "type": "object", "properties": { "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/peers": { "get": { "operationId": "getPeersUsingGET", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPeerDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "PeerDto", "type": "object", "properties": { "activeAppliance": { "title": "ActiveAppliance", "enum": [ "PRIMARY", "SECONDARY" ], "type": "string" }, "capacity": { "type": "integer" }, "disabled": { "type": "boolean" }, "droppedFlowsPerSecond": { "type": "integer" }, "flowLimit": { "type": "integer" }, "flowLoad": { "type": "integer" }, "flowsPerSecond": { "type": "integer" }, "interfaceLimit": { "type": "integer" }, "ip": { "type": "string" }, "master": { "type": "boolean" }, "model": { "type": "string" }, "name": { "type": "string" }, "netflowDeviceCount": { "type": "integer" }, "netflowInterfaceCount": { "type": "integer" }, "primaryIp": { "type": "string" }, "processedFlowsPerSecond": { "type": "integer" }, "secondaryIp": { "type": "string" }, "serverId": { "type": "integer" }, "serverLoad": { "type": "integer" }, "telephonyActiveCallsLimit": { "type": "integer" }, "telephonyPhones": { "type": "integer" }, "telephonyPhonesLimit": { "type": "integer" }, "totalCapacity": { "type": "number" }, "totalLoad": { "type": "integer" }, "virtualIp": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] } }, "/api/v1/peers/clusterSettings": { "get": { "operationId": "getClusterSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } } ] } }, "/api/v1/peers/current": { "get": { "operationId": "getCurrentPeerUsingGET", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PeerDto", "type": "object", "properties": { "activeAppliance": { "title": "ActiveAppliance", "enum": [ "PRIMARY", "SECONDARY" ], "type": "string" }, "capacity": { "type": "integer" }, "disabled": { "type": "boolean" }, "droppedFlowsPerSecond": { "type": "integer" }, "flowLimit": { "type": "integer" }, "flowLoad": { "type": "integer" }, "flowsPerSecond": { "type": "integer" }, "interfaceLimit": { "type": "integer" }, "ip": { "type": "string" }, "master": { "type": "boolean" }, "model": { "type": "string" }, "name": { "type": "string" }, "netflowDeviceCount": { "type": "integer" }, "netflowInterfaceCount": { "type": "integer" }, "primaryIp": { "type": "string" }, "processedFlowsPerSecond": { "type": "integer" }, "secondaryIp": { "type": "string" }, "serverId": { "type": "integer" }, "serverLoad": { "type": "integer" }, "telephonyActiveCallsLimit": { "type": "integer" }, "telephonyPhones": { "type": "integer" }, "telephonyPhonesLimit": { "type": "integer" }, "totalCapacity": { "type": "number" }, "totalLoad": { "type": "integer" }, "virtualIp": { "type": "string" } } } } } } } } }, "/api/v1/peers/incorporateMode": { "get": { "operationId": "getIncorporateModeUsingGET", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "IncorporateResponse", "type": "object", "properties": { "endTime": { "type": "integer" }, "startTime": { "type": "integer" }, "status": { "title": "Status1", "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" } } } } } } } }, "patch": { "operationId": "editIncorporateModeUsingPATCH", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "IncorporateResponse", "type": "object", "properties": { "endTime": { "type": "integer" }, "startTime": { "type": "integer" }, "status": { "title": "Status1", "enum": [ "ACTIVE", "INACTIVE" ], "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/peers/{id}": { "get": { "operationId": "getPeerUsingGET", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PeerDto", "type": "object", "properties": { "activeAppliance": { "title": "ActiveAppliance", "enum": [ "PRIMARY", "SECONDARY" ], "type": "string" }, "capacity": { "type": "integer" }, "disabled": { "type": "boolean" }, "droppedFlowsPerSecond": { "type": "integer" }, "flowLimit": { "type": "integer" }, "flowLoad": { "type": "integer" }, "flowsPerSecond": { "type": "integer" }, "interfaceLimit": { "type": "integer" }, "ip": { "type": "string" }, "master": { "type": "boolean" }, "model": { "type": "string" }, "name": { "type": "string" }, "netflowDeviceCount": { "type": "integer" }, "netflowInterfaceCount": { "type": "integer" }, "primaryIp": { "type": "string" }, "processedFlowsPerSecond": { "type": "integer" }, "secondaryIp": { "type": "string" }, "serverId": { "type": "integer" }, "serverLoad": { "type": "integer" }, "telephonyActiveCallsLimit": { "type": "integer" }, "telephonyPhones": { "type": "integer" }, "telephonyPhonesLimit": { "type": "integer" }, "totalCapacity": { "type": "number" }, "totalLoad": { "type": "integer" }, "virtualIp": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/peers/{id}/settings": { "get": { "operationId": "getSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } } ] } }, "/api/v1/reports/attachments/{id}": { "get": { "operationId": "getReportAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentDto", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateReportAttachmentById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentDto", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteReportAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/reports/attachments/{type}/endpoints": { "get": { "operationId": "getAllReportAttachmentEndpoints", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ] } }, "/api/v1/reports/{id}/attachments": { "get": { "operationId": "getAllReportAttachments", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfAttachmentDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "AttachmentDto", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } } ] } }, "/api/v1/objectgroups/rules": { "get": { "operationId": "getObjectGroupsRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfObjectGroupRuleDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "ObjectGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "deviceGroup": { "type": "integer" }, "deviceType": { "type": "integer" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } } ] }, "post": { "operationId": "createObjectGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "deviceGroup": { "type": "integer" }, "deviceType": { "type": "integer" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "subtypeId": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/objectgroups/rules/{id}": { "get": { "operationId": "getObjectGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "deviceGroup": { "type": "integer" }, "deviceType": { "type": "integer" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "subtypeId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateObjectGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "deviceGroup": { "type": "integer" }, "deviceType": { "type": "integer" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "subtypeId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteObjectGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/objectgroups/{id}/rules": { "get": { "operationId": "getObjectGroupRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfObjectGroupRuleDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "ObjectGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "deviceGroup": { "type": "integer" }, "deviceType": { "type": "integer" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } } ] } }, "/api/v1/objectgroups/{id}/rules/apply": { "post": { "operationId": "applyObjectGroupRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/users/mypreferences": { "get": { "operationId": "getCurrentUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "UserDto", "type": "object", "properties": { "authentication": { "title": "Authentication", "enum": [ "SEVONE", "LDAP", "TACACS", "RADIUS" ], "type": "string" }, "customTimeout": { "type": "integer", "description": "Timeout in minutes, minimum 5 minutes" }, "dateFormat": { "type": "string", "description": "Accepted values are `cluster`, `ISO8601`, `MMM D,YYYY h:mm:ss A ZZ`; `MMM D, YYYY h:mm:ss A z`; `MMM D, YYYY h:mm:ss A`; `MMM D, YYYY H:mm:ss A ZZ`;\n `MMM D, YYYY H:mm:ss A z`; `MMM D, YYYY H:mm:ss A`; `D MMM YY, h:mm:ss A ZZ`; `D MMM YY, h:mm:ss A z`; `D MMM YY, h:mm:ss A`; `D MMM YY, H:mm:ss ZZ`;\n `D MMM YY, H:mm:ss z`; `D MMM YY, H:mm:ss`; `D MMM 'YY H:mm:ss ZZ`; `D MMM 'YY H:mm:ss z`; `D MMM 'YY H:mm:ss`; `DD/MM/YYYY HH:mm:ss ZZ`;\n `DD/MM/YYYY HH:mm:ss z`; `DD/MM/YY HH:mm:ss ZZ`; `DD/MM/YY HH:mm:ss z`; `MM/DD/YYYY hh:mm:ss A ZZ`; `MM/DD/YYYY hh:mm:ss A z`; `MM/DD/YY hh:mm:ss A ZZ`;\n `MM/DD/YY hh:mm:ss A z`; `MM/DD/YYYY HH:mm:ss ZZ`; `MM/DD/YYYY HH:mm:ss z`; `DD.MM.YYYY HH:mm:ss ZZ`; `DD.MM.YYYY HH:mm:ss z`; `DD.MM.YY HH:mm:ss ZZ`;\n `DD.MM.YY HH:mm:ss z`; `YY.MM.DD HH:mm:ss ZZ`; `YY.MM.DD HH:mm:ss z`; `YYYY.MM.DD HH:mm:ss ZZ`; `YYYY.MM.DD HH:mm:ss z`; `MM/D/YY hh:mmA ZZ`;\n `MM/D/YY hh:mmA z`; `MMM D, YYYY hh:mm A ZZ`; `MMM D, YYYY hh:mm A z`; `MMM D, YYYY hh:mm A`; `MMM D, YYYY H:mm ZZ`; `MMM D, YYYY H:mm z`;\n `MMM D, YYYY H:mm`; `D MMM YY hh:mm A ZZ`; `D MMM YY hh:mm A z`; `D MMM YY hh:mm A`; `D MMM YY, H:mm ZZ`; `D MMM YY, H:mm z`; `D MMM YY, H:mm` `D MMM 'YY H:mm ZZ`; `D MMM 'YY H:mm z`; `D MMM 'YY H:mm`" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "forcePasswordChange": { "type": "boolean" }, "id": { "type": "integer" }, "isActive": { "type": "boolean" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "passwordNeverExpires": { "type": "boolean" }, "roleIds": { "type": "array", "items": { "type": "integer" }, "description": "" }, "timezone": { "type": "string" }, "timezoneStartupCheck": { "type": "boolean" }, "username": { "type": "string" } } } } } } } } }, "/api/v1/reports/attachments/object-groups/{id}/resources": { "get": { "operationId": "getObjectGroupAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupAttachmentResourceV1", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type66", "enum": [ "Object", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateObjectGroupAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupAttachmentResourceV1", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type66", "enum": [ "Object", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/object-groups/{id}/visualizations": { "get": { "operationId": "getObjectGroupAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateObjectGroupAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateObjectGroupAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/object-groups": { "post": { "operationId": "createObjectGroupAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupAttachmentResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "ObjectGroupAttachmentResource", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type66", "enum": [ "Object", "ObjectGroup", "Everything" ], "type": "string" } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/maps/{id}": { "patch": { "operationId": "partiallyUpdateStatusMapById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "StatusMapDto", "type": "object", "properties": { "connections": { "type": "array", "items": { "title": "ConnectionDto", "required": [ "data", "nodeAId", "nodeBId", "type" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "InternalObjectDto", "required": [ "elementId" ], "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "elementId": { "type": "integer" }, "pluginId": { "type": "integer", "description": "Required if type is Object" }, "reportId": { "type": "integer" } } }, "description": "" }, "id": { "type": "integer" }, "nodeAId": { "type": "integer" }, "nodeBId": { "type": "integer" }, "type": { "title": "Type12", "enum": [ "Device", "DeviceGroup", "Object", "ObjectGroup", "StatusMap" ], "type": "string" } } }, "description": "" }, "id": { "type": "integer" }, "imageId": { "type": "integer" }, "imageMimeType": { "type": "string" }, "imageName": { "type": "string" }, "imageSize": { "type": "integer" }, "name": { "type": "string" }, "nodes": { "type": "array", "items": { "title": "NodeDto", "required": [ "data", "name", "type", "x", "y" ], "type": "object", "properties": { "data": { "type": "array", "items": { "title": "InternalObjectDto", "required": [ "elementId" ], "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "elementId": { "type": "integer" }, "pluginId": { "type": "integer", "description": "Required if type is Object" }, "reportId": { "type": "integer" } } }, "description": "" }, "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "title": "Type12", "enum": [ "Device", "DeviceGroup", "Object", "ObjectGroup", "StatusMap" ], "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/devices/filters/schema": { "get": { "operationId": "getDeviceAttachmentFilterSchema", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceAttachmentFiltersSchema", "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } } }, "operations": { "type": "object", "additionalProperties": { "title": "FilterOperationDetails", "type": "object", "properties": { "arity": { "type": "integer" }, "name": { "type": "string" } } } } } } } } } } } }, "/api/v1/reports/attachments/devices/{id}/filters": { "get": { "operationId": "getDeviceAttachmentFilters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentFilters", "type": "object", "properties": { "empty": { "type": "boolean" }, "expression": { "type": "string" }, "filters": { "type": "array", "items": { "title": "AttachmentFilterDetails", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceAttachmentFilters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentFilters", "type": "object", "properties": { "empty": { "type": "boolean" }, "expression": { "type": "string" }, "filters": { "type": "array", "items": { "title": "AttachmentFilterDetails", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/devices/{id}/resources": { "get": { "operationId": "getDeviceAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type14", "enum": [ "Device", "DeviceGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type14", "enum": [ "Device", "DeviceGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/devices/{id}/settings": { "get": { "operationId": "getDeviceAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFieldsSetting": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFieldsSetting": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/devices/{id}/visualizations": { "get": { "operationId": "getDeviceAttachmentVisualization", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceAttachmentVisualization", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/devices": { "post": { "operationId": "createDeviceAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DevicesResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "DeviceGroupsResource", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type14", "enum": [ "Device", "DeviceGroup", "Everything" ], "type": "string" } } }, "settings": { "title": "DevicesSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFieldsSetting": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/devicegroups/{id}/resources": { "get": { "operationId": "getDeviceGroupsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupsResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type14", "enum": [ "Device", "DeviceGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceGroupsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupsResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type14", "enum": [ "Device", "DeviceGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/devicegroups/{id}/visualizations": { "get": { "operationId": "getDeviceGroupsAttachmentVisualization", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceGroupsAttachmentVisualization", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/devicegroups": { "post": { "operationId": "createDeviceGroupsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupsResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "DeviceGroupsResource", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type14", "enum": [ "Device", "DeviceGroup", "Everything" ], "type": "string" } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/metadata/{id}/resources": { "get": { "operationId": "getMetadataAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "MetadataAttachmentResourceV1", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type52", "enum": [ "Object", "Device", "ObjectGroup", "DeviceGroup" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateMetadataAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "MetadataAttachmentResourceV1", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type52", "enum": [ "Object", "Device", "ObjectGroup", "DeviceGroup" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/metadata/{id}/visualizations": { "get": { "operationId": "getMetadataAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "MetadataAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateMetadataAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "MetadataAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateMetadataAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "MetadataAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/metadata": { "post": { "operationId": "createMetadataAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "MetadataAttachmentResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "MetadataAttachmentResource", "type": "object", "properties": { "deviceId": { "type": "integer", "description": "Required if type is Object" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type52", "enum": [ "Object", "Device", "ObjectGroup", "DeviceGroup" ], "type": "string" } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/performance-metrics/{id}/resources": { "get": { "operationId": "getPerformanceMetricsAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsResourceV1", "type": "object", "properties": { "group": { "title": "PerformanceMetricsGroup", "type": "object", "properties": { "id": { "type": "integer" }, "indicatorTypes": { "title": "PerformanceMetricsIndicatorTypes", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "type": { "title": "Type29", "enum": [ "DeviceGroup", "ObjectGroup" ], "type": "string" } } }, "indicators": { "type": "array", "items": { "title": "PerformanceMetricsIndicator", "type": "object", "properties": { "deviceId": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updatePerformanceMetricsAttachmentResources", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsResourceV1", "type": "object", "properties": { "group": { "title": "PerformanceMetricsGroup", "type": "object", "properties": { "id": { "type": "integer" }, "indicatorTypes": { "title": "PerformanceMetricsIndicatorTypes", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "type": { "title": "Type29", "enum": [ "DeviceGroup", "ObjectGroup" ], "type": "string" } } }, "indicators": { "type": "array", "items": { "title": "PerformanceMetricsIndicator", "type": "object", "properties": { "deviceId": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/performance-metrics/{id}/settings": { "get": { "operationId": "getPerformanceMetricsAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsSettingsV1", "type": "object", "properties": { "rawDataSetting": { "title": "RawDataSetting2", "type": "object", "properties": { "dataAggregationSetting": { "title": "DataAggregationSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType4", "enum": [ "auto", "autoBar", "autoStacked", "autoStackedBar", "average", "minimum", "maximum", "total" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits1", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "aggregationValue": { "type": "integer" }, "useAggregation": { "type": "boolean" } } }, "rawDataSetting": { "title": "RawDataSettingV1", "type": "object", "properties": { "fitTimeSpanTo": { "title": "FitTimeSpanTo", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "percentiles": { "type": "integer" }, "projectionTime": { "type": "integer" }, "reduceData": { "type": "boolean" }, "standardDeviation": { "type": "integer" }, "timeOverTimeOnly": { "type": "boolean" }, "timeOverTimeType": { "title": "TimeOverTimeType", "enum": [ "none", "average", "minimum", "maximum", "total" ], "type": "string" }, "timeOverTimeUnits": { "title": "TimeOverTimeUnits", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "timeOverTimeValue": { "type": "integer" }, "trend": { "title": "Trend", "enum": [ "none", "standard", "historical", "projected" ], "type": "string" }, "trendType": { "title": "TrendType", "enum": [ "linear", "exponential", "logarithmic", "power", "none" ], "type": "string" }, "useBaseline": { "type": "boolean" }, "usePercentiles": { "type": "string" }, "useTimeOverTime": { "type": "boolean" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting1", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkhour1", "type": "object", "properties": { "days": { "type": "object" }, "startHour": { "type": "object" }, "startMin": { "type": "object" }, "endHour": { "type": "object" }, "endMin": { "type": "object" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updatePerformanceMetricsAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsSettingsV1", "type": "object", "properties": { "rawDataSetting": { "title": "RawDataSetting2", "type": "object", "properties": { "dataAggregationSetting": { "title": "DataAggregationSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType4", "enum": [ "auto", "autoBar", "autoStacked", "autoStackedBar", "average", "minimum", "maximum", "total" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits1", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "aggregationValue": { "type": "integer" }, "useAggregation": { "type": "boolean" } } }, "rawDataSetting": { "title": "RawDataSettingV1", "type": "object", "properties": { "fitTimeSpanTo": { "title": "FitTimeSpanTo", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "percentiles": { "type": "integer" }, "projectionTime": { "type": "integer" }, "reduceData": { "type": "boolean" }, "standardDeviation": { "type": "integer" }, "timeOverTimeOnly": { "type": "boolean" }, "timeOverTimeType": { "title": "TimeOverTimeType", "enum": [ "none", "average", "minimum", "maximum", "total" ], "type": "string" }, "timeOverTimeUnits": { "title": "TimeOverTimeUnits", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "timeOverTimeValue": { "type": "integer" }, "trend": { "title": "Trend", "enum": [ "none", "standard", "historical", "projected" ], "type": "string" }, "trendType": { "title": "TrendType", "enum": [ "linear", "exponential", "logarithmic", "power", "none" ], "type": "string" }, "useBaseline": { "type": "boolean" }, "usePercentiles": { "type": "string" }, "useTimeOverTime": { "type": "boolean" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting1", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkhour1", "type": "object", "properties": { "days": { "type": "object" }, "startHour": { "type": "object" }, "startMin": { "type": "object" }, "endHour": { "type": "object" }, "endMin": { "type": "object" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdatePerformanceMetricsAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsSettingsV1", "type": "object", "properties": { "rawDataSetting": { "title": "RawDataSetting2", "type": "object", "properties": { "dataAggregationSetting": { "title": "DataAggregationSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType4", "enum": [ "auto", "autoBar", "autoStacked", "autoStackedBar", "average", "minimum", "maximum", "total" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits1", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "aggregationValue": { "type": "integer" }, "useAggregation": { "type": "boolean" } } }, "rawDataSetting": { "title": "RawDataSettingV1", "type": "object", "properties": { "fitTimeSpanTo": { "title": "FitTimeSpanTo", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "percentiles": { "type": "integer" }, "projectionTime": { "type": "integer" }, "reduceData": { "type": "boolean" }, "standardDeviation": { "type": "integer" }, "timeOverTimeOnly": { "type": "boolean" }, "timeOverTimeType": { "title": "TimeOverTimeType", "enum": [ "none", "average", "minimum", "maximum", "total" ], "type": "string" }, "timeOverTimeUnits": { "title": "TimeOverTimeUnits", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "timeOverTimeValue": { "type": "integer" }, "trend": { "title": "Trend", "enum": [ "none", "standard", "historical", "projected" ], "type": "string" }, "trendType": { "title": "TrendType", "enum": [ "linear", "exponential", "logarithmic", "power", "none" ], "type": "string" }, "useBaseline": { "type": "boolean" }, "usePercentiles": { "type": "string" }, "useTimeOverTime": { "type": "boolean" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting1", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "title": "CustomWorkhour1", "type": "object", "properties": { "days": { "type": "object" }, "startHour": { "type": "object" }, "startMin": { "type": "object" }, "endHour": { "type": "object" }, "endMin": { "type": "object" } } }, "description": "" }, "type": { "title": "Type78", "enum": [ "none", "group", "device", "custom", "system" ], "type": "string" }, "workHoursGroupId": { "type": "integer" } } } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/performance-metrics/{id}/time": { "get": { "operationId": "getPerformanceMetricsAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updatePerformanceMetricsAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/performance-metrics/{id}/visualizations": { "get": { "operationId": "getPerformanceMetricsAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "line": { "title": "GraphLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "dualYAxes": { "type": "boolean" }, "logScale": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "radial": { "title": "GraphRadialSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedBar": { "title": "GraphStackedBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updatePerformanceMetricsAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "line": { "title": "GraphLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "dualYAxes": { "type": "boolean" }, "logScale": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "radial": { "title": "GraphRadialSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedBar": { "title": "GraphStackedBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdatePerformanceMetricsAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "line": { "title": "GraphLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "dualYAxes": { "type": "boolean" }, "logScale": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "radial": { "title": "GraphRadialSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedBar": { "title": "GraphStackedBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/performance-metrics": { "post": { "operationId": "createPerformanceMetricsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PerformanceMetricsResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "PerformanceMetricsResource", "type": "object", "properties": { "group": { "title": "PerformanceMetricsGroup", "type": "object", "properties": { "id": { "type": "integer" }, "indicatorTypes": { "title": "PerformanceMetricsIndicatorTypes", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "type": { "title": "Type29", "enum": [ "DeviceGroup", "ObjectGroup" ], "type": "string" } } }, "indicators": { "type": "array", "items": { "title": "PerformanceMetricsIndicator", "type": "object", "properties": { "deviceId": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" } } }, "settings": { "title": "Settings19", "type": "object", "properties": { "rawDataSetting": { "title": "RawDataSetting6", "type": "object", "properties": { "dataAggregationSetting": { "title": "DataAggregationSetting", "type": "object", "properties": { "aggregationType": { "title": "AggregationType4", "enum": [ "auto", "autoBar", "autoStacked", "autoStackedBar", "average", "minimum", "maximum", "total" ], "type": "string" }, "aggregationUnits": { "title": "AggregationUnits1", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "aggregationValue": { "type": "integer" }, "useAggregation": { "type": "boolean" } } }, "rawDataSetting": { "title": "RawDataSettingV1", "type": "object", "properties": { "fitTimeSpanTo": { "title": "FitTimeSpanTo", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "percentiles": { "type": "integer" }, "projectionTime": { "type": "integer" }, "reduceData": { "type": "boolean" }, "standardDeviation": { "type": "integer" }, "timeOverTimeOnly": { "type": "boolean" }, "timeOverTimeType": { "title": "TimeOverTimeType", "enum": [ "none", "average", "minimum", "maximum", "total" ], "type": "string" }, "timeOverTimeUnits": { "title": "TimeOverTimeUnits", "enum": [ "second", "seconds", "minute", "minutes", "hour", "hours", "sixhour", "sixhours", "day", "days", "week", "weeks", "month", "months", "quarter", "quarters", "year", "years" ], "type": "string" }, "timeOverTimeValue": { "type": "integer" }, "trend": { "title": "Trend", "enum": [ "none", "standard", "historical", "projected" ], "type": "string" }, "trendType": { "title": "TrendType", "enum": [ "linear", "exponential", "logarithmic", "power", "none" ], "type": "string" }, "useBaseline": { "type": "boolean" }, "usePercentiles": { "type": "string" }, "useTimeOverTime": { "type": "boolean" } } }, "unitsSetting": { "title": "UnitsSetting", "type": "object", "properties": { "percentage": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" } } }, "workHoursSetting": { "title": "WorkHoursSetting6", "type": "object", "properties": { "customWorkhours": { "type": "array", "items": { "type": "object" }, "description": "" }, "type": { "type": "object", "description": "" }, "workHoursGroupId": { "type": "integer" } } } } }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "timeSettings": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } }, "visualization": { "title": "PerformanceMetricsVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "line": { "title": "GraphLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "dualYAxes": { "type": "boolean" }, "logScale": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "radial": { "title": "GraphRadialSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedBar": { "title": "GraphStackedBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "stackedLine": { "title": "GraphStackedLineSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "sendGraphCSV": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/group-metrics/{id}/resources": { "get": { "operationId": "getGroupMetricsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsResourceV1", "required": [ "indicatorTypes", "type" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "indicatorTypes": { "type": "array", "items": { "title": "GroupMetricsIndicatorTypes", "required": [ "aggregations", "objectTypeId", "pluginId" ], "type": "object", "properties": { "aggregations": { "type": "array", "items": { "title": "Aggregation4", "enum": [ "avg", "max", "min", "avgPer", "maxPer", "minPer" ], "type": "string" }, "description": "Allowed values are `avg`, `avgPer`, `min`, `minPer`, `max`, `maxPer`" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" }, "type": { "title": "Type39", "enum": [ "DeviceGroup", "DeviceGroupChildren", "ObjectGroup" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateGroupMetricsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsResourceV1", "required": [ "indicatorTypes", "type" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "indicatorTypes": { "type": "array", "items": { "title": "GroupMetricsIndicatorTypes", "required": [ "aggregations", "objectTypeId", "pluginId" ], "type": "object", "properties": { "aggregations": { "type": "array", "items": { "title": "Aggregation4", "enum": [ "avg", "max", "min", "avgPer", "maxPer", "minPer" ], "type": "string" }, "description": "Allowed values are `avg`, `avgPer`, `min`, `minPer`, `max`, `maxPer`" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" }, "type": { "title": "Type39", "enum": [ "DeviceGroup", "DeviceGroupChildren", "ObjectGroup" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/group-metrics/{id}/settings": { "get": { "operationId": "getGroupMetricsAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsSettingsDtoV1", "type": "object", "properties": { "childrenReport": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateGroupMetricsAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsSettingsDtoV1", "type": "object", "properties": { "childrenReport": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/group-metrics/{id}/time": { "get": { "operationId": "getGroupMetricsAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateGroupMetricsAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/group-metrics/{id}/visualization": { "get": { "operationId": "getGroupMetricsAttachmentVisualization", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateGroupMetricsAttachmentVisualization", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/group-metrics": { "post": { "operationId": "createGroupMetricsAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "GroupMetricsResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "GroupMetricsResource", "required": [ "indicatorTypes", "type" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "indicatorTypes": { "type": "array", "items": { "title": "GroupMetricsIndicatorTypes", "required": [ "aggregations", "objectTypeId", "pluginId" ], "type": "object", "properties": { "aggregations": { "type": "array", "items": { "title": "Aggregation4", "enum": [ "avg", "max", "min", "avgPer", "maxPer", "minPer" ], "type": "string" }, "description": "Allowed values are `avg`, `avgPer`, `min`, `minPer`, `max`, `maxPer`" }, "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" }, "type": { "title": "Type39", "enum": [ "DeviceGroup", "DeviceGroupChildren", "ObjectGroup" ], "type": "string" } } }, "settings": { "title": "GroupMetricsSettingsDto", "type": "object", "properties": { "childrenReport": { "type": "boolean" }, "preferredUnits": { "title": "PreferredUnits", "enum": [ "bits", "bytes" ], "type": "string" }, "sourceFields": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "timeSettings": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/authentication/active-sessions": { "get": { "operationId": "getActiveSessions", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Token", "type": "object", "properties": { "createdDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "expirationDate": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "numberOfApiCalls": { "type": "integer" }, "phpSessionId": { "type": "string" }, "token": { "type": "string" }, "userId": { "type": "integer" } } }, "description": "" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": false, "schema": { "title": "token", "type": "string" } } ] } }, "/api/v1/authentication/keep-alive": { "get": { "operationId": "keepAlive", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/api/v1/authentication/signin": { "post": { "operationId": "signIn", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "SignInResponseDto", "type": "object", "properties": { "token": { "type": "string" } } } } } } }, "parameters": [ { "name": "nmsLogin", "in": "query", "required": false, "schema": { "title": "nmsLogin", "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/authentication/signout": { "delete": { "operationId": "signOut", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/api/v1/authentication/signout-others": { "delete": { "operationId": "signOutOthers", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/api/v1/authentication/signout/{userId}": { "delete": { "operationId": "signOutUser", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } } ] } }, "/api/v1/devicegroups/{id}": { "patch": { "operationId": "partiallyUpdateDeviceGroupById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" }, "devices": { "type": "array", "items": { "title": "DeviceDto", "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "integer" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "integer" }, "objects": { "type": "array", "items": { "title": "Object1", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "type": "object", "description": "" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object", "description": "" }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "peerId": { "type": "integer" }, "pluginInfo": { "type": "object", "additionalProperties": { "title": "PluginInfo", "type": "object", "properties": { "enabled": { "type": "boolean" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "working": { "type": "boolean" } } } }, "pluginManagerId": { "type": "integer" }, "pollFrequency": { "type": "integer" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "integer" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/devicetags/{id}": { "get": { "operationId": "getDeviceTagsById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceTagDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/reports/attachments/alerts/filters/schema": { "get": { "operationId": "getAlertAttachmentFilterSchema", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentFiltersSchema", "type": "object", "properties": { "filters": { "title": "AlertAttachmentFilters", "type": "object", "properties": { "alertId": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "alertTypes": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "assignedTo": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "isClosed": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "message": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "policyId": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "severity": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "showIgnored": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } }, "thresholdId": { "title": "FilterSchemaDetails", "type": "object", "properties": { "filterExpression": { "type": "string" }, "filterExpressionText": { "type": "string" }, "group": { "type": "string" }, "id": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" }, "description": "" }, "title": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "valuesDataStore": { "title": "FilterDataStoreDetails", "type": "object", "properties": { "keyField": { "type": "string" }, "method": { "type": "string" }, "parameters": { "type": "string" }, "url": { "type": "string" }, "valueField": { "type": "string" } } }, "valuesDescription": { "type": "string" } } } } }, "operations": { "type": "object", "additionalProperties": { "title": "FilterOperationDetails", "type": "object", "properties": { "arity": { "type": "integer" }, "name": { "type": "string" } } } } } } } } } } } }, "/api/v1/reports/attachments/alerts/{id}/aggregation": { "get": { "operationId": "getAlertAttachmentAggregation", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentAggregation", "type": "object", "properties": { "aggregation": { "title": "Aggregation", "enum": [ "None", "Device", "DeviceGroup", "ObjectGroup" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateAlertAttachmentAggregation", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentAggregation", "type": "object", "properties": { "aggregation": { "title": "Aggregation", "enum": [ "None", "Device", "DeviceGroup", "ObjectGroup" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/alerts/{id}/filters": { "get": { "operationId": "getAlertAttachmentFilters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentFilters", "type": "object", "properties": { "empty": { "type": "boolean" }, "expression": { "type": "string" }, "filters": { "type": "array", "items": { "title": "AttachmentFilterDetails", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateAlertAttachmentFilters", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AttachmentFilters", "type": "object", "properties": { "empty": { "type": "boolean" }, "expression": { "type": "string" }, "filters": { "type": "array", "items": { "title": "AttachmentFilterDetails", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "description": "" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/alerts/{id}/resources": { "get": { "operationId": "getAlertAttachmentResource", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type4", "enum": [ "Device", "DeviceGroup", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateAlertAttachmentResource", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type4", "enum": [ "Device", "DeviceGroup", "ObjectGroup", "Everything" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/alerts/{id}/settings": { "get": { "operationId": "getAlertAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentSettingsV1", "type": "object", "properties": { "alertSetting": { "title": "AlertSetting", "type": "object", "properties": { "defaultView": { "title": "DefaultView", "enum": [ "devices", "groups", "objects" ], "type": "string" }, "eventSummary": { "type": "boolean" }, "inlcudeMaintenanceWindowAlerts": { "type": "boolean" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFieldsSetting": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateAlertAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentSettingsV1", "type": "object", "properties": { "alertSetting": { "title": "AlertSetting", "type": "object", "properties": { "defaultView": { "title": "DefaultView", "enum": [ "devices", "groups", "objects" ], "type": "string" }, "eventSummary": { "type": "boolean" }, "inlcudeMaintenanceWindowAlerts": { "type": "boolean" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFieldsSetting": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/alerts/{id}/time": { "get": { "operationId": "getAlertAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateAlertAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/alerts/{id}/visualizations": { "get": { "operationId": "getAlertAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateAlertAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "patch": { "operationId": "partiallyUpdateAlertAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/alerts": { "post": { "operationId": "createAlertAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertAttachmentResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "resource": { "title": "AlertAttachmentResourceV1", "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "description": "" }, "type": { "title": "Type4", "enum": [ "Device", "DeviceGroup", "ObjectGroup", "Everything" ], "type": "string" } } }, "settings": { "title": "AlertAttachmentSettingsV1", "type": "object", "properties": { "alertSetting": { "title": "AlertSetting", "type": "object", "properties": { "defaultView": { "title": "DefaultView", "enum": [ "devices", "groups", "objects" ], "type": "string" }, "eventSummary": { "type": "boolean" }, "inlcudeMaintenanceWindowAlerts": { "type": "boolean" } } }, "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "sourceFieldsSetting": { "title": "SourceFieldsSetting", "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string" }, "description": "" }, "sort": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "timeSettings": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } }, "visualization": { "title": "AlertAttachmentVisualizationV1", "type": "object", "properties": { "bar": { "title": "GraphBarSetting", "type": "object", "properties": { "drawGraphOutline": { "type": "boolean" }, "prettyXAxis": { "type": "boolean" }, "prettyYAxis": { "type": "boolean" }, "scaleToMinimumValue": { "type": "boolean" }, "scaled": { "type": "boolean" }, "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "pie": { "title": "GraphPieSetting", "type": "object", "properties": { "showAggregation": { "type": "boolean" }, "showAverage": { "type": "boolean" }, "showFrequency": { "type": "boolean" }, "showLast": { "type": "boolean" }, "showLegend": { "type": "boolean" }, "showPeak": { "type": "boolean" }, "showTimespan": { "type": "boolean" }, "showTitle": { "type": "boolean" }, "showValley": { "type": "boolean" } } }, "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/plugins": { "get": { "operationId": "getAllPlugins", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPluginDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "PluginDto", "type": "object", "properties": { "dir": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "objectName": { "type": "string" }, "plottable": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "name", "in": "query", "required": false, "schema": { "title": "name", "type": "string" } }, { "name": "objectName", "in": "query", "required": false, "schema": { "title": "objectName", "type": "number" } } ] } }, "/api/v1/plugins/device/schema": { "get": { "operationId": "getDevicePluginInfoSchema", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } } } }, "/api/v1/plugins/indicator/schema/{pluginId}": { "get": { "operationId": "getIndicatorExtendedInfoSchema", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "title": "pluginId", "type": "number" } } ] } }, "/api/v1/plugins/indicatortypes": { "get": { "operationId": "getAllPluginIndicatorTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPluginIndicatorTypeDtoV1", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "IndicatorTypeDto", "type": "object", "properties": { "allowMaximumValue": { "type": "boolean" }, "dataUnits": { "type": "string" }, "description": { "type": "string" }, "displayUnits": { "type": "string" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "format": { "title": "Format", "enum": [ "GAUGE", "COUNTER32", "COUNTER64" ], "type": "string" }, "id": { "type": "integer" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "syntheticExpression": { "type": "string" }, "syntheticMaximumExpression": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeExtendedInfo", "in": "query", "required": false, "schema": { "title": "includeExtendedInfo", "type": "boolean" } } ] }, "post": { "operationId": "createPluginIndicatorType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PluginIndicatorTypeDtoV1", "type": "object", "properties": { "allowMaximumValue": { "type": "boolean" }, "dataUnits": { "type": "string" }, "description": { "type": "string" }, "displayUnits": { "type": "string" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "format": { "title": "Format", "enum": [ "GAUGE", "COUNTER32", "COUNTER64" ], "type": "string" }, "id": { "type": "integer" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "syntheticExpression": { "type": "string" }, "syntheticMaximumExpression": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/plugins/indicatortypes/filter": { "post": { "operationId": "filterPluginIndicatorTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPluginIndicatorTypeDtoV1", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "IndicatorTypeDto", "type": "object", "properties": { "allowMaximumValue": { "type": "boolean" }, "dataUnits": { "type": "string" }, "description": { "type": "string" }, "displayUnits": { "type": "string" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "format": { "title": "Format", "enum": [ "GAUGE", "COUNTER32", "COUNTER64" ], "type": "string" }, "id": { "type": "integer" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "syntheticExpression": { "type": "string" }, "syntheticMaximumExpression": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeExtendedInfo", "in": "query", "required": false, "schema": { "title": "includeExtendedInfo", "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/plugins/indicatortypes/schema/{pluginId}": { "get": { "operationId": "getSchemaForAllPluginIndicatorTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "title": "pluginId", "type": "number" } } ] } }, "/api/v1/plugins/indicatortypes/{id}": { "put": { "operationId": "updatePluginIndicatorType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PluginIndicatorTypeDtoV1", "type": "object", "properties": { "allowMaximumValue": { "type": "boolean" }, "dataUnits": { "type": "string" }, "description": { "type": "string" }, "displayUnits": { "type": "string" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "format": { "title": "Format", "enum": [ "GAUGE", "COUNTER32", "COUNTER64" ], "type": "string" }, "id": { "type": "integer" }, "isDefault": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "syntheticExpression": { "type": "string" }, "syntheticMaximumExpression": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/plugins/object/schema/{pluginId}": { "get": { "operationId": "getObjectExtendedInfoSchema", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "title": "pluginId", "type": "number" } } ] } }, "/api/v1/plugins/objecttypes": { "get": { "operationId": "getAllPluginObjectTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPluginObjectTypeDtoV1", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "PluginObjectTypeDto", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeExtendedInfo", "in": "query", "required": false, "schema": { "title": "includeExtendedInfo", "type": "boolean" } } ] }, "post": { "operationId": "createPluginObjectType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PluginObjectTypeDtoV1", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/plugins/objecttypes/filter": { "post": { "operationId": "filterPluginObjectTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPluginObjectTypeDtoV1", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "PluginObjectTypeDto", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeExtendedInfo", "in": "query", "required": false, "schema": { "title": "includeExtendedInfo", "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/plugins/objecttypes/schema/{pluginId}": { "get": { "operationId": "getSchemaForAllPluginObjectTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "pluginId", "in": "path", "required": true, "schema": { "title": "pluginId", "type": "number" } } ] } }, "/api/v1/plugins/objecttypes/{id}": { "put": { "operationId": "updatePluginObjectType", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PluginObjectTypeDtoV1", "type": "object", "properties": { "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "isEditable": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "name": { "type": "string" }, "parentObjectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/alerts/force": { "post": { "operationId": "createAlertForced", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertCreateDto", "type": "object", "properties": { "alertFlowFalcon": { "title": "AlertFlowFalconDto", "type": "object", "properties": { "alertId": { "type": "integer" }, "directionId": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "interfaceId": { "type": "integer" }, "netflowDeviceId": { "type": "integer" }, "viewId": { "type": "integer" } } }, "clearTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "deviceId": { "type": "integer" }, "endTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "id": { "type": "integer" }, "ignoreComment": { "type": "string" }, "ignoreUid": { "type": "integer" }, "ignoreUntil": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "number": { "type": "integer" }, "objectId": { "type": "integer" }, "origin": { "title": "Origin", "enum": [ "system", "trap", "flow" ], "type": "string" }, "pluginName": { "type": "string" }, "pollId": { "type": "integer" }, "severity": { "type": "integer" }, "startTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "thresholdId": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/alerts/netflow-device/{id}": { "get": { "operationId": "getFlowFalconDeviceAlerts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "NetflowDeviceAlertsDto", "type": "object", "properties": { "alerts": { "type": "array", "items": { "title": "AlertDto", "type": "object", "properties": { "acknowledgedBy": { "type": "string" }, "alertFlowFalcon": { "title": "AlertFlowFalconDto", "type": "object", "properties": { "alertId": { "type": "integer" }, "directionId": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "interfaceId": { "type": "integer" }, "netflowDeviceId": { "type": "integer" }, "viewId": { "type": "integer" } } }, "assignedTo": { "type": "integer" }, "clearMessage": { "type": "string" }, "clearTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "closed": { "type": "integer" }, "closedKey": { "type": "integer" }, "comments": { "type": "string" }, "deviceId": { "type": "integer" }, "endTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "id": { "type": "integer" }, "ignoreComment": { "type": "string" }, "ignoreUid": { "type": "integer" }, "ignoreUntil": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "indicatorId": { "type": "integer" }, "isMaintenanceAlert": { "type": "boolean" }, "lastProcessed": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "number": { "type": "integer" }, "objectId": { "type": "integer" }, "origin": { "title": "Origin", "enum": [ "system", "trap", "flow" ], "type": "string" }, "pluginName": { "type": "string" }, "pollId": { "type": "integer" }, "severity": { "type": "integer" }, "startTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "thresholdId": { "type": "integer" } } }, "description": "" }, "id": { "type": "integer" }, "name": { "type": "string" }, "originIp": { "type": "string" }, "overrideName": { "type": "integer" }, "peer": { "type": "integer" }, "systemName": { "type": "string" }, "versions": { "type": "string" }, "visible": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] } }, "/api/v1/alerts/objects": { "post": { "operationId": "getMaxSeverityAlertForObjects", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "Severity", "type": "object", "properties": { "active": { "type": "boolean" }, "alertId": { "type": "integer" }, "assigned": { "type": "boolean" }, "clearTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "deviceId": { "type": "integer" }, "endTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "numAlerts": { "type": "integer" }, "objectId": { "type": "integer" }, "severity": { "type": "integer" }, "startTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" } } }, "description": "" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/alerts/{id}": { "patch": { "operationId": "patchAlert", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "AlertDto", "type": "object", "properties": { "acknowledgedBy": { "type": "string" }, "alertFlowFalcon": { "title": "AlertFlowFalconDto", "type": "object", "properties": { "alertId": { "type": "integer" }, "directionId": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "interfaceId": { "type": "integer" }, "netflowDeviceId": { "type": "integer" }, "viewId": { "type": "integer" } } }, "assignedTo": { "type": "integer" }, "clearMessage": { "type": "string" }, "clearTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "closed": { "type": "integer" }, "closedKey": { "type": "integer" }, "comments": { "type": "string" }, "deviceId": { "type": "integer" }, "endTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "id": { "type": "integer" }, "ignoreComment": { "type": "string" }, "ignoreUid": { "type": "integer" }, "ignoreUntil": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "indicatorId": { "type": "integer" }, "isMaintenanceAlert": { "type": "boolean" }, "lastProcessed": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "number": { "type": "integer" }, "objectId": { "type": "integer" }, "origin": { "title": "Origin", "enum": [ "system", "trap", "flow" ], "type": "string" }, "pluginName": { "type": "string" }, "pollId": { "type": "integer" }, "severity": { "type": "integer" }, "startTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "thresholdId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/countries/timezones": { "get": { "operationId": "getTimezonesByCountries", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "title": "TimezoneDto", "type": "object", "properties": { "country": { "type": "string" }, "countryCode": { "type": "string" }, "displayName": { "type": "string" }, "offset": { "type": "integer", "description": "UTC offset in milliseconds" }, "timezone": { "type": "string" } } }, "description": "" } } } } } } }, "/api/v1/policies": { "get": { "operationId": "getPolicies", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPolicyDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "Content37", "type": "object", "properties": { "appendConditionMessages": { "type": "boolean" }, "clearConditions": { "type": "array", "items": { "title": "ClearCondition", "type": "object", "properties": { "aggregation": { "type": "object" }, "comparison": { "type": "object" }, "duration": { "type": "object" }, "id": { "type": "object" }, "indicatorTypeId": { "type": "object" }, "isTrigger": { "type": "object" }, "message": { "type": "object" }, "policyId": { "type": "object" }, "sigmaDirection": { "type": "object" }, "type": { "type": "object" }, "unit": { "type": "object" }, "value": { "type": "object" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be false. In clearExpression, use array index reference as an ID of clearCondition to make expression where ID of 1st clearCondition is 1. For PUT, we don't allow user to specify this field." }, "clearExpression": { "type": "string", "description": "Specify the criteria under which a cleared alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'clearConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a clearExpression may be '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is cleared. Index of clearConditions starts from 1" }, "clearMessage": { "type": "string" }, "description": { "type": "string" }, "flow": { "title": "PolicyFlowDto", "type": "object", "properties": { "direction": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "viewId": { "type": "integer" } } }, "folderId": { "type": "integer" }, "groupId": { "type": "integer", "description": "Deprecated. Use groupIdList instead." }, "groupIdList": { "type": "array", "items": { "type": "integer" }, "description": "A list of group IDs associated with the policy. If groupIdList and groupId are both set, groupId is ignored." }, "id": { "type": "integer", "description": "[Output Only]" }, "isDeviceGroup": { "type": "boolean" }, "isMemberOfAny": { "type": "boolean" }, "lastUpdated": { "type": "integer" }, "mailOnce": { "type": "boolean" }, "mailPeriod": { "type": "integer" }, "mailTo": { "type": "string" }, "name": { "type": "string" }, "objectSubTypeId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "severity": { "type": "integer" }, "triggerConditions": { "type": "array", "items": { "title": "TriggerCondition", "type": "object", "properties": { "aggregation": { "type": "object" }, "comparison": { "type": "object" }, "duration": { "type": "object" }, "id": { "type": "object" }, "indicatorTypeId": { "type": "object" }, "isTrigger": { "type": "object" }, "message": { "type": "object" }, "policyId": { "type": "object" }, "sigmaDirection": { "type": "object" }, "type": { "type": "object" }, "unit": { "type": "object" }, "value": { "type": "object" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be true. In triggerExpression, use array index reference as an ID of triggerCondition to make expression where ID of 1st triggerCondition is 1. For PUT, we don't allow user to specify this field." }, "triggerExpression": { "type": "string", "description": "Specify the criteria under which a triggered alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'triggerConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a triggerExpression '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is triggered. Index of triggerConditions starts from 1" }, "triggerMessage": { "type": "string" }, "type": { "title": "Type75", "enum": [ "other", "flow" ], "type": "string" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" }, "userEnabled": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] }, "post": { "operationId": "createPolicy", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyDto", "type": "object", "properties": { "appendConditionMessages": { "type": "boolean" }, "clearConditions": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be false. In clearExpression, use array index reference as an ID of clearCondition to make expression where ID of 1st clearCondition is 1. For PUT, we don't allow user to specify this field." }, "clearExpression": { "type": "string", "description": "Specify the criteria under which a cleared alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'clearConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a clearExpression may be '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is cleared. Index of clearConditions starts from 1" }, "clearMessage": { "type": "string" }, "description": { "type": "string" }, "flow": { "title": "PolicyFlowDto", "type": "object", "properties": { "direction": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "viewId": { "type": "integer" } } }, "folderId": { "type": "integer" }, "groupId": { "type": "integer", "description": "Deprecated. Use groupIdList instead." }, "groupIdList": { "type": "array", "items": { "type": "integer" }, "description": "A list of group IDs associated with the policy. If groupIdList and groupId are both set, groupId is ignored." }, "id": { "type": "integer", "description": "[Output Only]" }, "isDeviceGroup": { "type": "boolean" }, "isMemberOfAny": { "type": "boolean" }, "lastUpdated": { "type": "integer" }, "mailOnce": { "type": "boolean" }, "mailPeriod": { "type": "integer" }, "mailTo": { "type": "string" }, "name": { "type": "string" }, "objectSubTypeId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "severity": { "type": "integer" }, "triggerConditions": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be true. In triggerExpression, use array index reference as an ID of triggerCondition to make expression where ID of 1st triggerCondition is 1. For PUT, we don't allow user to specify this field." }, "triggerExpression": { "type": "string", "description": "Specify the criteria under which a triggered alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'triggerConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a triggerExpression '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is triggered. Index of triggerConditions starts from 1" }, "triggerMessage": { "type": "string" }, "type": { "title": "Type75", "enum": [ "other", "flow" ], "type": "string" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" }, "userEnabled": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/policies/filter": { "post": { "operationId": "filterPolicies", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPolicyDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "Content37", "type": "object", "properties": { "appendConditionMessages": { "type": "boolean" }, "clearConditions": { "type": "array", "items": { "title": "ClearCondition", "type": "object", "properties": { "aggregation": { "type": "object" }, "comparison": { "type": "object" }, "duration": { "type": "object" }, "id": { "type": "object" }, "indicatorTypeId": { "type": "object" }, "isTrigger": { "type": "object" }, "message": { "type": "object" }, "policyId": { "type": "object" }, "sigmaDirection": { "type": "object" }, "type": { "type": "object" }, "unit": { "type": "object" }, "value": { "type": "object" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be false. In clearExpression, use array index reference as an ID of clearCondition to make expression where ID of 1st clearCondition is 1. For PUT, we don't allow user to specify this field." }, "clearExpression": { "type": "string", "description": "Specify the criteria under which a cleared alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'clearConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a clearExpression may be '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is cleared. Index of clearConditions starts from 1" }, "clearMessage": { "type": "string" }, "description": { "type": "string" }, "flow": { "title": "PolicyFlowDto", "type": "object", "properties": { "direction": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "viewId": { "type": "integer" } } }, "folderId": { "type": "integer" }, "groupId": { "type": "integer", "description": "Deprecated. Use groupIdList instead." }, "groupIdList": { "type": "array", "items": { "type": "integer" }, "description": "A list of group IDs associated with the policy. If groupIdList and groupId are both set, groupId is ignored." }, "id": { "type": "integer", "description": "[Output Only]" }, "isDeviceGroup": { "type": "boolean" }, "isMemberOfAny": { "type": "boolean" }, "lastUpdated": { "type": "integer" }, "mailOnce": { "type": "boolean" }, "mailPeriod": { "type": "integer" }, "mailTo": { "type": "string" }, "name": { "type": "string" }, "objectSubTypeId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "severity": { "type": "integer" }, "triggerConditions": { "type": "array", "items": { "title": "TriggerCondition", "type": "object", "properties": { "aggregation": { "type": "object" }, "comparison": { "type": "object" }, "duration": { "type": "object" }, "id": { "type": "object" }, "indicatorTypeId": { "type": "object" }, "isTrigger": { "type": "object" }, "message": { "type": "object" }, "policyId": { "type": "object" }, "sigmaDirection": { "type": "object" }, "type": { "type": "object" }, "unit": { "type": "object" }, "value": { "type": "object" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be true. In triggerExpression, use array index reference as an ID of triggerCondition to make expression where ID of 1st triggerCondition is 1. For PUT, we don't allow user to specify this field." }, "triggerExpression": { "type": "string", "description": "Specify the criteria under which a triggered alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'triggerConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a triggerExpression '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is triggered. Index of triggerConditions starts from 1" }, "triggerMessage": { "type": "string" }, "type": { "title": "Type75", "enum": [ "other", "flow" ], "type": "string" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" }, "userEnabled": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/policies/folders": { "get": { "operationId": "getPolicyFolders", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPolicyFolderDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "DeviceTagDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] }, "post": { "operationId": "createPolicyFolder", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyFolderDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/policies/folders/{id}": { "put": { "operationId": "updatePolicyFolder", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyFolderDto", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parentId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deletePolicyFolderById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/policies/{id}": { "get": { "operationId": "getPolicy", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyDto", "type": "object", "properties": { "appendConditionMessages": { "type": "boolean" }, "clearConditions": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be false. In clearExpression, use array index reference as an ID of clearCondition to make expression where ID of 1st clearCondition is 1. For PUT, we don't allow user to specify this field." }, "clearExpression": { "type": "string", "description": "Specify the criteria under which a cleared alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'clearConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a clearExpression may be '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is cleared. Index of clearConditions starts from 1" }, "clearMessage": { "type": "string" }, "description": { "type": "string" }, "flow": { "title": "PolicyFlowDto", "type": "object", "properties": { "direction": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "viewId": { "type": "integer" } } }, "folderId": { "type": "integer" }, "groupId": { "type": "integer", "description": "Deprecated. Use groupIdList instead." }, "groupIdList": { "type": "array", "items": { "type": "integer" }, "description": "A list of group IDs associated with the policy. If groupIdList and groupId are both set, groupId is ignored." }, "id": { "type": "integer", "description": "[Output Only]" }, "isDeviceGroup": { "type": "boolean" }, "isMemberOfAny": { "type": "boolean" }, "lastUpdated": { "type": "integer" }, "mailOnce": { "type": "boolean" }, "mailPeriod": { "type": "integer" }, "mailTo": { "type": "string" }, "name": { "type": "string" }, "objectSubTypeId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "severity": { "type": "integer" }, "triggerConditions": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be true. In triggerExpression, use array index reference as an ID of triggerCondition to make expression where ID of 1st triggerCondition is 1. For PUT, we don't allow user to specify this field." }, "triggerExpression": { "type": "string", "description": "Specify the criteria under which a triggered alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'triggerConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a triggerExpression '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is triggered. Index of triggerConditions starts from 1" }, "triggerMessage": { "type": "string" }, "type": { "title": "Type75", "enum": [ "other", "flow" ], "type": "string" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" }, "userEnabled": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updatePolicy", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyDto", "type": "object", "properties": { "appendConditionMessages": { "type": "boolean" }, "clearConditions": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be false. In clearExpression, use array index reference as an ID of clearCondition to make expression where ID of 1st clearCondition is 1. For PUT, we don't allow user to specify this field." }, "clearExpression": { "type": "string", "description": "Specify the criteria under which a cleared alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'clearConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a clearExpression may be '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is cleared. Index of clearConditions starts from 1" }, "clearMessage": { "type": "string" }, "description": { "type": "string" }, "flow": { "title": "PolicyFlowDto", "type": "object", "properties": { "direction": { "type": "integer" }, "filterId": { "type": "integer" }, "id": { "type": "integer" }, "viewId": { "type": "integer" } } }, "folderId": { "type": "integer" }, "groupId": { "type": "integer", "description": "Deprecated. Use groupIdList instead." }, "groupIdList": { "type": "array", "items": { "type": "integer" }, "description": "A list of group IDs associated with the policy. If groupIdList and groupId are both set, groupId is ignored." }, "id": { "type": "integer", "description": "[Output Only]" }, "isDeviceGroup": { "type": "boolean" }, "isMemberOfAny": { "type": "boolean" }, "lastUpdated": { "type": "integer" }, "mailOnce": { "type": "boolean" }, "mailPeriod": { "type": "integer" }, "mailTo": { "type": "string" }, "name": { "type": "string" }, "objectSubTypeId": { "type": "integer" }, "objectTypeId": { "type": "integer" }, "pluginId": { "type": "integer" }, "severity": { "type": "integer" }, "triggerConditions": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "For POST, Array of Policy conditions where isTrigger will be true. In triggerExpression, use array index reference as an ID of triggerCondition to make expression where ID of 1st triggerCondition is 1. For PUT, we don't allow user to specify this field." }, "triggerExpression": { "type": "string", "description": "Specify the criteria under which a triggered alert is generated for the policy. The criteria is defined in disjunctive normal form in which propositions are the id fields of PolicyConditionDto(s) in the 'triggerConditions' field. We use '|' to denote the 'or' relation and ',' to denote the 'and' relation. For example, suppose that there are three conditions with ids 1,2 and 3, a triggerExpression '1,2|3' means that when either condition 1 and condition 2 hold or condition 3 hold, the policy alert is triggered. Index of triggerConditions starts from 1" }, "triggerMessage": { "type": "string" }, "type": { "title": "Type75", "enum": [ "other", "flow" ], "type": "string" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" }, "userEnabled": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deletePolicyById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/policies/{policyId}/actions": { "get": { "operationId": "getActionsUsingGET", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyActionDto", "type": "object", "properties": { "mailAction": { "title": "MailActionDto", "type": "object", "properties": { "mails": { "type": "array", "items": { "type": "string" }, "description": "" }, "repeated": { "type": "boolean" }, "repeatedPeriod": { "type": "integer" }, "roleIds": { "type": "array", "items": { "type": "integer" }, "description": "" }, "userIds": { "type": "array", "items": { "type": "integer" }, "description": "" } } }, "trapAction": { "title": "TrapActionDto", "type": "object", "properties": { "trapDestinations": { "type": "array", "items": { "type": "integer" }, "description": "" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" } } } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } } ] }, "put": { "operationId": "updatePolicyAction", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyActionDto", "type": "object", "properties": { "mailAction": { "title": "MailActionDto", "type": "object", "properties": { "mails": { "type": "array", "items": { "type": "string" }, "description": "" }, "repeated": { "type": "boolean" }, "repeatedPeriod": { "type": "integer" }, "roleIds": { "type": "array", "items": { "type": "integer" }, "description": "" }, "userIds": { "type": "array", "items": { "type": "integer" }, "description": "" } } }, "trapAction": { "title": "TrapActionDto", "type": "object", "properties": { "trapDestinations": { "type": "array", "items": { "type": "integer" }, "description": "" }, "useCustomTraps": { "type": "boolean" }, "useDefaultTraps": { "type": "boolean" }, "useDeviceTraps": { "type": "boolean" } } } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deletePolicyActionById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } } ] } }, "/api/v1/policies/{policyId}/conditions": { "get": { "operationId": "findAllUsingGET", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfPolicyConditionDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] }, "post": { "operationId": "createPolicyCondition", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/policies/{policyId}/conditions/{conditionId}": { "get": { "operationId": "getPolicyConditionById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "title": "conditionId", "type": "number" } } ] }, "put": { "operationId": "updatePolicyCondition", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PolicyConditionDto", "type": "object", "properties": { "aggregation": { "type": "integer" }, "comparison": { "type": "integer" }, "duration": { "type": "integer" }, "id": { "type": "integer", "description": "For POST /policies, id is compulsory in triggerConditions and clearConditions." }, "indicatorTypeId": { "type": "integer" }, "isTrigger": { "type": "boolean", "description": "isTrigger is READ-ONLY in all endpoints except POST /policies/{policyId}/conditions", "example": false }, "message": { "type": "string" }, "policyId": { "type": "integer" }, "sigmaDirection": { "type": "integer" }, "type": { "type": "integer" }, "unit": { "type": "string" }, "value": { "type": "number" } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "title": "conditionId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deletePolicyConditionById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "policyId", "in": "path", "required": true, "schema": { "title": "policyId", "type": "number" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "title": "conditionId", "type": "number" } } ] } }, "/api/v1/reports": { "get": { "operationId": "getAllReports", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfReportDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "ReportDto", "type": "object", "properties": { "description": { "type": "string" }, "emailTo": { "type": "string" }, "folderId": { "type": "integer" }, "id": { "type": "integer" }, "isEmailed": { "type": "boolean" }, "isFtped": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isTemporary": { "type": "boolean" }, "lastAccessed": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "lastModified": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "migrated": { "type": "integer" }, "name": { "type": "string" }, "nextRun": { "type": "integer" }, "numberOfColumns": { "type": "integer" }, "runUnit": { "type": "string" }, "runValue": { "type": "integer" }, "templateType": { "type": "string" }, "timezone": { "type": "string" }, "userId": { "type": "integer" }, "userRoleId": { "type": "integer" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "userId", "in": "query", "required": false, "schema": { "title": "userId", "type": "number" } }, { "name": "name", "in": "query", "required": false, "schema": { "title": "name", "type": "string" } } ] }, "post": { "operationId": "createReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ReportDto", "type": "object", "properties": { "description": { "type": "string" }, "emailTo": { "type": "string" }, "folderId": { "type": "integer" }, "id": { "type": "integer" }, "isEmailed": { "type": "boolean" }, "isFtped": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isTemporary": { "type": "boolean" }, "lastAccessed": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "lastModified": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "migrated": { "type": "integer" }, "name": { "type": "string" }, "nextRun": { "type": "integer" }, "numberOfColumns": { "type": "integer" }, "runUnit": { "type": "string" }, "runValue": { "type": "integer" }, "templateType": { "type": "string" }, "timezone": { "type": "string" }, "userId": { "type": "integer" }, "userRoleId": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/folders": { "get": { "operationId": "getAllReportFolders", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfReportFolderDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "ReportFolderDto", "type": "object", "properties": { "id": { "type": "integer", "description": "READ-ONLY" }, "name": { "type": "string" }, "parentId": { "type": "integer", "description": "2" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } } ] }, "post": { "operationId": "createReportFolder", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ReportFolderDto", "type": "object", "properties": { "id": { "type": "integer", "description": "READ-ONLY" }, "name": { "type": "string" }, "parentId": { "type": "integer", "description": "2" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/folders/{id}": { "put": { "operationId": "updateReportFolderById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ReportFolderDto", "type": "object", "properties": { "id": { "type": "integer", "description": "READ-ONLY" }, "name": { "type": "string" }, "parentId": { "type": "integer", "description": "2" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteReportFolderById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/reports/{id}": { "get": { "operationId": "getReport", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ReportDto", "type": "object", "properties": { "description": { "type": "string" }, "emailTo": { "type": "string" }, "folderId": { "type": "integer" }, "id": { "type": "integer" }, "isEmailed": { "type": "boolean" }, "isFtped": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isTemporary": { "type": "boolean" }, "lastAccessed": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "lastModified": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "migrated": { "type": "integer" }, "name": { "type": "string" }, "nextRun": { "type": "integer" }, "numberOfColumns": { "type": "integer" }, "runUnit": { "type": "string" }, "runValue": { "type": "integer" }, "templateType": { "type": "string" }, "timezone": { "type": "string" }, "userId": { "type": "integer" }, "userRoleId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateReportById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ReportDto", "type": "object", "properties": { "description": { "type": "string" }, "emailTo": { "type": "string" }, "folderId": { "type": "integer" }, "id": { "type": "integer" }, "isEmailed": { "type": "boolean" }, "isFtped": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isTemporary": { "type": "boolean" }, "lastAccessed": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "lastModified": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "message": { "type": "string" }, "migrated": { "type": "integer" }, "name": { "type": "string" }, "nextRun": { "type": "integer" }, "numberOfColumns": { "type": "integer" }, "runUnit": { "type": "string" }, "runValue": { "type": "integer" }, "templateType": { "type": "string" }, "timezone": { "type": "string" }, "userId": { "type": "integer" }, "userRoleId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteReportById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/reports/attachments/telephony/{id}/aggregation": { "get": { "operationId": "getTelephonyAttachmentAggregation", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentAggregationV1", "type": "object", "properties": { "aggregation": { "title": "Aggregation15", "enum": [ "None", "Destination", "DestinationCodec", "DestinationIP", "DestinationPhone", "DestinationPool", "PBXName", "Source", "SourceCodec", "SourceIP", "SourcePhone", "SourcePool", "Domain" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTelephonyAttachmentAggregation", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentAggregationV1", "type": "object", "properties": { "aggregation": { "title": "Aggregation15", "enum": [ "None", "Destination", "DestinationCodec", "DestinationIP", "DestinationPhone", "DestinationPool", "PBXName", "Source", "SourceCodec", "SourceIP", "SourcePhone", "SourcePool", "Domain" ], "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/telephony/{id}/settings": { "get": { "operationId": "getTelephonyAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "telephonySetting": { "title": "TelephonySetting", "type": "object", "properties": { "sortBy": { "title": "SortBy", "enum": [ "duration", "jitter", "latency", "loss", "mos", "r" ], "type": "string" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTelephonyAttachmentSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "telephonySetting": { "title": "TelephonySetting", "type": "object", "properties": { "sortBy": { "title": "SortBy", "enum": [ "duration", "jitter", "latency", "loss", "mos", "r" ], "type": "string" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/telephony/{id}/time": { "get": { "operationId": "getTelephonyAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTelephonyAttachmentTimeSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/attachments/telephony/{id}/visualizations": { "get": { "operationId": "getTelephonyAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateTelephonyAttachmentVisualizationSettings", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/reports/{id}/attachments/telephony": { "post": { "operationId": "createTelephonyAttachment", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "TelephonyAttachmentResponseDtoV1", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "settings": { "title": "TelephonyAttachmentSettingsV1", "type": "object", "properties": { "resultLimitSetting": { "title": "ResultLimitSettingV1", "type": "object", "properties": { "resultLimit": { "type": "integer" } } }, "telephonySetting": { "title": "TelephonySetting", "type": "object", "properties": { "sortBy": { "title": "SortBy", "enum": [ "duration", "jitter", "latency", "loss", "mos", "r" ], "type": "string" }, "sortOrder": { "title": "SortOrder", "enum": [ "DESC", "ASC" ], "type": "string" } } } } }, "timeSettings": { "title": "TimeSettingV1", "type": "object", "properties": { "ranges": { "title": "TimeRangeV1", "type": "object", "properties": { "end": { "type": "string" }, "start": { "type": "string" }, "type": { "title": "Type1", "enum": [ "CustomWeek", "RelativePeriod", "SpecificInterval" ], "type": "string" } } }, "timezone": { "type": "string" } } }, "visualization": { "title": "DeviceGroupsVisualizationV1", "type": "object", "properties": { "table": { "title": "VisualizationTableSettingV1", "type": "object", "properties": { "columnSetting": { "title": "ColumnSetting", "type": "object", "properties": { "exclude": { "type": "array", "items": { "type": "string" }, "description": "" }, "include": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "csvSetting": { "title": "CSVSetting", "type": "object", "properties": { "expandTimeseries": { "type": "boolean" }, "formatTimestamp": { "type": "boolean" } } }, "dataPresentationSetting": { "title": "DataPresentationSetting", "type": "object", "properties": { "formatNumbers": { "type": "boolean" }, "precision": { "type": "integer" } } }, "tableSetting": { "title": "TableSetting", "type": "object", "properties": { "blockVis": { "type": "boolean" }, "hideHeaders": { "type": "boolean" }, "wrapCells": { "type": "boolean" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/pluginmanager/register": { "post": { "operationId": "registerDynamicPluginManager", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DynamicPluginManagerResponseDto", "type": "object", "properties": { "id": { "type": "integer" }, "identifier": { "type": "string" }, "lastSeen": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "name": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/pluginmanager/{id}/plugin/register": { "post": { "operationId": "registerDynamicPlugin", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DynamicPluginResponseDto", "type": "object", "properties": { "fields": { "type": "array", "items": { "title": "DynamicPluginFieldDto", "type": "object", "properties": { "defaultEntry": { "type": "string" }, "description": { "type": "string" }, "enumList": { "type": "string" }, "maxLength": { "type": "integer" }, "name": { "type": "string" }, "type": { "title": "Type26", "enum": [ "BOOLEAN", "INTEGER", "FLOAT", "LIST", "TEXT", "SECRET" ], "type": "string" }, "valueRange": { "type": "string" } } }, "description": "" }, "name": { "type": "string" }, "technology": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/objectgroups/{id}": { "patch": { "operationId": "partiallyUpdateObjectGroupById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ObjectGroupDto", "type": "object", "properties": { "id": { "type": "integer" }, "members": { "type": "array", "items": { "title": "DeviceObjectDto", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "title": "Enabled", "enum": [ "ENABLED", "DISABLED", "AUTO" ], "type": "string" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "title": "IndicatorDto", "type": "object", "properties": { "dataUnits": { "type": "string" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "displayUnits": { "type": "string" }, "evaluationOrder": { "type": "integer" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "firstSeen": { "type": "integer" }, "format": { "title": "Format", "enum": [ "GAUGE", "COUNTER32", "COUNTER64" ], "type": "string" }, "id": { "type": "integer" }, "isBaselining": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "lastInvalidationTime": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "lastSeen": { "type": "integer" }, "maxValue": { "type": "number" }, "name": { "type": "string" }, "objectId": { "type": "integer" }, "pluginId": { "type": "integer" }, "pluginIndicatorTypeId": { "type": "integer" }, "syntheticExpression": { "type": "string" }, "systemIsBaselining": { "type": "boolean" }, "systemIsEnabled": { "type": "boolean" }, "systemMaxValue": { "type": "number" } } }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "name": { "type": "string" }, "parentId": { "type": "integer" }, "readOnly": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/devices/{id}": { "patch": { "operationId": "partiallyUpdateDeviceById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceDto", "type": "object", "properties": { "allowDelete": { "type": "boolean" }, "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "disableConcurrentPolling": { "type": "boolean" }, "disablePolling": { "type": "boolean" }, "disableThresholding": { "type": "boolean" }, "id": { "type": "integer" }, "ipAddress": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isNew": { "type": "boolean" }, "lastDiscovery": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "manualIP": { "type": "boolean" }, "name": { "type": "string" }, "numElements": { "type": "integer" }, "objects": { "type": "array", "items": { "title": "Object1", "type": "object", "properties": { "alternateName": { "type": "string" }, "dateAdded": { "type": "integer", "description": "Unix timestamp with milliseconds proximity" }, "description": { "type": "string" }, "deviceId": { "type": "integer" }, "enabled": { "type": "object", "description": "" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "id": { "type": "integer" }, "indicators": { "type": "array", "items": { "type": "object", "description": "" }, "description": "" }, "isDeleted": { "type": "boolean" }, "isEnabled": { "type": "boolean", "description": "This field is deprecated and would be removed in a newer version of the API. Please use 'enabled' field instead.", "example": false }, "isVisible": { "type": "boolean" }, "name": { "type": "string" }, "pluginId": { "type": "integer" }, "pluginObjectTypeId": { "type": "integer" }, "subtypeId": { "type": "integer" } } }, "description": "" }, "peerId": { "type": "integer" }, "pluginInfo": { "type": "object", "additionalProperties": { "title": "PluginInfo", "type": "object", "properties": { "enabled": { "type": "boolean" }, "extendedInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "working": { "type": "boolean" } } } }, "pluginManagerId": { "type": "integer" }, "pollFrequency": { "type": "integer" }, "timezone": { "type": "string" }, "workhoursGroupId": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/mapimages": { "get": { "operationId": "getMapImages", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfMapImageDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "MapImageDto", "type": "object", "properties": { "id": { "type": "integer" }, "imageMimeType": { "type": "string" }, "imageSize": { "type": "integer" }, "name": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] } }, "/api/v1/mapimages/{id}": { "get": { "operationId": "getMapImageById", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/application/logger": { "post": { "operationId": "postLoggingLevel", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/application/metrics": { "get": { "operationId": "getPublicMetrics", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "title": "filter", "type": "string" } } ] } }, "/api/v1/application/version": { "get": { "operationId": "getVersion", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ApiInfo", "type": "object", "properties": { "buildTime": { "type": "string" }, "buildVersion": { "type": "string" }, "commitIdAbbrev": { "type": "string" }, "commitTime": { "type": "string" } } } } } } } } }, "/api/v1/devicegroups/rules": { "get": { "operationId": "getDeviceGroupsRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfDeviceGroupRuleDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "DeviceGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "mgtIpExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "sysContactExpression": { "type": "string" }, "sysDescrExpression": { "type": "string" }, "sysLocationExpression": { "type": "string" }, "sysNameExpression": { "type": "string" }, "sysObjectIdExpression": { "type": "string" }, "walkCheckOid": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] }, "post": { "operationId": "createDeviceGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "mgtIpExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "sysContactExpression": { "type": "string" }, "sysDescrExpression": { "type": "string" }, "sysLocationExpression": { "type": "string" }, "sysNameExpression": { "type": "string" }, "sysObjectIdExpression": { "type": "string" }, "walkCheckOid": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/api/v1/devicegroups/rules/{id}": { "get": { "operationId": "getDeviceGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "mgtIpExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "sysContactExpression": { "type": "string" }, "sysDescrExpression": { "type": "string" }, "sysLocationExpression": { "type": "string" }, "sysNameExpression": { "type": "string" }, "sysObjectIdExpression": { "type": "string" }, "walkCheckOid": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] }, "put": { "operationId": "updateDeviceGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "DeviceGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "mgtIpExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "sysContactExpression": { "type": "string" }, "sysDescrExpression": { "type": "string" }, "sysLocationExpression": { "type": "string" }, "sysNameExpression": { "type": "string" }, "sysObjectIdExpression": { "type": "string" }, "walkCheckOid": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "operationId": "deleteDeviceGroupRule", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "ResponseEntity", "type": "object", "properties": { "body": { "type": "object" }, "statusCode": { "title": "StatusCode", "enum": [ 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511 ], "type": "integer", "example": 100 }, "statusCodeValue": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ] } }, "/api/v1/devicegroups/{id}/rules": { "get": { "operationId": "getDeviceGroupRules", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "PagerOfDeviceGroupRuleDto", "type": "object", "properties": { "content": { "type": "array", "items": { "title": "DeviceGroupRuleDto", "type": "object", "properties": { "attributeId": { "type": "integer" }, "descriptionExpression": { "type": "string" }, "groupId": { "type": "integer" }, "id": { "type": "integer" }, "metadataValueExpression": { "type": "string" }, "mgtIpExpression": { "type": "string" }, "nameExpression": { "type": "string" }, "namespaceId": { "type": "integer" }, "sysContactExpression": { "type": "string" }, "sysDescrExpression": { "type": "string" }, "sysLocationExpression": { "type": "string" }, "sysNameExpression": { "type": "string" }, "sysObjectIdExpression": { "type": "string" }, "walkCheckOid": { "type": "string" } } }, "description": "" }, "pageNumber": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalElements": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } }, { "name": "page", "in": "query", "required": false, "schema": { "title": "page", "type": "number" } }, { "name": "size", "in": "query", "required": false, "schema": { "title": "size", "type": "number" } }, { "name": "includeCount", "in": "query", "required": false, "schema": { "title": "includeCount", "type": "boolean" } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "sortBy", "type": "string" } }, { "name": "fields", "in": "query", "required": false, "schema": { "title": "fields", "type": "string" } } ] } } }, "components": { "schemas": {} } }