omc

package

v0.1.0 Latest Latest Go to latest Published: Dec 8, 2023 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/netdoop/netdoop

Links

Open Source Insights

Documentation ¶

Index ¶

func HandleAddDeviceObject(c echo.Context) error
func HandleCreateDataModel(c echo.Context) error
func HandleCreateDataModelParameter(c echo.Context) error
func HandleCreateDataModelTemplate(c echo.Context) error
func HandleCreateDevice(c echo.Context) error
func HandleCreateFirmware(c echo.Context) error
func HandleCreateGroup(c echo.Context) error
func HandleCreateKPIMeasure(c echo.Context) error
func HandleCreateKPITemplate(c echo.Context) error
func HandleCreateProduct(c echo.Context) error
func HandleCreateTask(c echo.Context) error
func HandleDeleteDataModel(c echo.Context) error
func HandleDeleteDataModelParameter(c echo.Context) error
func HandleDeleteDataModelTemplate(c echo.Context) error
func HandleDeleteDeletedDevice(c echo.Context) error
func HandleDeleteDeletedProduct(c echo.Context) error
func HandleDeleteDevice(c echo.Context) error
func HandleDeleteDeviceObject(c echo.Context) error
func HandleDeleteDeviceTransferLog(c echo.Context) error
func HandleDeleteFirmware(c echo.Context) error
func HandleDeleteGroup(c echo.Context) error
func HandleDeleteKPIMeasure(c echo.Context) error
func HandleDeleteKPITemplate(c echo.Context) error
func HandleDeleteProduct(c echo.Context) error
func HandleDeleteTask(c echo.Context) error
func HandleGetDataModel(c echo.Context) error
func HandleGetDataModelParameter(c echo.Context) error
func HandleGetDataModelTemplate(c echo.Context) error
func HandleGetDevice(c echo.Context) error
func HandleGetDeviceAlarm(c echo.Context) error
func HandleGetDeviceEvent(c echo.Context) error
func HandleGetDeviceMethodCall(c echo.Context) error
func HandleGetDeviceMethods(c echo.Context) error
func HandleGetDeviceParameterNames(c echo.Context) error
func HandleGetDeviceParameterValues(c echo.Context) error
func HandleGetDeviceParameters(c echo.Context) error
func HandleGetDeviceTransferLog(c echo.Context) error
func HandleGetFirmware(c echo.Context) error
func HandleGetGroup(c echo.Context) error
func HandleGetGroupChild(c echo.Context) error
func HandleGetKPIMeasure(c echo.Context) error
func HandleGetKPITemplate(c echo.Context) error
func HandleGetProduct(c echo.Context) error
func HandleGetTask(c echo.Context) error
func HandleGetTaskDeviceLog(c echo.Context) error
func HandleListDataModel(c echo.Context) error
func HandleListDataModelParameters(c echo.Context) error
func HandleListDataModelTemplates(c echo.Context) error
func HandleListDeletedDevices(c echo.Context) error
func HandleListDeletedProducts(c echo.Context) error
func HandleListDeviceAlarms(c echo.Context) error
func HandleListDeviceEvents(c echo.Context) error
func HandleListDeviceMethodCalls(c echo.Context) error
func HandleListDeviceTransferLogs(c echo.Context) error
func HandleListDevices(c echo.Context) error
func HandleListFirmwares(c echo.Context) error
func HandleListGroups(c echo.Context) error
func HandleListKPIMeasures(c echo.Context) error
func HandleListKPITemplateRecords(c echo.Context) error
func HandleListKPITemplates(c echo.Context) error
func HandleListProductFirmwares(c echo.Context) error
func HandleListProducts(c echo.Context) error
func HandleListTaskDeviceLogs(c echo.Context) error
func HandleListTasks(c echo.Context) error
func HandleQueryData(c echo.Context) error
func HandleRebootDevice(c echo.Context) error
func HandleRecoverDeletedDevice(c echo.Context) error
func HandleSetDeviceParameterValues(c echo.Context) error
func HandleSetDevicePerfDisable(c echo.Context) error
func HandleSetDevicePerfEnable(c echo.Context) error
func HandleSetFirmwareProducts(c echo.Context) error
func HandleSetGroupForDevice(c echo.Context) error
func HandleSetGroupParent(c echo.Context) error
func HandleSetKPIMeasureDisable(c echo.Context) error
func HandleSetKPIMeasureEnable(c echo.Context) error
func HandleSetProductDisable(c echo.Context) error
func HandleSetProductEnable(c echo.Context) error
func HandleUpdateDeviceInfo(c echo.Context) error
func HandleUpdateGroupInfo(c echo.Context) error
func HandleUpdateKPIMeasureInfo(c echo.Context) error
func HandleUpdateKPITemplateInfo(c echo.Context) error
func HandleUpdateProductInfo(c echo.Context) error
func HandleUpgradeDevice(c echo.Context) error
func HandleUploadDeviceFile(c echo.Context) error
func HandlesSetDeviceDisable(c echo.Context) error
func HandlesSetDeviceEnable(c echo.Context) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func HandleAddDeviceObject ¶

