{ "swagger": "2.0", "info": { "title": "", "version": "" }, "schemes": [ "http", "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/api/v1/things/device/auth/access": { "post": { "summary": "设备操作认证", "operationId": "postApiV1ThingsDeviceAuthAccess", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceAuthAccessReq" } } ], "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth/login": { "post": { "summary": "设备登录认证", "operationId": "postApiV1ThingsDeviceAuthLogin", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceAuthLoginReq" } } ], "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth/register": { "post": { "summary": "设备自动注册", "operationId": "postApiV1ThingsDeviceAuthRegister", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceRegisterResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceRegisterReq" } } ], "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth/root-check": { "post": { "summary": "鉴定是否是root账号", "operationId": "postApiV1ThingsDeviceAuthRoot-check", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceAuthRootCheckReq" } } ], "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth5/access": { "post": { "summary": "设备操作认证", "operationId": "postApiV1ThingsDeviceAuth5Access", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceAuth5AccessResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceAuth5AccessReq" } } ], "tags": [ "things/device/auth5", "thingsDeviceAuth5" ] } }, "/api/v1/things/device/auth5/login": { "post": { "summary": "设备登录认证", "operationId": "postApiV1ThingsDeviceAuth5Login", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceAuth5LoginResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceAuth5LoginReq" } } ], "tags": [ "things/device/auth5", "thingsDeviceAuth5" ] } }, "/api/v1/things/device/edge/send/{handle}/{type}": { "post": { "summary": "设备使用http协议用云端交互,需要在http头中带上mqtt的账号密码(basic auth)", "operationId": "postApiV1ThingsDeviceEdgeSend:handle:type", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractEdgeSendResp" } } } } }, "parameters": [ { "name": "handle", "description": "对应 mqtt topic的第一个 thing ota config 等等\r", "in": "path", "required": true, "type": "string", "schema": {} }, { "name": "type", "description": "操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为\r", "in": "path", "required": true, "type": "string", "schema": {} }, { "name": "productID", "description": "如果网关类型要操作子设备的topic,需要指定子设备的产品ID和设备ID,如果没有填写则默认是账号里的设备\r", "in": "header", "required": false, "type": "string", "schema": {} }, { "name": "deviceName", "description": "如果网关类型要操作子设备的topic,需要指定子设备的产品ID和设备ID,如果没有填写则默认是账号里的设备\r", "in": "header", "required": false, "type": "string", "schema": {} }, { "name": "authorization", "description": "basic auth 账号密码使用mqtt格式生成的账号密码\r", "in": "header", "required": true, "type": "string", "schema": {} }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractEdgeSendReq" } } ], "tags": [ "things/device/edge", "thingsDeviceEdge" ] } }, "/api/v1/things/device/gateway/index": { "post": { "summary": "获取子设备列表", "operationId": "postApiV1ThingsDeviceGatewayIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceGateWayIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceGateWayIndexReq" } } ], "tags": [ "things/device/gateway", "thingsDeviceGateway" ] } }, "/api/v1/things/device/gateway/multi-create": { "post": { "summary": "添加网关子设备", "operationId": "postApiV1ThingsDeviceGatewayMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceGateWayMultiCreateReq" } } ], "tags": [ "things/device/gateway", "thingsDeviceGateway" ] } }, "/api/v1/things/device/gateway/multi-delete": { "post": { "summary": "解绑子设备", "operationId": "postApiV1ThingsDeviceGatewayMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceGateWayMultiDeleteReq" } } ], "tags": [ "things/device/gateway", "thingsDeviceGateway" ] } }, "/api/v1/things/device/group/multi-create": { "post": { "summary": "将设备加到多个分组中", "operationId": "postApiV1ThingsDeviceGroupMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceGroupMultiSaveReq" } } ], "tags": [ "things/device/group", "thingsDeviceGroup" ] } }, "/api/v1/things/device/group/multi-delete": { "post": { "summary": "删除设备所在分组", "operationId": "postApiV1ThingsDeviceGroupMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceGroupMultiSaveReq" } } ], "tags": [ "things/device/group", "thingsDeviceGroup" ] } }, "/api/v1/things/device/group/multi-update": { "post": { "summary": "更新设备所在分组", "operationId": "postApiV1ThingsDeviceGroupMulti-update", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceGroupMultiSaveReq" } } ], "tags": [ "things/device/group", "thingsDeviceGroup" ] } }, "/api/v1/things/device/info/bind": { "post": { "summary": "绑定", "operationId": "postApiV1ThingsDeviceInfoBind", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoBindReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/bind/token/create": { "post": { "summary": "创建绑定token", "operationId": "postApiV1ThingsDeviceInfoBindTokenCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceBindTokenInfo" } } } } }, "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/bind/token/read": { "post": { "summary": "绑定token状态查询", "operationId": "postApiV1ThingsDeviceInfoBindTokenRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceBindTokenInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceBindTokenReadReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/can-bind": { "post": { "summary": "是否可以绑定设备", "operationId": "postApiV1ThingsDeviceInfoCan-bind", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoCanBindReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/count": { "post": { "summary": "设备统计详情", "operationId": "postApiV1ThingsDeviceInfoCount", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceCountResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceCountReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/create": { "post": { "summary": "新增设备", "operationId": "postApiV1ThingsDeviceInfoCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfo" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/delete": { "post": { "summary": "删除设备", "operationId": "postApiV1ThingsDeviceInfoDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoDeleteReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/index": { "post": { "summary": "获取设备列表", "operationId": "postApiV1ThingsDeviceInfoIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInfoIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoIndexReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/move": { "post": { "summary": "转移设备到新设备上", "operationId": "postApiV1ThingsDeviceInfoMove", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMoveReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-bind": { "post": { "summary": "批量绑定", "operationId": "postApiV1ThingsDeviceInfoMulti-bind", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInfoMultiBindResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoMultiBindReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-import": { "post": { "summary": "批量导入设备", "operationId": "postApiV1ThingsDeviceInfoMulti-import", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMultiImportResp" } } } } }, "parameters": [ { "name": "file", "in": "formData", "required": true, "type": "file" } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-update": { "post": { "summary": "批量更新设备", "operationId": "postApiV1ThingsDeviceInfoMulti-update", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoMultiUpdateReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-update-import": { "post": { "summary": "导入批量更新设备", "operationId": "postApiV1ThingsDeviceInfoMulti-update-import", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMultiUpdateImportResp" } } } } }, "parameters": [ { "name": "file", "in": "formData", "required": true, "type": "file" } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/read": { "post": { "summary": "获取设备详情", "operationId": "postApiV1ThingsDeviceInfoRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoReadReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/transfer": { "post": { "summary": "转让设备", "operationId": "postApiV1ThingsDeviceInfoTransfer", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoTransferReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/unbind": { "post": { "summary": "解绑设备", "operationId": "postApiV1ThingsDeviceInfoUnbind", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfoUnbindReq" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/update": { "post": { "summary": "更新设备", "operationId": "postApiV1ThingsDeviceInfoUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInfo" } } ], "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/interact/action-read": { "post": { "summary": "获取调用设备行为的结果", "operationId": "postApiV1ThingsDeviceInteractAction-read", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractSendActionResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractRespReadReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/action-send": { "post": { "summary": "调用设备行为", "operationId": "postApiV1ThingsDeviceInteractAction-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractSendActionResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractSendActionReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/gateway-get-found-send": { "post": { "summary": "请求网关上报拓扑关系", "operationId": "postApiV1ThingsDeviceInteractGateway-get-found-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GatewayGetFoundReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/gateway-notify-bind-send": { "post": { "summary": "通知网关绑定子设备", "operationId": "postApiV1ThingsDeviceInteractGateway-notify-bind-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GatewayNotifyBindSendReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-control-multi-send": { "post": { "summary": "批量调用设备属性", "operationId": "postApiV1ThingsDeviceInteractProperty-control-multi-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractMultiSendPropertyResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractMultiSendPropertyReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-control-read": { "post": { "summary": "获取调用设备属性的结果", "operationId": "postApiV1ThingsDeviceInteractProperty-control-read", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractSendPropertyResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractRespReadReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-control-send": { "post": { "summary": "调用设备属性", "operationId": "postApiV1ThingsDeviceInteractProperty-control-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractSendPropertyResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractSendPropertyReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-get-report-multi-send": { "post": { "summary": "批量请求设备获取设备最新属性", "operationId": "postApiV1ThingsDeviceInteractProperty-get-report-multi-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractPropertyGetReportMultiSendResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractPropertyGetReportMultiSendReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-get-report-send": { "post": { "summary": "请求设备获取设备最新属性", "operationId": "postApiV1ThingsDeviceInteractProperty-get-report-send", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceInteractPropertyGetReportSendResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceInteractPropertyGetReportSendReq" } } ], "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/msg/abnormal-log/index": { "post": { "summary": "获取设备异常日志", "operationId": "postApiV1ThingsDeviceMsgAbnormal-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgAbnormalLogIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgAbnormalLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/event-log/index": { "post": { "summary": "获取事件历史记录", "operationId": "postApiV1ThingsDeviceMsgEvent-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgEventLogIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgEventLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/gateway-can-bind-index": { "post": { "summary": "获取网关可以绑定的子设备列表", "operationId": "postApiV1ThingsDeviceMsgGateway-can-bind-index", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/GatewayCanBindIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GatewayCanBindIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/hub-log/index": { "post": { "summary": "获取云端诊断日志", "operationId": "postApiV1ThingsDeviceMsgHub-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgHubLogIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgHubLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log-latest/index": { "post": { "summary": "获取最新属性记录", "operationId": "postApiV1ThingsDeviceMsgProperty-log-latestIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgPropertyIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgPropertyLogLatestIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log/index": { "post": { "summary": "获取单个id属性历史记录", "operationId": "postApiV1ThingsDeviceMsgProperty-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgPropertyIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgPropertyLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/sdk-log/index": { "post": { "summary": "获取设备sdk日志", "operationId": "postApiV1ThingsDeviceMsgSdk-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgSdkIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgSdkLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/send-log/index": { "post": { "summary": "获取设备命令日志", "operationId": "postApiV1ThingsDeviceMsgSend-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgSendLogIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgSendLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/shadow/index": { "post": { "summary": "获取设备影子列表", "operationId": "postApiV1ThingsDeviceMsgShadowIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgShadowIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgPropertyLogLatestIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/status-log/index": { "post": { "summary": "获取设备状态日志", "operationId": "postApiV1ThingsDeviceMsgStatus-logIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceMsgStatusLogIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceMsgStatusLogIndexReq" } } ], "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/profile/delete": { "post": { "summary": "删除设备配置", "operationId": "postApiV1ThingsDeviceProfileDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceProfileReadReq" } } ], "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/profile/index": { "post": { "summary": "获取设备配置列表", "operationId": "postApiV1ThingsDeviceProfileIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceProfileIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceProfileIndexReq" } } ], "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/profile/read": { "post": { "summary": "获取设备配置详情", "operationId": "postApiV1ThingsDeviceProfileRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceProfile" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceProfileReadReq" } } ], "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/profile/update": { "post": { "summary": "更新设备配置", "operationId": "postApiV1ThingsDeviceProfileUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceProfile" } } ], "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/schema/create": { "post": { "summary": "创建设备物模型", "operationId": "postApiV1ThingsDeviceSchemaCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "description": "/*物模型条目*/", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceSchema" } } ], "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/index": { "post": { "summary": "获取设备物模型列表", "operationId": "postApiV1ThingsDeviceSchemaIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceSchemaIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceSchemaIndexReq" } } ], "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/multi-create": { "post": { "summary": "批量创建设备物模型", "operationId": "postApiV1ThingsDeviceSchemaMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceSchemaMultiCreateReq" } } ], "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/multi-delete": { "post": { "summary": "批量删除设备物模型", "operationId": "postApiV1ThingsDeviceSchemaMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceSchemaMultiDeleteReq" } } ], "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/tsl-read": { "post": { "summary": "获取设备物模型tsl", "operationId": "postApiV1ThingsDeviceSchemaTsl-read", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceSchemaTslReadResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceSchemaTslReadReq" } } ], "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/update": { "post": { "summary": "更新设备物模型", "operationId": "postApiV1ThingsDeviceSchemaUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "description": "/*物模型条目*/", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceSchema" } } ], "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/version/index": { "post": { "summary": "获取设备模块版本详情", "operationId": "postApiV1ThingsDeviceVersionIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceModuleVersionIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceModuleVersionIndexReq" } } ], "tags": [ "things/device/module/version", "thingsDeviceModuleVersion" ] } }, "/api/v1/things/device/version/read": { "post": { "summary": "获取设备模块版本列表", "operationId": "postApiV1ThingsDeviceVersionRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/DeviceModuleVersion" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DeviceModuleVersionReadReq" } } ], "tags": [ "things/device/module/version", "thingsDeviceModuleVersion" ] } }, "/api/v1/things/group/device/multi-create": { "post": { "summary": "添加分组设备", "operationId": "postApiV1ThingsGroupDeviceMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupDeviceMultiSaveReq" } } ], "tags": [ "things/group/device", "thingsGroupDevice" ] } }, "/api/v1/things/group/device/multi-delete": { "post": { "summary": "删除分组设备", "operationId": "postApiV1ThingsGroupDeviceMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupDeviceMultiDeleteReq" } } ], "tags": [ "things/group/device", "thingsGroupDevice" ] } }, "/api/v1/things/group/device/multi-update": { "post": { "summary": "更新分组设备", "operationId": "postApiV1ThingsGroupDeviceMulti-update", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupDeviceMultiSaveReq" } } ], "tags": [ "things/group/device", "thingsGroupDevice" ] } }, "/api/v1/things/group/info/create": { "post": { "summary": "创建分组", "operationId": "postApiV1ThingsGroupInfoCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupInfo" } } ], "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/delete": { "post": { "summary": "删除分组", "operationId": "postApiV1ThingsGroupInfoDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/index": { "post": { "summary": "获取分组列表", "operationId": "postApiV1ThingsGroupInfoIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/GroupInfoIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupInfoIndexReq" } } ], "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/read": { "post": { "summary": "获取分组详情信息", "operationId": "postApiV1ThingsGroupInfoRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/GroupInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupInfoReadReq" } } ], "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/update": { "post": { "summary": "更新分组信息", "operationId": "postApiV1ThingsGroupInfoUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GroupInfo" } } ], "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/ota/firmware/device/cancel": { "post": { "summary": "取消指定任务下的升级", "operationId": "postApiV1ThingsOtaFirmwareDeviceCancel", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareDeviceCancelReq" } } ], "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ] } }, "/api/v1/things/ota/firmware/device/confirm": { "post": { "summary": "确认升级设备", "operationId": "postApiV1ThingsOtaFirmwareDeviceConfirm", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareDeviceConfirmReq" } } ], "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ] } }, "/api/v1/things/ota/firmware/device/index": { "post": { "summary": "查询升级设备列表", "operationId": "postApiV1ThingsOtaFirmwareDeviceIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/OtaFirmwareDeviceIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareDeviceIndexReq" } } ], "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ] } }, "/api/v1/things/ota/firmware/device/retry": { "post": { "summary": "重试设备升级", "operationId": "postApiV1ThingsOtaFirmwareDeviceRetry", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareDeviceRetryReq" } } ], "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ] } }, "/api/v1/things/ota/firmware/info/create": { "post": { "summary": "添加升级包", "operationId": "postApiV1ThingsOtaFirmwareInfoCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FirmwareCreateReq" } } ], "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ] } }, "/api/v1/things/ota/firmware/info/delete": { "post": { "summary": "删除升级包", "operationId": "postApiV1ThingsOtaFirmwareInfoDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ] } }, "/api/v1/things/ota/firmware/info/index": { "post": { "summary": "升级包列表", "operationId": "postApiV1ThingsOtaFirmwareInfoIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/FirmwareIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FirmwareIndexReq" } } ], "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ] } }, "/api/v1/things/ota/firmware/info/read": { "post": { "summary": "查询升级包", "operationId": "postApiV1ThingsOtaFirmwareInfoRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/FirmwareInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ] } }, "/api/v1/things/ota/firmware/info/update": { "post": { "summary": "修改升级包", "operationId": "postApiV1ThingsOtaFirmwareInfoUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/FirmwareUpdateReq" } } ], "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ] } }, "/api/v1/things/ota/firmware/job/create": { "post": { "summary": "创建升级任务", "operationId": "postApiV1ThingsOtaFirmwareJobCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareJobInfo" } } ], "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ] } }, "/api/v1/things/ota/firmware/job/index": { "post": { "summary": "获取升级包下的升级任务批次列表", "operationId": "postApiV1ThingsOtaFirmwareJobIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/OtaFirmwareJobInfoIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareJobIndexReq" } } ], "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ] } }, "/api/v1/things/ota/firmware/job/read": { "post": { "summary": "查询指定升级批次的详情", "operationId": "postApiV1ThingsOtaFirmwareJobRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/OtaFirmwareJobInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ] } }, "/api/v1/things/ota/firmware/job/update": { "post": { "summary": "更新升级批次", "operationId": "postApiV1ThingsOtaFirmwareJobUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaFirmwareJobInfo" } } ], "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ] } }, "/api/v1/things/ota/module/info/create": { "post": { "summary": "创建模块", "operationId": "postApiV1ThingsOtaModuleInfoCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaModuleInfo" } } ], "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ] } }, "/api/v1/things/ota/module/info/delete": { "post": { "summary": "删除模块", "operationId": "postApiV1ThingsOtaModuleInfoDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ] } }, "/api/v1/things/ota/module/info/index": { "post": { "summary": "获取模块列表", "operationId": "postApiV1ThingsOtaModuleInfoIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/OtaModuleInfoIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaModuleInfoIndexReq" } } ], "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ] } }, "/api/v1/things/ota/module/info/read": { "post": { "summary": "查询模块详情", "operationId": "postApiV1ThingsOtaModuleInfoRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/OtaModuleInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDOrCode" } } ], "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ] } }, "/api/v1/things/ota/module/info/update": { "post": { "summary": "更新模块", "operationId": "postApiV1ThingsOtaModuleInfoUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OtaModuleInfo" } } ], "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ] } }, "/api/v1/things/product/category/create": { "post": { "summary": "新增产品品类", "operationId": "postApiV1ThingsProductCategoryCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategory" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/delete": { "post": { "summary": "删除产品品类", "operationId": "postApiV1ThingsProductCategoryDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/index": { "post": { "summary": "获取产品品类列表", "operationId": "postApiV1ThingsProductCategoryIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductCategoryIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategoryIndexReq" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/read": { "post": { "summary": "获取产品品类详情", "operationId": "postApiV1ThingsProductCategoryRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductCategory" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDChildren" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/schema/index": { "post": { "summary": "获取产品品类物模型列表", "operationId": "postApiV1ThingsProductCategorySchemaIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductCategorySchemaIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategorySchemaIndexReq" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/schema/multi-create": { "post": { "summary": "批量新增产品品类物模型", "operationId": "postApiV1ThingsProductCategorySchemaMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategorySchemaMultiSaveReq" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/schema/multi-delete": { "post": { "summary": "批量删除产品品类物模型", "operationId": "postApiV1ThingsProductCategorySchemaMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategorySchemaMultiSaveReq" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/schema/multi-update": { "post": { "summary": "批量更新产品品类物模型", "operationId": "postApiV1ThingsProductCategorySchemaMulti-update", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategorySchemaMultiSaveReq" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/update": { "post": { "summary": "更新产品品类", "operationId": "postApiV1ThingsProductCategoryUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCategory" } } ], "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/config/update": { "post": { "summary": "更新配置", "operationId": "postApiV1ThingsProductConfigUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductConfig" } } ], "tags": [ "things/product/config", "thingsProductConfig" ] } }, "/api/v1/things/product/custom/read": { "post": { "summary": "获取产品自定义信息详情", "operationId": "postApiV1ThingsProductCustomRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductCustom" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCustomReadReq" } } ], "tags": [ "things/product/custom", "thingsProductCustom" ] } }, "/api/v1/things/product/custom/update": { "post": { "summary": "更新产品自定义信息", "operationId": "postApiV1ThingsProductCustomUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductCustom" } } ], "tags": [ "things/product/custom", "thingsProductCustom" ] } }, "/api/v1/things/product/info/create": { "post": { "summary": "新增产品", "operationId": "postApiV1ThingsProductInfoCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductInfo" } } ], "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/delete": { "post": { "summary": "删除产品", "operationId": "postApiV1ThingsProductInfoDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductInfoDeleteReq" } } ], "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/index": { "post": { "summary": "获取产品信息列表", "operationId": "postApiV1ThingsProductInfoIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductInfoIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductInfoIndexReq" } } ], "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/init": { "post": { "summary": "初始化产品", "operationId": "postApiV1ThingsProductInfoInit", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductInitReq" } } ], "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/read": { "post": { "summary": "获取产品详情", "operationId": "postApiV1ThingsProductInfoRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductInfoReadReq" } } ], "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/update": { "post": { "summary": "更新产品", "operationId": "postApiV1ThingsProductInfoUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductInfo" } } ], "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/remote-config/create": { "post": { "summary": "创建配置", "operationId": "postApiV1ThingsProductRemote-configCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductRemoteConfigCreateReq" } } ], "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/remote-config/index": { "post": { "summary": "获取配置列表", "operationId": "postApiV1ThingsProductRemote-configIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductRemoteConfigIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductRemoteConfigIndexReq" } } ], "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/remote-config/lastest-read": { "post": { "summary": "获取最新配置", "operationId": "postApiV1ThingsProductRemote-configLastest-read", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductRemoteConfigLastestReadResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductRemoteConfigLastestReadReq" } } ], "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/remote-config/push-all": { "post": { "summary": "推送配置", "operationId": "postApiV1ThingsProductRemote-configPush-all", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductRemoteConfigPushAllReq" } } ], "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/schema/create": { "post": { "summary": "创建产品物模型", "operationId": "postApiV1ThingsProductSchemaCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaCreateReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/delete": { "post": { "summary": "删除产品物模型", "operationId": "postApiV1ThingsProductSchemaDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaDeleteReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/index": { "post": { "summary": "获取产品物模型", "operationId": "postApiV1ThingsProductSchemaIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductSchemaIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaIndexReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/multi-create": { "post": { "summary": "批量创建产品物模型", "operationId": "postApiV1ThingsProductSchemaMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaMultiCreateReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/tsl-import": { "post": { "summary": "导入产品物模型tsl", "operationId": "postApiV1ThingsProductSchemaTsl-import", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaTslImportReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/tsl-read": { "post": { "summary": "获取产品物模型tsl", "operationId": "postApiV1ThingsProductSchemaTsl-read", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProductSchemaTslReadResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaTslReadReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/update": { "post": { "summary": "更新产品物模型", "operationId": "postApiV1ThingsProductSchemaUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProductSchemaUpdateReq" } } ], "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/protocol/info/create": { "post": { "summary": "新增自定义协议", "operationId": "postApiV1ThingsProtocolInfoCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolInfo" } } ], "tags": [ "things/protocol/info", "thingsProtocolInfo" ] } }, "/api/v1/things/protocol/info/delete": { "post": { "summary": "删除自定义协议", "operationId": "postApiV1ThingsProtocolInfoDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/protocol/info", "thingsProtocolInfo" ] } }, "/api/v1/things/protocol/info/index": { "post": { "summary": "获取自定义协议信息列表", "operationId": "postApiV1ThingsProtocolInfoIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolInfoIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolInfoIndexReq" } } ], "tags": [ "things/protocol/info", "thingsProtocolInfo" ] } }, "/api/v1/things/protocol/info/read": { "post": { "summary": "获取自定义协议详情", "operationId": "postApiV1ThingsProtocolInfoRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDOrCode" } } ], "tags": [ "things/protocol/info", "thingsProtocolInfo" ] } }, "/api/v1/things/protocol/info/update": { "post": { "summary": "更新自定义协议", "operationId": "postApiV1ThingsProtocolInfoUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolInfo" } } ], "tags": [ "things/protocol/info", "thingsProtocolInfo" ] } }, "/api/v1/things/protocol/script/create": { "post": { "summary": "新增协议脚本", "operationId": "postApiV1ThingsProtocolScriptCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithIDStr" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScript" } } ], "tags": [ "things/protocol/script", "thingsProtocolScript" ] } }, "/api/v1/things/protocol/script/debug": { "post": { "summary": "协议脚本调试", "operationId": "postApiV1ThingsProtocolScriptDebug", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolScriptDebugResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScriptDebugReq" } } ], "tags": [ "things/protocol/script", "thingsProtocolScript" ] } }, "/api/v1/things/protocol/script/delete": { "post": { "summary": "删除协议脚本", "operationId": "postApiV1ThingsProtocolScriptDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDStr" } } ], "tags": [ "things/protocol/script", "thingsProtocolScript" ] } }, "/api/v1/things/protocol/script/device/create": { "post": { "summary": "新增协议脚本设备", "operationId": "postApiV1ThingsProtocolScriptDeviceCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithIDStr" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScriptDevice" } } ], "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ] } }, "/api/v1/things/protocol/script/device/delete": { "post": { "summary": "删除协议脚本设备", "operationId": "postApiV1ThingsProtocolScriptDeviceDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDStr" } } ], "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ] } }, "/api/v1/things/protocol/script/device/index": { "post": { "summary": "获取协议脚本设备列表", "operationId": "postApiV1ThingsProtocolScriptDeviceIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolScriptDeviceIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScriptDeviceIndexReq" } } ], "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ] } }, "/api/v1/things/protocol/script/device/read": { "post": { "summary": "获取协议脚本设备详情", "operationId": "postApiV1ThingsProtocolScriptDeviceRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolScriptDevice" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDStr" } } ], "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ] } }, "/api/v1/things/protocol/script/device/update": { "post": { "summary": "更新协议脚本设备", "operationId": "postApiV1ThingsProtocolScriptDeviceUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScriptDevice" } } ], "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ] } }, "/api/v1/things/protocol/script/index": { "post": { "summary": "获取协议脚本列表", "operationId": "postApiV1ThingsProtocolScriptIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolScriptIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScriptIndexReq" } } ], "tags": [ "things/protocol/script", "thingsProtocolScript" ] } }, "/api/v1/things/protocol/script/read": { "post": { "summary": "获取协议脚本详情", "operationId": "postApiV1ThingsProtocolScriptRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolScript" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithIDStr" } } ], "tags": [ "things/protocol/script", "thingsProtocolScript" ] } }, "/api/v1/things/protocol/script/update": { "post": { "summary": "更新协议脚本", "operationId": "postApiV1ThingsProtocolScriptUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolScript" } } ], "tags": [ "things/protocol/script", "thingsProtocolScript" ] } }, "/api/v1/things/protocol/service/delete": { "post": { "summary": "删除自定义协议服务器", "operationId": "postApiV1ThingsProtocolServiceDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/WithID" } } ], "tags": [ "things/protocol/service", "thingsProtocolService" ] } }, "/api/v1/things/protocol/service/index": { "post": { "summary": "获取自定义协议服务器信息列表", "operationId": "postApiV1ThingsProtocolServiceIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolServiceIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolServiceIndexReq" } } ], "tags": [ "things/protocol/service", "thingsProtocolService" ] } }, "/api/v1/things/protocol/sync/device": { "post": { "summary": "设备同步(如果该协议不支持会返回不支持)", "operationId": "postApiV1ThingsProtocolSyncDevice", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/ProtocolSyncDeviceResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ProtocolSyncDeviceReq" } } ], "tags": [ "things/protocol/sync", "thingsProtocolSync" ] } }, "/api/v1/things/protocol/sync/product": { "post": { "summary": "产品同步(如果该协议不支持会返回不支持)", "operationId": "postApiV1ThingsProtocolSyncProduct", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CodeReq" } } ], "tags": [ "things/protocol/sync", "thingsProtocolSync" ] } }, "/api/v1/things/schema/common/create": { "post": { "summary": "新增通用物模型", "operationId": "postApiV1ThingsSchemaCommonCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CommonSchemaCreateReq" } } ], "tags": [ "things/schema/common", "thingsSchemaCommon" ] } }, "/api/v1/things/schema/common/delete": { "post": { "summary": "删除通用物模型", "operationId": "postApiV1ThingsSchemaCommonDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CommonSchemaDeleteReq" } } ], "tags": [ "things/schema/common", "thingsSchemaCommon" ] } }, "/api/v1/things/schema/common/index": { "post": { "summary": "获取通用物模型列表", "operationId": "postApiV1ThingsSchemaCommonIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/CommonSchemaIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CommonSchemaIndexReq" } } ], "tags": [ "things/schema/common", "thingsSchemaCommon" ] } }, "/api/v1/things/schema/common/init": { "post": { "summary": "初始化通用物模型", "operationId": "postApiV1ThingsSchemaCommonInit", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "tags": [ "things/schema/common", "thingsSchemaCommon" ] } }, "/api/v1/things/schema/common/update": { "post": { "summary": "更新通用物模型", "operationId": "postApiV1ThingsSchemaCommonUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CommonSchemaUpdateReq" } } ], "tags": [ "things/schema/common", "thingsSchemaCommon" ] } }, "/api/v1/things/slot/area/create": { "post": { "summary": "插槽区域创建", "operationId": "postApiV1ThingsSlotAreaCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SlotAreaSaveReq" } } ], "tags": [ "things/slot/area", "thingsSlotArea" ] } }, "/api/v1/things/slot/area/delete": { "post": { "summary": "插槽区域更新", "operationId": "postApiV1ThingsSlotAreaDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SlotAreaSaveReq" } } ], "tags": [ "things/slot/area", "thingsSlotArea" ] } }, "/api/v1/things/slot/user/subscribe": { "post": { "summary": "插槽用户订阅", "operationId": "postApiV1ThingsSlotUserSubscribe", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/SlotUserSubscribeResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SlotUserSubscribe" } } ], "tags": [ "things/slot/user", "thingsSlotUser" ] } }, "/api/v1/things/user/device/collect/index": { "post": { "summary": "获取收藏设备列表", "operationId": "postApiV1ThingsUserDeviceCollectIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/UserCollectDeviceInfo" } } } } }, "tags": [ "things/user/device/collect", "thingsUserDeviceCollect" ] } }, "/api/v1/things/user/device/collect/multi-create": { "post": { "summary": "批量收藏设备", "operationId": "postApiV1ThingsUserDeviceCollectMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserCollectDeviceSave" } } ], "tags": [ "things/user/device/collect", "thingsUserDeviceCollect" ] } }, "/api/v1/things/user/device/collect/multi-delete": { "post": { "summary": "批量取消收藏设备", "operationId": "postApiV1ThingsUserDeviceCollectMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserCollectDeviceSave" } } ], "tags": [ "things/user/device/collect", "thingsUserDeviceCollect" ] } }, "/api/v1/things/user/device/share/create": { "post": { "summary": "分享设备", "operationId": "postApiV1ThingsUserDeviceShareCreate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/WithID" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareInfo" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/delete": { "post": { "summary": "取消分享设备", "operationId": "postApiV1ThingsUserDeviceShareDelete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareReadReq" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/index": { "post": { "summary": "获取分享设备列表", "operationId": "postApiV1ThingsUserDeviceShareIndex", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/UserDeviceShareIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareIndexReq" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-accept": { "post": { "summary": "接受批量分享设备", "operationId": "postApiV1ThingsUserDeviceShareMulti-accept", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareMultiAcceptInfo" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-create": { "post": { "summary": "生成批量分享设备二维码", "operationId": "postApiV1ThingsUserDeviceShareMulti-create", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/UserDeviceShareMultiToken" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareMultiInfo" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-delete": { "post": { "summary": "批量取消分享设备", "operationId": "postApiV1ThingsUserDeviceShareMulti-delete", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareMultiDeleteReq" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-index": { "post": { "summary": "获取批量分享的设备列表", "operationId": "postApiV1ThingsUserDeviceShareMulti-index", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/UserDeviceShareMultiIndexResp" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareMultiToken" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/read": { "post": { "summary": "获取分享设备详情", "operationId": "postApiV1ThingsUserDeviceShareRead", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" }, "data": { "$ref": "#/definitions/UserDeviceShareInfo" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareReadReq" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/update": { "post": { "summary": "更新分享设备信息", "operationId": "postApiV1ThingsUserDeviceShareUpdate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": { "code": { "type": "integer", "default": "200", "title": "返回code" }, "msg": { "type": "string", "title": "返回的消息" } } } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDeviceShareInfo" } } ], "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } } }, "definitions": { "AreaInfo": { "type": "object", "properties": { "projectID": { "type": "string", "description": "项目id（只读）" }, "areaID": { "type": "string", "description": "项目区域id（只读）" }, "areaName": { "type": "string", "description": "项目区域名称（读写）" } }, "title": "AreaInfo" }, "CodeReq": { "type": "object", "properties": { "code": { "type": "string" } }, "title": "CodeReq", "required": [ "code" ] }, "CommonResp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": " id" } }, "title": "CommonResp" }, "CommonSchemaCreateReq": { "type": "object", "properties": { "": { "$ref": "#/definitions/CommonSchemaInfo" } }, "title": "CommonSchemaCreateReq" }, "CommonSchemaDeleteReq": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "产品id" } }, "title": "CommonSchemaDeleteReq", "required": [ "id" ] }, "CommonSchemaIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "type": { "type": "integer", "format": "int64", "description": "物模型类型 1:property属性 2:event事件 3:action行为" }, "types": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "过滤标识符列表" }, "productIDs": { "type": "array", "items": { "type": "string" }, "description": "提取产品共有的物模型" }, "name": { "type": "string" }, "productCategoryID": { "type": "integer", "format": "int64" }, "productCategoryWithFather": { "type": "boolean", "format": "boolean" }, "isCanSceneLinkage": { "type": "integer", "format": "int64", "description": "是否可以场景联动" }, "funcGroup": { "type": "integer", "format": "int64", "description": " 功能分类: 1:普通功能 2:系统功能" }, "userPerm": { "type": "integer", "format": "int64", "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)" }, "groupID": { "type": "integer", "format": "int64" }, "groupIDs": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "projectID": { "type": "string", "description": "过滤项目下共有的物模型" }, "areaID": { "type": "string" }, "areaIDPath": { "type": "string", "description": "过滤区域id路径下有设备的产品" }, "propertyMode": { "type": "string", "description": "属性类型可用 读写类型: r(只读) rw(可读可写)" }, "controlMode": { "type": "integer", "format": "int64", "description": "控制模式: 1: 可以群控,可以单控 2:只能单控" }, "productSceneMode": { "type": "string", "description": "产品场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)" } }, "title": "CommonSchemaIndexReq" }, "CommonSchemaIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/CommonSchemaInfo" }, "description": "分页信息,只获取一个则不填" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "CommonSchemaIndexResp", "required": [ "list" ] }, "CommonSchemaInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "产品id" }, "type": { "type": "integer", "format": "int64", "description": "物模型类型 1:property属性 2:event事件 3:action行为" }, "identifier": { "type": "string", "description": "标识符" }, "extendConfig": { "type": "string", "description": "拓展参数" }, "name": { "type": "string", "description": "功能名称" }, "desc": { "type": "string", "description": "描述" }, "required": { "type": "integer", "format": "int64", "description": "是否必须 1:是 2:否" }, "affordance": { "type": "string", "description": "各功能类型的详细参数定义" }, "isCanSceneLinkage": { "type": "integer", "format": "int64", "description": "是否可以场景联动" }, "funcGroup": { "type": "integer", "format": "int64", "description": " 功能分类: 1:普通功能 2:系统功能" }, "userPerm": { "type": "integer", "format": "int64", "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)" }, "isHistory": { "type": "integer", "format": "int64", "description": " 是否存储历史记录" }, "isPassword": { "type": "integer", "format": "int64", "description": "是否是密码类型,密码类型需要加掩码" }, "order": { "type": "integer", "format": "int64", "description": " 排序" }, "controlMode": { "type": "integer", "format": "int64", "description": "控制模式: 1: 可以群控,可以单控 2:只能单控" } }, "title": "CommonSchemaInfo" }, "CommonSchemaUpdateReq": { "type": "object", "properties": { "": { "$ref": "#/definitions/CommonSchemaInfo" } }, "title": "CommonSchemaUpdateReq" }, "CompareInt64": { "type": "object", "properties": { "cmpType": { "type": "string", "description": "\"=\":相等 \"!=\":不相等 \"\u003e\":大于\"\u003e=\":大于等于\"\u003c\":小于\"\u003c=\":小于等于 \"like\":模糊查询" }, "value": { "type": "string" } }, "title": "CompareInt64", "required": [ "cmpType", "value" ] }, "CompareString": { "type": "object", "properties": { "cmpType": { "type": "string", "description": "默认为=,\"=\":相等 \"!=\":不相等 \"\u003e\":大于\"\u003e=\":大于等于\"\u003c\":小于\"\u003c=\":小于等于 \"like\":模糊查询" }, "value": { "type": "string" } }, "title": "CompareString", "required": [ "value" ] }, "DateRange": { "type": "object", "properties": { "start": { "type": "string", "description": "开始时间 格式：yyyy-mm-dd" }, "end": { "type": "string", "description": "结束时间 格式：yyyy-mm-dd" } }, "title": "DateRange" }, "DevInit": { "type": "object", "properties": { "tenantCode": { "type": "string", "description": "设备创建默认分配给的租户" }, "projectID": { "type": "string", "description": "设备创建默认分配给的项目" }, "areaID": { "type": "string", "description": "设备创建默认分配给的区域ID" }, "deptID": { "type": "string", "description": "设备创建默认分配给的部门" } }, "title": "DevInit" }, "DeviceAuth5AccessReq": { "type": "object", "properties": { "username": { "type": "string", "description": "用户名" }, "topic": { "type": "string", "description": "主题" }, "clientID": { "type": "string", "description": "clientID" }, "action": { "type": "string", "description": "操作" }, "ip": { "type": "string", "description": "访问的ip地址" } }, "title": "DeviceAuth5AccessReq" }, "DeviceAuth5AccessResp": { "type": "object", "properties": { "result": { "type": "string", "description": "验证结果 \"allow\" | \"deny\" | \"ignore\"" } }, "title": "DeviceAuth5AccessResp", "required": [ "result" ] }, "DeviceAuth5LoginReq": { "type": "object", "properties": { "username": { "type": "string", "description": "用户名" }, "password": { "type": "string", "description": "密码" }, "clientID": { "type": "string", "description": "clientID" }, "ip": { "type": "string", "description": "访问的ip地址" }, "certificate": { "type": "string", "description": "客户端证书 base64后传过来" } }, "title": "DeviceAuth5LoginReq", "required": [ "username", "clientID", "ip" ] }, "DeviceAuth5LoginResp": { "type": "object", "properties": { "result": { "type": "string", "description": "验证结果 \"allow\" | \"deny\" | \"ignore\"" }, "is_superuser": { "type": "boolean", "format": "boolean", "description": "是否为超级用户，可选 true | false，该项为空时默认为 false" } }, "title": "DeviceAuth5LoginResp", "required": [ "result" ] }, "DeviceAuthAccessReq": { "type": "object", "properties": { "username": { "type": "string", "description": "用户名" }, "topic": { "type": "string", "description": "主题" }, "clientID": { "type": "string", "description": "clientID" }, "access": { "type": "string", "description": "操作" }, "ip": { "type": "string", "description": "访问的ip地址" } }, "title": "DeviceAuthAccessReq" }, "DeviceAuthLoginReq": { "type": "object", "properties": { "username": { "type": "string", "description": "用户名" }, "password": { "type": "string", "description": "密码" }, "clientID": { "type": "string", "description": "clientID" }, "ip": { "type": "string", "description": "访问的ip地址" }, "certificate": { "type": "string", "description": "客户端证书 base64后传过来" } }, "title": "DeviceAuthLoginReq", "required": [ "username", "clientID", "ip" ] }, "DeviceAuthRootCheckReq": { "type": "object", "properties": { "username": { "type": "string", "description": "用户名" }, "password": { "type": "string", "description": "密码" }, "clientID": { "type": "string", "description": "clientID" }, "ip": { "type": "string", "description": "访问的ip地址" }, "certificate": { "type": "string", "description": "客户端证书" } }, "title": "DeviceAuthRootCheckReq" }, "DeviceBindTokenInfo": { "type": "object", "properties": { "token": { "type": "string", "description": "配网token" }, "status": { "type": "integer", "format": "int64", "description": "token状态 1:初始状态 2: 设备已上报" } }, "title": "DeviceBindTokenInfo" }, "DeviceBindTokenReadReq": { "type": "object", "properties": { "token": { "type": "string", "description": "配网token" } }, "title": "DeviceBindTokenReadReq", "required": [ "token" ] }, "DeviceCore": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品ID" }, "productName": { "type": "string" }, "deviceName": { "type": "string", "description": "设备名称" } }, "title": "DeviceCore", "required": [ "productID", "deviceName" ] }, "DeviceCountInfo": { "type": "object", "properties": { "rangeID": { "type": "string" }, "count": { "type": "object" } }, "title": "DeviceCountInfo", "required": [ "rangeID", "count" ] }, "DeviceCountReq": { "type": "object", "properties": { "countTypes": { "type": "array", "items": { "type": "string" }, "description": "总数:total,在线设备数:status,设备类型: deviceType" }, "rangeType": { "type": "string", "description": "0:全部 1:area 2:group" }, "rangeIDs": { "type": "array", "items": { "type": "string" }, "description": "统计的id列表, areaID或者groupID" } }, "title": "DeviceCountReq", "required": [ "countTypes", "rangeType", "rangeIDs" ] }, "DeviceCountResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceCountInfo" } } }, "title": "DeviceCountResp", "required": [ "list" ] }, "DeviceError": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名称" }, "code": { "type": "integer", "format": "int64" }, "msg": { "type": "string" } }, "title": "DeviceError" }, "DeviceGateWayIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息 只获取一个则不填" }, "gateWayProductID": { "type": "string", "description": "产品ID" }, "gateWaydeviceName": { "type": "string", "description": "设备名称" } }, "title": "DeviceGateWayIndexReq", "required": [ "gateWayProductID", "gateWaydeviceName" ] }, "DeviceGateWayIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceInfo" }, "description": "分组信息" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceGateWayIndexResp", "required": [ "list" ] }, "DeviceGateWayMultiCreateReq": { "type": "object", "properties": { "gateWayProductID": { "type": "string", "description": "产品ID" }, "gateWaydeviceName": { "type": "string", "description": "设备名称" }, "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "分组tag" } }, "title": "DeviceGateWayMultiCreateReq", "required": [ "gateWayProductID", "gateWaydeviceName" ] }, "DeviceGateWayMultiDeleteReq": { "type": "object", "properties": { "gateWayProductID": { "type": "string", "description": "产品ID" }, "gateWaydeviceName": { "type": "string", "description": "设备名称" }, "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "分组tag" } }, "title": "DeviceGateWayMultiDeleteReq", "required": [ "gateWayProductID", "gateWaydeviceName" ] }, "DeviceGroupMultiSaveReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名称" }, "purpose": { "type": "string", "description": "用途 不填默认为default" }, "groupIDs": { "type": "array", "items": { "type": "string" } } }, "title": "DeviceGroupMultiSaveReq", "required": [ "productID", "deviceName", "groupIDs" ] }, "DeviceInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "tenantCode": { "type": "string" }, "productID": { "type": "string", "description": "产品id 只读" }, "projectID": { "type": "string", "description": "项目id 只读" }, "productName": { "type": "string" }, "deviceType": { "type": "integer", "format": "int64", "description": "设备类型:1:直连设备,2:网关,3:子设备,4:监控设备" }, "productImg": { "type": "string", "description": "产品图片" }, "areaID": { "type": "string", "description": "项目区域id 只读" }, "deviceName": { "type": "string", "description": "设备名称 读写" }, "deviceAlias": { "type": "string", "description": "设备别名 读写" }, "secret": { "type": "string", "description": "设备秘钥 只读" }, "cert": { "type": "string", "description": " 设备证书 只读" }, "imei": { "type": "string", "description": " IMEI号信息 只读" }, "mac": { "type": "string", "description": " MAC号信息 只读" }, "categoryID": { "type": "integer", "format": "int64", "description": "产品品类" }, "version": { "type": "string", "description": " 固件版本 读写" }, "hardInfo": { "type": "string", "description": " 模组硬件型号 只读" }, "softInfo": { "type": "string", "description": " 模组软件版本 只读" }, "mobileOperator": { "type": "integer", "format": "int64", "description": "移动运营商:1)移动 2)联通 3)电信 4)广电", "maximum": 10 }, "phone": { "type": "string", "description": "手机号" }, "iccid": { "type": "string", "description": "SIM卡卡号" }, "position": { "$ref": "#/definitions/Point", "description": "设备定位,默认百度坐标系" }, "address": { "type": "string", "description": "所在地址" }, "adcode": { "type": "string", "description": "地区编码" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": " 设备tag" }, "schemaAlias": { "type": "object", "description": "设备物模型别名,如果是结构体类型则key为xxx.xxx" }, "isOnline": { "type": "integer", "format": "int64", "description": " 在线状态 1离线 2在线 只读", "maximum": 2 }, "firstLogin": { "type": "string", "description": "激活时间 只读" }, "firstBind": { "type": "string" }, "lastBind": { "type": "string", "description": "最后绑定时间 只读" }, "lastLogin": { "type": "string", "description": "最后上线时间 只读" }, "expTime": { "type": "string", "description": "到期时间" }, "logLevel": { "type": "integer", "format": "int64", "description": " 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写", "maximum": 5 }, "rssi": { "type": "integer", "format": "int64", "description": "信号强度" }, "createdTime": { "type": "string", "description": "创建时间 只读" }, "status": { "type": "integer", "format": "int64", "description": "设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中)" }, "isEnable": { "type": "integer", "format": "int64", "description": "是否启用" }, "withProperties": { "type": "object", "description": "获取的属性列表,如果不传withProperty,则不会返回" }, "protocolConf": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": "协议配置" }, "subProtocolConf": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": "子协议配置" }, "profiles": { "type": "object" }, "owner": { "$ref": "#/definitions/UserCore" }, "ratedPower": { "type": "integer", "format": "int64" }, "netType": { "type": "integer", "format": "int64", "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE", "maximum": 10 }, "needConfirmVersion": { "type": "string", "description": "待确认升级的版本" }, "userID": { "type": "string" }, "lastIp": { "type": "string", "description": "最后登录的ip地址" }, "sort": { "type": "integer", "format": "int64", "description": "排序" }, "deviceImg": { "type": "string", "description": "设备图片" }, "isUpdateDeviceImg": { "type": "boolean", "format": "boolean", "description": "只有这个参数为true的时候才会更新设备图片,传参为设备图片的file path" }, "file": { "type": "string", "description": "设备相关文件" }, "isUpdateFile": { "type": "boolean", "format": "boolean", "description": "只有这个参数为true的时候才会更新设备文件,传参为设备文件的file path" }, "desc": { "type": "string" }, "distributor": { "$ref": "#/definitions/IDPath" }, "gateway": { "$ref": "#/definitions/DeviceInfo", "description": "子设备绑定的网关信息,只读" }, "area": { "$ref": "#/definitions/AreaInfo", "description": "区域信息,只读" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/GroupCore" }, "description": "所在分组信息,只读" }, "groupPurpose": { "type": "string", "description": "更新的时候使用,将设备该用途下的分组进行更新" }, "groupIDs": { "type": "array", "items": { "type": "string" }, "description": "如果要更新分组,必须填写groupPurpose" } }, "title": "DeviceInfo", "required": [ "productID", "deviceName" ] }, "DeviceInfoBindReq": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" }, "areaID": { "type": "string" }, "token": { "type": "string", "description": "配网token,中绑定需要" } }, "title": "DeviceInfoBindReq", "required": [ "device" ] }, "DeviceInfoCanBindReq": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" } }, "title": "DeviceInfoCanBindReq", "required": [ "device" ] }, "DeviceInfoDeleteReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "deviceName": { "type": "string", "description": "设备名称 读写" } }, "title": "DeviceInfoDeleteReq", "required": [ "productID", "deviceName" ] }, "DeviceInfoIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息 只获取一个则不填" }, "tenantCode": { "type": "string" }, "productID": { "type": "string", "description": "产品id 为空时获取所有产品" }, "productIDs": { "type": "array", "items": { "type": "string" }, "description": "产品id 为空时获取所有产品" }, "deviceName": { "type": "string", "description": "过滤条件:模糊查询 设备名" }, "deviceNames": { "type": "array", "items": { "type": "string" }, "description": "过滤条件:精准查询 设备名" }, "expTime": { "$ref": "#/definitions/CompareInt64", "description": "到期时间" }, "ratedPower": { "$ref": "#/definitions/CompareInt64", "description": "额定功率:单位w/h" }, "rssi": { "$ref": "#/definitions/CompareInt64", "description": "信号强度" }, "deviceAlias": { "type": "string", "description": "过滤条件:模糊查询 设备别名" }, "deviceTypes": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备" }, "position": { "$ref": "#/definitions/Point", "description": "设备定位,默认百度坐标系，用于获取以该点为中心，Range范围内的设备列表，与Range连用" }, "range": { "type": "integer", "format": "int64", "description": "过滤条件:距离坐标点固定范围内的设备 单位：米" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": " key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值" }, "withProperties": { "type": "array", "items": { "type": "string" }, "description": "如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表,如果没有匹配的则不会返回" }, "withProfiles": { "type": "array", "items": { "type": "string" } }, "areaIDs": { "type": "array", "items": { "type": "string" }, "description": "项目区域ids" }, "areaIDPath": { "type": "string", "description": "区域路径过滤" }, "isOnline": { "type": "integer", "format": "int64", "description": " 在线状态过滤 1离线 2在线", "maximum": 2 }, "productCategoryID": { "type": "integer", "format": "int64" }, "productCategoryIDs": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "withShared": { "type": "integer", "format": "int64", "description": " 过滤分享的设备1: 同时获取分享的设备 2:只获取分享的设备", "maximum": 2 }, "withCollect": { "type": "integer", "format": "int64", "description": " 过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备", "maximum": 2 }, "versions": { "type": "array", "items": { "type": "string" } }, "notVersion": { "type": "string" }, "gateway": { "$ref": "#/definitions/DeviceCore", "description": "过滤网关" }, "groupID": { "type": "string" }, "notGroupID": { "type": "string" }, "parentGroupID": { "type": "string" }, "groupPurpose": { "type": "string", "description": "设备分组用途 不填默认为default" }, "groupName": { "type": "string" }, "notAreaID": { "type": "string" }, "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" } }, "status": { "type": "integer", "format": "int64", "description": "设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中)" }, "statuses": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "withOwner": { "type": "boolean", "format": "boolean", "description": "同时获取拥有人的信息" }, "withGateway": { "type": "boolean", "format": "boolean", "description": "同时返回子设备绑定的网关信息" }, "hasOwner": { "type": "integer", "format": "int64", "description": "是否被人拥有,1为是 2为否" }, "userID": { "type": "string" }, "netType": { "type": "integer", "format": "int64", "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网", "maximum": 8 }, "withArea": { "type": "boolean", "format": "boolean", "description": "同时返回区域信息" }, "isOnlyCore": { "type": "boolean", "format": "boolean", "description": "只返回核心信息" }, "iccid": { "type": "string", "description": "SIM卡卡号" }, "withGroups": { "type": "array", "items": { "type": "string" } }, "property": { "type": "object", "description": "设备最新属性过滤,key为属性的id,如果是结构体则key为 aaa.bbb 数组为aaa.1" } }, "title": "DeviceInfoIndexReq" }, "DeviceInfoIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceInfo" }, "description": "设备信息" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceInfoIndexResp", "required": [ "list" ] }, "DeviceInfoMultiBindReq": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" } }, "areaID": { "type": "string" } }, "title": "DeviceInfoMultiBindReq", "required": [ "devices" ] }, "DeviceInfoMultiBindResp": { "type": "object", "properties": { "errs": { "type": "array", "items": { "$ref": "#/definitions/DeviceError" } } }, "title": "DeviceInfoMultiBindResp", "required": [ "errs" ] }, "DeviceInfoMultiUpdateReq": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" } }, "areaID": { "type": "string" }, "ratedPower": { "type": "integer", "format": "int64" } }, "title": "DeviceInfoMultiUpdateReq", "required": [ "devices" ] }, "DeviceInfoReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 为空时获取所有产品" }, "deviceName": { "type": "string", "description": "设备名称 读写" }, "withProperties": { "type": "array", "items": { "type": "string" }, "description": "如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表" }, "withProfiles": { "type": "array", "items": { "type": "string" } }, "withOwner": { "type": "boolean", "format": "boolean", "description": "同时获取拥有人的信息" }, "withGateway": { "type": "boolean", "format": "boolean", "description": "同时返回子设备绑定的网关信息" }, "withArea": { "type": "boolean", "format": "boolean", "description": "同时返回区域信息" } }, "title": "DeviceInfoReadReq", "required": [ "deviceName" ] }, "DeviceInfoSaveReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "deviceName": { "type": "string", "description": "设备名称 读写" }, "deviceAlias": { "type": "string", "description": "设备别名 读写" }, "logLevel": { "type": "integer", "format": "int64", "description": " 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写", "maximum": 5 }, "address": { "type": "string", "description": "所在地址" }, "position": { "$ref": "#/definitions/Point", "description": "设备定位,默认百度坐标系" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": " 设备tag" }, "phone": { "type": "string", "description": "手机号" }, "iccid": { "type": "string", "description": "SIM卡卡号" }, "userID": { "type": "string", "description": " 用户id" }, "mobileOperator": { "type": "integer", "format": "int64", "description": "移动运营商:1)移动 2)联通 3)电信 4)广电", "maximum": 4 }, "areaID": { "type": "string", "description": "项目区域id 只读（1: root节点 2: 未分类节点 其他:子节点）" }, "schemaAlias": { "type": "object", "description": "设备物模型别名,如果是结构体类型则key为xxx.xxx" } }, "title": "DeviceInfoSaveReq", "required": [ "productID", "deviceName" ] }, "DeviceInfoTransferReq": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" }, "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" } }, "srcProjectID": { "type": "string", "description": "指定原来的项目ID,不写使用头" }, "transferTo": { "type": "integer", "format": "int64", "description": "转让给: 1: 某个人 2: 自己的某个项目" }, "userID": { "type": "string" }, "projectID": { "type": "string" }, "areaID": { "type": "string", "description": "转移到项目时指定区域ID" }, "isCleanData": { "type": "integer", "format": "int64", "description": "是否清除数据:1是 2否" } }, "title": "DeviceInfoTransferReq", "required": [ "transferTo", "isCleanData" ] }, "DeviceInfoUnbindReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "deviceName": { "type": "string", "description": "设备名称 读写" }, "secretType": { "type": "string", "description": "采用秘钥的类型" }, "signature": { "type": "string", "description": "签名" }, "timestamp": { "type": "integer", "format": "int64", "description": "秒时间戳" }, "signType": { "type": "string", "description": "hmacsha256 hmacsha1 hmacmd5(默认)" }, "nonce": { "type": "integer", "format": "int64", "description": "随机数" } }, "title": "DeviceInfoUnbindReq", "required": [ "productID", "deviceName" ] }, "DeviceInfoWithProperty": { "type": "object", "properties": { "value": { "type": "string", "description": "获取到的值" }, "timestamp": { "type": "string", "description": "发生时间戳" } }, "title": "DeviceInfoWithProperty", "required": [ "value", "timestamp" ] }, "DeviceInteractEdgeSendReq": { "type": "object", "properties": {}, "title": "DeviceInteractEdgeSendReq" }, "DeviceInteractEdgeSendResp": { "type": "object", "properties": {}, "title": "DeviceInteractEdgeSendResp" }, "DeviceInteractMultiSendPropertyMsg": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "code": { "type": "integer", "format": "int64", "description": "设备返回状态码" }, "msg": { "type": "string", "description": "返回状态" }, "msgToken": { "type": "string", "description": "调用id" }, "sysCode": { "type": "integer", "format": "int64", "description": "系统错误码" }, "sysMsg": { "type": "string", "description": "系统错误信息" } }, "title": "DeviceInteractMultiSendPropertyMsg", "required": [ "productID", "deviceName", "code", "msg", "msgToken", "sysCode", "sysMsg" ] }, "DeviceInteractMultiSendPropertyReq": { "type": "object", "properties": { "areaID": { "type": "string", "description": "项目区域id,传了优先从项目区域中获取设备列表" }, "areaIDPath": { "type": "string", "description": "根据区域路径控制设备" }, "groupID": { "type": "string", "description": "分组ID,传了会从分组下获取设备" }, "productID": { "type": "string", "description": "产品id" }, "deviceNames": { "type": "array", "items": { "type": "string" }, "description": "设备名列表" }, "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用" }, "isAsync": { "type": "boolean", "format": "boolean", "description": "是否异步操作 异步情况通过获取接口来获取" }, "syncTimeout": { "type": "integer", "format": "int64", "description": "同步超时时间(单位:秒,不填默认3秒)" }, "shadowControl": { "type": "integer", "format": "int64", "description": "设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发" }, "data": { "type": "string", "description": "属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义" } }, "title": "DeviceInteractMultiSendPropertyReq", "required": [ "data" ] }, "DeviceInteractMultiSendPropertyResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceInteractMultiSendPropertyMsg" }, "description": "批量设备返回结果列表" } }, "title": "DeviceInteractMultiSendPropertyResp", "required": [ "list" ] }, "DeviceInteractPropertyGetReportMultiSendReq": { "type": "object", "properties": { "dataIDs": { "type": "array", "items": { "type": "string" }, "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条" }, "productID": { "type": "string", "description": "产品id" }, "deviceNames": { "type": "array", "items": { "type": "string" }, "description": "设备名" }, "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用" }, "areaID": { "type": "string", "description": "控制一个区域的设备" }, "areaIDPath": { "type": "string", "description": "根据区域路径控制设备" }, "groupID": { "type": "string", "description": "控制一个组的设备" } }, "title": "DeviceInteractPropertyGetReportMultiSendReq" }, "DeviceInteractPropertyGetReportMultiSendResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceInteractPropertyGetReportSendMsg" }, "description": "批量设备返回结果列表" } }, "title": "DeviceInteractPropertyGetReportMultiSendResp", "required": [ "list" ] }, "DeviceInteractPropertyGetReportSendMsg": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "description": "设备返回状态码" }, "msg": { "type": "string", "description": "返回状态" }, "msgToken": { "type": "string", "description": "调用id" }, "timestamp": { "type": "integer", "format": "int64", "description": "上报时间戳(毫秒时间戳)" }, "params": { "type": "string", "description": "获取到的值" }, "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "sysCode": { "type": "integer", "format": "int64", "description": "系统错误码" }, "sysMsg": { "type": "string", "description": "系统错误信息" } }, "title": "DeviceInteractPropertyGetReportSendMsg", "required": [ "code", "msg", "msgToken", "timestamp", "params", "productID", "deviceName", "sysCode", "sysMsg" ] }, "DeviceInteractPropertyGetReportSendReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id (必填)" }, "deviceName": { "type": "string", "description": "设备名(必填)" }, "dataIDs": { "type": "array", "items": { "type": "string" }, "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条" } }, "title": "DeviceInteractPropertyGetReportSendReq", "required": [ "productID", "deviceName" ] }, "DeviceInteractPropertyGetReportSendResp": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "description": "设备返回状态码" }, "msg": { "type": "string", "description": "返回状态" }, "msgToken": { "type": "string", "description": "调用id" }, "timestamp": { "type": "integer", "format": "int64", "description": "上报时间戳(毫秒时间戳)" }, "params": { "type": "string", "description": "获取到的值" } }, "title": "DeviceInteractPropertyGetReportSendResp", "required": [ "code", "msg", "msgToken", "timestamp", "params" ] }, "DeviceInteractRespReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "msgToken": { "type": "string", "description": "调用id" } }, "title": "DeviceInteractRespReadReq", "required": [ "productID", "deviceName", "msgToken" ] }, "DeviceInteractSendActionReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "actionID": { "type": "string", "description": "产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义" }, "inputParams": { "type": "string", "description": "输入参数" }, "isAsync": { "type": "boolean", "format": "boolean", "description": "是否异步操作 异步情况通过获取接口来获取" }, "option": { "$ref": "#/definitions/SendOption", "description": "异步重试选项" } }, "title": "DeviceInteractSendActionReq", "required": [ "productID", "deviceName", "actionID" ] }, "DeviceInteractSendActionResp": { "type": "object", "properties": { "msgToken": { "type": "string", "description": "调用id" }, "outputParams": { "type": "string", "description": "输出参数 注意：此字段可能返回 null，表示取不到有效值。" }, "msg": { "type": "string", "description": "返回状态" }, "code": { "type": "integer", "format": "int64", "description": "设备返回状态码" } }, "title": "DeviceInteractSendActionResp", "required": [ "msgToken", "outputParams", "msg", "code" ] }, "DeviceInteractSendMsgReq": { "type": "object", "properties": { "topic": { "type": "string", "description": "发送的topic" }, "payload": { "type": "string", "description": "发送的数据" } }, "title": "DeviceInteractSendMsgReq", "required": [ "topic", "payload" ] }, "DeviceInteractSendPropertyReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "data": { "type": "string", "description": "属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义" }, "isAsync": { "type": "boolean", "format": "boolean", "description": "是否异步操作 异步情况通过获取接口来获取" }, "syncTimeout": { "type": "integer", "format": "int64", "description": "同步超时时间(单位:秒,不填默认3秒)" }, "shadowControl": { "type": "integer", "format": "int64", "description": "设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发 3:只修改云端的值 4:只修改云端的值并记录操作日志" }, "withProfile": { "$ref": "#/definitions/WithProfile", "description": "同时修改该设备的配置信息" } }, "title": "DeviceInteractSendPropertyReq", "required": [ "productID", "deviceName", "data" ] }, "DeviceInteractSendPropertyResp": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "description": "设备返回状态码" }, "msg": { "type": "string", "description": "返回状态" }, "msgToken": { "type": "string", "description": "调用id" } }, "title": "DeviceInteractSendPropertyResp", "required": [ "code", "msg", "msgToken" ] }, "DeviceModuleVersion": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "productID": { "type": "string", "description": "产品id 只读" }, "productName": { "type": "string" }, "moduleCode": { "type": "integer", "format": "int64" }, "version": { "type": "string" } }, "title": "DeviceModuleVersion" }, "DeviceModuleVersionIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息 只获取一个则不填" }, "productID": { "type": "string", "description": "产品id 只读" }, "productName": { "type": "string" }, "moduleCode": { "type": "integer", "format": "int64" } }, "title": "DeviceModuleVersionIndexReq" }, "DeviceModuleVersionIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceModuleVersion" }, "description": "设备信息" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceModuleVersionIndexResp", "required": [ "list" ] }, "DeviceModuleVersionReadReq": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "productID": { "type": "string", "description": "产品id 只读" }, "productName": { "type": "string" }, "moduleCode": { "type": "integer", "format": "int64" } }, "title": "DeviceModuleVersionReadReq" }, "DeviceMoveReq": { "type": "object", "properties": { "old": { "$ref": "#/definitions/DeviceCore", "description": "需要转移的设备" }, "new": { "$ref": "#/definitions/DeviceCore", "description": "转移的对象" }, "withTarget": { "type": "array", "items": { "type": "string" }, "description": "设备配置-profile,schemaAlias:profile" } }, "title": "DeviceMoveReq", "required": [ "old", "new" ] }, "DeviceMsgAbnormalLogIndexReq": { "type": "object", "properties": { "productCategoryID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "projectID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "areaID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "areaIDPath": { "type": "string", "description": "只有管理员有权限" }, "areaIDs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "只有管理员有权限" }, "belongGroup": { "type": "object", "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回" }, "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "timeStart": { "type": "string", "description": "获取时间的开始(毫秒时间戳)" }, "timeEnd": { "type": "string", "description": "时间的结束(毫秒时间戳)" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" }, "type": { "type": "string", "description": "异常类型" }, "action": { "type": "integer", "format": "int64", "description": "触发1 还是解除2" } }, "title": "DeviceMsgAbnormalLogIndexReq" }, "DeviceMsgAbnormalLogIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgAbnormalLogInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgAbnormalLogIndexResp", "required": [ "list" ] }, "DeviceMsgAbnormalLogInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "发生时间戳(毫秒时间戳)" }, "productID": { "type": "string" }, "deviceName": { "type": "string" }, "action": { "type": "integer", "format": "int64", "description": "触发1 还是解除2" }, "type": { "type": "string", "description": "异常类型" }, "traceID": { "type": "string", "description": "服务器端事务id" }, "reason": { "type": "string", "description": "原因" } }, "title": "DeviceMsgAbnormalLogInfo" }, "DeviceMsgEventLogIndexReq": { "type": "object", "properties": { "deviceNames": { "type": "array", "items": { "type": "string" }, "description": "设备名(不填获取产品下所有设备)" }, "productID": { "type": "string", "description": "产品id 获取产品id下的所有设备信息" }, "dataID": { "type": "string", "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值" }, "timeStart": { "type": "string", "description": "获取时间的开始" }, "timeEnd": { "type": "string", "description": "时间的结束" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" }, "types": { "type": "array", "items": { "type": "string" }, "description": "类型 事件类型: 信息:info 告警alert 故障:fault" } }, "title": "DeviceMsgEventLogIndexReq" }, "DeviceMsgEventLogIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgEventLogInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgEventLogIndexResp", "required": [ "list" ] }, "DeviceMsgEventLogInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "发生时间戳" }, "type": { "type": "string", "description": "类型 事件类型: 信息:info 告警alert 故障:fault" }, "dataID": { "type": "string", "description": "获取的具体属性值" }, "params": { "type": "string", "description": "获取到的值" } }, "title": "DeviceMsgEventLogInfo", "required": [ "timestamp", "dataID" ] }, "DeviceMsgHubLogIndexReq": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "设备名" }, "productID": { "type": "string", "description": "产品id 获取产品id下的所有设备信息" }, "timeStart": { "type": "string", "description": "获取时间的开始" }, "timeEnd": { "type": "string", "description": "时间的结束" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" }, "actions": { "type": "array", "items": { "type": "string" }, "description": "过滤操作类型 connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志" }, "topics": { "type": "array", "items": { "type": "string" }, "description": "过滤主题" }, "content": { "type": "string", "description": "过滤内容" }, "requestID": { "type": "string", "description": "过滤请求ID" } }, "title": "DeviceMsgHubLogIndexReq" }, "DeviceMsgHubLogIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgHubLogInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgHubLogIndexResp", "required": [ "list" ] }, "DeviceMsgHubLogInfo": { "type": "object", "properties": { "timestamp": { "type": "string" }, "action": { "type": "string", "description": "connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志" }, "requestID": { "type": "string" }, "traceID": { "type": "string" }, "topic": { "type": "string" }, "content": { "type": "string" }, "resultCode": { "type": "string" }, "respPayload": { "type": "string" } }, "title": "DeviceMsgHubLogInfo", "required": [ "timestamp", "action", "requestID", "traceID", "topic", "content", "resultCode", "respPayload" ] }, "DeviceMsgPropertyIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgPropertyLogInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgPropertyIndexResp", "required": [ "list" ] }, "DeviceMsgPropertyLogIndexReq": { "type": "object", "properties": { "tenantCode": { "type": "string", "description": "只有管理员有权限" }, "projectID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "areaID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "areaIDPath": { "type": "string", "description": "只有管理员有权限" }, "areaIDs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "只有管理员有权限" }, "belongGroup": { "type": "object", "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回" }, "deviceName": { "type": "string", "description": "设备名(不填获取产品下所有设备)" }, "deviceNames": { "type": "array", "items": { "type": "string" }, "description": "设备名(不填获取产品下所有设备,只有管理员有权限)" }, "productID": { "type": "string", "description": "产品id 获取产品id下的所有设备信息" }, "productCategoryID": { "type": "integer", "format": "int64", "description": "产品品类id,通用物模型有效" }, "dataID": { "type": "string", "description": "获取的具体标识符的数据" }, "timeStart": { "type": "string", "description": "获取时间的开始" }, "timeEnd": { "type": "string", "description": "时间的结束" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" }, "interval": { "type": "integer", "format": "int64", "description": "间隔 如果这个值不为零值 则时间的开始和结束必须有效及聚合函数不应该为空" }, "intervalUnit": { "type": "string", "description": "间隔单位 a (毫秒,默认), d (天), h (小时), m (分钟), n (月), s (秒), u (微秒), w (周), y (年) 则时间的开始和结束必须有效及聚合函数不应该为空" }, "argFunc": { "type": "string", "description": "聚合函数 avg:平均值 first:第一个参数 last:最后一个参数 count:总数 twa: 时间加权平均函数 参考: https:docs.taosdata.com/reference/taos-sql/function/#apercentile" }, "fill": { "type": "string", "description": "指定窗口区间数据缺失的情况下的填充模式 参考: https:docs.taosdata.com/reference/taos-sql/distinguished/#fill-%E5%AD%90%E5%8F%A5" }, "order": { "type": "integer", "format": "int64", "description": "时间排序 0:aes(默认,从久到近排序) 1:desc(时间从近到久排序)" }, "partitionBy": { "type": "string", "description": "切分数据,可以填写deviceName" } }, "title": "DeviceMsgPropertyLogIndexReq" }, "DeviceMsgPropertyLogInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "发生时间戳" }, "deviceName": { "type": "string", "description": "设备名称" }, "dataID": { "type": "string", "description": "获取的具体属性值" }, "value": { "type": "string", "description": "获取到的值" }, "tenantCode": { "type": "string", "description": "只有partitionBy 传该参数的时候才会返回" }, "projectID": { "type": "integer", "format": "int64", "description": "只有partitionBy 传该参数的时候才会返回" }, "areaID": { "type": "integer", "format": "int64", "description": "只有partitionBy 传该参数的时候才会返回" }, "areaIDPath": { "type": "string", "description": "只有partitionBy 传该参数的时候才会返回" }, "areaIDs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "只有partitionBy 传该参数的时候才会返回" }, "belongGroup": { "type": "object", "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回" } }, "title": "DeviceMsgPropertyLogInfo", "required": [ "timestamp", "dataID" ] }, "DeviceMsgPropertyLogLatestIndexReq": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "设备名" }, "productID": { "type": "string", "description": "产品id 获取产品id下的所有设备信息" }, "dataIDs": { "type": "array", "items": { "type": "string" }, "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值" } }, "title": "DeviceMsgPropertyLogLatestIndexReq" }, "DeviceMsgSdkIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgSdkInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgSdkIndexResp", "required": [ "list" ] }, "DeviceMsgSdkInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "发生时间戳" }, "loglevel": { "type": "integer", "format": "int64", "description": "日志级别 1)关闭 2)错误 3)告警 4)信息 5)调试" }, "content": { "type": "string", "description": "具体内容" } }, "title": "DeviceMsgSdkInfo", "required": [ "timestamp", "loglevel", "content" ] }, "DeviceMsgSdkLogIndexReq": { "type": "object", "properties": { "deviceName": { "type": "string", "description": "设备名" }, "productID": { "type": "string", "description": "产品id 获取产品id下的所有设备信息" }, "timeStart": { "type": "string", "description": "获取时间的开始" }, "timeEnd": { "type": "string", "description": "时间的结束" }, "logLevel": { "type": "integer", "format": "int32", "description": "等级" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" } }, "title": "DeviceMsgSdkLogIndexReq" }, "DeviceMsgSendLogIndexReq": { "type": "object", "properties": { "productCategoryID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "projectID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "areaID": { "type": "integer", "format": "int64", "description": "只有管理员有权限" }, "areaIDPath": { "type": "string", "description": "只有管理员有权限" }, "areaIDs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "只有管理员有权限" }, "groupIDPaths": { "type": "array", "items": { "type": "string" }, "description": "只有管理员有权限" }, "groupIDs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "只有管理员有权限" }, "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "timeStart": { "type": "string", "description": "获取时间的开始(毫秒时间戳)" }, "timeEnd": { "type": "string", "description": "时间的结束(毫秒时间戳)" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" }, "userID": { "type": "string" }, "actions": { "type": "array", "items": { "type": "string" } }, "resultCode": { "type": "integer", "format": "int64", "description": "请求结果状态,200为成功" }, "dataID": { "type": "string", "description": "模糊查询" }, "dataIDs": { "type": "array", "items": { "type": "string" }, "description": "精确查询" }, "withUser": { "type": "boolean", "format": "boolean", "description": "同时返回用户信息" } }, "title": "DeviceMsgSendLogIndexReq" }, "DeviceMsgSendLogIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgSendLogInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgSendLogIndexResp", "required": [ "list" ] }, "DeviceMsgSendLogInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "发生时间戳(毫秒时间戳)" }, "account": { "type": "string" }, "userID": { "type": "string" }, "productID": { "type": "string" }, "deviceName": { "type": "string" }, "action": { "type": "string", "description": "操作类型 propertySend:属性控制 actionSend:操作控制 propertyGetReportSend:获取最新属性请求" }, "dataID": { "type": "string", "description": "identify" }, "traceID": { "type": "string", "description": "服务器端事务id" }, "content": { "type": "string", "description": "操作的内容" }, "resultCode": { "type": "integer", "format": "int64", "description": "请求结果状态,200为成功" }, "user": { "$ref": "#/definitions/UserCore" } }, "title": "DeviceMsgSendLogInfo" }, "DeviceMsgShadowIndex": { "type": "object", "properties": { "dataID": { "type": "string", "description": "属性id" }, "value": { "type": "string", "description": "获取到的值" }, "updatedDeviceTime": { "type": "integer", "format": "int64", "description": "更新到设备的时间" } }, "title": "DeviceMsgShadowIndex", "required": [ "dataID", "value", "updatedDeviceTime" ] }, "DeviceMsgShadowIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgShadowIndex" } } }, "title": "DeviceMsgShadowIndexResp", "required": [ "list" ] }, "DeviceMsgStatusLogIndexReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string", "description": "设备名" }, "timeStart": { "type": "string", "description": "获取时间的开始(毫秒时间戳)" }, "timeEnd": { "type": "string", "description": "时间的结束(毫秒时间戳)" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" }, "status": { "type": "integer", "format": "int64", "description": "在线状态" } }, "title": "DeviceMsgStatusLogIndexReq" }, "DeviceMsgStatusLogIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceMsgStatusLogInfo" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceMsgStatusLogIndexResp", "required": [ "list" ] }, "DeviceMsgStatusLogInfo": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "发生时间戳(毫秒时间戳)" }, "status": { "type": "integer", "format": "int64", "description": "过滤请求ID" }, "deviceName": { "type": "string" }, "productID": { "type": "string" } }, "title": "DeviceMsgStatusLogInfo" }, "DeviceMultiImportErrdata": { "type": "object", "properties": { "row": { "type": "integer", "format": "int64", "description": "错误所在表格行" }, "msg": { "type": "string", "description": "详细错误信息" } }, "title": "DeviceMultiImportErrdata", "required": [ "row", "msg" ] }, "DeviceMultiImportReq": { "type": "object", "properties": {}, "title": "DeviceMultiImportReq" }, "DeviceMultiImportResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64", "description": "当前表格数据量" }, "headers": { "$ref": "#/definitions/DeviceMultiImportRow", "description": "表格表头信息" }, "errdata": { "type": "array", "items": { "$ref": "#/definitions/DeviceMultiImportRow" }, "description": "批量导入错误清单" } }, "title": "DeviceMultiImportResp", "required": [ "total", "headers", "errdata" ] }, "DeviceMultiImportRow": { "type": "object", "properties": { "row": { "type": "integer", "format": "int64", "description": "【提示】数据所在表格行" }, "productID": { "type": "string", "description": "【必填】产品ID" }, "deviceName": { "type": "string", "description": "【必填】设备名称" }, "deviceAlias": { "type": "string", "description": "【选填】设备别名" }, "secret": { "type": "string", "description": "【选填】设备秘钥" }, "gatewayProductID": { "type": "string", "description": "【选填】绑定的网关产品ID(网关的设备ID全局唯一可不填)" }, "gatewayDeviceName": { "type": "string", "description": "【选填】绑定的网关设备ID" }, "logLevel": { "type": "string", "description": "【选填】日志级别（关闭/错误/告警/信息/调试）" }, "tags": { "type": "string", "description": "【选填】设备标签（格式k1:v1;k2:v2;...）" }, "position": { "type": "string", "description": "【选填】设备位置百度坐标（格式:经,纬）" }, "address": { "type": "string", "description": "【选填】设备所在详细地址" }, "tips": { "type": "string", "description": "【提示】模板使用提示" } }, "title": "DeviceMultiImportRow", "required": [ "row", "productID", "deviceName", "deviceAlias", "secret", "gatewayProductID", "gatewayDeviceName", "logLevel", "tags", "position", "address", "tips" ] }, "DeviceMultiUpdateImportError": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" }, "code": { "type": "integer", "format": "int64" }, "msg": { "type": "string" } }, "title": "DeviceMultiUpdateImportError", "required": [ "device", "code", "msg" ] }, "DeviceMultiUpdateImportReq": { "type": "object", "properties": {}, "title": "DeviceMultiUpdateImportReq" }, "DeviceMultiUpdateImportResp": { "type": "object", "properties": { "total": { "type": "integer", "format": "int64", "description": "导入总接口数" }, "errCount": { "type": "integer", "format": "int64", "description": "失败数" }, "errDetail": { "type": "array", "items": { "$ref": "#/definitions/DeviceMultiUpdateImportError" }, "description": "失败详情" }, "ignoreCount": { "type": "integer", "format": "int64", "description": "忽略数" }, "succCount": { "type": "integer", "format": "int64", "description": "成功数" } }, "title": "DeviceMultiUpdateImportResp", "required": [ "total", "errCount", "errDetail", "ignoreCount", "succCount" ] }, "DeviceProfile": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" }, "code": { "type": "string" }, "params": { "type": "string" } }, "title": "DeviceProfile", "required": [ "device", "code", "params" ] }, "DeviceProfileIndexReq": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" }, "codes": { "type": "array", "items": { "type": "string" } } }, "title": "DeviceProfileIndexReq", "required": [ "device" ] }, "DeviceProfileIndexResp": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "$ref": "#/definitions/DeviceProfile" } } }, "title": "DeviceProfileIndexResp" }, "DeviceProfileReadReq": { "type": "object", "properties": { "device": { "$ref": "#/definitions/DeviceCore" }, "code": { "type": "string" } }, "title": "DeviceProfileReadReq", "required": [ "device", "code" ] }, "DeviceRegisterReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "deviceName": { "type": "string", "description": "设备名称 读写" }, "nonce": { "type": "integer", "format": "int64", "description": "随机数" }, "timestamp": { "type": "integer", "format": "int64", "description": "秒级时间戳" }, "signature": { "type": "string", "description": "签名信息" } }, "title": "DeviceRegisterReq", "required": [ "productID", "deviceName", "nonce", "timestamp", "signature" ] }, "DeviceRegisterResp": { "type": "object", "properties": { "len": { "type": "integer", "format": "int64", "description": "payload加密前信息的长度" }, "payload": { "type": "string" } }, "title": "DeviceRegisterResp", "required": [ "len", "payload" ] }, "DeviceSchema": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "deviceName": { "type": "string" }, "type": { "type": "integer", "format": "int64", "description": "物模型类型 1:property属性 2:event事件 3:action行为" }, "tag": { "type": "integer", "format": "int64", "description": "物模型标签 1:自定义 2:可选 3:必选 必选不可删除" }, "identifier": { "type": "string", "description": "标识符" }, "extendConfig": { "type": "string", "description": "拓展参数" }, "name": { "type": "string", "description": "功能名称" }, "desc": { "type": "string", "description": "描述" }, "required": { "type": "integer", "format": "int64", "description": "是否必须 1:是 2:否" }, "affordance": { "type": "string", "description": "各功能类型的详细参数定义" }, "isCanSceneLinkage": { "type": "integer", "format": "int64", "description": "是否可以场景联动" }, "funcGroup": { "type": "integer", "format": "int64", "description": " 功能分类: 1:普通功能 2:系统功能" }, "userPerm": { "type": "integer", "format": "int64", "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)" }, "isHistory": { "type": "integer", "format": "int64", "description": " 是否存储历史记录" }, "isPassword": { "type": "integer", "format": "int64", "description": "是否是密码类型,密码类型需要加掩码" }, "order": { "type": "integer", "format": "int64", "description": " 排序" }, "controlMode": { "type": "integer", "format": "int64", "description": "控制模式: 1: 可以群控,可以单控 2:只能单控" } }, "title": "DeviceSchema", "required": [ "productID", "deviceName", "type", "tag", "identifier" ] }, "DeviceSchemaDeleteReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string" }, "identifier": { "type": "string", "description": "标识符" } }, "title": "DeviceSchemaDeleteReq", "required": [ "productID", "deviceName", "identifier" ] }, "DeviceSchemaIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string" }, "type": { "type": "integer", "format": "int64", "description": "物模型类型 1:property属性 2:event事件 3:action行为" }, "types": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "tag": { "type": "integer", "format": "int64", "description": "过滤条件: 物模型标签 1:自定义 2:可选 3:必选" }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "过滤标识符列表" }, "name": { "type": "string" }, "isCanSceneLinkage": { "type": "integer", "format": "int64", "description": "是否可以场景联动" }, "funcGroup": { "type": "integer", "format": "int64", "description": " 功能分类: 1:普通功能 2:系统功能" }, "userPerm": { "type": "integer", "format": "int64", "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)" }, "propertyMode": { "type": "string", "description": "属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)" }, "controlMode": { "type": "integer", "format": "int64", "description": "控制模式: 1: 可以群控,可以单控 2:只能单控" }, "withProductSchema": { "type": "boolean", "format": "boolean", "description": "同时获取产品物模型" } }, "title": "DeviceSchemaIndexReq", "required": [ "productID", "deviceName" ] }, "DeviceSchemaIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceSchema" }, "description": "分页信息,只获取一个则不填" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "DeviceSchemaIndexResp", "required": [ "list" ] }, "DeviceSchemaMultiCreateReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string" }, "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceSchema" }, "description": "分页信息,只获取一个则不填" } }, "title": "DeviceSchemaMultiCreateReq", "required": [ "productID", "deviceName", "list" ] }, "DeviceSchemaMultiDeleteReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string" }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "物模型ID列表" } }, "title": "DeviceSchemaMultiDeleteReq", "required": [ "productID", "deviceName", "identifiers" ] }, "DeviceSchemaTslReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "deviceName": { "type": "string" } }, "title": "DeviceSchemaTslReadReq", "required": [ "productID", "deviceName" ] }, "DeviceSchemaTslReadResp": { "type": "object", "properties": { "tsl": { "type": "string", "description": "物模型tsl" } }, "title": "DeviceSchemaTslReadResp", "required": [ "tsl" ] }, "DeviceSchemaUpdateReq": { "type": "object", "properties": { "": { "$ref": "#/definitions/DeviceSchema" } }, "title": "DeviceSchemaUpdateReq" }, "DeviceShareInfo": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品ID" }, "productName": { "type": "string" }, "productImg": { "type": "string", "description": "产品图片" }, "deviceName": { "type": "string", "description": "设备名称" }, "deviceAlias": { "type": "string", "description": "设备别名 读写" } }, "title": "DeviceShareInfo", "required": [ "productID", "deviceName" ] }, "FileCore": { "type": "object", "properties": { "path": { "type": "string", "description": "文件的路径" }, "isUpdate": { "type": "boolean", "format": "boolean", "description": "如果要更新该文件,则需要将该参数置为true" } }, "title": "FileCore" }, "FirmwareCreateReq": { "type": "object", "properties": { "productID": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" }, "signMethod": { "type": "string" }, "desc": { "type": "string" }, "isDiff": { "type": "integer", "format": "int64" }, "srcVersion": { "type": "string" }, "isNeedToVerify": { "type": "integer", "format": "int64" }, "extra": { "type": "string" }, "moduleCode": { "type": "string" }, "filePaths": { "type": "array", "items": { "type": "string" } } }, "title": "FirmwareCreateReq", "required": [ "productID", "name", "version", "signMethod", "isDiff", "srcVersion", "isNeedToVerify", "filePaths" ] }, "FirmwareFile": { "type": "object", "properties": { "name": { "type": "string" }, "filePath": { "type": "string" }, "fileMd5": { "type": "string" }, "signature": { "type": "string" } }, "title": "FirmwareFile", "required": [ "name", "filePath", "fileMd5", "signature" ] }, "FirmwareIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo" }, "productID": { "type": "string" }, "name": { "type": "string" } }, "title": "FirmwareIndexReq" }, "FirmwareIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/FirmwareInfo" } }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "FirmwareIndexResp", "required": [ "list" ] }, "FirmwareInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "固件id" }, "name": { "type": "string", "description": "固件升级包名称" }, "version": { "type": "string", "description": "版本号" }, "productID": { "type": "string", "description": "产品id" }, "productName": { "type": "string", "description": "产品名称" }, "status": { "type": "integer", "format": "int64", "description": "状态" }, "createdTime": { "type": "integer", "format": "int64", "description": "添加时间" }, "signMethod": { "type": "string", "description": "签名方式:MD5/SHA256" }, "desc": { "type": "string", "description": "文件描述" }, "extra": { "type": "string", "description": "推给设备端端消息" }, "isDiff": { "type": "integer", "format": "int64", "description": "整包or差包" }, "isNeedToVerify": { "type": "integer", "format": "int64", "description": "是否需要验证" }, "moduleCode": { "type": "string", "description": "模块编码" }, "fileList": { "type": "array", "items": { "$ref": "#/definitions/FirmwareFile" }, "description": "文件列表" } }, "title": "FirmwareInfo", "required": [ "id", "name", "version", "productID", "productName", "status", "createdTime", "signMethod", "desc", "extra", "isDiff", "isNeedToVerify", "moduleCode", "fileList" ] }, "FirmwareUpdateReq": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "desc": { "type": "string" }, "extra": { "type": "string" } }, "title": "FirmwareUpdateReq", "required": [ "id" ] }, "GatewayCanBindIndexReq": { "type": "object", "properties": { "gateway": { "$ref": "#/definitions/DeviceCore", "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用" } }, "title": "GatewayCanBindIndexReq", "required": [ "gateway" ] }, "GatewayCanBindIndexResp": { "type": "object", "properties": { "subDevices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用" }, "updatedTime": { "type": "integer", "format": "int64" } }, "title": "GatewayCanBindIndexResp", "required": [ "subDevices", "updatedTime" ] }, "GatewayGetFoundReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id (必填)" }, "deviceName": { "type": "string", "description": "设备名(必填)" } }, "title": "GatewayGetFoundReq", "required": [ "productID", "deviceName" ] }, "GatewayNotifyBindSendReq": { "type": "object", "properties": { "gateway": { "$ref": "#/definitions/DeviceCore", "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用" }, "subDevices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用" } }, "title": "GatewayNotifyBindSendReq", "required": [ "gateway", "subDevices" ] }, "GroupCore": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "parentID": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "purpose": { "type": "string", "description": "用途" } }, "title": "GroupCore", "required": [ "id", "parentID", "name", "purpose" ] }, "GroupDeviceMultiDeleteReq": { "type": "object", "properties": { "groupID": { "type": "integer", "format": "int64", "description": "分组ID" }, "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "分组tag" } }, "title": "GroupDeviceMultiDeleteReq", "required": [ "groupID" ] }, "GroupDeviceMultiSaveReq": { "type": "object", "properties": { "groupID": { "type": "integer", "format": "int64", "description": "分组ID" }, "list": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "分组tag" } }, "title": "GroupDeviceMultiSaveReq", "required": [ "groupID" ] }, "GroupInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "分组ID" }, "idPath": { "type": "string", "description": "分组ID路径" }, "purpose": { "type": "string", "description": "用途 不填默认为default" }, "parentID": { "type": "integer", "format": "int64", "description": "父组ID" }, "projectID": { "type": "string", "description": "项目ID" }, "areaID": { "type": "string", "description": "区域ID" }, "name": { "type": "string", "description": "分组名称" }, "productID": { "type": "string", "description": "产品ID" }, "productName": { "type": "string", "description": "产品ID" }, "createdTime": { "type": "string", "description": "创建时间" }, "desc": { "type": "string", "description": "分组描述" }, "deviceCount": { "type": "integer", "format": "int64", "description": "设备数量统计" }, "isLeaf": { "type": "integer", "format": "int64" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": "分组tag" }, "files": { "type": "object", "description": "key 是用途, value是文件的路径," }, "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" } }, "children": { "type": "array", "items": { "$ref": "#/definitions/GroupInfo" } } }, "title": "GroupInfo" }, "GroupInfoIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息 只获取一个则不填" }, "areaID": { "type": "string", "description": "区域ID" }, "parentID": { "type": "integer", "format": "int64", "description": "父组ID" }, "productID": { "type": "string", "description": "产品ID" }, "name": { "type": "string", "description": "分组名称" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": "分组tag" }, "purpose": { "type": "string", "description": "用途 不填默认为default" } }, "title": "GroupInfoIndexReq" }, "GroupInfoIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/GroupInfo" }, "description": "分组信息" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "GroupInfoIndexResp", "required": [ "list" ] }, "GroupInfoReadReq": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": " id" }, "purpose": { "type": "string", "description": "用途 不填默认为default" }, "withChildren": { "type": "boolean", "format": "boolean" } }, "title": "GroupInfoReadReq", "required": [ "id" ] }, "IDPath": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "idPath": { "type": "string" } }, "title": "IDPath" }, "IDsInfo": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "idPaths": { "type": "array", "items": { "type": "string" } } }, "title": "IDsInfo" }, "OrderBy": { "type": "object", "properties": { "field": { "type": "string", "description": "排序的字段名" }, "sort": { "type": "integer", "format": "int64", "description": "排序方式：1 从小到大, 2 从大到小" } }, "title": "OrderBy" }, "OtaFirmwareCreateReq": { "type": "object", "properties": { "name": { "type": "string", "description": "升级包名称" }, "productID": { "type": "string", "description": "产品id" }, "version": { "type": "string", "description": "升级包版本" }, "isDiff": { "type": "integer", "format": "int32", "description": "是否差分包,1:整包,2:差分" }, "signMethod": { "type": "string", "description": "签名方法 MD5/SHA@256" }, "desc": { "type": "string", "description": "描述" }, "extData": { "type": "string", "description": "自定义数据" }, "files": { "type": "array", "items": { "$ref": "#/definitions/OtaFirmwareFile" }, "description": "升级包附件列表，最多支持上传20个文件，总文件大小不能超过1,000 MB。" } }, "title": "OtaFirmwareCreateReq", "required": [ "name", "productID", "version", "isDiff", "signMethod", "desc", "extData", "files" ] }, "OtaFirmwareDeviceCancelReq": { "type": "object", "properties": { "firmwareID": { "type": "integer", "format": "int64" }, "jobID": { "type": "integer", "format": "int64" }, "deviceNames": { "type": "array", "items": { "type": "string" } } }, "title": "OtaFirmwareDeviceCancelReq", "required": [ "firmwareID", "jobID", "deviceNames" ] }, "OtaFirmwareDeviceConfirmReq": { "type": "object", "properties": { "productID": { "type": "string" }, "deviceName": { "type": "string" } }, "title": "OtaFirmwareDeviceConfirmReq", "required": [ "productID", "deviceName" ] }, "OtaFirmwareDeviceIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": " 分页信息" }, "jobID": { "type": "integer", "format": "int64", "description": " 作业ID" }, "firmwareID": { "type": "integer", "format": "int64", "description": " 任务状态" }, "deviceName": { "type": "string", "description": " 设备名称" }, "srcVersion": { "type": "string" }, "status": { "type": "integer", "format": "int64", "description": "设备升级作业状态。1：待确认。 2：待推送。 3：已推送。 4：升级中。 5:升级成功 6: 升级失败. 7:已取消" }, "isOnline": { "type": "integer", "format": "int64", "description": "设备是否在线" } }, "title": "OtaFirmwareDeviceIndexReq" }, "OtaFirmwareDeviceIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/OtaFirmwareDeviceInfo" }, "description": " OTA任务信息列表" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "OtaFirmwareDeviceIndexResp", "required": [ "list" ] }, "OtaFirmwareDeviceInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "firmwareID": { "type": "integer", "format": "int64" }, "jobID": { "type": "integer", "format": "int64" }, "productID": { "type": "string" }, "productName": { "type": "string" }, "deviceName": { "type": "string" }, "srcVersion": { "type": "string" }, "destVersion": { "type": "string" }, "step": { "type": "integer", "format": "int64" }, "detail": { "type": "string" }, "status": { "type": "integer", "format": "int64" }, "createdTime": { "type": "integer", "format": "int64" }, "updatedTime": { "type": "integer", "format": "int64" }, "isOnline": { "type": "integer", "format": "int64", "description": "设备是否在线" } }, "title": "OtaFirmwareDeviceInfo", "required": [ "id", "firmwareID", "jobID", "productID", "productName", "deviceName", "srcVersion", "destVersion", "step", "detail", "status", "createdTime", "updatedTime" ] }, "OtaFirmwareDeviceInfoResp": { "type": "object", "properties": { "versions": { "type": "string" } }, "title": "OtaFirmwareDeviceInfoResp", "required": [ "versions" ] }, "OtaFirmwareDeviceRetryReq": { "type": "object", "properties": { "firmwareID": { "type": "integer", "format": "int64" }, "jobID": { "type": "integer", "format": "int64" }, "deviceNames": { "type": "array", "items": { "type": "string" } } }, "title": "OtaFirmwareDeviceRetryReq", "required": [ "firmwareID", "jobID", "deviceNames" ] }, "OtaFirmwareFile": { "type": "object", "properties": { "filePath": { "type": "string", "description": "附件地址，上传附件后接口应该返回" }, "name": { "type": "string", "description": "附件原名，上传附件后接口应该返回" } }, "title": "OtaFirmwareFile", "required": [ "filePath", "name" ] }, "OtaFirmwareFileInfo": { "type": "object", "properties": { "uri": { "type": "string", "description": "附件地址" }, "name": { "type": "string", "description": "附件原名" }, "size": { "type": "integer", "format": "int64", "description": "文件大小" }, "signature": { "type": "string", "description": "签名值" } }, "title": "OtaFirmwareFileInfo", "required": [ "uri", "name", "size", "signature" ] }, "OtaFirmwareIndex": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "固件升级包编号" }, "name": { "type": "string", "description": "升级包名称" }, "version": { "type": "string", "description": "升级包版本" }, "productID": { "type": "string", "description": "产品id" }, "productName": { "type": "string", "description": "产品名称" }, "isDiff": { "type": "integer", "format": "int32", "description": "是否差分包,1:整包,2:差分" }, "createdTime": { "type": "integer", "format": "int64", "description": "创建时间 只读" }, "signMethod": { "type": "string", "description": "签名方法" } }, "title": "OtaFirmwareIndex", "required": [ "id", "name", "version", "productID", "productName", "isDiff", "createdTime", "signMethod" ] }, "OtaFirmwareIndexReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 获取产品id下的所有升级包" }, "timeStart": { "type": "string", "description": "获取时间的开始" }, "timeEnd": { "type": "string", "description": "时间的结束" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" } }, "title": "OtaFirmwareIndexReq" }, "OtaFirmwareIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/OtaFirmwareIndex" }, "description": "数据" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "OtaFirmwareIndexResp", "required": [ "list" ] }, "OtaFirmwareInfo": { "type": "object", "properties": { "firmwareID": { "type": "integer", "format": "int64", "description": "固件升级包编号" }, "name": { "type": "string", "description": "升级包名称" }, "version": { "type": "string", "description": "升级包版本" }, "productID": { "type": "string", "description": "产品id" }, "productName": { "type": "string", "description": "产品名称" }, "isDiff": { "type": "integer", "format": "int32", "description": "是否差分包,1:整包,2:差分" }, "createdTime": { "type": "integer", "format": "int64", "description": "创建时间 只读" }, "signMethod": { "type": "string", "description": "签名方法" }, "desc": { "type": "string", "description": "描述" }, "extData": { "type": "string", "description": "自定义数据" } }, "title": "OtaFirmwareInfo", "required": [ "firmwareID", "name", "version", "productID", "productName", "isDiff", "createdTime", "signMethod", "desc", "extData" ] }, "OtaFirmwareInfoUpdateReq": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "固件升级包编号" }, "name": { "type": "string", "description": "升级包名称" }, "desc": { "type": "string", "description": "描述" }, "extData": { "type": "string", "description": "自定义数据" } }, "title": "OtaFirmwareInfoUpdateReq", "required": [ "id", "name", "desc", "extData" ] }, "OtaFirmwareJobDynamic": { "type": "object", "properties": { "dynamicMode": { "type": "integer", "format": "int64", "maximum": 2 } }, "title": "OtaFirmwareJobDynamic" }, "OtaFirmwareJobIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": " 分页信息" }, "firmwareID": { "type": "integer", "format": "int64", "description": " 固件ID" } }, "title": "OtaFirmwareJobIndexReq", "required": [ "page", "firmwareID" ] }, "OtaFirmwareJobInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "firmwareID": { "type": "integer", "format": "int64", "description": " 升级包ID，升级包的唯一标识符。" }, "type": { "type": "integer", "format": "int64", "description": " 升级包所属产品的JobType。 验证升级包:1 批量升级:2", "maximum": 2 }, "status": { "type": "integer", "format": "int64", "description": " 批次状态,计划中:1 执行中:2 已完成:3 已取消:4", "maximum": 4 }, "upgradeType": { "type": "integer", "format": "int64", "description": " 升级策略，1-静态，2-动态", "maximum": 2 }, "srcVersions": { "type": "array", "items": { "type": "string" }, "description": " 待升级版本号列表。最多可传入10个版本号。用逗号分隔多个版本号" }, "retryInterval": { "type": "integer", "format": "int64", "description": " 设备升级失败后，自动重试的时间间隔，单位为分钟。 动态升级 静态升级" }, "retryCount": { "type": "integer", "format": "int64", "description": " 自动重试次数。1/2/5次 动态升级 静态升级" }, "timeoutInMinutes": { "type": "integer", "format": "int64", "description": " 设备升级超时时间，单位为分钟。 动态升级 静态升级" }, "maximumPerMinute": { "type": "integer", "format": "int64", "description": " 每分钟最多向多少个设备推送升级包下载URL。 动态升级 静态升级" }, "isOverwriteMode": { "type": "integer", "format": "int64", "description": " 是否覆盖之前的升级任务。取值：2（不覆盖）、1（覆盖）。", "maximum": 2 }, "isNeedPush": { "type": "integer", "format": "int64", "description": " 物联网平台是否主动向设备推送升级任务。", "maximum": 2 }, "isNeedConfirm": { "type": "integer", "format": "int64", "maximum": 2 }, "target": { "type": "string", "description": " 分组升级和区域升级填写对应的id" }, "targetSelection": { "type": "integer", "format": "int64", "description": "升级范围。 1：全量升级。 2：定向升级。 3：灰度升级。 4：分组升级(不做) 5: 区域升级(不做)", "maximum": 4 }, "tenantCodes": { "type": "array", "items": { "type": "string" }, "description": "指定租户" }, "createdTime": { "type": "integer", "format": "int64" }, "dynamicMode": { "type": "integer", "format": "int64", "maximum": 2 }, "targetDeviceNames": { "type": "array", "items": { "type": "string" }, "description": " 定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔" }, "scheduleFinishTime": { "type": "integer", "format": "int64", "description": " 指定结束升级的时间，单位为毫秒。" }, "scheduleTime": { "type": "integer", "format": "int64" }, "grayPercent": { "type": "integer", "format": "int64", "description": "灰度的范围,小数点后两位, 1.23%为 123" } }, "title": "OtaFirmwareJobInfo" }, "OtaFirmwareJobInfoIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/OtaFirmwareJobInfo" }, "description": " OTA作业信息列表" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "OtaFirmwareJobInfoIndexResp", "required": [ "list" ] }, "OtaFirmwareJobStatic": { "type": "object", "properties": { "targetDeviceNames": { "type": "array", "items": { "type": "string" }, "description": " 定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔" }, "scheduleFinishTime": { "type": "integer", "format": "int64", "description": " 指定结束升级的时间，单位为毫秒。" }, "scheduleTime": { "type": "integer", "format": "int64" }, "grayPercent": { "type": "integer", "format": "int64", "description": "灰度的范围,小数点后两位, 1.23%为 123" } }, "title": "OtaFirmwareJobStatic" }, "OtaFirmwareReadResp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "固件升级包编号" }, "name": { "type": "string", "description": "升级包名称" }, "version": { "type": "string", "description": "升级包版本" }, "productID": { "type": "string", "description": "产品id" }, "productName": { "type": "string", "description": "产品名称" }, "isDiff": { "type": "integer", "format": "int32", "description": "是否差分包,1:整包,2:差分" }, "isNeedToVerify": { "type": "integer", "format": "int64" }, "createdTime": { "type": "integer", "format": "int64", "description": "创建时间 只读" }, "signMethod": { "type": "string", "description": "签名方法" }, "desc": { "type": "string", "description": "描述" }, "extData": { "type": "string", "description": "自定义数据" }, "files": { "type": "array", "items": { "$ref": "#/definitions/OtaFirmwareFileInfo" } } }, "title": "OtaFirmwareReadResp", "required": [ "id", "name", "version", "productID", "productName", "isDiff", "isNeedToVerify", "createdTime", "signMethod", "desc", "extData", "files" ] }, "OtaModuleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "code": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "productID": { "type": "string" }, "createdTime": { "type": "integer", "format": "int64" } }, "title": "OtaModuleInfo" }, "OtaModuleInfoIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": " 分页信息" }, "name": { "type": "string" }, "productID": { "type": "string" } }, "title": "OtaModuleInfoIndexReq" }, "OtaModuleInfoIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/OtaModuleInfo" }, "description": " OTA作业信息列表" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "OtaModuleInfoIndexResp", "required": [ "list" ] }, "PageInfo": { "type": "object", "properties": { "page": { "type": "integer", "format": "int64", "description": " 页码" }, "size": { "type": "integer", "format": "int64", "description": " 每页大小" }, "orders": { "type": "array", "items": { "$ref": "#/definitions/OrderBy" }, "description": "排序" } }, "title": "PageInfo" }, "PageResp": { "type": "object", "properties": { "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "PageResp", "required": [ "total" ] }, "Point": { "type": "object", "properties": { "longitude": { "type": "number", "format": "double", "description": "经度", "maximum": 180 }, "latitude": { "type": "number", "format": "double", "description": "纬度", "maximum": 90 } }, "title": "Point", "required": [ "longitude", "latitude" ] }, "ProductCategory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "parentID": { "type": "integer", "format": "int64" }, "idPath": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "只读" }, "name": { "type": "string" }, "desc": { "type": "string", "description": "描述" }, "headImg": { "type": "string", "description": " 用户头像" }, "isUpdateHeadImg": { "type": "boolean", "format": "boolean", "description": " 用户头像" }, "isLeaf": { "type": "integer", "format": "int64" }, "deviceCount": { "type": "integer", "format": "int64", "description": "设备数量" }, "children": { "type": "array", "items": { "$ref": "#/definitions/ProductCategory" } } }, "title": "ProductCategory" }, "ProductCategoryIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "name": { "type": "string", "description": "过滤产品名称" }, "parentID": { "type": "integer", "format": "int64" }, "ids": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "id过滤" }, "projectID": { "type": "string", "description": "项目id,只获取项目下有设备的" } }, "title": "ProductCategoryIndexReq" }, "ProductCategoryIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProductCategory" }, "description": "产品信息" }, "total": { "type": "integer", "format": "int64", "description": "拥有的总数" }, "num": { "type": "integer", "format": "int64", "description": "返回的数量" } }, "title": "ProductCategoryIndexResp", "required": [ "list" ] }, "ProductCategorySchemaIndexReq": { "type": "object", "properties": { "productCategoryID": { "type": "integer", "format": "int64" }, "withFather": { "type": "boolean", "format": "boolean" } }, "title": "ProductCategorySchemaIndexReq", "required": [ "productCategoryID" ] }, "ProductCategorySchemaIndexResp": { "type": "object", "properties": { "identifiers": { "type": "array", "items": { "type": "string" } } }, "title": "ProductCategorySchemaIndexResp", "required": [ "identifiers" ] }, "ProductCategorySchemaMultiSaveReq": { "type": "object", "properties": { "productCategoryID": { "type": "integer", "format": "int64" }, "identifiers": { "type": "array", "items": { "type": "string" } } }, "title": "ProductCategorySchemaMultiSaveReq", "required": [ "productCategoryID", "identifiers" ] }, "ProductConfig": { "type": "object", "properties": { "productID": { "type": "string" }, "devInit": { "$ref": "#/definitions/DevInit", "description": "设备初始化配置" } }, "title": "ProductConfig", "required": [ "productID" ] }, "ProductCustom": { "type": "object", "properties": { "productID": { "type": "string" }, "transformScript": { "type": "string", "description": "协议转换脚本" }, "loginAuthScript": { "type": "string", "description": "登录认证脚本" }, "scriptLang": { "type": "integer", "format": "int64", "description": "脚本语言类型（默认JavaScript） 1:JavaScript 2:lua 3:python" }, "customTopics": { "type": "array", "items": { "$ref": "#/definitions/ProductCustomTopic" }, "description": "自定义topic数组" } }, "title": "ProductCustom", "required": [ "productID" ] }, "ProductCustomReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" } }, "title": "ProductCustomReadReq", "required": [ "productID" ] }, "ProductCustomTopic": { "type": "object", "properties": { "topic": { "type": "string", "description": "自定义主题需要以$custom 并包含设备名称{deviceName}及产品名称{productID}" }, "direction": { "type": "integer", "format": "int64", "description": "1:上行 2:下行 3:双向" } }, "title": "ProductCustomTopic", "required": [ "topic", "direction" ] }, "ProductCustomUi": { "type": "object", "properties": { "path": { "type": "string", "description": "前端路径" }, "version": { "type": "integer", "format": "int64", "description": "版本号" }, "isUpdateUi": { "type": "boolean", "format": "boolean" } }, "title": "ProductCustomUi", "required": [ "path" ] }, "ProductInfo": { "type": "object", "properties": { "createdTime": { "type": "string", "description": "创建时间 只读" }, "productID": { "type": "string", "description": "产品id 只读" }, "productName": { "type": "string", "description": "产品名称" }, "productImg": { "type": "string", "description": "产品图片" }, "isUpdateProductImg": { "type": "boolean", "format": "boolean", "description": "只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path" }, "authMode": { "type": "integer", "format": "int64", "description": "认证方式:1:账密认证,2:秘钥认证", "maximum": 2 }, "deviceType": { "type": "integer", "format": "int64", "description": "设备类型:1:直连设备,2:网关,3:子设备,4:监控设备", "maximum": 4 }, "deviceSchemaMode": { "type": "integer", "format": "int64", "description": " 设备物模型模式:1:手动创建,2:设备自动创建 3: 设备自动创建及上报无定义自动创建 4: 设备自动创建及上报无定义自动创建(数字类型只使用浮点)", "maximum": 4 }, "categoryID": { "type": "integer", "format": "int64", "description": "产品品类" }, "netType": { "type": "integer", "format": "int64", "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE", "maximum": 10 }, "protocolCode": { "type": "string", "description": "协议code,默认urMqtt,设备下发只会发送给主协议 urMqtt,urHttp,wumei,aliyun,huaweiyun,tuya" }, "subProtocolCode": { "type": "string", "description": "子协议,主协议和子协议传输类型必须不相同, 设备控制下发只会发送给主协议, 当设备是音视频设备但是控制协议需要单独走的时候就可以把主协议定义为普通协议,子协议定义为音视频协议,这样就能实现音视频走音视频协议,控制走子协议" }, "autoRegister": { "type": "integer", "format": "int64", "description": "动态注册:1:关闭,2:打开,3:打开并自动创建设备", "maximum": 3 }, "secret": { "type": "string", "description": "动态注册产品秘钥 只读" }, "trialTime": { "type": "string", "description": "试用时间(单位为天,为0不限制)" }, "desc": { "type": "string", "description": "描述" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": " 产品tag" }, "sceneMode": { "type": "string", "description": "场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)" }, "status": { "type": "integer", "format": "int64", "description": "产品状态 1:启用 2:禁用 3:开发中" }, "bindLevel": { "type": "integer", "format": "int64", "description": "绑定级别: 1:强绑定(默认,只有用户解绑之后才能绑定) 2:中绑定(可以通过token强制解绑设备) 3:弱绑定(app可以内部解绑被绑定的设备)" }, "protocolConf": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": "协议配置" }, "subProtocolConf": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": "子协议协议配置" }, "protocol": { "$ref": "#/definitions/ProtocolInfo" }, "category": { "$ref": "#/definitions/ProductCategory" }, "config": { "$ref": "#/definitions/ProductConfig", "description": "产品配置,只有管理员会返回该字段" }, "customUi": { "type": "object", "description": "自定义ui,key是端的类型(web-client mini-client) value是以下类型的对象{version:123(版本号,只读),isUpdateUi:bool(是否更新ui),path:string(前端路径,如果需要修改,需要将isUpdateUi置为true并在这个参数中传入压缩包的filePath)}" } }, "title": "ProductInfo" }, "ProductInfoDeleteReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" } }, "title": "ProductInfoDeleteReq", "required": [ "productID" ] }, "ProductInfoIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "productName": { "type": "string", "description": "过滤产品名称" }, "deviceType": { "type": "integer", "format": "int64", "description": "过滤设备类型:0:全部,1:设备,2:网关,3:子设备", "maximum": 3 }, "deviceTypes": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备" }, "productIDs": { "type": "array", "items": { "type": "string" }, "description": "过滤产品id列表" }, "tags": { "type": "array", "items": { "$ref": "#/definitions/Tag" }, "description": " key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值" }, "protocolCode": { "type": "string", "description": "协议code" }, "protocolType": { "type": "string", "description": "协议类型" }, "withProtocol": { "type": "boolean", "format": "boolean", "description": "同时返回协议详情" }, "withCategory": { "type": "boolean", "format": "boolean", "description": "同时返回品类详情" }, "sceneModes": { "type": "array", "items": { "type": "string" }, "description": "场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)" }, "sceneMode": { "type": "string", "description": "场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)" }, "status": { "type": "integer", "format": "int64", "description": "产品状态 1:启用 2:禁用 3:开发中" }, "statuses": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "产品状态 1:启用 2:禁用 3:开发中" }, "netType": { "type": "integer", "format": "int64", "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE", "maximum": 10 }, "projectID": { "type": "string", "description": "项目id,只获取项目下有设备的" }, "areaID": { "type": "string", "description": "过滤区域下有设备的产品" }, "areaIDPath": { "type": "string", "description": "过滤区域id路径下有设备的产品" }, "categoryIDs": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "产品品类" } }, "title": "ProductInfoIndexReq" }, "ProductInfoIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProductInfo" }, "description": "产品信息" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "ProductInfoIndexResp", "required": [ "list" ] }, "ProductInfoReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "withProtocol": { "type": "boolean", "format": "boolean", "description": "同时返回协议详情" }, "withCategory": { "type": "boolean", "format": "boolean", "description": "同时返回品类详情" } }, "title": "ProductInfoReadReq", "required": [ "productID" ] }, "ProductInitReq": { "type": "object", "properties": { "productIDs": { "type": "array", "items": { "type": "string" }, "description": "产品id 只读" } }, "title": "ProductInitReq" }, "ProductRemoteConfig": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "配置编号" }, "content": { "type": "string", "description": "配置内容" }, "createTime": { "type": "string", "description": "创建时间" } }, "title": "ProductRemoteConfig", "required": [ "id", "content", "createTime" ] }, "ProductRemoteConfigCreateReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "content": { "type": "string", "description": "配置内容" } }, "title": "ProductRemoteConfigCreateReq", "required": [ "productID", "content" ] }, "ProductRemoteConfigIndexReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息" } }, "title": "ProductRemoteConfigIndexReq", "required": [ "productID" ] }, "ProductRemoteConfigIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProductRemoteConfig" }, "description": "产品信息" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "ProductRemoteConfigIndexResp", "required": [ "list" ] }, "ProductRemoteConfigLastestReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" } }, "title": "ProductRemoteConfigLastestReadReq", "required": [ "productID" ] }, "ProductRemoteConfigLastestReadResp": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "配置编号" }, "content": { "type": "string", "description": "配置内容" }, "createTime": { "type": "string", "description": "创建时间" } }, "title": "ProductRemoteConfigLastestReadResp" }, "ProductRemoteConfigPushAllReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" } }, "title": "ProductRemoteConfigPushAllReq", "required": [ "productID" ] }, "ProductSchemaCreateReq": { "type": "object", "properties": { "": { "$ref": "#/definitions/ProductSchemaInfo" } }, "title": "ProductSchemaCreateReq" }, "ProductSchemaDeleteReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "identifier": { "type": "string", "description": "标识符" } }, "title": "ProductSchemaDeleteReq", "required": [ "productID", "identifier" ] }, "ProductSchemaIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "productID": { "type": "string", "description": "产品id" }, "type": { "type": "integer", "format": "int64", "description": "物模型类型 1:property属性 2:event事件 3:action行为" }, "types": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "tag": { "type": "integer", "format": "int64", "description": "过滤条件: 物模型标签 1:自定义 2:可选 3:必选" }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "过滤标识符列表" }, "name": { "type": "string" }, "isCanSceneLinkage": { "type": "integer", "format": "int64", "description": "是否可以场景联动" }, "funcGroup": { "type": "integer", "format": "int64", "description": " 功能分类: 1:普通功能 2:系统功能" }, "userPerm": { "type": "integer", "format": "int64", "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)" }, "propertyMode": { "type": "string", "description": "属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)" }, "controlMode": { "type": "integer", "format": "int64", "description": "控制模式: 1: 可以群控,可以单控 2:只能单控" } }, "title": "ProductSchemaIndexReq", "required": [ "productID" ] }, "ProductSchemaIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProductSchemaInfo" }, "description": "分页信息,只获取一个则不填" }, "page": { "type": "integer", "format": "int64", "description": " 页码" }, "pageSize": { "type": "integer", "format": "int64", "description": " 每页大小" }, "total": { "type": "integer", "format": "int64" } }, "title": "ProductSchemaIndexResp", "required": [ "list" ] }, "ProductSchemaInfo": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "type": { "type": "integer", "format": "int64", "description": "物模型类型 1:property属性 2:event事件 3:action行为" }, "tag": { "type": "integer", "format": "int64", "description": "物模型标签 1:自定义 2:可选 3:必选 必选不可删除" }, "identifier": { "type": "string", "description": "标识符" }, "extendConfig": { "type": "string", "description": "拓展参数" }, "name": { "type": "string", "description": "功能名称" }, "desc": { "type": "string", "description": "描述" }, "required": { "type": "integer", "format": "int64", "description": "是否必须 1:是 2:否" }, "affordance": { "type": "string", "description": "各功能类型的详细参数定义" }, "isCanSceneLinkage": { "type": "integer", "format": "int64", "description": "是否可以场景联动" }, "funcGroup": { "type": "integer", "format": "int64", "description": " 功能分类: 1:普通功能 2:系统功能" }, "userPerm": { "type": "integer", "format": "int64", "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)" }, "isHistory": { "type": "integer", "format": "int64", "description": " 是否存储历史记录" }, "isPassword": { "type": "integer", "format": "int64", "description": "是否是密码类型,密码类型需要加掩码" }, "order": { "type": "integer", "format": "int64", "description": " 排序" }, "controlMode": { "type": "integer", "format": "int64", "description": "控制模式: 1: 可以群控,可以单控 2:只能单控" } }, "title": "ProductSchemaInfo", "required": [ "type", "tag", "identifier" ] }, "ProductSchemaMultiCreateReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" }, "list": { "type": "array", "items": { "$ref": "#/definitions/ProductSchemaInfo" }, "description": "分页信息,只获取一个则不填" } }, "title": "ProductSchemaMultiCreateReq", "required": [ "productID", "list" ] }, "ProductSchemaTslImportReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id 只读" }, "tsl": { "type": "string", "description": "物模型tsl" } }, "title": "ProductSchemaTslImportReq", "required": [ "productID", "tsl" ] }, "ProductSchemaTslReadReq": { "type": "object", "properties": { "productID": { "type": "string", "description": "产品id" } }, "title": "ProductSchemaTslReadReq", "required": [ "productID" ] }, "ProductSchemaTslReadResp": { "type": "object", "properties": { "tsl": { "type": "string", "description": "物模型tsl" } }, "title": "ProductSchemaTslReadResp", "required": [ "tsl" ] }, "ProductSchemaUpdateReq": { "type": "object", "properties": { "": { "$ref": "#/definitions/ProductSchemaInfo" } }, "title": "ProductSchemaUpdateReq" }, "ProtocolConfigField": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "group": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" }, "isRequired": { "type": "boolean", "format": "boolean" }, "sort": { "type": "integer", "format": "int64" } }, "title": "ProtocolConfigField", "required": [ "id", "group", "key", "label", "isRequired", "sort" ] }, "ProtocolConfigInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "config": { "type": "object" }, "desc": { "type": "string" } }, "title": "ProtocolConfigInfo", "required": [ "id", "config", "desc" ] }, "ProtocolInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "code": { "type": "string", "description": " iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya" }, "type": { "type": "string", "description": "协议类型: 普通设备(默认):normal 音视频:media" }, "transProtocol": { "type": "string", "description": " 传输协议: mqtt,tcp,udp" }, "desc": { "type": "string" }, "endpoints": { "type": "array", "items": { "type": "string" } }, "etcdKey": { "type": "string" }, "isEnableSyncProduct": { "type": "integer", "format": "int64", "description": "是否支持主动同步产品信息" }, "isEnableSyncDevice": { "type": "integer", "format": "int64", "description": "是否支持主动同步设备信息" }, "configFields": { "type": "array", "items": { "$ref": "#/definitions/ProtocolConfigField" }, "description": "配置字段列表,没有可以不传" }, "configInfos": { "type": "array", "items": { "$ref": "#/definitions/ProtocolConfigInfo" }, "description": "配置列表" }, "productFields": { "type": "array", "items": { "$ref": "#/definitions/ProtocolConfigField" }, "description": "产品级的配置字段列表,没有可以不传" }, "deviceFields": { "type": "array", "items": { "$ref": "#/definitions/ProtocolConfigField" }, "description": "设备级的配置字段列表,没有可以不传" } }, "title": "ProtocolInfo", "required": [ "isEnableSyncProduct", "isEnableSyncDevice" ] }, "ProtocolInfoIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "name": { "type": "string" }, "code": { "type": "string" }, "codes": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string", "description": "协议类型: 普通设备(默认):normal 音视频:media" }, "transProtocol": { "type": "string", "description": " 传输协议: mqtt,tcp,udp" } }, "title": "ProtocolInfoIndexReq" }, "ProtocolInfoIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProtocolInfo" }, "description": "自定义协议信息" }, "total": { "type": "integer", "format": "int64", "description": "拥有的总数" } }, "title": "ProtocolInfoIndexResp", "required": [ "list" ] }, "ProtocolScript": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "desc": { "type": "string" }, "triggerDir": { "type": "integer", "format": "int64", "description": "1:up 2:down" }, "triggerTimer": { "type": "integer", "format": "int64", "description": "收到前处理1:before 2:after" }, "triggerHandle": { "type": "string", "description": "对应 mqtt topic的第一个 thing ota config 等等" }, "triggerType": { "type": "string", "description": " 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为" }, "script": { "type": "string", "description": "脚本内容" }, "status": { "type": "integer", "format": "int64", "description": "状态:是否启用" }, "createdTime": { "type": "integer", "format": "int64", "description": "创建时间" } }, "title": "ProtocolScript" }, "ProtocolScriptDebugReq": { "type": "object", "properties": { "triggerDir": { "type": "integer", "format": "int64", "description": "1:up 2:down" }, "triggerTimer": { "type": "integer", "format": "int64", "description": "收到前处理1:before 2:after" }, "script": { "type": "string", "description": "脚本内容" }, "req": { "$ref": "#/definitions/PublishMsg", "description": "请求" }, "resp": { "$ref": "#/definitions/PublishMsg", "description": "回复" } }, "title": "ProtocolScriptDebugReq", "required": [ "triggerDir", "triggerTimer", "script", "req" ] }, "ProtocolScriptDebugResp": { "type": "object", "properties": { "out": { "$ref": "#/definitions/PublishMsg" }, "logs": { "type": "array", "items": { "type": "string" } } }, "title": "ProtocolScriptDebugResp", "required": [ "out", "logs" ] }, "ProtocolScriptDevice": { "type": "object", "properties": { "id": { "type": "string" }, "triggerSrc": { "type": "integer", "format": "int64", "description": "product:1 device:2" }, "productID": { "type": "string" }, "deviceName": { "type": "string" }, "scriptID": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int64", "description": "执行优先级" }, "status": { "type": "integer", "format": "int64", "description": "状态:是否启用" }, "createdTime": { "type": "integer", "format": "int64", "description": "创建时间" }, "script": { "$ref": "#/definitions/ProtocolScript", "description": "只读 脚本信息 withScript传true返回" }, "product": { "$ref": "#/definitions/ProductInfo", "description": "withDevice时,绑定的是产品返回" }, "device": { "$ref": "#/definitions/DeviceInfo", "description": "withDevice时,绑定的是设备返回" } }, "title": "ProtocolScriptDevice" }, "ProtocolScriptDeviceIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "triggerSrc": { "type": "integer", "format": "int64", "description": "product:1 device:2" }, "productID": { "type": "string" }, "deviceName": { "type": "string" }, "status": { "type": "integer", "format": "int64", "description": "状态:是否启用" }, "scriptID": { "type": "string" }, "withScript": { "type": "boolean", "format": "boolean" }, "withDevice": { "type": "boolean", "format": "boolean" } }, "title": "ProtocolScriptDeviceIndexReq" }, "ProtocolScriptDeviceIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProtocolScriptDevice" }, "description": "自定义协议信息" }, "total": { "type": "integer", "format": "int64", "description": "拥有的总数" } }, "title": "ProtocolScriptDeviceIndexResp", "required": [ "list" ] }, "ProtocolScriptIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "name": { "type": "string" }, "triggerDir": { "type": "integer", "format": "int64", "description": "1:up 2:down" }, "triggerTimer": { "type": "integer", "format": "int64", "description": "收到前处理1:before 2:after" }, "triggerHandle": { "type": "string", "description": "对应 mqtt topic的第一个 thing ota config 等等" }, "triggerType": { "type": "string", "description": " 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为" }, "status": { "type": "integer", "format": "int64", "description": "状态:是否启用" } }, "title": "ProtocolScriptIndexReq" }, "ProtocolScriptIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProtocolScript" }, "description": "自定义协议信息" }, "total": { "type": "integer", "format": "int64", "description": "拥有的总数" } }, "title": "ProtocolScriptIndexResp", "required": [ "list" ] }, "ProtocolService": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "code": { "type": "string", "description": "协议code" }, "ip": { "type": "string", "description": " 协议服务的ip地址" }, "port": { "type": "integer", "format": "int64", "description": "监听的端口,如果没有填0即可" }, "status": { "type": "integer", "format": "int64", "description": "服务状态" }, "updatedTime": { "type": "integer", "format": "int64", "description": "更新时间" }, "createdTime": { "type": "integer", "format": "int64", "description": "首次加入时间" } }, "title": "ProtocolService", "required": [ "id", "code", "ip", "port", "status", "updatedTime", "createdTime" ] }, "ProtocolServiceIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo", "description": "分页信息,只获取一个则不填" }, "code": { "type": "string" } }, "title": "ProtocolServiceIndexReq", "required": [ "code" ] }, "ProtocolServiceIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/ProtocolService" }, "description": "自定义协议信息" }, "total": { "type": "integer", "format": "int64", "description": "拥有的总数" } }, "title": "ProtocolServiceIndexResp", "required": [ "list" ] }, "ProtocolSyncDeviceReq": { "type": "object", "properties": { "code": { "type": "string", "description": " 协议code" }, "productID": { "type": "string" } }, "title": "ProtocolSyncDeviceReq", "required": [ "code", "productID" ] }, "ProtocolSyncDeviceResp": { "type": "object", "properties": { "deviceNames": { "type": "array", "items": { "type": "string" }, "description": "同步新增的设备ID列表" } }, "title": "ProtocolSyncDeviceResp", "required": [ "deviceNames" ] }, "PublishMsg": { "type": "object", "properties": { "handle": { "type": "string", "description": "对应 mqtt topic的第一个 thing ota config 等等" }, "type": { "type": "string", "description": "操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为" }, "payload": { "type": "string" }, "timestamp": { "type": "string", "description": "毫秒时间戳" }, "productID": { "type": "string" }, "deviceName": { "type": "string" }, "explain": { "type": "string", "description": "内部使用的拓展字段" }, "protocolCode": { "type": "string", "description": "如果有该字段则回复的时候也会带上该字段" } }, "title": "PublishMsg" }, "SchemaAction": { "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/SchemaParam" }, "description": "调用参数" }, "output": { "type": "array", "items": { "$ref": "#/definitions/SchemaParam" }, "description": "返回参数" } }, "title": "SchemaAction" }, "SchemaDefine": { "type": "object", "properties": { "type": { "type": "string", "description": "参数类型: bool int string float timestamp array enum" }, "mapping": { "type": "object", "description": "枚举及bool类型:bool enum" }, "min": { "type": "string", "description": "数值最小值:int float" }, "max": { "type": "string", "description": "数值最大值:int string float" }, "start": { "type": "string", "description": "初始值:int float" }, "step": { "type": "string", "description": "步长:int float" }, "unit": { "type": "string", "description": "单位:int float" }, "specs": { "type": "array", "items": { "$ref": "#/definitions/SchemaSpec" }, "description": "结构体:" }, "arrayInfo": { "$ref": "#/definitions/SchemaDefine", "description": "数组:array" } }, "title": "SchemaDefine", "required": [ "type" ] }, "SchemaEvent": { "type": "object", "properties": { "type": { "type": "string", "description": "事件类型: 信息:info 告警alert 故障:fault" }, "params": { "type": "array", "items": { "$ref": "#/definitions/SchemaParam" }, "description": "事件参数" } }, "title": "SchemaEvent", "required": [ "type" ] }, "SchemaParam": { "type": "object", "properties": { "identifier": { "type": "string", "description": "参数标识符" }, "name": { "type": "string", "description": "参数名称" }, "define": { "$ref": "#/definitions/SchemaDefine", "description": "参数定义" } }, "title": "SchemaParam", "required": [ "identifier", "name" ] }, "SchemaProperty": { "type": "object", "properties": { "mode": { "type": "string", "description": "读写类型: r(只读) rw(可读可写)" }, "define": { "$ref": "#/definitions/SchemaDefine", "description": "参数定义" } }, "title": "SchemaProperty", "required": [ "define" ] }, "SchemaSpec": { "type": "object", "properties": { "identifier": { "type": "string", "description": "参数标识符" }, "name": { "type": "string", "description": "参数名称" }, "dataType": { "$ref": "#/definitions/SchemaDefine", "description": "参数定义" } }, "title": "SchemaSpec", "required": [ "identifier", "name", "dataType" ] }, "SendOption": { "type": "object", "properties": { "timeoutToFail": { "type": "integer", "format": "int64", "description": "超时失败时间" }, "requestTimeout": { "type": "integer", "format": "int64", "description": "请求超时,超时后会进行重试" }, "retryInterval": { "type": "integer", "format": "int64", "description": "重试间隔" } }, "title": "SendOption" }, "SharePerm": { "type": "object", "properties": { "perm": { "type": "integer", "format": "int64", "default": "3", "description": "2:读写权限 3读权限" } }, "title": "SharePerm" }, "SlotAreaSaveReq": { "type": "object", "properties": { "projectID": { "type": "string", "description": "项目id（只读）" }, "areaID": { "type": "string", "description": "项目区域id（只读）" }, "parentAreaID": { "type": "string", "description": "上级项目区域id（只读）" } }, "title": "SlotAreaSaveReq" }, "SlotUserSubscribe": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object" } }, "title": "SlotUserSubscribe", "required": [ "code", "params" ] }, "SlotUserSubscribeResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/map[string]interface" } } }, "title": "SlotUserSubscribeResp", "required": [ "list" ] }, "Tag": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "title": "Tag", "required": [ "key", "value" ] }, "TimeRange": { "type": "object", "properties": { "start": { "type": "integer", "format": "int64", "description": "开始时间 unix时间戳" }, "end": { "type": "integer", "format": "int64", "description": "结束时间 unix时间戳" } }, "title": "TimeRange" }, "UserCollectDeviceInfo": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceInfo" } } }, "title": "UserCollectDeviceInfo", "required": [ "devices" ] }, "UserCollectDeviceSave": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" } } }, "title": "UserCollectDeviceSave", "required": [ "devices" ] }, "UserCore": { "type": "object", "properties": { "userID": { "type": "string", "description": " 用户id" }, "userName": { "type": "string", "description": " 用户名(唯一)" }, "email": { "type": "string", "description": " 邮箱" }, "phone": { "type": "string", "description": " 手机号" }, "lastIP": { "type": "string", "description": " 最后登录ip" }, "regIP": { "type": "string", "description": " 注册ip" }, "nickName": { "type": "string", "description": " 用户的昵称" }, "headImg": { "type": "string", "description": " 用户头像" }, "createdTime": { "type": "string", "description": " 创建时间" } }, "title": "UserCore" }, "UserDeviceShareIndexReq": { "type": "object", "properties": { "page": { "$ref": "#/definitions/PageInfo" }, "device": { "$ref": "#/definitions/DeviceCore", "description": "设备信息" }, "withUser": { "type": "boolean", "format": "boolean", "description": "同时返回用户信息" } }, "title": "UserDeviceShareIndexReq" }, "UserDeviceShareIndexResp": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/UserDeviceShareInfo" } }, "total": { "type": "integer", "format": "int64" } }, "title": "UserDeviceShareIndexResp" }, "UserDeviceShareInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "projectID": { "type": "string" }, "device": { "$ref": "#/definitions/DeviceCore", "description": "设备信息" }, "sharedUserID": { "type": "string", "description": "分享的对象" }, "sharedUserAccount": { "type": "string" }, "authType": { "type": "integer", "format": "int64", "description": "授权类型:1:全部授权 2:部分授权" }, "schemaPerm": { "type": "object", "description": "普通功能权限 2:读写权限 3读权限" }, "accessPerm": { "type": "object", "description": "系统功能权限 2:读写权限 3读权限" }, "expTime": { "type": "string", "description": "到期时间" }, "user": { "$ref": "#/definitions/UserCore", "description": "只读,传withUser会赋值" }, "createdTime": { "type": "integer", "format": "int64" } }, "title": "UserDeviceShareInfo" }, "UserDeviceShareMultiAcceptInfo": { "type": "object", "properties": { "shareToken": { "type": "string", "description": "分享后的用于生成二维码的字符串" }, "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "批量设备信息" } }, "title": "UserDeviceShareMultiAcceptInfo" }, "UserDeviceShareMultiDeleteReq": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "projectID": { "type": "string" } }, "title": "UserDeviceShareMultiDeleteReq" }, "UserDeviceShareMultiIndexResp": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceShareInfo" }, "description": "批量设备信息" }, "authType": { "type": "integer", "format": "int64", "description": "授权类型:1:全部授权 2:部分授权" }, "schemaPerm": { "type": "object", "description": "普通功能权限 2:读写权限 3读权限" }, "accessPerm": { "type": "object", "description": "系统功能权限 2:读写权限 3读权限" }, "expTime": { "type": "integer", "format": "int64", "description": "到期时间" }, "createdTime": { "type": "integer", "format": "int64" } }, "title": "UserDeviceShareMultiIndexResp" }, "UserDeviceShareMultiInfo": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/definitions/DeviceCore" }, "description": "批量设备信息" }, "authType": { "type": "integer", "format": "int64", "description": "授权类型:1:全部授权 2:部分授权" }, "schemaPerm": { "type": "object", "description": "普通功能权限 2:读写权限 3读权限" }, "accessPerm": { "type": "object", "description": "系统功能权限 2:读写权限 3读权限" }, "expTime": { "type": "integer", "format": "int64", "description": "到期时间" }, "createdTime": { "type": "integer", "format": "int64" } }, "title": "UserDeviceShareMultiInfo" }, "UserDeviceShareMultiToken": { "type": "object", "properties": { "shareToken": { "type": "string" } }, "title": "UserDeviceShareMultiToken" }, "UserDeviceShareReadReq": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "device": { "$ref": "#/definitions/DeviceCore", "description": "设备信息" } }, "title": "UserDeviceShareReadReq" }, "WithID": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": " id" } }, "title": "WithID" }, "WithIDChildren": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": " id" }, "withChildren": { "type": "boolean", "format": "boolean" } }, "title": "WithIDChildren" }, "WithIDOrCode": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": " id" }, "code": { "type": "string" } }, "title": "WithIDOrCode" }, "WithIDStr": { "type": "object", "properties": { "id": { "type": "string", "description": " id" } }, "title": "WithIDStr" }, "WithProfile": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "string" } }, "title": "WithProfile", "required": [ "code", "params" ] } }, "securityDefinitions": { "apiKey": { "type": "apiKey", "description": "Enter JWT Bearer token **_only_**", "name": "Authorization", "in": "header" } } }