func HandleAddDeviceObject(c echo.Context) error

HandleAddDeviceObjectNames godoc @Summary Add object of a device @Tags OMC Devices @ID add-device-object @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body addDeviceObejectBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/add-device-object [post]

func HandleCreateDataModel ¶

func HandleCreateDataModel(c echo.Context) error

HandleCreateDataModel creates a new data model. @Summary Create data model @ID create-datamodel @Produce json @Security Bearer @Param body body createDataModelBody true "DataModel" @Success 200 {object} omc.DataModel @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels [post] @Tags OMC DataModel

func HandleCreateDataModelParameter ¶

func HandleCreateDataModelParameter(c echo.Context) error

HandleCreateDataModelParameter creates a new data model parameter. @Summary Create data model parameter @ID create-datamodel-parameter @Produce json @Security Bearer @Param body body createDataModelParameterBody true "DataModelParameter" @Success 200 {object} omc.DataModelParameter @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id}/parameters [post] @Tags OMC DataModel Parameter

func HandleCreateDataModelTemplate ¶

func HandleCreateDataModelTemplate(c echo.Context) error

HandleCreateDataModelTemplate creates a new data model template. @Summary Create data model template @ID create-datamodel-template @Produce json @Security Bearer @Param body body createDataModelTemplateBody true "DataModelTemplate" @Success 200 {object} omc.DataModelTemplate @Failure 400 {object} echo.HTTPError "Bad Request: invalid input template" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id}/templates [post] @Tags OMC DataModel Template

func HandleCreateDevice ¶

func HandleCreateDevice(c echo.Context) error

HandleCreateDevice godoc @Summary Create a device @Tags OMC Devices @ID create-device @Accept json @Produce json @Security Bearer @Param body body createDeviceBody true "Device" @Success 200 {object} omc.Device @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 404 {object} echo.HTTPError "Not Found: invalid product" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices [post]

func HandleCreateFirmware ¶

func HandleCreateFirmware(c echo.Context) error

HandleCreateFirmware creates a new firmware. @Summary Create firmware @ID create-firmware @Produce json @Security Bearer @Accept multipart/form-data @Param Version formData string true "Version" @Param ProductType formData string true "ProductType" @Param Products formData string true "Product list" @Param File formData file true "Firmware file to upload" @Success 200 {object} omc.Firmware @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/firmwares [post] @Tags OMC Firmwares

func HandleCreateGroup ¶

func HandleCreateGroup(c echo.Context) error

HandleCreateGroup godoc @Summary Create a group @Tags OMC Groups @ID create-group @Security Bearer @Param body body createGroupBody true "Create Group Body" @Success 200 {object} omc.Group @Failure 400 {object} echo.HTTPError "Bad Request" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups [post]

func HandleCreateKPIMeasure ¶

func HandleCreateKPIMeasure(c echo.Context) error

HandleCreateKPIMeasure creates a new kpi measure. @Summary Create kpi measure @ID create-kpi-measure @Produce json @Security Bearer @Param body body createKPIMeasureBody true "KPIMeas" @Success 200 {object} omc.KPIMeas @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/measures [post] @Tags OMC KPI

func HandleCreateKPITemplate ¶

func HandleCreateKPITemplate(c echo.Context) error

HandleCreateKPITemplate creates a new kpi template. @Summary Create kpi template @ID create-kpi-template @Produce json @Security Bearer @Param body body createKPITemplateBody true "KPITemplate" @Success 200 {object} omc.KPITemplate @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/templates [post] @Tags OMC KPI

func HandleCreateProduct ¶

func HandleCreateProduct(c echo.Context) error

HandleCreateProduct creates a new product. @Summary Create product @ID create-product @Produce json @Security Bearer @Param body body createProductBody true "Product" @Success 200 {object} omc.Product @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/products [post] @Tags OMC Products

func HandleCreateTask ¶

func HandleCreateTask(c echo.Context) error

HandleCreateTask creates a new task. @Summary Create task @ID create-task @Produce json @Security Bearer @Param body body createTaskBody true "Task" @Success 200 {object} omc.Task @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/tasks [post] @Tags OMC Tasks

func HandleDeleteDataModel ¶

func HandleDeleteDataModel(c echo.Context) error

HandleDeleteDataModel deletes the data model. @Summary Delete data model @Tags OMC DataModel @ID delete-datamodel @Security Bearer @Param id path int true "ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id} [delete]

func HandleDeleteDataModelParameter ¶

func HandleDeleteDataModelParameter(c echo.Context) error

HandleDeleteDataModelParameter deletes the data model parameter. @Summary Delete data model parameter @Tags OMC DataModel Parameter @ID delete-datamodel-parameter @Security Bearer @Param id path int true "ID" @Param parameter_id path string true "Parameter ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id}/parameter/{parameter_id} [delete]

func HandleDeleteDataModelTemplate ¶

func HandleDeleteDataModelTemplate(c echo.Context) error

HandleDeleteDataModelTemplate deletes the data model template. @Summary Delete data model template @Tags OMC DataModel Template @ID delete-datamodel-template @Security Bearer @Param id path int true "ID" @Param template_id path string true "TemplateID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id}/template/{template_id} [delete]

func HandleDeleteDeletedDevice ¶

func HandleDeleteDeletedDevice(c echo.Context) error

HandleDeleteDeletedDevice godoc @Summary Delete a device permanently @Tags OMC Deleted Devices @ID delete-deleted-device @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/deleted-devices/{id} [delete]

func HandleDeleteDeletedProduct ¶

func HandleDeleteDeletedProduct(c echo.Context) error

HandleDeleteDeletedProduct deletes the product. @Summary Delete deleted product @Tags OMC Deleted Products @ID delete-deleted-product @Security Bearer @Param id path int true "Product ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/deleted-products/{id} [delete]

func HandleDeleteDevice ¶

func HandleDeleteDevice(c echo.Context) error

HandleDeleteDevice godoc @Summary Delete a device @Tags OMC Devices @ID delete-device @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id} [delete]

func HandleDeleteDeviceObject ¶

func HandleDeleteDeviceObject(c echo.Context) error

HandleDeleteDeviceObject godoc @Summary Delete object of a device @Tags OMC Devices @ID delete-device-object @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body deleteDeviceObejectBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/delete-device-object [post]

func HandleDeleteDeviceTransferLog ¶

func HandleDeleteDeviceTransferLog(c echo.Context) error

HandleDeleteDeviceTransferLog @Summary Delete device transfer log @Tags OMC Device Transfer Logs @ID delete-device-transfer-log @Security Bearer @Accept json @Param ts path int true "Timestamp" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/transfer-logs/{ts} [delete]

func HandleDeleteFirmware ¶

func HandleDeleteFirmware(c echo.Context) error

HandleDeleteFirmware deletes the firmware. @Summary Delete firmware @Tags OMC Firmwares @ID delete-firmware @Security Bearer @Accept json @Param id path int true "Firmware ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/firmwares/{id} [delete]

func HandleDeleteGroup ¶

func HandleDeleteGroup(c echo.Context) error

@Summary Delete a group @Tags OMC Groups @ID delete-group @Security Bearer @Param id path int true "Group ID" @Success 204 "No Content" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups/{id} [delete]

func HandleDeleteKPIMeasure ¶

func HandleDeleteKPIMeasure(c echo.Context) error

HandleDeleteKPIMeasure deletes the kpi measure. @Summary Delete kpi measure @Tags OMC KPI @ID delete-kpi-measure @Security Bearer @Param id path int true "ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/measures/{id} [delete]

func HandleDeleteKPITemplate ¶

func HandleDeleteKPITemplate(c echo.Context) error

HandleDeleteKPITemplate deletes the kpi template. @Summary Delete kpi template @Tags OMC KPI @ID delete-kpi-template @Security Bearer @Param id path int true "ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/templates/{id} [delete]

func HandleDeleteProduct ¶

func HandleDeleteProduct(c echo.Context) error

HandleDeleteProduct deletes the product. @Summary Delete product @Tags OMC Products @ID delete-product @Security Bearer @Param id path int true "Product ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/products/{id} [delete]

func HandleDeleteTask ¶

func HandleDeleteTask(c echo.Context) error

HandleDeleteTask deletes the task. @Summary Delete task @Tags OMC Tasks @ID delete-task @Security Bearer @Param id path int true "Task ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/tasks/{id} [delete]

func HandleGetDataModel ¶

func HandleGetDataModel(c echo.Context) error

HandleGetDataModel retrieves a single data model. @Summary Get data model @ID get-datamodel @Produce json @Security Bearer @Param id path int true "ID" @Success 200 {object} omc.DataModel @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id} [get] @Tags OMC DataModel

func HandleGetDataModelParameter ¶

func HandleGetDataModelParameter(c echo.Context) error

HandleGetDataModelParameter retrieves a single data model parameter. @Summary Get data model parameter @ID get-datamodel-parameter @Produce json @Security Bearer @Param id path int true "ID" @Param parameter_id path string true "Parameter ID" @Success 200 {object} omc.DataModelParameter @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id}/parameters/{parameter_id} [get] @Tags OMC DataModel Parameter

func HandleGetDataModelTemplate ¶

func HandleGetDataModelTemplate(c echo.Context) error

HandleGetDataModelTemplate retrieves a single data model template. @Summary Get data model template @ID get-datamodel-template @Produce json @Security Bearer @Param id path int true "ID" @Param template_id path string true "TemplateID" @Success 200 {object} omc.DataModelTemplate @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels/{id}/templates/{template_id} [get] @Tags OMC DataModel Template

func HandleGetDevice ¶

func HandleGetDevice(c echo.Context) error

HandleGetDevice godoc @Summary Get a device @Tags OMC Devices @ID get-device @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 200 {object} omc.Device @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id} [get]

func HandleGetDeviceAlarm ¶

func HandleGetDeviceAlarm(c echo.Context) error

HandleGetDeviceAlarm retrieves a single device alarm. @Summary Get device alarm @ID get-device-alarm @Produce json @Security Bearer @Param ts path int true "Timestamp" @Success 200 {object} omc.DeviceAlarm @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-alarms/{ts} [get] @Tags OMC Device Alarms

func HandleGetDeviceEvent ¶

func HandleGetDeviceEvent(c echo.Context) error

HandleGetDeviceEvent retrieves a single device event. @Summary Get device event @ID get-device-event @Produce json @Security Bearer @Param ts path int true "Timestamp" @Success 200 {object} omc.DeviceEvent @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-events/{ts} [get] @Tags OMC DeviceEvents

func HandleGetDeviceMethodCall ¶

func HandleGetDeviceMethodCall(c echo.Context) error

HandleGetDeviceMethodCall retrieves a single device method call. @Summary Get device method call @ID get-device-method-call @Produce json @Security Bearer @Param ts path int true "Timestamp" @Success 200 {object} omc.DeviceMethodCall @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-method-calls/{ts} [get] @Tags OMC Device MethodCalls

func HandleGetDeviceMethods ¶

func HandleGetDeviceMethods(c echo.Context) error

HandleGetDeviceMethods godoc @Summary Get the methods of a device @Tags OMC Devices @ID list-device-methods @Accept json @Produce json @Security Bearer @Param id path string true "Device ID" @Success 200 {object} omc.Methods @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/methods [get]

func HandleGetDeviceParameterNames ¶

func HandleGetDeviceParameterNames(c echo.Context) error

HandleGetDeviceParameterNames godoc @Summary Get parameter names of a device @Tags OMC Devices @ID get-device-parameter-names @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body getDeviceParameterNamesBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/get-parameter-names [post]

func HandleGetDeviceParameterValues ¶

func HandleGetDeviceParameterValues(c echo.Context) error

HandleGetDeviceParameterValues godoc @Summary Get parameter values of a device @Tags OMC Devices @ID get-device-parameter-values @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body getDeviceParameterValuesBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/get-parameter-values [post]

func HandleGetDeviceParameters ¶

func HandleGetDeviceParameters(c echo.Context) error

HandleGetDeviceParameters godoc @Summary Get the parameters of a device @Tags OMC Devices @ID list-device-parameters @Accept json @Produce json @Security Bearer @Param id path string true "Device ID" @Success 200 {object} omc.ParameterValues @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/parameters [get]

func HandleGetDeviceTransferLog ¶

func HandleGetDeviceTransferLog(c echo.Context) error

HandleGetDeviceTransferLog @Summary Get device transfer log @ID get-device-transfer-log @Tags OMC Device Transfer Logs @Produce json @Security Bearer @Param ts path int true "Timestamp" @Success 200 {object} omc.DeviceTransferLog @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/transfer-logs/{ts} [get]

func HandleGetFirmware ¶

func HandleGetFirmware(c echo.Context) error

HandleGetFirmware retrieves a single firmware. @Summary Get firmware @ID get-firmware @Produce json @Security Bearer @Param id path int true "Firmware ID" @Success 200 {object} omc.Firmware @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/firmwares/{id} [get] @Tags OMC Firmwares

func HandleGetGroup ¶

func HandleGetGroup(c echo.Context) error

HandleGetGroup godoc @Summary Get group details @Tags OMC Groups @ID get-group @Security Bearer @Param id path int true "Group ID" @Success 200 {object} omc.Group @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups/{id} [get]

func HandleGetGroupChild ¶

func HandleGetGroupChild(c echo.Context) error

HandleGetGroupChild godoc @Summary Get child groups @Tags OMC Groups @ID get-group-children @Security Bearer @Param id path int true "Group ID" @Success 200 {array} omc.Group @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups/{id}/children [get]

func HandleGetKPIMeasure ¶

func HandleGetKPIMeasure(c echo.Context) error

HandleGetKPIMeasure retrieves a single kpi measure. @Summary Get kpi measure @ID get-kpi-measure @Produce json @Security Bearer @Param id path int true "ID" @Success 200 {object} omc.KPIMeas @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/measures/{id} [get] @Tags OMC KPI

func HandleGetKPITemplate ¶

func HandleGetKPITemplate(c echo.Context) error

HandleGetKPITemplate retrieves a single kpi template. @Summary Get kpi template @ID get-kpi-template @Produce json @Security Bearer @Param id path int true "ID" @Success 200 {object} omc.KPITemplate @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/templates/{id} [get] @Tags OMC KPI

func HandleGetProduct ¶

func HandleGetProduct(c echo.Context) error

HandleGetProduct retrieves a single product. @Summary Get product @ID get-product @Produce json @Security Bearer @Param id path int true "Product ID" @Success 200 {object} omc.Product @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/products/{id} [get] @Tags OMC Products

func HandleGetTask ¶

func HandleGetTask(c echo.Context) error

HandleGetTask retrieves a single task. @Summary Get task @ID get-task @Produce json @Security Bearer @Param id path int true "Task ID" @Success 200 {object} omc.Task @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/tasks/{id} [get] @Tags OMC Tasks

func HandleGetTaskDeviceLog ¶

func HandleGetTaskDeviceLog(c echo.Context) error

HandleGetTaskDeviceLog retrieves a single log device log. @Summary Get log device log @ID get-device-log @Produce json @Security Bearer @Param ts path int true "Timestamp" @Success 200 {object} omc.TaskDeviceLog @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-logs/{ts} [get] @Tags OMC TaskDeviceLogs

func HandleListDataModel ¶

func HandleListDataModel(c echo.Context) error

HandleListDataModel lists all data models. @Summary List data models @ID list-datamodels @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listDataModelData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/datamodels [get] @Tags OMC DataModel

func HandleListDataModelParameters ¶

func HandleListDataModelParameters(c echo.Context) error

HandleListDataModelParameters godoc @Summary List the parameters of a datamodel @Tags OMC DataModel @ID list-datamodel-parameters @Accept json @Produce json @Security Bearer @Param id path string true "Device ID" @Success 200 {object} omc.ParameterValues @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/datamodels/{id}/parameters [get]

func HandleListDataModelTemplates ¶

func HandleListDataModelTemplates(c echo.Context) error

HandleListDataModelTemplates godoc @Summary List the templates of a datamodel @Tags OMC DataModel @ID list-datamodel-templates @Accept json @Produce json @Security Bearer @Param id path string true "Device ID" @Success 200 {object} omc.ParameterValues @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/datamodels/{id}/templates [get]

func HandleListDeletedDevices ¶

func HandleListDeletedDevices(c echo.Context) error

HandleListDeletedDevices godoc @Summary List deleted devices @Tags OMC Deleted Devices @ID list-deleted-devices @Accept json @Produce json @Param q query string false "Query" default() @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Security Bearer @Success 200 {object} listDeletedDevicesData @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/deleted-devices [get]

func HandleListDeletedProducts ¶

func HandleListDeletedProducts(c echo.Context) error

HandleListDeletedProducts lists all products. @Summary List deleted products @Tags OMC Deleted Products @ID list-deleted-products @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listDeletedProductsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/deleted-products [get]

func HandleListDeviceAlarms ¶

func HandleListDeviceAlarms(c echo.Context) error

HandleListDeviceAlarms lists all device alarms. @Summary List device alarms @ID list-device-alarms @Produce json @Security Bearer @Param offset query int false "Offset" default(0) @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param q query string false "Query" default() @Param order_by query string false "Sort order" default() @Success 200 {object} listDeviceAlarmsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-alarms [get] @Tags OMC Device Alarms(

func HandleListDeviceEvents ¶

func HandleListDeviceEvents(c echo.Context) error

HandleListDeviceEvents lists all device events. @Summary List device events @ID list-device-events @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listDeviceEventsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-events [get] @Tags OMC DeviceEvents

func HandleListDeviceMethodCalls ¶

func HandleListDeviceMethodCalls(c echo.Context) error

HandleListDeviceMethodCalls lists all device method calls. @Summary List device method calls @ID list-device-method-calls @Produce json @Security Bearer @Param offset query int false "Offset" default(0) @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param q query string false "Query" default() @Param order_by query string false "Sort order" default() @Success 200 {object} listDeviceMethodCallsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-method-calls [get] @Tags OMC Device MethodCalls

func HandleListDeviceTransferLogs ¶

func HandleListDeviceTransferLogs(c echo.Context) error

HandleListDeviceTransferLogs lists all transfer logs. @Summary List transfer logs @ID list-device-transfer-logs @Tags OMC Device Transfer Logs @Produce json @Security Bearer @Accept json @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listDeviceTransferLogsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/transfer-logs [get]

func HandleListDevices ¶

func HandleListDevices(c echo.Context) error

HandleListDevices godoc @Summary List devices @Tags OMC Devices @ID list-devices @Accept json @Produce json @Param q query string false "Query" default() @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Security Bearer @Success 200 {object} listDevicesData @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices [get]

func HandleListFirmwares ¶

func HandleListFirmwares(c echo.Context) error

HandleListFirmwares lists all firmwares. @Summary List firmwares @ID list-firmwares @Produce json @Security Bearer @Accept json @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listFirmwaresData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/firmwares [get] @Tags OMC Firmwares

func HandleListGroups ¶

func HandleListGroups(c echo.Context) error

HandleListGroups godoc @Summary List child groups @Tags OMC Groups @ID list-groups @Security Bearer @Success 200 {array} omc.Group @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups [get]

func HandleListKPIMeasures ¶

func HandleListKPIMeasures(c echo.Context) error

HandleListKPIMeasures lists all kpi measures. @Summary List kpi measures @ID list-kpi-measures @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listKPIMeasuresData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/measures [get] @Tags OMC KPI

func HandleListKPITemplateRecords ¶

func HandleListKPITemplateRecords(c echo.Context) error

HandleListKPITemplateRecords lists all kpi templates. @Summary List kpi template records @ID list-kpi-template-records @Produce json @Security Bearer @Param id path int true "ID" @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listKPITemplateRecordsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/templates/{id}/records [get] @Tags OMC KPI

func HandleListKPITemplates ¶

func HandleListKPITemplates(c echo.Context) error

HandleListKPITemplates lists all kpi templates. @Summary List kpi templates @ID list-kpi-templates @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listKPITemplatesData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/templates [get] @Tags OMC KPI

func HandleListProductFirmwares ¶

func HandleListProductFirmwares(c echo.Context) error

HandleListProductFirmwares @Summary List product firmwares @ID list-product-firmwares @Produce json @Security Bearer @Param id path int true "Product ID" @Success 200 {array} omc.Firmware "Firmwares" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/products/{id}/firmwares [get] @Tags OMC Products

func HandleListProducts ¶

func HandleListProducts(c echo.Context) error

HandleListProducts lists all products. @Summary List products @ID list-products @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listProductsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/products [get] @Tags OMC Products

func HandleListTaskDeviceLogs ¶

func HandleListTaskDeviceLogs(c echo.Context) error

HandleListTaskDeviceLogs lists all log device logs. @Summary List log device logs @ID list-device-logs @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listTaskDeviceLogsData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/device-logs [get] @Tags OMC TaskDeviceLogs

func HandleListTasks ¶

func HandleListTasks(c echo.Context) error

HandleListTasks lists all tasks. @Summary List tasks @ID list-tasks @Produce json @Security Bearer @Param page query int false "Page" default(1) @Param page_size query int false "Page size" default(20) @Param order_by query string false "Sort order" default() @Param q query string false "Query" default() @Success 200 {object} listTasksData @Header 200 {int} X-Total "Total number" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/tasks [get] @Tags OMC Tasks

func HandleQueryData ¶

func HandleQueryData(c echo.Context) error

HandleQueryData query series. @Summary Query data series @ID query-data @Produce json @Security Bearer @Param body body tsdb.TSQueryCommand true "Query Command" @Success 200 {object} tsdb.TSResult @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/data [post] @Tags OMC Data

func HandleRebootDevice ¶

func HandleRebootDevice(c echo.Context) error

HandleRebootDevice godoc @Summary Reboot a device @Tags OMC Devices @ID reboot-device @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/reboot [post]

func HandleRecoverDeletedDevice ¶

func HandleRecoverDeletedDevice(c echo.Context) error

HandleRecoverDeletedDevice godoc @Summary Recover a deleted device @Tags OMC Deleted Devices @ID recover-deleted-device @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 204 @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/deleted-devices/{id}/recover [post]

func HandleSetDeviceParameterValues ¶

func HandleSetDeviceParameterValues(c echo.Context) error

HandleSetDeviceParameterValues godoc @Summary Set parameter values of a device @Tags OMC Devices @ID set-device-parameter-values @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body setDeviceParameterValuesBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/set-parameter-values [post]

func HandleSetDevicePerfDisable ¶

func HandleSetDevicePerfDisable(c echo.Context) error

HandleSetDevicePerfDisable godoc @Summary Set a device perf disable @Tags OMC Devices @ID set-device-perf-disable @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 200 {object} echo.Map @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/perf-disable [post]

func HandleSetDevicePerfEnable ¶

func HandleSetDevicePerfEnable(c echo.Context) error

HandleSetDevicePerfEnable godoc @Summary Set a device perf enable @Tags OMC Devices @ID set-device-perf-enable @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 200 {object} echo.Map @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/perf-enable [post]

func HandleSetFirmwareProducts ¶

func HandleSetFirmwareProducts(c echo.Context) error

HandleSetFirmwareProducts godoc @Summary Set firmware products @Tags OMC Firmwares @ID set-firmware-products @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body setFirmwareProductsBody true "Body" @Success 200 {object} omc.Device @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/firmwares/{id}/products [put]

func HandleSetGroupForDevice ¶

func HandleSetGroupForDevice(c echo.Context) error

HandleSetGroupForDevice godoc @Summary Set group for device @Tags OMC Devices @ID set-group-for-device @Security Bearer @Param id path int true "Device ID" @Param group_id body setGroupForDeviceBody true "Group ID" @Success 200 {object} omc.Device @Failure 400 {object} echo.HTTPError "Bad Request" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 404 {object} echo.HTTPError "Not Found" @Failure 500 {object} echo.HTTPError "Internal Server Error" @Router /omc/devices/{id}/group [put]

func HandleSetGroupParent ¶

func HandleSetGroupParent(c echo.Context) error

HandleSetGroupParent godoc @Summary Set group parent @Tags OMC Groups @ID set-group-parent @Security Bearer @Param id path int true "Group ID" @Param body body setGroupParentBody true "Set Group Parent Body" @Success 200 {object} omc.Group @Failure 400 {object} echo.HTTPError "Bad Request" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups/{id}/parent [put]

func HandleSetKPIMeasureDisable ¶

func HandleSetKPIMeasureDisable(c echo.Context) error

HandleSetKPIMeasureDisable godoc @Summary Set kpi measure disable @Tags OMC KPI @ID set-kpi-measure-disable @Security Bearer @Param id path int true "ID" @Success 200 {object} omc.KPIMeas @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/kpi/measures/{id}/disable [put]

func HandleSetKPIMeasureEnable ¶

func HandleSetKPIMeasureEnable(c echo.Context) error

HandleSetKPIMeasureEnable godoc @Summary Set kpi measure enable @Tags OMC KPI @ID set-kpi-measure-enable @Security Bearer @Param id path int true "ID" @Success 200 {object} omc.KPIMeas @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/kpi/measures/{id}/enable [put]

func HandleSetProductDisable ¶

func HandleSetProductDisable(c echo.Context) error

HandleSetProductDisable godoc @Summary Set product disable @Tags OMC Products @ID set-product-disable @Security Bearer @Param id path int true "Product ID" @Success 200 {object} omc.Product @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/products/{id}/disable [put]

func HandleSetProductEnable ¶

func HandleSetProductEnable(c echo.Context) error

HandleSetProductEnable godoc @Summary Set product enable @Tags OMC Products @ID set-product-enable @Security Bearer @Param id path int true "Product ID" @Success 200 {object} omc.Product @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/products/{id}/enable [put]

func HandleUpdateDeviceInfo ¶

func HandleUpdateDeviceInfo(c echo.Context) error

HandleUpdateDeviceInfo godoc @Summary Update device info @Tags OMC Devices @ID update-device-info @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body updateDeviceInfoBody true "Device" @Success 200 {object} omc.Device @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id} [put]

func HandleUpdateGroupInfo ¶

func HandleUpdateGroupInfo(c echo.Context) error

HandleUpdateGroupInfo godoc @Summary Update group information @Tags OMC Groups @ID update-group-info @Security Bearer @Param id path int true "Group ID" @Param body body updateGroupInfoBody true "Update Group Info Body" @Success 200 {object} omc.Group @Failure 400 {object} echo.HTTPError "Bad Request" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/groups/{id} [put]

func HandleUpdateKPIMeasureInfo ¶

func HandleUpdateKPIMeasureInfo(c echo.Context) error

HandleUpdateKPIMeasureInfo updates a kpi measure info @Summary Update kpi measure info @ID update-kpi-measure-info @Produce json @Security Bearer @Param id path int true "ID" @Param body body updateKPIMeasureInfoBody true "KPIMeas" @Success 200 {object} omc.KPIMeas @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/measures/{id} [put] @Tags OMC KPI

func HandleUpdateKPITemplateInfo ¶

func HandleUpdateKPITemplateInfo(c echo.Context) error

HandleUpdateKPITemplate updates a kpi template @Summary Update kpi template @ID update-kpi-template @Produce json @Security Bearer @Param id path int true "ID" @Param body body updateKPITemplateBody true "KPITemplate" @Success 200 {object} omc.KPITemplate @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/kpi/templates/{id} [put] @Tags OMC KPI

func HandleUpdateProductInfo ¶

func HandleUpdateProductInfo(c echo.Context) error

HandleUpdateProductInfo updates a product's name and manufacturer. @Summary Update product info @ID update-product-info @Produce json @Security Bearer @Param id path int true "Product ID" @Param body body updateProductInfoBody true "Product" @Success 200 {object} omc.Product @Failure 400 {object} echo.HTTPError "Bad Request: invalid input parameter" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 403 {object} echo.HTTPError "Forbidden" @Failure 500 {object} echo.HTTPError "Internal Server error" @Router /omc/products/{id} [put] @Tags OMC Products

func HandleUpgradeDevice ¶

func HandleUpgradeDevice(c echo.Context) error

HandleUpgradeDevice godoc @Summary Upgrade device @Tags OMC Devices @ID ugrade-device @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body upgradeDeviceBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/upgrade [post]

func HandleUploadDeviceFile ¶

func HandleUploadDeviceFile(c echo.Context) error

HandleUploadDeviceFile godoc @Summary Upload file of device @Tags OMC Devices @ID upload-device-file @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Param body body uploadDeviceFileBody true "Data" @Success 200 {object} omc.DeviceMethodCall @Failure 400 {object} echo.HTTPError "BadRequest" @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/upload-file [post]

func HandlesSetDeviceDisable ¶

func HandlesSetDeviceDisable(c echo.Context) error

HandlesSetDeviceDisable godoc @Summary Set a device disable @Tags OMC Devices @ID set-device-disable @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 200 {object} echo.Map @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/disable [put]

func HandlesSetDeviceEnable ¶

func HandlesSetDeviceEnable(c echo.Context) error

HandlesSetDeviceEnable godoc @Summary Set a device enable @Tags OMC Devices @ID set-device-enable @Accept json @Produce json @Security Bearer @Param id path int true "Device ID" @Success 200 {object} echo.Map @Failure 401 {object} echo.HTTPError "Unauthorized" @Failure 500 {object} echo.HTTPError "Internal server error" @Router /omc/devices/{id}/enable [put]

Types ¶

This section is empty.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL