{ "components": { "schemas": { "AreaInfo": { "properties": { "areaID": { "description": "项目区域id(只读)", "type": "string" }, "areaName": { "description": "项目区域名称(读写)", "type": "string" }, "projectID": { "description": "项目id(只读)", "type": "string" } }, "title": "AreaInfo", "type": "object" }, "CodeReq": { "properties": { "code": { "type": "string" } }, "required": [ "code" ], "title": "CodeReq", "type": "object" }, "CommonResp": { "properties": { "id": { "description": " id", "format": "int64", "type": "integer" } }, "title": "CommonResp", "type": "object" }, "CommonSchemaDeleteReq": { "properties": { "id": { "description": "产品id", "format": "int64", "type": "integer" } }, "required": [ "id" ], "title": "CommonSchemaDeleteReq", "type": "object" }, "CommonSchemaExportReq": { "properties": { "identifiers": { "items": { "type": "string" }, "type": "array" } }, "title": "CommonSchemaExportReq", "type": "object" }, "CommonSchemaExportResp": { "properties": { "schemas": { "type": "string" } }, "required": [ "schemas" ], "title": "CommonSchemaExportResp", "type": "object" }, "CommonSchemaImportReq": { "properties": { "schemas": { "type": "string" } }, "required": [ "schemas" ], "title": "CommonSchemaImportReq", "type": "object" }, "CommonSchemaIndexReq": { "properties": { "areaID": { "type": "string" }, "areaIDPath": { "description": "过滤区域id路径下有设备的产品", "type": "string" }, "controlMode": { "description": "控制模式: 1: 可以群控,可以单控 2:只能单控", "format": "int64", "type": "integer" }, "funcGroup": { "description": " 功能分类: 1:普通功能 2:系统功能", "format": "int64", "type": "integer" }, "groupID": { "format": "int64", "type": "integer" }, "groupIDs": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "identifier": { "description": "标识符模糊过滤", "type": "string" }, "identifiers": { "description": "过滤标识符列表", "items": { "type": "string" }, "type": "array" }, "isCanSceneLinkage": { "description": "是否可以场景联动", "format": "int64", "type": "integer" }, "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productCategoryID": { "format": "int64", "type": "integer" }, "productCategoryWithFather": { "format": "boolean", "type": "boolean" }, "productIDs": { "description": "提取产品共有的物模型", "items": { "type": "string" }, "type": "array" }, "productSceneMode": { "description": "产品场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)", "type": "string" }, "projectID": { "description": "过滤项目下共有的物模型", "type": "string" }, "propertyMode": { "description": "属性类型可用 读写类型: r(只读) rw(可读可写)", "type": "string" }, "type": { "description": "物模型类型 1:property属性 2:event事件 3:action行为", "format": "int64", "type": "integer" }, "types": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "userPerm": { "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)", "format": "int64", "type": "integer" } }, "title": "CommonSchemaIndexReq", "type": "object" }, "CommonSchemaIndexResp": { "properties": { "list": { "description": "分页信息,只获取一个则不填", "items": { "$ref": "#/components/schemas/CommonSchemaInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "CommonSchemaIndexResp", "type": "object" }, "CommonSchemaInfo": { "properties": { "affordance": { "type": "string" }, "controlMode": { "description": "控制模式: 1: 可以群控,可以单控 2:只能单控", "format": "int64", "type": "integer" }, "desc": { "description": "描述", "type": "string" }, "extendConfig": { "description": "拓展参数", "type": "string" }, "funcGroup": { "description": " 功能分类: 1:普通功能 2:系统功能", "format": "int64", "type": "integer" }, "id": { "description": "产品id", "format": "int64", "type": "integer" }, "identifier": { "description": "标识符", "type": "string" }, "isCanSceneLinkage": { "description": "是否可以场景联动", "format": "int64", "type": "integer" }, "isPassword": { "description": "是否是密码类型,密码类型需要加掩码", "format": "int64", "type": "integer" }, "name": { "description": "功能名称", "type": "string" }, "order": { "description": " 排序", "format": "int64", "type": "integer" }, "recordMode": { "description": " 1(默认) 记录历史记录 2 只记录差异值 3 不记录历史记录", "format": "int64", "type": "integer" }, "required": { "description": "是否必须 1:是 2:否", "format": "int64", "type": "integer" }, "type": { "description": "物模型类型 1:property属性 2:event事件 3:action行为", "format": "int64", "type": "integer" }, "userPerm": { "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)", "format": "int64", "type": "integer" } }, "title": "CommonSchemaInfo", "type": "object" }, "Compare": { "properties": { "castTo": { "description": "参数的类型(填写了会进行数据类型的转换): int float string", "type": "string" }, "cmpType": { "description": "\"=\":相等 \"!=\":不相等 \"\u003e\":大于\"\u003e=\":大于等于\"\u003c\":小于\"\u003c=\":小于等于 \"like\":模糊查询,只有string类型可以使用", "type": "string" }, "value": { "type": "string" } }, "required": [ "cmpType", "value", "castTo" ], "title": "Compare", "type": "object" }, "CompareInt64": { "properties": { "cmpType": { "description": "\"=\":相等 \"!=\":不相等 \"\u003e\":大于\"\u003e=\":大于等于\"\u003c\":小于\"\u003c=\":小于等于 \"like\":模糊查询", "type": "string" }, "value": { "type": "string" } }, "required": [ "cmpType", "value" ], "title": "CompareInt64", "type": "object" }, "CompareString": { "properties": { "cmpType": { "description": "默认为=,\"=\":相等 \"!=\":不相等 \"\u003e\":大于\"\u003e=\":大于等于\"\u003c\":小于\"\u003c=\":小于等于 \"like\":模糊查询", "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ], "title": "CompareString", "type": "object" }, "DateRange": { "properties": { "end": { "description": "结束时间 格式:yyyy-mm-dd", "type": "string" }, "start": { "description": "开始时间 格式:yyyy-mm-dd", "type": "string" } }, "title": "DateRange", "type": "object" }, "DevInit": { "properties": { "areaID": { "description": "设备创建默认分配给的区域ID", "type": "string" }, "deptID": { "description": "设备创建默认分配给的部门", "type": "string" }, "projectID": { "description": "设备创建默认分配给的项目", "type": "string" }, "tenantCode": { "description": "设备创建默认分配给的租户", "type": "string" } }, "title": "DevInit", "type": "object" }, "DeviceAuth5AccessReq": { "properties": { "action": { "description": "操作", "type": "string" }, "clientID": { "description": "clientID", "type": "string" }, "ip": { "description": "访问的ip地址", "type": "string" }, "topic": { "description": "主题", "type": "string" }, "username": { "description": "用户名", "type": "string" } }, "title": "DeviceAuth5AccessReq", "type": "object" }, "DeviceAuth5AccessResp": { "properties": { "result": { "description": "验证结果 \"allow\" | \"deny\" | \"ignore\"", "type": "string" } }, "required": [ "result" ], "title": "DeviceAuth5AccessResp", "type": "object" }, "DeviceAuth5LoginReq": { "properties": { "certificate": { "description": "客户端证书 base64后传过来", "type": "string" }, "clientID": { "description": "clientID", "type": "string" }, "ip": { "description": "访问的ip地址", "type": "string" }, "password": { "description": "密码", "type": "string" }, "username": { "description": "用户名", "type": "string" } }, "required": [ "username", "clientID", "ip" ], "title": "DeviceAuth5LoginReq", "type": "object" }, "DeviceAuth5LoginResp": { "properties": { "is_superuser": { "description": "是否为超级用户,可选 true | false,该项为空时默认为 false", "format": "boolean", "type": "boolean" }, "result": { "description": "验证结果 \"allow\" | \"deny\" | \"ignore\"", "type": "string" } }, "required": [ "result" ], "title": "DeviceAuth5LoginResp", "type": "object" }, "DeviceAuthAccessReq": { "properties": { "access": { "description": "操作", "type": "string" }, "clientID": { "description": "clientID", "type": "string" }, "ip": { "description": "访问的ip地址", "type": "string" }, "topic": { "description": "主题", "type": "string" }, "username": { "description": "用户名", "type": "string" } }, "title": "DeviceAuthAccessReq", "type": "object" }, "DeviceAuthLoginReq": { "properties": { "certificate": { "description": "客户端证书 base64后传过来", "type": "string" }, "clientID": { "description": "clientID", "type": "string" }, "ip": { "description": "访问的ip地址", "type": "string" }, "password": { "description": "密码", "type": "string" }, "username": { "description": "用户名", "type": "string" } }, "required": [ "username", "clientID", "ip" ], "title": "DeviceAuthLoginReq", "type": "object" }, "DeviceAuthRootCheckReq": { "properties": { "certificate": { "description": "客户端证书", "type": "string" }, "clientID": { "description": "clientID", "type": "string" }, "ip": { "description": "访问的ip地址", "type": "string" }, "password": { "description": "密码", "type": "string" }, "username": { "description": "用户名", "type": "string" } }, "title": "DeviceAuthRootCheckReq", "type": "object" }, "DeviceBindTokenInfo": { "properties": { "status": { "description": "token状态 1:初始状态 2: 设备已上报", "format": "int64", "type": "integer" }, "token": { "description": "配网token", "type": "string" } }, "title": "DeviceBindTokenInfo", "type": "object" }, "DeviceBindTokenReadReq": { "properties": { "token": { "description": "配网token", "type": "string" } }, "required": [ "token" ], "title": "DeviceBindTokenReadReq", "type": "object" }, "DeviceCore": { "properties": { "deviceName": { "description": "设备名称", "type": "string" }, "productID": { "description": "产品ID", "type": "string" }, "productName": { "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceCore", "type": "object" }, "DeviceCountInfo": { "properties": { "count": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" }, "rangeID": { "type": "string" } }, "required": [ "rangeID", "count" ], "title": "DeviceCountInfo", "type": "object" }, "DeviceCountReq": { "properties": { "countTypes": { "description": "总数:total,在线设备数:status,设备类型: deviceType", "items": { "type": "string" }, "type": "array" }, "rangeIDs": { "description": "统计的id列表, areaID或者groupID", "items": { "type": "string" }, "type": "array" }, "rangeType": { "description": "0:全部 1:area 2:group", "type": "string" } }, "required": [ "countTypes", "rangeType", "rangeIDs" ], "title": "DeviceCountReq", "type": "object" }, "DeviceCountResp": { "properties": { "list": { "items": { "$ref": "#/components/schemas/DeviceCountInfo" }, "type": "array" } }, "required": [ "list" ], "title": "DeviceCountResp", "type": "object" }, "DeviceError": { "properties": { "code": { "format": "int64", "type": "integer" }, "deviceName": { "description": "设备名称", "type": "string" }, "msg": { "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "title": "DeviceError", "type": "object" }, "DeviceGateWayIndexReq": { "properties": { "gateWayProductID": { "description": "产品ID", "type": "string" }, "gateWaydeviceName": { "description": "设备名称", "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "gateWayProductID", "gateWaydeviceName" ], "title": "DeviceGateWayIndexReq", "type": "object" }, "DeviceGateWayIndexResp": { "properties": { "list": { "description": "分组信息", "items": { "$ref": "#/components/schemas/DeviceInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceGateWayIndexResp", "type": "object" }, "DeviceGateWayMultiCreateReq": { "properties": { "gateWayProductID": { "description": "产品ID", "type": "string" }, "gateWaydeviceName": { "description": "设备名称", "type": "string" }, "list": { "description": "分组tag", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "gateWayProductID", "gateWaydeviceName" ], "title": "DeviceGateWayMultiCreateReq", "type": "object" }, "DeviceGateWayMultiDeleteReq": { "properties": { "gateWayProductID": { "description": "产品ID", "type": "string" }, "gateWaydeviceName": { "description": "设备名称", "type": "string" }, "list": { "description": "分组tag", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "gateWayProductID", "gateWaydeviceName" ], "title": "DeviceGateWayMultiDeleteReq", "type": "object" }, "DeviceGroupMultiSaveReq": { "properties": { "deviceName": { "description": "设备名称", "type": "string" }, "groupIDs": { "items": { "type": "string" }, "type": "array" }, "productID": { "description": "产品id", "type": "string" }, "purpose": { "description": "用途 不填默认为default", "type": "string" } }, "required": [ "productID", "deviceName", "groupIDs" ], "title": "DeviceGroupMultiSaveReq", "type": "object" }, "DeviceInfo": { "properties": { "adcode": { "description": "地区编码", "type": "string" }, "address": { "description": "所在地址", "type": "string" }, "area": { "$ref": "#/components/schemas/AreaInfo" }, "areaID": { "description": "项目区域id 只读", "type": "string" }, "categoryID": { "description": "产品品类", "format": "int64", "type": "integer" }, "cert": { "description": " 设备证书 只读", "type": "string" }, "createdTime": { "description": "创建时间 只读", "type": "string" }, "desc": { "type": "string" }, "deviceAlias": { "description": "设备别名 读写", "type": "string" }, "deviceImg": { "description": "设备图片", "type": "string" }, "deviceName": { "description": "设备名称 读写", "type": "string" }, "deviceType": { "description": "设备类型:1:直连设备,2:网关,3:子设备,4:监控设备", "format": "int64", "type": "integer" }, "distributor": { "$ref": "#/components/schemas/IDPath" }, "expTime": { "description": "到期时间", "type": "string" }, "file": { "description": "设备相关文件", "type": "string" }, "firstBind": { "type": "string" }, "firstLogin": { "description": "激活时间 只读", "type": "string" }, "gateway": { "$ref": "#/components/schemas/DeviceInfo" }, "groupIDs": { "description": "如果要更新分组,必须填写groupPurpose", "items": { "type": "string" }, "type": "array" }, "groupPurpose": { "description": "更新的时候使用,将设备该用途下的分组进行更新", "type": "string" }, "groups": { "description": "所在分组信息,只读", "items": { "$ref": "#/components/schemas/GroupCore" }, "type": "array" }, "hardInfo": { "description": " 模组硬件型号 只读", "type": "string" }, "iccid": { "description": "SIM卡卡号", "type": "string" }, "id": { "format": "int64", "type": "integer" }, "imei": { "description": " IMEI号信息 只读", "type": "string" }, "isEnable": { "description": "是否启用", "format": "int64", "type": "integer" }, "isOnline": { "description": " 在线状态 1离线 2在线 只读", "format": "int64", "maximum": 2, "type": "integer" }, "isUpdateDeviceImg": { "description": "只有这个参数为true的时候才会更新设备图片,传参为设备图片的file path", "format": "boolean", "type": "boolean" }, "isUpdateFile": { "description": "只有这个参数为true的时候才会更新设备文件,传参为设备文件的file path", "format": "boolean", "type": "boolean" }, "lastBind": { "description": "最后绑定时间 只读", "type": "string" }, "lastIp": { "description": "最后登录的ip地址", "type": "string" }, "lastLocalIp": { "description": "最后登录局域网的ip地址", "type": "string" }, "lastLogin": { "description": "最后上线时间 只读", "type": "string" }, "lastOffline": { "description": "最后下线时间 只读", "type": "string" }, "logLevel": { "description": " 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写", "format": "int64", "maximum": 5, "type": "integer" }, "mac": { "description": " MAC号信息 只读", "type": "string" }, "mobileOperator": { "description": "移动运营商:1)移动 2)联通 3)电信 4)广电", "format": "int64", "maximum": 10, "type": "integer" }, "needConfirmVersion": { "description": "待确认升级的版本", "type": "string" }, "netType": { "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE", "format": "int64", "maximum": 10, "type": "integer" }, "owner": { "$ref": "#/components/schemas/UserCore" }, "phone": { "description": "手机号", "type": "string" }, "position": { "$ref": "#/components/schemas/Point" }, "productID": { "description": "产品id 只读", "type": "string" }, "productImg": { "description": "产品图片", "type": "string" }, "productName": { "type": "string" }, "profiles": { "additionalProperties": { "type": "string" }, "type": "object" }, "projectID": { "description": "项目id 只读", "type": "string" }, "protocolConf": { "description": "协议配置", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "ratedPower": { "format": "int64", "type": "integer" }, "rssi": { "description": "信号强度", "format": "int64", "type": "integer" }, "schemaAlias": { "additionalProperties": { "type": "string" }, "description": "设备物模型别名,如果是结构体类型则key为xxx.xxx", "type": "object" }, "secret": { "description": "设备秘钥 只读", "type": "string" }, "softInfo": { "description": " 模组软件版本 只读", "type": "string" }, "sort": { "description": "排序", "format": "int64", "type": "integer" }, "status": { "description": "设备状态 1-未激活,2-在线,3-离线 4-异常(频繁上下线,告警中)", "format": "int64", "type": "integer" }, "subProtocolConf": { "description": "子协议配置", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "tags": { "description": " 设备tag", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "tenantCode": { "type": "string" }, "userID": { "type": "string" }, "version": { "description": " 固件版本 读写", "type": "string" }, "withProperties": { "additionalProperties": { "$ref": "#/components/schemas/DeviceInfoWithProperty" }, "description": "获取的属性列表,如果不传withProperty,则不会返回", "type": "object" } }, "required": [ "productID", "deviceName" ], "title": "DeviceInfo", "type": "object" }, "DeviceInfoBindReq": { "properties": { "areaID": { "type": "string" }, "device": { "$ref": "#/components/schemas/DeviceCore" }, "expand": { "additionalProperties": { "type": "string" }, "description": "拓展字段", "type": "object" }, "token": { "description": "配网token,中绑定需要", "type": "string" } }, "required": [ "device" ], "title": "DeviceInfoBindReq", "type": "object" }, "DeviceInfoCanBindReq": { "properties": { "device": { "$ref": "#/components/schemas/DeviceCore" } }, "required": [ "device" ], "title": "DeviceInfoCanBindReq", "type": "object" }, "DeviceInfoDeleteReq": { "properties": { "deviceName": { "description": "设备名称 读写", "type": "string" }, "productID": { "description": "产品id 只读", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceInfoDeleteReq", "type": "object" }, "DeviceInfoIndexReq": { "properties": { "areaID": { "description": "项目区域ids", "type": "string" }, "areaIDPath": { "description": "区域路径过滤", "type": "string" }, "areaIDPaths": { "description": "区域路径过滤", "items": { "type": "string" }, "type": "array" }, "areaIDs": { "description": "项目区域ids", "items": { "type": "string" }, "type": "array" }, "deviceAlias": { "description": "过滤条件:模糊查询 设备别名", "type": "string" }, "deviceName": { "description": "过滤条件:模糊查询 设备名", "type": "string" }, "deviceNameOrAlias": { "description": "过滤条件:模糊查询 设备名或别名", "type": "string" }, "deviceNames": { "description": "过滤条件:精准查询 设备名", "items": { "type": "string" }, "type": "array" }, "deviceTypes": { "description": "设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "devices": { "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "expTime": { "$ref": "#/components/schemas/CompareInt64" }, "gateway": { "$ref": "#/components/schemas/DeviceCore" }, "groupID": { "type": "string" }, "groupIDPath": { "type": "string" }, "groupIDPaths": { "items": { "type": "string" }, "type": "array" }, "groupIDs": { "items": { "type": "string" }, "type": "array" }, "groupName": { "type": "string" }, "groupPurpose": { "description": "设备分组用途 不填默认为default", "type": "string" }, "hasOwner": { "description": "是否被人拥有,1为是 2为否", "format": "int64", "type": "integer" }, "iccid": { "description": "SIM卡卡号", "type": "string" }, "isOnline": { "description": " 在线状态过滤 1离线 2在线", "format": "int64", "maximum": 2, "type": "integer" }, "isOnlyCore": { "description": "只返回核心信息", "format": "boolean", "type": "boolean" }, "netType": { "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网", "format": "int64", "maximum": 8, "type": "integer" }, "notAreaID": { "type": "string" }, "notGroupID": { "type": "string" }, "notVersion": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "parentGroupID": { "type": "string" }, "position": { "$ref": "#/components/schemas/Point" }, "productCategoryID": { "format": "int64", "type": "integer" }, "productCategoryIDs": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "productID": { "description": "产品id 为空时获取所有产品", "type": "string" }, "productIDs": { "description": "产品id 为空时获取所有产品", "items": { "type": "string" }, "type": "array" }, "property": { "additionalProperties": { "$ref": "#/components/schemas/Compare" }, "description": "设备最新属性过滤,key为属性的id,如果是结构体则key为 aaa.bbb 数组为aaa.1", "type": "object" }, "propertyIgnoreEmpty": { "description": " 设备属性是否忽略空值,空值是否返回", "format": "boolean", "type": "boolean" }, "range": { "description": "过滤条件:距离坐标点固定范围内的设备 单位:米", "format": "int64", "type": "integer" }, "ratedPower": { "$ref": "#/components/schemas/CompareInt64" }, "rssi": { "$ref": "#/components/schemas/CompareInt64" }, "status": { "description": "设备状态 1-未激活,2-在线,3-离线 4-异常(频繁上下线,告警中)", "format": "int64", "type": "integer" }, "statuses": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "tags": { "description": " key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "tenantCode": { "type": "string" }, "userID": { "type": "string" }, "versions": { "items": { "type": "string" }, "type": "array" }, "withArea": { "description": "同时返回区域信息", "format": "boolean", "type": "boolean" }, "withCollect": { "description": " 过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备", "format": "int64", "maximum": 2, "type": "integer" }, "withGateway": { "description": "同时返回子设备绑定的网关信息", "format": "boolean", "type": "boolean" }, "withGroups": { "items": { "type": "string" }, "type": "array" }, "withOwner": { "description": "同时获取拥有人的信息", "format": "boolean", "type": "boolean" }, "withProfiles": { "items": { "type": "string" }, "type": "array" }, "withProperties": { "description": "如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表,如果没有匹配的则不会返回", "items": { "type": "string" }, "type": "array" }, "withShared": { "description": " 过滤分享的设备1: 同时获取分享的设备 2:只获取分享的设备", "format": "int64", "maximum": 2, "type": "integer" } }, "title": "DeviceInfoIndexReq", "type": "object" }, "DeviceInfoIndexResp": { "properties": { "list": { "description": "设备信息", "items": { "$ref": "#/components/schemas/DeviceInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceInfoIndexResp", "type": "object" }, "DeviceInfoMultiBindReq": { "properties": { "areaID": { "type": "string" }, "devices": { "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "devices" ], "title": "DeviceInfoMultiBindReq", "type": "object" }, "DeviceInfoMultiBindResp": { "properties": { "errs": { "items": { "$ref": "#/components/schemas/DeviceError" }, "type": "array" } }, "required": [ "errs" ], "title": "DeviceInfoMultiBindResp", "type": "object" }, "DeviceInfoMultiUpdateReq": { "properties": { "areaID": { "type": "string" }, "devices": { "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "ratedPower": { "format": "int64", "type": "integer" } }, "required": [ "devices" ], "title": "DeviceInfoMultiUpdateReq", "type": "object" }, "DeviceInfoReadReq": { "properties": { "deviceName": { "description": "设备名称 读写", "type": "string" }, "isOnlyCore": { "description": "只返回核心信息", "format": "boolean", "type": "boolean" }, "productID": { "description": "产品id 为空时获取所有产品", "type": "string" }, "propertyIgnoreEmpty": { "description": " 设备属性是否忽略空值,空值是否返回", "format": "boolean", "type": "boolean" }, "withArea": { "description": "同时返回区域信息", "format": "boolean", "type": "boolean" }, "withGateway": { "description": "同时返回子设备绑定的网关信息", "format": "boolean", "type": "boolean" }, "withOwner": { "description": "同时获取拥有人的信息", "format": "boolean", "type": "boolean" }, "withProfiles": { "items": { "type": "string" }, "type": "array" }, "withProperties": { "description": "如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表", "items": { "type": "string" }, "type": "array" } }, "required": [ "deviceName" ], "title": "DeviceInfoReadReq", "type": "object" }, "DeviceInfoSaveReq": { "properties": { "address": { "description": "所在地址", "type": "string" }, "areaID": { "description": "项目区域id 只读(1: root节点 2: 未分类节点 其他:子节点)", "type": "string" }, "deviceAlias": { "description": "设备别名 读写", "type": "string" }, "deviceName": { "description": "设备名称 读写", "type": "string" }, "iccid": { "description": "SIM卡卡号", "type": "string" }, "logLevel": { "description": " 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写", "format": "int64", "maximum": 5, "type": "integer" }, "mobileOperator": { "description": "移动运营商:1)移动 2)联通 3)电信 4)广电", "format": "int64", "maximum": 4, "type": "integer" }, "phone": { "description": "手机号", "type": "string" }, "position": { "$ref": "#/components/schemas/Point" }, "productID": { "description": "产品id 只读", "type": "string" }, "schemaAlias": { "additionalProperties": { "type": "string" }, "description": "设备物模型别名,如果是结构体类型则key为xxx.xxx", "type": "object" }, "tags": { "description": " 设备tag", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "userID": { "description": " 用户id", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceInfoSaveReq", "type": "object" }, "DeviceInfoTransferReq": { "properties": { "areaID": { "description": "转移到项目时指定区域ID", "type": "string" }, "device": { "$ref": "#/components/schemas/DeviceCore" }, "devices": { "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "isCleanData": { "description": "是否清除数据:1是 2否", "format": "int64", "type": "integer" }, "projectID": { "type": "string" }, "srcProjectID": { "description": "指定原来的项目ID,不写使用头", "type": "string" }, "transferTo": { "description": "转让给: 1: 某个人 2: 自己的某个项目", "format": "int64", "type": "integer" }, "userID": { "type": "string" } }, "required": [ "transferTo", "isCleanData" ], "title": "DeviceInfoTransferReq", "type": "object" }, "DeviceInfoUnbindReq": { "properties": { "deviceName": { "description": "设备名称 读写", "type": "string" }, "nonce": { "description": "随机数", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "secretType": { "description": "采用秘钥的类型", "type": "string" }, "signType": { "description": "hmacsha256 hmacsha1 hmacmd5(默认)", "type": "string" }, "signature": { "description": "签名", "type": "string" }, "timestamp": { "description": "秒时间戳", "format": "int64", "type": "integer" } }, "required": [ "productID", "deviceName" ], "title": "DeviceInfoUnbindReq", "type": "object" }, "DeviceInfoWithProperty": { "properties": { "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "value": { "description": "获取到的值", "type": "string" } }, "required": [ "value", "timestamp" ], "title": "DeviceInfoWithProperty", "type": "object" }, "DeviceInteractActionRespReq": { "properties": { "code": { "description": "设备返回状态码", "format": "int64", "type": "integer" }, "deviceName": { "description": "设备名", "type": "string" }, "msg": { "description": "返回状态", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" }, "outputParams": { "description": "输出参数 注意:此字段可能返回 null,表示取不到有效值。", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName", "msgToken", "msg", "code" ], "title": "DeviceInteractActionRespReq", "type": "object" }, "DeviceInteractEdgeSendReq": { "title": "DeviceInteractEdgeSendReq", "type": "object" }, "DeviceInteractEdgeSendResp": { "title": "DeviceInteractEdgeSendResp", "type": "object" }, "DeviceInteractMultiSendPropertyMsg": { "properties": { "code": { "description": "设备返回状态码", "format": "int64", "type": "integer" }, "deviceName": { "description": "设备名", "type": "string" }, "msg": { "description": "返回状态", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "sysCode": { "description": "系统错误码", "format": "int64", "type": "integer" }, "sysMsg": { "description": "系统错误信息", "type": "string" } }, "required": [ "productID", "deviceName", "code", "msg", "msgToken", "sysCode", "sysMsg" ], "title": "DeviceInteractMultiSendPropertyMsg", "type": "object" }, "DeviceInteractMultiSendPropertyReq": { "properties": { "areaID": { "description": "项目区域id,传了优先从项目区域中获取设备列表", "type": "string" }, "areaIDPath": { "description": "根据区域路径控制设备", "type": "string" }, "data": { "description": "属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义", "type": "string" }, "deviceNames": { "description": "设备名列表", "items": { "type": "string" }, "type": "array" }, "devices": { "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "groupID": { "description": "分组ID,传了会从分组下获取设备", "type": "string" }, "isAsync": { "description": "是否异步操作 异步情况通过获取接口来获取", "format": "boolean", "type": "boolean" }, "productID": { "description": "产品id", "type": "string" }, "shadowControl": { "description": "设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发", "format": "int64", "type": "integer" }, "syncTimeout": { "description": "同步超时时间(单位:秒,不填默认3秒)", "format": "int64", "type": "integer" } }, "required": [ "data" ], "title": "DeviceInteractMultiSendPropertyReq", "type": "object" }, "DeviceInteractMultiSendPropertyResp": { "properties": { "list": { "description": "批量设备返回结果列表", "items": { "$ref": "#/components/schemas/DeviceInteractMultiSendPropertyMsg" }, "type": "array" } }, "required": [ "list" ], "title": "DeviceInteractMultiSendPropertyResp", "type": "object" }, "DeviceInteractPropertyGetReportMultiSendReq": { "properties": { "areaID": { "description": "控制一个区域的设备", "type": "string" }, "areaIDPath": { "description": "根据区域路径控制设备", "type": "string" }, "dataIDs": { "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条", "items": { "type": "string" }, "type": "array" }, "deviceNames": { "description": "设备名", "items": { "type": "string" }, "type": "array" }, "devices": { "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "groupID": { "description": "控制一个组的设备", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "title": "DeviceInteractPropertyGetReportMultiSendReq", "type": "object" }, "DeviceInteractPropertyGetReportMultiSendResp": { "properties": { "list": { "description": "批量设备返回结果列表", "items": { "$ref": "#/components/schemas/DeviceInteractPropertyGetReportSendMsg" }, "type": "array" } }, "required": [ "list" ], "title": "DeviceInteractPropertyGetReportMultiSendResp", "type": "object" }, "DeviceInteractPropertyGetReportSendMsg": { "properties": { "code": { "description": "设备返回状态码", "format": "int64", "type": "integer" }, "deviceName": { "description": "设备名", "type": "string" }, "msg": { "description": "返回状态", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" }, "params": { "description": "获取到的值", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "sysCode": { "description": "系统错误码", "format": "int64", "type": "integer" }, "sysMsg": { "description": "系统错误信息", "type": "string" }, "timestamp": { "description": "上报时间戳(毫秒时间戳)", "format": "int64", "type": "integer" } }, "required": [ "code", "msg", "msgToken", "timestamp", "params", "productID", "deviceName", "sysCode", "sysMsg" ], "title": "DeviceInteractPropertyGetReportSendMsg", "type": "object" }, "DeviceInteractPropertyGetReportSendReq": { "properties": { "dataIDs": { "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条", "items": { "type": "string" }, "type": "array" }, "deviceName": { "description": "设备名(必填)", "type": "string" }, "productID": { "description": "产品id (必填)", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceInteractPropertyGetReportSendReq", "type": "object" }, "DeviceInteractPropertyGetReportSendResp": { "properties": { "code": { "description": "设备返回状态码", "format": "int64", "type": "integer" }, "msg": { "description": "返回状态", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" }, "params": { "description": "获取到的值", "type": "string" }, "timestamp": { "description": "上报时间戳(毫秒时间戳)", "format": "int64", "type": "integer" } }, "required": [ "code", "msg", "msgToken", "timestamp", "params" ], "title": "DeviceInteractPropertyGetReportSendResp", "type": "object" }, "DeviceInteractRespReadReq": { "properties": { "deviceName": { "description": "设备名", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName", "msgToken" ], "title": "DeviceInteractRespReadReq", "type": "object" }, "DeviceInteractSendActionReq": { "properties": { "actionID": { "description": "产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义", "type": "string" }, "deviceName": { "description": "设备名", "type": "string" }, "inputParams": { "description": "输入参数", "type": "string" }, "isAsync": { "description": "是否异步操作 异步情况通过获取接口来获取", "format": "boolean", "type": "boolean" }, "option": { "$ref": "#/components/schemas/SendOption" }, "outputParams": { "description": "输出参数(模拟的时候才需要填写) ,如果填写该参数,那么不会下发给设备,直接记录操作记录", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName", "actionID" ], "title": "DeviceInteractSendActionReq", "type": "object" }, "DeviceInteractSendActionResp": { "properties": { "code": { "description": "设备返回状态码", "format": "int64", "type": "integer" }, "msg": { "description": "返回状态", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" }, "outputParams": { "description": "输出参数 注意:此字段可能返回 null,表示取不到有效值。", "type": "string" } }, "required": [ "msgToken", "outputParams", "msg", "code" ], "title": "DeviceInteractSendActionResp", "type": "object" }, "DeviceInteractSendMsgReq": { "properties": { "payload": { "description": "发送的数据", "type": "string" }, "topic": { "description": "发送的topic", "type": "string" } }, "required": [ "topic", "payload" ], "title": "DeviceInteractSendMsgReq", "type": "object" }, "DeviceInteractSendPropertyReq": { "properties": { "data": { "description": "属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义", "type": "string" }, "deviceName": { "description": "设备名", "type": "string" }, "isAsync": { "description": "是否异步操作 异步情况通过获取接口来获取", "format": "boolean", "type": "boolean" }, "productID": { "description": "产品id", "type": "string" }, "shadowControl": { "description": "设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发 3:只修改云端的值 4:只修改云端的值并记录操作日志", "format": "int64", "type": "integer" }, "syncTimeout": { "description": "同步超时时间(单位:秒,不填默认3秒)", "format": "int64", "type": "integer" }, "withProfile": { "$ref": "#/components/schemas/WithProfile" } }, "required": [ "productID", "deviceName", "data" ], "title": "DeviceInteractSendPropertyReq", "type": "object" }, "DeviceInteractSendPropertyResp": { "properties": { "code": { "description": "设备返回状态码", "format": "int64", "type": "integer" }, "msg": { "description": "返回状态", "type": "string" }, "msgToken": { "description": "调用id", "type": "string" } }, "required": [ "code", "msg", "msgToken" ], "title": "DeviceInteractSendPropertyResp", "type": "object" }, "DeviceModuleVersion": { "properties": { "id": { "format": "int64", "type": "integer" }, "moduleCode": { "format": "int64", "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "productName": { "type": "string" }, "version": { "type": "string" } }, "title": "DeviceModuleVersion", "type": "object" }, "DeviceModuleVersionIndexReq": { "properties": { "moduleCode": { "format": "int64", "type": "integer" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id 只读", "type": "string" }, "productName": { "type": "string" } }, "title": "DeviceModuleVersionIndexReq", "type": "object" }, "DeviceModuleVersionIndexResp": { "properties": { "list": { "description": "设备信息", "items": { "$ref": "#/components/schemas/DeviceModuleVersion" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceModuleVersionIndexResp", "type": "object" }, "DeviceModuleVersionReadReq": { "properties": { "id": { "format": "int64", "type": "integer" }, "moduleCode": { "format": "int64", "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "productName": { "type": "string" } }, "title": "DeviceModuleVersionReadReq", "type": "object" }, "DeviceMoveReq": { "properties": { "new": { "$ref": "#/components/schemas/DeviceCore" }, "old": { "$ref": "#/components/schemas/DeviceCore" }, "withTarget": { "description": "设备配置-profile,schemaAlias:profile", "items": { "type": "string" }, "type": "array" } }, "required": [ "old", "new" ], "title": "DeviceMoveReq", "type": "object" }, "DeviceMsgAbnormalLogIndexReq": { "properties": { "action": { "description": "触发1 还是解除2", "format": "int64", "type": "integer" }, "areaID": { "description": "只有管理员有权限", "type": "string" }, "areaIDPath": { "description": "只有管理员有权限", "type": "string" }, "areaIDs": { "description": "只有管理员有权限", "items": { "type": "string" }, "type": "array" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "deviceName": { "description": "设备名", "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productCategoryID": { "description": "只有管理员有权限", "format": "int64", "type": "integer" }, "productID": { "description": "产品id", "type": "string" }, "projectID": { "description": "只有管理员有权限", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" }, "type": { "description": "异常类型", "type": "string" } }, "title": "DeviceMsgAbnormalLogIndexReq", "type": "object" }, "DeviceMsgAbnormalLogIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgAbnormalLogInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgAbnormalLogIndexResp", "type": "object" }, "DeviceMsgAbnormalLogInfo": { "properties": { "action": { "description": "触发1 还是解除2", "format": "int64", "type": "integer" }, "deviceName": { "type": "string" }, "productID": { "type": "string" }, "reason": { "description": "原因", "type": "string" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "traceID": { "description": "服务器端事务id", "type": "string" }, "type": { "description": "异常类型", "type": "string" } }, "title": "DeviceMsgAbnormalLogInfo", "type": "object" }, "DeviceMsgEventLogIndexReq": { "properties": { "dataID": { "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值", "type": "string" }, "deviceNames": { "description": "设备名(不填获取产品下所有设备)", "items": { "type": "string" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" }, "types": { "description": "类型 事件类型: 信息:info 告警alert 故障:fault", "items": { "type": "string" }, "type": "array" } }, "title": "DeviceMsgEventLogIndexReq", "type": "object" }, "DeviceMsgEventLogIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgEventLogInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgEventLogIndexResp", "type": "object" }, "DeviceMsgEventLogInfo": { "properties": { "dataID": { "description": "获取的具体属性值", "type": "string" }, "params": { "description": "获取到的值", "type": "string" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "type": { "description": "类型 事件类型: 信息:info 告警alert 故障:fault", "type": "string" } }, "required": [ "timestamp", "dataID" ], "title": "DeviceMsgEventLogInfo", "type": "object" }, "DeviceMsgHubLogIndexReq": { "properties": { "actions": { "description": "过滤操作类型 connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志", "items": { "type": "string" }, "type": "array" }, "content": { "description": "过滤内容", "type": "string" }, "deviceName": { "description": "设备名", "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" }, "requestID": { "description": "过滤请求ID", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" }, "topics": { "description": "过滤主题", "items": { "type": "string" }, "type": "array" } }, "title": "DeviceMsgHubLogIndexReq", "type": "object" }, "DeviceMsgHubLogIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgHubLogInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgHubLogIndexResp", "type": "object" }, "DeviceMsgHubLogInfo": { "properties": { "action": { "description": "connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志", "type": "string" }, "content": { "type": "string" }, "requestID": { "type": "string" }, "respPayload": { "type": "string" }, "resultCode": { "type": "string" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "topic": { "type": "string" }, "traceID": { "type": "string" } }, "required": [ "timestamp", "action", "requestID", "traceID", "topic", "content", "resultCode", "respPayload" ], "title": "DeviceMsgHubLogInfo", "type": "object" }, "DeviceMsgPropertyAgg": { "properties": { "argFuncs": { "description": "聚合函数 avg:平均值 first:第一个参数 last:最后一个参数 count:总数 twa: 时间加权平均函数 参考: https:docs.taosdata.com/reference/taos-sql/function/#apercentile", "items": { "type": "string" }, "type": "array" }, "dataID": { "description": "获取的具体标识符的数据", "type": "string" }, "fill": { "description": "指定窗口区间数据缺失的情况下的填充模式 参考: https:docs.taosdata.com/reference/taos-sql/distinguished/#fill-%E5%AD%90%E5%8F%A5", "type": "string" }, "noFirstTs": { "description": "时间戳填充不填充最早的值,聚合模式使用", "format": "boolean", "type": "boolean" } }, "required": [ "argFuncs" ], "title": "DeviceMsgPropertyAgg", "type": "object" }, "DeviceMsgPropertyAggByDevice": { "properties": { "argFuncs": { "description": "聚合函数 avg:平均值 first:第一个参数 last:最后一个参数 count:总数 twa: 时间加权平均函数 参考: https:docs.taosdata.com/reference/taos-sql/function/#apercentile", "items": { "type": "string" }, "type": "array" }, "dataID": { "description": "获取的具体标识符的数据", "type": "string" }, "device": { "$ref": "#/components/schemas/DeviceCore" }, "fill": { "description": "指定窗口区间数据缺失的情况下的填充模式 参考: https:docs.taosdata.com/reference/taos-sql/distinguished/#fill-%E5%AD%90%E5%8F%A5", "type": "string" }, "noFirstTs": { "description": "时间戳填充不填充最早的值,聚合模式使用", "format": "boolean", "type": "boolean" } }, "required": [ "device", "argFuncs" ], "title": "DeviceMsgPropertyAggByDevice", "type": "object" }, "DeviceMsgPropertyAggByDeviceIndexReq": { "properties": { "aggs": { "description": "聚合对象", "items": { "$ref": "#/components/schemas/DeviceMsgPropertyAggByDevice" }, "type": "array" }, "interval": { "description": "间隔 如果这个值不为零值 则时间的开始和结束必须有效及聚合函数不应该为空", "format": "int64", "type": "integer" }, "intervalUnit": { "description": "间隔单位 a (毫秒,默认), d (天), h (小时), m (分钟), n (月), s (秒), u (微秒), w (周), y (年) 则时间的开始和结束必须有效及聚合函数不应该为空", "type": "string" }, "partitionBy": { "description": "切分数据,可以填写deviceName", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" } }, "required": [ "aggs" ], "title": "DeviceMsgPropertyAggByDeviceIndexReq", "type": "object" }, "DeviceMsgPropertyAggCore": { "properties": { "argFuncs": { "description": "聚合函数 avg:平均值 first:第一个参数 last:最后一个参数 count:总数 twa: 时间加权平均函数 参考: https:docs.taosdata.com/reference/taos-sql/function/#apercentile", "items": { "type": "string" }, "type": "array" }, "dataID": { "description": "获取的具体标识符的数据", "type": "string" } }, "required": [ "argFuncs" ], "title": "DeviceMsgPropertyAggCore", "type": "object" }, "DeviceMsgPropertyIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgPropertyLogInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgPropertyIndexResp", "type": "object" }, "DeviceMsgPropertyLatestAggIndexReq": { "properties": { "aggs": { "description": "聚合对象", "items": { "$ref": "#/components/schemas/DeviceMsgPropertyAgg" }, "type": "array" }, "areaID": { "description": "只有管理员有权限", "type": "string" }, "areaIDPath": { "description": "只有管理员有权限", "type": "string" }, "areaIDs": { "description": "只有管理员有权限", "items": { "type": "string" }, "type": "array" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "deviceName": { "description": "设备名(不填获取产品下所有设备)", "type": "string" }, "deviceNames": { "description": "设备名(不填获取产品下所有设备,只有管理员有权限)", "items": { "type": "string" }, "type": "array" }, "partitionBy": { "description": "切分数据,可以填写deviceName", "type": "string" }, "productCategoryID": { "description": "产品品类id,通用物模型有效", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" }, "projectID": { "description": "只有管理员有权限", "type": "string" }, "tenantCode": { "description": "只有管理员有权限", "type": "string" } }, "required": [ "aggs" ], "title": "DeviceMsgPropertyLatestAggIndexReq", "type": "object" }, "DeviceMsgPropertyLatestAggIndexResp": { "properties": { "list": { "items": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestAggResp" }, "type": "array" } }, "required": [ "list" ], "title": "DeviceMsgPropertyLatestAggIndexResp", "type": "object" }, "DeviceMsgPropertyLatestAggResp": { "properties": { "areaID": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "areaIDPath": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "areaIDs": { "description": "只有partitionBy 传该参数的时候才会返回", "items": { "type": "string" }, "type": "array" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "deviceName": { "description": "设备名称", "type": "string" }, "productID": { "type": "string" }, "projectID": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "tenantCode": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "values": { "items": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestAggRespDetail" }, "type": "array" } }, "required": [ "values" ], "title": "DeviceMsgPropertyLatestAggResp", "type": "object" }, "DeviceMsgPropertyLatestAggRespDetail": { "properties": { "dataID": { "description": "属性ID", "type": "string" }, "dataName": { "description": "属性名称", "type": "string" }, "values": { "additionalProperties": { "type": "string" }, "description": "key是聚合函数", "type": "object" } }, "required": [ "dataID", "dataName", "values" ], "title": "DeviceMsgPropertyLatestAggRespDetail", "type": "object" }, "DeviceMsgPropertyLatestIndexReq": { "properties": { "dataIDs": { "description": "获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值", "items": { "type": "string" }, "type": "array" }, "deviceName": { "description": "设备名", "type": "string" }, "ignoreEmpty": { "description": " 设备属性是否忽略空值,空值是否返回", "format": "boolean", "type": "boolean" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" } }, "title": "DeviceMsgPropertyLatestIndexReq", "type": "object" }, "DeviceMsgPropertyLogAggIndexReq": { "properties": { "aggs": { "description": "聚合对象", "items": { "$ref": "#/components/schemas/DeviceMsgPropertyAgg" }, "type": "array" }, "areaID": { "description": "只有管理员有权限", "type": "string" }, "areaIDPath": { "description": "只有管理员有权限", "type": "string" }, "areaIDs": { "description": "只有管理员有权限", "items": { "type": "string" }, "type": "array" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "deviceName": { "description": "设备名(不填获取产品下所有设备)", "type": "string" }, "deviceNames": { "description": "设备名(不填获取产品下所有设备,只有管理员有权限)", "items": { "type": "string" }, "type": "array" }, "interval": { "description": "间隔 如果这个值不为零值 则时间的开始和结束必须有效及聚合函数不应该为空", "format": "int64", "type": "integer" }, "intervalUnit": { "description": "间隔单位 a (毫秒,默认), d (天), h (小时), m (分钟), n (月), s (秒), u (微秒), w (周), y (年) 则时间的开始和结束必须有效及聚合函数不应该为空", "type": "string" }, "partitionBy": { "description": "切分数据,可以填写deviceName", "type": "string" }, "productCategoryID": { "description": "产品品类id,通用物模型有效", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" }, "projectID": { "description": "只有管理员有权限", "type": "string" }, "tenantCode": { "description": "只有管理员有权限", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" } }, "required": [ "interval", "aggs" ], "title": "DeviceMsgPropertyLogAggIndexReq", "type": "object" }, "DeviceMsgPropertyLogAggIndexResp": { "properties": { "list": { "items": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggResp" }, "type": "array" } }, "required": [ "list" ], "title": "DeviceMsgPropertyLogAggIndexResp", "type": "object" }, "DeviceMsgPropertyLogAggResp": { "properties": { "areaID": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "areaIDPath": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "areaIDs": { "description": "只有partitionBy 传该参数的时候才会返回", "items": { "type": "string" }, "type": "array" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "deviceName": { "description": "设备名称", "type": "string" }, "productID": { "type": "string" }, "projectID": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "tenantCode": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "values": { "items": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggRespDetail" }, "type": "array" } }, "required": [ "values" ], "title": "DeviceMsgPropertyLogAggResp", "type": "object" }, "DeviceMsgPropertyLogAggRespDataDetail": { "properties": { "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "value": { "description": "获取到的值", "type": "string" } }, "title": "DeviceMsgPropertyLogAggRespDataDetail", "type": "object" }, "DeviceMsgPropertyLogAggRespDetail": { "properties": { "dataID": { "description": "属性ID", "type": "string" }, "dataName": { "description": "属性名称", "type": "string" }, "timeWindow": { "description": "发生时间窗口", "type": "string" }, "values": { "additionalProperties": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggRespDataDetail" }, "description": "key是聚合函数", "type": "object" } }, "required": [ "dataID", "dataName", "timeWindow", "values" ], "title": "DeviceMsgPropertyLogAggRespDetail", "type": "object" }, "DeviceMsgPropertyLogIndexReq": { "properties": { "areaID": { "description": "只有管理员有权限", "type": "string" }, "areaIDPath": { "description": "只有管理员有权限", "type": "string" }, "areaIDs": { "description": "只有管理员有权限", "items": { "type": "string" }, "type": "array" }, "argFunc": { "description": "聚合函数 avg:平均值 first:第一个参数 last:最后一个参数 count:总数 twa: 时间加权平均函数 参考: https:docs.taosdata.com/reference/taos-sql/function/#apercentile", "type": "string" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "dataID": { "description": "获取的具体标识符的数据", "type": "string" }, "deviceName": { "description": "设备名(不填获取产品下所有设备)", "type": "string" }, "deviceNames": { "description": "设备名(不填获取产品下所有设备,只有管理员有权限)", "items": { "type": "string" }, "type": "array" }, "fill": { "description": "指定窗口区间数据缺失的情况下的填充模式 参考: https:docs.taosdata.com/reference/taos-sql/distinguished/#fill-%E5%AD%90%E5%8F%A5", "type": "string" }, "interval": { "description": "间隔 如果这个值不为零值 则时间的开始和结束必须有效及聚合函数不应该为空", "format": "int64", "type": "integer" }, "intervalUnit": { "description": "间隔单位 a (毫秒,默认), d (天), h (小时), m (分钟), n (月), s (秒), u (微秒), w (周), y (年) 则时间的开始和结束必须有效及聚合函数不应该为空", "type": "string" }, "noFirstTs": { "description": "时间戳填充不填充最早的值,聚合模式使用", "format": "boolean", "type": "boolean" }, "order": { "description": "时间排序 1:aes(默认,从久到近排序) 2:desc(时间从近到久排序)", "format": "int64", "type": "integer" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "partitionBy": { "description": "切分数据,可以填写deviceName", "type": "string" }, "productCategoryID": { "description": "产品品类id,通用物模型有效", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" }, "projectID": { "description": "只有管理员有权限", "type": "string" }, "tenantCode": { "description": "只有管理员有权限", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" } }, "title": "DeviceMsgPropertyLogIndexReq", "type": "object" }, "DeviceMsgPropertyLogInfo": { "properties": { "areaID": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "areaIDPath": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "areaIDs": { "description": "只有partitionBy 传该参数的时候才会返回", "items": { "type": "string" }, "type": "array" }, "belongGroup": { "additionalProperties": { "$ref": "#/components/schemas/IDsInfo" }, "description": "key是group的purpose, value是里面包含的分组id 只有partitionBy 传该参数的时候才会返回", "type": "object" }, "dataID": { "description": "属性ID", "type": "string" }, "dataName": { "description": "属性名称", "type": "string" }, "deviceName": { "description": "设备名称", "type": "string" }, "projectID": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "tenantCode": { "description": "只有partitionBy 传该参数的时候才会返回", "type": "string" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "value": { "description": "获取到的值", "type": "string" } }, "required": [ "timestamp", "dataID", "dataName" ], "title": "DeviceMsgPropertyLogInfo", "type": "object" }, "DeviceMsgPropertyLogMultiIndexReq": { "properties": { "reqs": { "items": { "$ref": "#/components/schemas/DeviceMsgPropertyLogIndexReq" }, "type": "array" } }, "required": [ "reqs" ], "title": "DeviceMsgPropertyLogMultiIndexReq", "type": "object" }, "DeviceMsgPropertyMultiIndexResp": { "properties": { "lists": { "description": "数据", "items": { "items": { "format": "UNKNOWN", "type": "invalid" }, "type": "array" }, "type": "array" } }, "required": [ "lists" ], "title": "DeviceMsgPropertyMultiIndexResp", "type": "object" }, "DeviceMsgSdkIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgSdkInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgSdkIndexResp", "type": "object" }, "DeviceMsgSdkInfo": { "properties": { "content": { "description": "具体内容", "type": "string" }, "loglevel": { "description": "日志级别 1)关闭 2)错误 3)告警 4)信息 5)调试", "format": "int64", "type": "integer" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" } }, "required": [ "timestamp", "loglevel", "content" ], "title": "DeviceMsgSdkInfo", "type": "object" }, "DeviceMsgSdkLogIndexReq": { "properties": { "deviceName": { "description": "设备名", "type": "string" }, "logLevel": { "description": "等级", "format": "int32", "type": "integer" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id 获取产品id下的所有设备信息", "type": "string" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" } }, "title": "DeviceMsgSdkLogIndexReq", "type": "object" }, "DeviceMsgSendLogIndexReq": { "properties": { "actions": { "items": { "type": "string" }, "type": "array" }, "areaID": { "description": "只有管理员有权限", "type": "string" }, "areaIDPath": { "description": "只有管理员有权限", "type": "string" }, "areaIDs": { "description": "只有管理员有权限", "items": { "type": "string" }, "type": "array" }, "dataID": { "description": "模糊查询", "type": "string" }, "dataIDs": { "description": "精确查询", "items": { "type": "string" }, "type": "array" }, "deviceName": { "description": "设备名", "type": "string" }, "groupIDPaths": { "description": "只有管理员有权限", "items": { "type": "string" }, "type": "array" }, "groupIDs": { "description": "只有管理员有权限", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productCategoryID": { "description": "只有管理员有权限", "format": "int64", "type": "integer" }, "productID": { "description": "产品id", "type": "string" }, "projectID": { "description": "只有管理员有权限", "type": "string" }, "resultCode": { "description": "请求结果状态,200为成功", "format": "int64", "type": "integer" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" }, "userID": { "type": "string" }, "withUser": { "description": "同时返回用户信息", "format": "boolean", "type": "boolean" } }, "title": "DeviceMsgSendLogIndexReq", "type": "object" }, "DeviceMsgSendLogIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgSendLogInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgSendLogIndexResp", "type": "object" }, "DeviceMsgSendLogInfo": { "properties": { "account": { "type": "string" }, "action": { "description": "操作类型 propertySend:属性控制 actionSend:操作控制 propertyGetReportSend:获取最新属性请求", "type": "string" }, "content": { "description": "操作的内容", "type": "string" }, "dataID": { "description": "identify", "type": "string" }, "deviceName": { "type": "string" }, "productID": { "type": "string" }, "resultCode": { "description": "请求结果状态,200为成功", "format": "int64", "type": "integer" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" }, "traceID": { "description": "服务器端事务id", "type": "string" }, "user": { "$ref": "#/components/schemas/UserCore" }, "userID": { "type": "string" } }, "title": "DeviceMsgSendLogInfo", "type": "object" }, "DeviceMsgShadowIndex": { "properties": { "dataID": { "description": "属性id", "type": "string" }, "updatedDeviceTime": { "description": "更新到设备的时间", "format": "int64", "type": "integer" }, "value": { "description": "获取到的值", "type": "string" } }, "required": [ "dataID", "value", "updatedDeviceTime" ], "title": "DeviceMsgShadowIndex", "type": "object" }, "DeviceMsgShadowIndexResp": { "properties": { "list": { "items": { "$ref": "#/components/schemas/DeviceMsgShadowIndex" }, "type": "array" } }, "required": [ "list" ], "title": "DeviceMsgShadowIndexResp", "type": "object" }, "DeviceMsgStatusLogIndexReq": { "properties": { "deviceName": { "description": "设备名", "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id", "type": "string" }, "status": { "description": "在线状态", "format": "int64", "type": "integer" }, "timeEnd": { "description": "时间的结束(毫秒时间戳)", "type": "string" }, "timeStart": { "description": "获取时间的开始(毫秒时间戳)", "type": "string" } }, "title": "DeviceMsgStatusLogIndexReq", "type": "object" }, "DeviceMsgStatusLogIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/DeviceMsgStatusLogInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceMsgStatusLogIndexResp", "type": "object" }, "DeviceMsgStatusLogInfo": { "properties": { "deviceName": { "type": "string" }, "productID": { "type": "string" }, "status": { "description": "过滤请求ID", "format": "int64", "type": "integer" }, "timestamp": { "description": "发生时间戳(毫秒时间戳)", "type": "string" } }, "title": "DeviceMsgStatusLogInfo", "type": "object" }, "DeviceMultiImportErrdata": { "properties": { "msg": { "description": "详细错误信息", "type": "string" }, "row": { "description": "错误所在表格行", "format": "int64", "type": "integer" } }, "required": [ "row", "msg" ], "title": "DeviceMultiImportErrdata", "type": "object" }, "DeviceMultiImportReq": { "title": "DeviceMultiImportReq", "type": "object" }, "DeviceMultiImportResp": { "properties": { "errdata": { "description": "批量导入错误清单", "items": { "$ref": "#/components/schemas/DeviceMultiImportRow" }, "type": "array" }, "headers": { "$ref": "#/components/schemas/DeviceMultiImportRow" }, "total": { "description": "当前表格数据量", "format": "int64", "type": "integer" } }, "required": [ "total", "headers", "errdata" ], "title": "DeviceMultiImportResp", "type": "object" }, "DeviceMultiImportRow": { "properties": { "address": { "description": "【选填】设备所在详细地址", "type": "string" }, "deviceAlias": { "description": "【选填】设备别名", "type": "string" }, "deviceName": { "description": "【必填】设备名称", "type": "string" }, "gatewayDeviceName": { "description": "【选填】绑定的网关设备ID", "type": "string" }, "gatewayProductID": { "description": "【选填】绑定的网关产品ID(网关的设备ID全局唯一可不填)", "type": "string" }, "logLevel": { "description": "【选填】日志级别(关闭/错误/告警/信息/调试)", "type": "string" }, "position": { "description": "【选填】设备位置百度坐标(格式:经,纬)", "type": "string" }, "productID": { "description": "【必填】产品ID", "type": "string" }, "row": { "description": "【提示】数据所在表格行", "format": "int64", "type": "integer" }, "secret": { "description": "【选填】设备秘钥", "type": "string" }, "tags": { "description": "【选填】设备标签(格式k1:v1;k2:v2;...)", "type": "string" }, "tips": { "description": "【提示】模板使用提示", "type": "string" } }, "required": [ "row", "productID", "deviceName", "deviceAlias", "secret", "gatewayProductID", "gatewayDeviceName", "logLevel", "tags", "position", "address", "tips" ], "title": "DeviceMultiImportRow", "type": "object" }, "DeviceMultiUpdateImportError": { "properties": { "code": { "format": "int64", "type": "integer" }, "device": { "$ref": "#/components/schemas/DeviceCore" }, "msg": { "type": "string" } }, "required": [ "device", "code", "msg" ], "title": "DeviceMultiUpdateImportError", "type": "object" }, "DeviceMultiUpdateImportReq": { "title": "DeviceMultiUpdateImportReq", "type": "object" }, "DeviceMultiUpdateImportResp": { "properties": { "errCount": { "description": "失败数", "format": "int64", "type": "integer" }, "errDetail": { "description": "失败详情", "items": { "$ref": "#/components/schemas/DeviceMultiUpdateImportError" }, "type": "array" }, "ignoreCount": { "description": "忽略数", "format": "int64", "type": "integer" }, "succCount": { "description": "成功数", "format": "int64", "type": "integer" }, "total": { "description": "导入总接口数", "format": "int64", "type": "integer" } }, "required": [ "total", "errCount", "errDetail", "ignoreCount", "succCount" ], "title": "DeviceMultiUpdateImportResp", "type": "object" }, "DeviceOtaUpgradeReq": { "properties": { "deviceName": { "description": " 设备名称", "type": "string" }, "productID": { "description": " 产品ID", "type": "string" }, "version": { "description": " 当前版本,如果和设备的当前版本不一致,会更新设备的版本,如果和固件的版本一致,这个固件的升级进度会变成成功", "type": "string" } }, "required": [ "productID", "deviceName", "version" ], "title": "DeviceOtaUpgradeReq", "type": "object" }, "DeviceOtaUpgradeResp": { "properties": { "firmware": { "$ref": "#/components/schemas/OtaUpgradeData" } }, "required": [ "firmware" ], "title": "DeviceOtaUpgradeResp", "type": "object" }, "DevicePairConfirmReq": { "properties": { "areaID": { "type": "string" }, "deviceName": { "type": "string" }, "grantToken": { "type": "string" }, "mac": { "type": "string" }, "pairAckPayload": { "type": "string" }, "productID": { "type": "string" } }, "required": [ "productID", "mac", "grantToken", "pairAckPayload" ], "title": "DevicePairConfirmReq", "type": "object" }, "DevicePairConfirmResp": { "properties": { "bindEpoch": { "format": "int64", "type": "integer" }, "blePairKey": { "type": "string" }, "bleSecVer": { "format": "int64", "type": "integer" }, "deviceName": { "type": "string" }, "mac": { "type": "string" }, "message": { "type": "string" }, "productID": { "type": "string" } }, "required": [ "productID", "mac", "deviceName", "bindEpoch", "bleSecVer", "blePairKey", "message" ], "title": "DevicePairConfirmResp", "type": "object" }, "DevicePairGrantReq": { "properties": { "deviceName": { "type": "string" }, "mac": { "type": "string" }, "observedBindEpoch": { "format": "int64", "type": "integer" }, "productID": { "type": "string" } }, "required": [ "productID", "mac" ], "title": "DevicePairGrantReq", "type": "object" }, "DevicePairGrantResp": { "properties": { "authTag": { "type": "string" }, "deviceName": { "type": "string" }, "grantToken": { "type": "string" }, "mac": { "type": "string" }, "nonce": { "type": "string" }, "productID": { "type": "string" }, "ttlSec": { "format": "int64", "type": "integer" } }, "required": [ "productID", "mac", "deviceName", "grantToken", "nonce", "authTag", "ttlSec" ], "title": "DevicePairGrantResp", "type": "object" }, "DeviceProfile": { "properties": { "code": { "type": "string" }, "device": { "$ref": "#/components/schemas/DeviceCore" }, "params": { "type": "string" } }, "required": [ "device", "code", "params" ], "title": "DeviceProfile", "type": "object" }, "DeviceProfileIndexReq": { "properties": { "codes": { "items": { "type": "string" }, "type": "array" }, "device": { "$ref": "#/components/schemas/DeviceCore" } }, "required": [ "device" ], "title": "DeviceProfileIndexReq", "type": "object" }, "DeviceProfileIndexResp": { "properties": { "profiles": { "items": { "$ref": "#/components/schemas/DeviceProfile" }, "type": "array" } }, "title": "DeviceProfileIndexResp", "type": "object" }, "DeviceProfileReadReq": { "properties": { "code": { "type": "string" }, "device": { "$ref": "#/components/schemas/DeviceCore" } }, "required": [ "device", "code" ], "title": "DeviceProfileReadReq", "type": "object" }, "DeviceRegisterReq": { "properties": { "deviceName": { "description": "设备名称 读写", "type": "string" }, "nonce": { "description": "随机数", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "signature": { "description": "签名信息", "type": "string" }, "timestamp": { "description": "秒级时间戳", "format": "int64", "type": "integer" } }, "required": [ "productID", "deviceName", "nonce", "timestamp", "signature" ], "title": "DeviceRegisterReq", "type": "object" }, "DeviceRegisterResp": { "properties": { "len": { "description": "payload加密前信息的长度", "format": "int64", "type": "integer" }, "payload": { "type": "string" } }, "required": [ "len", "payload" ], "title": "DeviceRegisterResp", "type": "object" }, "DeviceSchema": { "properties": { "affordance": { "type": "string" }, "controlMode": { "description": "控制模式: 1: 可以群控,可以单控 2:只能单控", "format": "int64", "type": "integer" }, "desc": { "description": "描述", "type": "string" }, "deviceName": { "type": "string" }, "extendConfig": { "description": "拓展参数", "type": "string" }, "funcGroup": { "description": " 功能分类: 1:普通功能 2:系统功能", "format": "int64", "type": "integer" }, "identifier": { "description": "标识符", "type": "string" }, "isCanSceneLinkage": { "description": "是否可以场景联动", "format": "int64", "type": "integer" }, "isPassword": { "description": "是否是密码类型,密码类型需要加掩码", "format": "int64", "type": "integer" }, "name": { "description": "功能名称", "type": "string" }, "order": { "description": " 排序", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "recordMode": { "description": " 1(默认) 记录历史记录 2 只记录差异值 3 不记录历史记录", "format": "int64", "type": "integer" }, "required": { "description": "是否必须 1:是 2:否", "format": "int64", "type": "integer" }, "tag": { "description": "物模型标签 1:自定义 2:可选 3:必选 必选不可删除", "format": "int64", "type": "integer" }, "type": { "description": "物模型类型 1:property属性 2:event事件 3:action行为", "format": "int64", "type": "integer" }, "userPerm": { "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)", "format": "int64", "type": "integer" } }, "required": [ "type", "tag", "identifier" ], "title": "DeviceSchema", "type": "object" }, "DeviceSchemaDeleteReq": { "properties": { "deviceName": { "type": "string" }, "identifier": { "description": "标识符", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName", "identifier" ], "title": "DeviceSchemaDeleteReq", "type": "object" }, "DeviceSchemaIndexReq": { "properties": { "controlMode": { "description": "控制模式: 1: 可以群控,可以单控 2:只能单控", "format": "int64", "type": "integer" }, "deviceName": { "type": "string" }, "funcGroup": { "description": " 功能分类: 1:普通功能 2:系统功能", "format": "int64", "type": "integer" }, "identifier": { "description": "标识符模糊过滤", "type": "string" }, "identifiers": { "description": "过滤标识符列表", "items": { "type": "string" }, "type": "array" }, "isCanSceneLinkage": { "description": "是否可以场景联动", "format": "int64", "type": "integer" }, "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id", "type": "string" }, "propertyMode": { "description": "属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)", "type": "string" }, "tag": { "description": "过滤条件: 物模型标签 1:自定义 2:可选 3:必选", "format": "int64", "type": "integer" }, "type": { "description": "物模型类型 1:property属性 2:event事件 3:action行为", "format": "int64", "type": "integer" }, "types": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "userPerm": { "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)", "format": "int64", "type": "integer" }, "withProductSchema": { "description": "同时获取产品物模型", "format": "boolean", "type": "boolean" } }, "required": [ "productID", "deviceName" ], "title": "DeviceSchemaIndexReq", "type": "object" }, "DeviceSchemaIndexResp": { "properties": { "list": { "description": "分页信息,只获取一个则不填", "items": { "$ref": "#/components/schemas/DeviceSchema" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "DeviceSchemaIndexResp", "type": "object" }, "DeviceSchemaMultiCreateReq": { "properties": { "deviceName": { "type": "string" }, "identifiers": { "description": "导入的标识符列表", "items": { "type": "string" }, "type": "array" }, "list": { "description": "如果没有填标识符列表取这里", "items": { "$ref": "#/components/schemas/DeviceSchema" }, "type": "array" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceSchemaMultiCreateReq", "type": "object" }, "DeviceSchemaMultiDeleteReq": { "properties": { "deviceName": { "type": "string" }, "identifiers": { "description": "物模型ID列表", "items": { "type": "string" }, "type": "array" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName", "identifiers" ], "title": "DeviceSchemaMultiDeleteReq", "type": "object" }, "DeviceSchemaTslReadReq": { "properties": { "deviceName": { "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceSchemaTslReadReq", "type": "object" }, "DeviceSchemaTslReadResp": { "properties": { "tsl": { "description": "物模型tsl", "type": "string" } }, "required": [ "tsl" ], "title": "DeviceSchemaTslReadResp", "type": "object" }, "DeviceSchemaUpdateReq": { "properties": { "": { "$ref": "#/components/schemas/DeviceSchema" } }, "title": "DeviceSchemaUpdateReq", "type": "object" }, "DeviceShareInfo": { "properties": { "deviceAlias": { "description": "设备别名 读写", "type": "string" }, "deviceName": { "description": "设备名称", "type": "string" }, "productID": { "description": "产品ID", "type": "string" }, "productImg": { "description": "产品图片", "type": "string" }, "productName": { "type": "string" }, "useBy": { "description": "用途", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "DeviceShareInfo", "type": "object" }, "FileCore": { "properties": { "isUpdate": { "description": "如果要更新该文件,则需要将该参数置为true", "format": "boolean", "type": "boolean" }, "path": { "description": "文件的路径", "type": "string" } }, "title": "FileCore", "type": "object" }, "FirmwareCreateReq": { "properties": { "desc": { "type": "string" }, "extra": { "type": "string" }, "filePaths": { "items": { "type": "string" }, "type": "array" }, "isDiff": { "format": "int64", "type": "integer" }, "isNeedToVerify": { "format": "int64", "type": "integer" }, "moduleCode": { "type": "string" }, "name": { "type": "string" }, "productID": { "type": "string" }, "signMethod": { "type": "string" }, "srcVersion": { "type": "string" }, "version": { "type": "string" } }, "required": [ "productID", "name", "version", "signMethod", "isDiff", "srcVersion", "isNeedToVerify", "filePaths" ], "title": "FirmwareCreateReq", "type": "object" }, "FirmwareFile": { "properties": { "fileMd5": { "type": "string" }, "filePath": { "type": "string" }, "name": { "type": "string" }, "signature": { "type": "string" } }, "required": [ "name", "filePath", "fileMd5", "signature" ], "title": "FirmwareFile", "type": "object" }, "FirmwareIndexReq": { "properties": { "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "type": "string" } }, "title": "FirmwareIndexReq", "type": "object" }, "FirmwareIndexResp": { "properties": { "list": { "items": { "$ref": "#/components/schemas/FirmwareInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "FirmwareIndexResp", "type": "object" }, "FirmwareInfo": { "properties": { "createdTime": { "description": "添加时间", "format": "int64", "type": "integer" }, "desc": { "description": "文件描述", "type": "string" }, "extra": { "description": "推给设备端端消息", "type": "string" }, "fileList": { "description": "文件列表", "items": { "$ref": "#/components/schemas/FirmwareFile" }, "type": "array" }, "id": { "description": "固件id", "format": "int64", "type": "integer" }, "isDiff": { "description": "整包or差包", "format": "int64", "type": "integer" }, "isNeedToVerify": { "description": "是否需要验证", "format": "int64", "type": "integer" }, "moduleCode": { "description": "模块编码", "type": "string" }, "name": { "description": "固件升级包名称", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "productName": { "description": "产品名称", "type": "string" }, "signMethod": { "description": "签名方式:MD5/SHA256", "type": "string" }, "status": { "description": "状态", "format": "int64", "type": "integer" }, "version": { "description": "版本号", "type": "string" } }, "required": [ "id", "name", "version", "productID", "productName", "status", "createdTime", "signMethod", "desc", "extra", "isDiff", "isNeedToVerify", "moduleCode", "fileList" ], "title": "FirmwareInfo", "type": "object" }, "FirmwareUpdateReq": { "properties": { "desc": { "type": "string" }, "extra": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" } }, "required": [ "id" ], "title": "FirmwareUpdateReq", "type": "object" }, "GatewayCanBindIndexReq": { "properties": { "gateway": { "$ref": "#/components/schemas/DeviceCore" } }, "required": [ "gateway" ], "title": "GatewayCanBindIndexReq", "type": "object" }, "GatewayCanBindIndexResp": { "properties": { "subDevices": { "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "updatedTime": { "format": "int64", "type": "integer" } }, "required": [ "subDevices", "updatedTime" ], "title": "GatewayCanBindIndexResp", "type": "object" }, "GatewayGetFoundReq": { "properties": { "deviceName": { "description": "设备名(必填)", "type": "string" }, "productID": { "description": "产品id (必填)", "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "GatewayGetFoundReq", "type": "object" }, "GatewayNotifyBindSendReq": { "properties": { "gateway": { "$ref": "#/components/schemas/DeviceCore" }, "subDevices": { "description": "如果是不同的产品,则传这个字段,上面两个参数填了优先使用", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "gateway", "subDevices" ], "title": "GatewayNotifyBindSendReq", "type": "object" }, "GroupCore": { "properties": { "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "parentID": { "format": "int64", "type": "integer" }, "purpose": { "description": "用途", "type": "string" } }, "required": [ "id", "parentID", "name", "purpose" ], "title": "GroupCore", "type": "object" }, "GroupDeviceMultiDeleteReq": { "properties": { "groupID": { "description": "分组ID", "format": "int64", "type": "integer" }, "list": { "description": "分组tag", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "groupID" ], "title": "GroupDeviceMultiDeleteReq", "type": "object" }, "GroupDeviceMultiSaveReq": { "properties": { "groupID": { "description": "分组ID", "format": "int64", "type": "integer" }, "list": { "description": "分组tag", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "groupID" ], "title": "GroupDeviceMultiSaveReq", "type": "object" }, "GroupInfo": { "properties": { "areaID": { "description": "区域ID", "type": "string" }, "children": { "items": { "$ref": "#/components/schemas/GroupInfo" }, "type": "array" }, "createdTime": { "description": "创建时间", "type": "string" }, "desc": { "description": "分组描述", "type": "string" }, "deviceCount": { "description": "设备数量统计", "format": "int64", "type": "integer" }, "devices": { "description": " withDevices=true 时返回分组下设备核心信息", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "files": { "additionalProperties": { "type": "string" }, "description": "key 是用途, value是文件的路径,", "type": "object" }, "id": { "description": "分组ID", "format": "int64", "type": "integer" }, "idPath": { "description": "分组ID路径", "type": "string" }, "isLeaf": { "format": "int64", "type": "integer" }, "name": { "description": "分组名称", "type": "string" }, "parentID": { "description": "父组ID", "format": "int64", "type": "integer" }, "productID": { "description": "产品ID", "type": "string" }, "productName": { "description": "产品ID", "type": "string" }, "projectID": { "description": "项目ID", "type": "string" }, "purpose": { "description": "用途 不填默认为default", "type": "string" }, "tags": { "description": "分组tag", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "title": "GroupInfo", "type": "object" }, "GroupInfoIndexReq": { "properties": { "areaID": { "description": "区域ID", "type": "string" }, "name": { "description": "分组名称", "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "parentID": { "description": "父组ID", "format": "int64", "type": "integer" }, "productID": { "description": "产品ID", "type": "string" }, "purpose": { "description": "用途 不填默认为default", "type": "string" }, "tags": { "description": "分组tag", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "withDevices": { "description": " true 时返回 list[].devices 设备核心信息", "format": "boolean", "type": "boolean" } }, "title": "GroupInfoIndexReq", "type": "object" }, "GroupInfoIndexResp": { "properties": { "list": { "description": "分组信息", "items": { "$ref": "#/components/schemas/GroupInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "GroupInfoIndexResp", "type": "object" }, "GroupInfoReadReq": { "properties": { "id": { "description": " id", "format": "int64", "type": "integer" }, "purpose": { "description": "用途 不填默认为default", "type": "string" }, "withChildren": { "format": "boolean", "type": "boolean" }, "withDevices": { "description": " true 时返回 devices 设备核心信息", "format": "boolean", "type": "boolean" } }, "required": [ "id" ], "title": "GroupInfoReadReq", "type": "object" }, "IDPath": { "properties": { "id": { "format": "int64", "type": "integer" }, "idPath": { "type": "string" } }, "title": "IDPath", "type": "object" }, "IDsInfo": { "properties": { "idPaths": { "items": { "type": "string" }, "type": "array" }, "ids": { "items": { "type": "string" }, "type": "array" } }, "title": "IDsInfo", "type": "object" }, "ImportResp": { "properties": { "errCount": { "description": "失败数", "format": "int64", "type": "integer" }, "ignoreCount": { "description": "忽略数", "format": "int64", "type": "integer" }, "succCount": { "description": "成功数", "format": "int64", "type": "integer" }, "total": { "description": "导入总接口数", "format": "int64", "type": "integer" } }, "required": [ "total", "errCount", "ignoreCount", "succCount" ], "title": "ImportResp", "type": "object" }, "OrderBy": { "properties": { "field": { "description": "排序的字段名", "type": "string" }, "sort": { "description": "排序方式:1 从小到大, 2 从大到小", "format": "int64", "type": "integer" } }, "title": "OrderBy", "type": "object" }, "OtaFile": { "properties": { "fileMd5": { "description": " 文件MD5校验值", "type": "string" }, "fileUrl": { "description": " 文件下载地址", "type": "string" }, "name": { "description": " 文件名", "type": "string" }, "signature": { "description": " 文件签名值", "type": "string" }, "size": { "description": " 文件大小(字节)", "format": "int64", "type": "integer" } }, "required": [ "size", "name", "fileUrl", "fileMd5", "signature" ], "title": "OtaFile", "type": "object" }, "OtaFirmwareCreateReq": { "properties": { "desc": { "description": "描述", "type": "string" }, "extData": { "description": "自定义数据", "type": "string" }, "files": { "description": "升级包附件列表,最多支持上传20个文件,总文件大小不能超过1,000 MB。", "items": { "$ref": "#/components/schemas/OtaFirmwareFile" }, "type": "array" }, "isDiff": { "description": "是否差分包,1:整包,2:差分", "format": "int32", "type": "integer" }, "name": { "description": "升级包名称", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "signMethod": { "description": "签名方法 MD5/SHA@256", "type": "string" }, "version": { "description": "升级包版本", "type": "string" } }, "required": [ "name", "productID", "version", "isDiff", "signMethod", "desc", "extData", "files" ], "title": "OtaFirmwareCreateReq", "type": "object" }, "OtaFirmwareDeviceCancelReq": { "properties": { "deviceNames": { "items": { "type": "string" }, "type": "array" }, "firmwareID": { "format": "int64", "type": "integer" }, "jobID": { "format": "int64", "type": "integer" } }, "required": [ "firmwareID", "jobID", "deviceNames" ], "title": "OtaFirmwareDeviceCancelReq", "type": "object" }, "OtaFirmwareDeviceConfirmReq": { "properties": { "deviceName": { "type": "string" }, "productID": { "type": "string" } }, "required": [ "productID", "deviceName" ], "title": "OtaFirmwareDeviceConfirmReq", "type": "object" }, "OtaFirmwareDeviceIndexReq": { "properties": { "deviceName": { "description": " 设备名称", "type": "string" }, "firmwareID": { "description": " 任务状态", "format": "int64", "type": "integer" }, "isOnline": { "description": "设备是否在线", "format": "int64", "type": "integer" }, "jobID": { "description": " 作业ID", "format": "int64", "type": "integer" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "srcVersion": { "type": "string" }, "status": { "description": "设备升级作业状态。1:待确认。 2:待推送。 3:已推送。 4:升级中。 5:升级成功 6: 升级失败. 7:已取消", "format": "int64", "type": "integer" } }, "title": "OtaFirmwareDeviceIndexReq", "type": "object" }, "OtaFirmwareDeviceIndexResp": { "properties": { "list": { "description": " OTA任务信息列表", "items": { "$ref": "#/components/schemas/OtaFirmwareDeviceInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "OtaFirmwareDeviceIndexResp", "type": "object" }, "OtaFirmwareDeviceInfo": { "properties": { "createdTime": { "format": "int64", "type": "integer" }, "destVersion": { "type": "string" }, "detail": { "type": "string" }, "deviceName": { "type": "string" }, "firmwareID": { "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "isOnline": { "description": "设备是否在线", "format": "int64", "type": "integer" }, "jobID": { "format": "int64", "type": "integer" }, "productID": { "type": "string" }, "productName": { "type": "string" }, "srcVersion": { "type": "string" }, "status": { "format": "int64", "type": "integer" }, "step": { "format": "int64", "type": "integer" }, "updatedTime": { "format": "int64", "type": "integer" } }, "required": [ "id", "firmwareID", "jobID", "productID", "productName", "deviceName", "srcVersion", "destVersion", "step", "detail", "status", "createdTime", "updatedTime" ], "title": "OtaFirmwareDeviceInfo", "type": "object" }, "OtaFirmwareDeviceInfoResp": { "properties": { "versions": { "type": "string" } }, "required": [ "versions" ], "title": "OtaFirmwareDeviceInfoResp", "type": "object" }, "OtaFirmwareDeviceRetryReq": { "properties": { "deviceNames": { "items": { "type": "string" }, "type": "array" }, "firmwareID": { "format": "int64", "type": "integer" }, "jobID": { "format": "int64", "type": "integer" } }, "required": [ "firmwareID", "jobID", "deviceNames" ], "title": "OtaFirmwareDeviceRetryReq", "type": "object" }, "OtaFirmwareFile": { "properties": { "filePath": { "description": "附件地址,上传附件后接口应该返回", "type": "string" }, "name": { "description": "附件原名,上传附件后接口应该返回", "type": "string" } }, "required": [ "filePath", "name" ], "title": "OtaFirmwareFile", "type": "object" }, "OtaFirmwareFileInfo": { "properties": { "name": { "description": "附件原名", "type": "string" }, "signature": { "description": "签名值", "type": "string" }, "size": { "description": "文件大小", "format": "int64", "type": "integer" }, "uri": { "description": "附件地址", "type": "string" } }, "required": [ "uri", "name", "size", "signature" ], "title": "OtaFirmwareFileInfo", "type": "object" }, "OtaFirmwareIndex": { "properties": { "createdTime": { "description": "创建时间 只读", "format": "int64", "type": "integer" }, "id": { "description": "固件升级包编号", "format": "int64", "type": "integer" }, "isDiff": { "description": "是否差分包,1:整包,2:差分", "format": "int32", "type": "integer" }, "name": { "description": "升级包名称", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "productName": { "description": "产品名称", "type": "string" }, "signMethod": { "description": "签名方法", "type": "string" }, "version": { "description": "升级包版本", "type": "string" } }, "required": [ "id", "name", "version", "productID", "productName", "isDiff", "createdTime", "signMethod" ], "title": "OtaFirmwareIndex", "type": "object" }, "OtaFirmwareIndexReq": { "properties": { "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id 获取产品id下的所有升级包", "type": "string" }, "timeEnd": { "description": "时间的结束", "type": "string" }, "timeStart": { "description": "获取时间的开始", "type": "string" } }, "title": "OtaFirmwareIndexReq", "type": "object" }, "OtaFirmwareIndexResp": { "properties": { "list": { "description": "数据", "items": { "$ref": "#/components/schemas/OtaFirmwareIndex" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "OtaFirmwareIndexResp", "type": "object" }, "OtaFirmwareInfo": { "properties": { "createdTime": { "description": "创建时间 只读", "format": "int64", "type": "integer" }, "desc": { "description": "描述", "type": "string" }, "extData": { "description": "自定义数据", "type": "string" }, "firmwareID": { "description": "固件升级包编号", "format": "int64", "type": "integer" }, "isDiff": { "description": "是否差分包,1:整包,2:差分", "format": "int32", "type": "integer" }, "name": { "description": "升级包名称", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "productName": { "description": "产品名称", "type": "string" }, "signMethod": { "description": "签名方法", "type": "string" }, "version": { "description": "升级包版本", "type": "string" } }, "required": [ "firmwareID", "name", "version", "productID", "productName", "isDiff", "createdTime", "signMethod", "desc", "extData" ], "title": "OtaFirmwareInfo", "type": "object" }, "OtaFirmwareInfoUpdateReq": { "properties": { "desc": { "description": "描述", "type": "string" }, "extData": { "description": "自定义数据", "type": "string" }, "id": { "description": "固件升级包编号", "format": "int64", "type": "integer" }, "name": { "description": "升级包名称", "type": "string" } }, "required": [ "id", "name", "desc", "extData" ], "title": "OtaFirmwareInfoUpdateReq", "type": "object" }, "OtaFirmwareJobDynamic": { "properties": { "dynamicMode": { "format": "int64", "maximum": 2, "type": "integer" } }, "title": "OtaFirmwareJobDynamic", "type": "object" }, "OtaFirmwareJobIndexReq": { "properties": { "firmwareID": { "description": " 固件ID", "format": "int64", "type": "integer" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "page", "firmwareID" ], "title": "OtaFirmwareJobIndexReq", "type": "object" }, "OtaFirmwareJobInfo": { "properties": { "createdTime": { "format": "int64", "type": "integer" }, "dynamicMode": { "format": "int64", "maximum": 2, "type": "integer" }, "firmwareID": { "description": " 升级包ID,升级包的唯一标识符。", "format": "int64", "type": "integer" }, "grayPercent": { "description": "灰度的范围,小数点后两位, 1.23%为 123", "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "isNeedConfirm": { "format": "int64", "maximum": 2, "type": "integer" }, "isNeedPush": { "description": " 物联网平台是否主动向设备推送升级任务。", "format": "int64", "maximum": 2, "type": "integer" }, "isOverwriteMode": { "description": " 是否覆盖之前的升级任务。取值:2(不覆盖)、1(覆盖)。", "format": "int64", "maximum": 2, "type": "integer" }, "maximumPerMinute": { "description": " 每分钟最多向多少个设备推送升级包下载URL。 动态升级 静态升级", "format": "int64", "type": "integer" }, "retryCount": { "description": " 自动重试次数。1/2/5次 动态升级 静态升级", "format": "int64", "type": "integer" }, "retryInterval": { "description": " 设备升级失败后,自动重试的时间间隔,单位为分钟。 动态升级 静态升级", "format": "int64", "type": "integer" }, "scheduleFinishTime": { "description": " 指定结束升级的时间,单位为毫秒。", "format": "int64", "type": "integer" }, "scheduleTime": { "format": "int64", "type": "integer" }, "srcVersions": { "description": " 待升级版本号列表。最多可传入10个版本号。用逗号分隔多个版本号", "items": { "type": "string" }, "type": "array" }, "status": { "description": " 批次状态,计划中:1 执行中:2 已完成:3 已取消:4", "format": "int64", "maximum": 4, "type": "integer" }, "target": { "description": " 分组升级和区域升级填写对应的id", "type": "string" }, "targetDeviceNames": { "description": " 定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔", "items": { "type": "string" }, "type": "array" }, "targetSelection": { "description": "升级范围。 1:全量升级。 2:定向升级。 3:灰度升级。 4:分组升级(不做) 5: 区域升级(不做)", "format": "int64", "maximum": 4, "type": "integer" }, "tenantCodes": { "description": "指定租户", "items": { "type": "string" }, "type": "array" }, "timeoutInMinutes": { "description": " 设备升级超时时间,单位为分钟。 动态升级 静态升级", "format": "int64", "type": "integer" }, "type": { "description": " 升级包所属产品的JobType。 验证升级包:1 批量升级:2", "format": "int64", "maximum": 2, "type": "integer" }, "upgradeType": { "description": " 升级策略,1-静态,2-动态", "format": "int64", "maximum": 2, "type": "integer" } }, "title": "OtaFirmwareJobInfo", "type": "object" }, "OtaFirmwareJobInfoIndexResp": { "properties": { "list": { "description": " OTA作业信息列表", "items": { "$ref": "#/components/schemas/OtaFirmwareJobInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "OtaFirmwareJobInfoIndexResp", "type": "object" }, "OtaFirmwareJobStatic": { "properties": { "grayPercent": { "description": "灰度的范围,小数点后两位, 1.23%为 123", "format": "int64", "type": "integer" }, "scheduleFinishTime": { "description": " 指定结束升级的时间,单位为毫秒。", "format": "int64", "type": "integer" }, "scheduleTime": { "format": "int64", "type": "integer" }, "targetDeviceNames": { "description": " 定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔", "items": { "type": "string" }, "type": "array" } }, "title": "OtaFirmwareJobStatic", "type": "object" }, "OtaFirmwareReadResp": { "properties": { "createdTime": { "description": "创建时间 只读", "format": "int64", "type": "integer" }, "desc": { "description": "描述", "type": "string" }, "extData": { "description": "自定义数据", "type": "string" }, "files": { "items": { "$ref": "#/components/schemas/OtaFirmwareFileInfo" }, "type": "array" }, "id": { "description": "固件升级包编号", "format": "int64", "type": "integer" }, "isDiff": { "description": "是否差分包,1:整包,2:差分", "format": "int32", "type": "integer" }, "isNeedToVerify": { "format": "int64", "type": "integer" }, "name": { "description": "升级包名称", "type": "string" }, "productID": { "description": "产品id", "type": "string" }, "productName": { "description": "产品名称", "type": "string" }, "signMethod": { "description": "签名方法", "type": "string" }, "version": { "description": "升级包版本", "type": "string" } }, "required": [ "id", "name", "version", "productID", "productName", "isDiff", "isNeedToVerify", "createdTime", "signMethod", "desc", "extData", "files" ], "title": "OtaFirmwareReadResp", "type": "object" }, "OtaModuleInfo": { "properties": { "code": { "type": "string" }, "createdTime": { "format": "int64", "type": "integer" }, "desc": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "name": { "type": "string" }, "productID": { "type": "string" } }, "title": "OtaModuleInfo", "type": "object" }, "OtaModuleInfoIndexReq": { "properties": { "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "type": "string" } }, "title": "OtaModuleInfoIndexReq", "type": "object" }, "OtaModuleInfoIndexResp": { "properties": { "list": { "description": " OTA作业信息列表", "items": { "$ref": "#/components/schemas/OtaModuleInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "OtaModuleInfoIndexResp", "type": "object" }, "OtaUpgradeData": { "properties": { "desc": { "description": " 文件描述", "type": "string" }, "extra": { "description": " 额外信息", "type": "string" }, "files": { "description": " 升级文件列表", "items": { "$ref": "#/components/schemas/OtaFile" }, "type": "array" }, "isDiff": { "description": " 是否差分升级包(0/1)", "format": "int64", "type": "integer" }, "name": { "description": " 固件升级包名称", "type": "string" }, "signMethod": { "description": " OTA升级包签名方法(MD5/SHA256,默认MD5)", "type": "string" }, "version": { "description": " 新固件的版本", "type": "string" } }, "required": [ "version", "name", "desc", "isDiff", "signMethod", "extra", "files" ], "title": "OtaUpgradeData", "type": "object" }, "PageInfo": { "properties": { "orders": { "description": "排序", "items": { "$ref": "#/components/schemas/OrderBy" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "size": { "description": " 每页大小", "format": "int64", "type": "integer" } }, "title": "PageInfo", "type": "object" }, "PageResp": { "properties": { "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "total" ], "title": "PageResp", "type": "object" }, "Point": { "properties": { "latitude": { "description": "纬度", "format": "double", "maximum": 90, "type": "number" }, "longitude": { "description": "经度", "format": "double", "maximum": 180, "type": "number" } }, "required": [ "longitude", "latitude" ], "title": "Point", "type": "object" }, "ProductCategory": { "properties": { "children": { "items": { "$ref": "#/components/schemas/ProductCategory" }, "type": "array" }, "desc": { "description": "描述", "type": "string" }, "deviceCount": { "description": "设备数量", "format": "int64", "type": "integer" }, "headImg": { "description": " 用户头像", "type": "string" }, "id": { "format": "int64", "type": "integer" }, "idPath": { "description": "只读", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "isLeaf": { "format": "int64", "type": "integer" }, "isUpdateHeadImg": { "description": " 用户头像", "format": "boolean", "type": "boolean" }, "name": { "type": "string" }, "order": { "description": "排序,必须大于等于1,为0代表不修改", "format": "int64", "type": "integer" }, "parentID": { "format": "int64", "type": "integer" } }, "title": "ProductCategory", "type": "object" }, "ProductCategoryExportReq": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" } }, "title": "ProductCategoryExportReq", "type": "object" }, "ProductCategoryExportResp": { "properties": { "categories": { "type": "string" } }, "required": [ "categories" ], "title": "ProductCategoryExportResp", "type": "object" }, "ProductCategoryImportReq": { "properties": { "categories": { "type": "string" } }, "required": [ "categories" ], "title": "ProductCategoryImportReq", "type": "object" }, "ProductCategoryIndexReq": { "properties": { "ids": { "description": "id过滤", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "name": { "description": "过滤产品名称", "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "parentID": { "format": "int64", "type": "integer" }, "projectID": { "description": "项目id,只获取项目下有设备的", "type": "string" } }, "title": "ProductCategoryIndexReq", "type": "object" }, "ProductCategoryIndexResp": { "properties": { "list": { "description": "产品信息", "items": { "$ref": "#/components/schemas/ProductCategory" }, "type": "array" }, "num": { "description": "返回的数量", "format": "int64", "type": "integer" }, "total": { "description": "拥有的总数", "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProductCategoryIndexResp", "type": "object" }, "ProductCategorySchemaIndexReq": { "properties": { "productCategoryID": { "format": "int64", "type": "integer" }, "withFather": { "format": "boolean", "type": "boolean" } }, "required": [ "productCategoryID" ], "title": "ProductCategorySchemaIndexReq", "type": "object" }, "ProductCategorySchemaIndexResp": { "properties": { "identifiers": { "items": { "type": "string" }, "type": "array" } }, "required": [ "identifiers" ], "title": "ProductCategorySchemaIndexResp", "type": "object" }, "ProductCategorySchemaMultiSaveReq": { "properties": { "identifiers": { "items": { "type": "string" }, "type": "array" }, "productCategoryID": { "format": "int64", "type": "integer" } }, "required": [ "productCategoryID", "identifiers" ], "title": "ProductCategorySchemaMultiSaveReq", "type": "object" }, "ProductConfig": { "properties": { "devInit": { "$ref": "#/components/schemas/DevInit" }, "productID": { "type": "string" } }, "required": [ "productID" ], "title": "ProductConfig", "type": "object" }, "ProductCustom": { "properties": { "customTopics": { "description": "自定义topic数组", "items": { "$ref": "#/components/schemas/ProductCustomTopic" }, "type": "array" }, "loginAuthScript": { "description": "登录认证脚本", "type": "string" }, "productID": { "type": "string" }, "scriptLang": { "description": "脚本语言类型(默认JavaScript) 1:JavaScript 2:lua 3:python", "format": "int64", "type": "integer" }, "transformScript": { "description": "协议转换脚本", "type": "string" } }, "required": [ "productID" ], "title": "ProductCustom", "type": "object" }, "ProductCustomReadReq": { "properties": { "productID": { "description": "产品id 只读", "type": "string" } }, "required": [ "productID" ], "title": "ProductCustomReadReq", "type": "object" }, "ProductCustomTopic": { "properties": { "direction": { "description": "1:上行 2:下行 3:双向", "format": "int64", "type": "integer" }, "topic": { "description": "自定义主题需要以$custom 并包含设备名称{deviceName}及产品名称{productID}", "type": "string" } }, "required": [ "topic", "direction" ], "title": "ProductCustomTopic", "type": "object" }, "ProductCustomUi": { "properties": { "isUpdateUi": { "format": "boolean", "type": "boolean" }, "path": { "description": "前端路径", "type": "string" }, "version": { "description": "版本号", "format": "int64", "type": "integer" } }, "required": [ "path" ], "title": "ProductCustomUi", "type": "object" }, "ProductID": { "properties": { "productID": { "description": "产品id 只读", "type": "string" } }, "required": [ "productID" ], "title": "ProductID", "type": "object" }, "ProductInfo": { "properties": { "authMode": { "description": "认证方式:1:账密认证,2:秘钥认证", "format": "int64", "maximum": 2, "type": "integer" }, "autoRegister": { "description": "动态注册:1:关闭,2:打开,3:打开并自动创建设备,4:在前面的基础上绑定没有也自动创建", "format": "int64", "maximum": 4, "type": "integer" }, "bindLevel": { "description": "绑定级别: 1:强绑定(默认,只有用户解绑之后才能绑定) 2:中绑定(可以通过token强制解绑设备) 3:弱绑定(app可以内部解绑被绑定的设备)", "format": "int64", "type": "integer" }, "category": { "$ref": "#/components/schemas/ProductCategory" }, "categoryID": { "description": "产品品类", "format": "int64", "type": "integer" }, "config": { "$ref": "#/components/schemas/ProductConfig" }, "createdTime": { "description": "创建时间 只读", "type": "string" }, "customUi": { "additionalProperties": { "$ref": "#/components/schemas/ProductCustomUi" }, "description": "自定义ui,key是端的类型(web-client mini-client) value是以下类型的对象{version:123(版本号,只读),isUpdateUi:bool(是否更新ui),path:string(前端路径,如果需要修改,需要将isUpdateUi置为true并在这个参数中传入压缩包的filePath)}", "type": "object" }, "desc": { "description": "描述", "type": "string" }, "deviceSchemaMode": { "description": " 设备物模型模式:1:手动创建,2:设备自动创建 3: 设备自动创建及上报无定义自动创建 4: 设备自动创建及上报无定义自动创建(数字类型只使用浮点)", "format": "int64", "maximum": 4, "type": "integer" }, "deviceType": { "description": "设备类型:1:直连设备,2:网关,3:子设备,4:监控设备", "format": "int64", "maximum": 4, "type": "integer" }, "isUpdateProductImg": { "description": "只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path", "format": "boolean", "type": "boolean" }, "netType": { "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE", "format": "int64", "type": "integer" }, "onlineHandle": { "description": "在线处理:1: 自动 2: 永远在线", "format": "int64", "maximum": 2, "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "productImg": { "description": "产品图片", "type": "string" }, "productName": { "description": "产品名称", "type": "string" }, "protocol": { "$ref": "#/components/schemas/ProtocolInfo" }, "protocolCode": { "description": "协议code,默认urMqtt,设备下发只会发送给主协议 urMqtt,urHttp,wumei,aliyun,huaweiyun,tuya", "type": "string" }, "protocolConf": { "description": "协议配置", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "sceneMode": { "description": "场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)", "type": "string" }, "secret": { "description": "动态注册产品秘钥 只读", "type": "string" }, "status": { "description": "产品状态 1:启用 2:禁用 3:开发中", "format": "int64", "type": "integer" }, "subDeviceOnlineHandle": { "description": "子设备在线处理:1:自动(跟随网关下线) 2:独立(不跟随)", "format": "int64", "maximum": 2, "type": "integer" }, "subProtocolCode": { "description": "子协议,主协议和子协议传输类型必须不相同, 设备控制下发只会发送给主协议, 当设备是音视频设备但是控制协议需要单独走的时候就可以把主协议定义为普通协议,子协议定义为音视频协议,这样就能实现音视频走音视频协议,控制走子协议", "type": "string" }, "subProtocolConf": { "description": "子协议协议配置", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "tags": { "description": " 产品tag", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "tenantCode": { "description": "租户号,common 为公共的产品,公共的大家都可以看,但是只有default可以修改", "type": "string" }, "trialTime": { "description": "试用时间(单位为天,为0不限制)", "type": "string" } }, "title": "ProductInfo", "type": "object" }, "ProductInfoExportReq": { "properties": { "productIDs": { "items": { "type": "string" }, "type": "array" } }, "title": "ProductInfoExportReq", "type": "object" }, "ProductInfoExportResp": { "properties": { "products": { "type": "string" } }, "required": [ "products" ], "title": "ProductInfoExportResp", "type": "object" }, "ProductInfoImportReq": { "properties": { "products": { "type": "string" } }, "required": [ "products" ], "title": "ProductInfoImportReq", "type": "object" }, "ProductInfoIndexReq": { "properties": { "areaID": { "description": "过滤区域下有设备的产品", "type": "string" }, "areaIDPath": { "description": "过滤区域id路径下有设备的产品", "type": "string" }, "categoryIDs": { "description": "产品品类", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "deviceType": { "description": "过滤设备类型:0:全部,1:设备,2:网关,3:子设备", "format": "int64", "maximum": 3, "type": "integer" }, "deviceTypes": { "description": "设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "netType": { "description": "通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE", "format": "int64", "type": "integer" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productIDs": { "description": "过滤产品id列表", "items": { "type": "string" }, "type": "array" }, "productName": { "description": "过滤产品名称", "type": "string" }, "projectID": { "description": "项目id,只获取项目下有设备的", "type": "string" }, "protocolCode": { "description": "协议code", "type": "string" }, "protocolType": { "description": "协议类型", "type": "string" }, "sceneMode": { "description": "场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)", "type": "string" }, "sceneModes": { "description": "场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)", "items": { "type": "string" }, "type": "array" }, "status": { "description": "产品状态 1:启用 2:禁用 3:开发中", "format": "int64", "type": "integer" }, "statuses": { "description": "产品状态 1:启用 2:禁用 3:开发中", "items": { "format": "int64", "type": "integer" }, "type": "array" }, "tags": { "description": " key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值", "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "tenantCode": { "description": "租户号过滤,common 为公共的产品,公共的大家都可以看", "type": "string" }, "withCategory": { "description": "同时返回品类详情", "format": "boolean", "type": "boolean" }, "withProtocol": { "description": "同时返回协议详情", "format": "boolean", "type": "boolean" } }, "title": "ProductInfoIndexReq", "type": "object" }, "ProductInfoIndexResp": { "properties": { "list": { "description": "产品信息", "items": { "$ref": "#/components/schemas/ProductInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProductInfoIndexResp", "type": "object" }, "ProductInfoReadReq": { "properties": { "productID": { "description": "产品id", "type": "string" }, "withCategory": { "description": "同时返回品类详情", "format": "boolean", "type": "boolean" }, "withProtocol": { "description": "同时返回协议详情", "format": "boolean", "type": "boolean" } }, "required": [ "productID" ], "title": "ProductInfoReadReq", "type": "object" }, "ProductInitReq": { "properties": { "productIDs": { "description": "产品id 只读", "items": { "type": "string" }, "type": "array" } }, "title": "ProductInitReq", "type": "object" }, "ProductRemoteConfig": { "properties": { "content": { "description": "配置内容", "type": "string" }, "createTime": { "description": "创建时间", "type": "string" }, "id": { "description": "配置编号", "format": "int64", "type": "integer" } }, "required": [ "id", "content", "createTime" ], "title": "ProductRemoteConfig", "type": "object" }, "ProductRemoteConfigCreateReq": { "properties": { "content": { "description": "配置内容", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "content" ], "title": "ProductRemoteConfigCreateReq", "type": "object" }, "ProductRemoteConfigIndexReq": { "properties": { "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID" ], "title": "ProductRemoteConfigIndexReq", "type": "object" }, "ProductRemoteConfigIndexResp": { "properties": { "list": { "description": "产品信息", "items": { "$ref": "#/components/schemas/ProductRemoteConfig" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProductRemoteConfigIndexResp", "type": "object" }, "ProductRemoteConfigLastestReadReq": { "properties": { "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID" ], "title": "ProductRemoteConfigLastestReadReq", "type": "object" }, "ProductRemoteConfigLastestReadResp": { "properties": { "content": { "description": "配置内容", "type": "string" }, "createTime": { "description": "创建时间", "type": "string" }, "id": { "description": "配置编号", "format": "int64", "type": "integer" } }, "title": "ProductRemoteConfigLastestReadResp", "type": "object" }, "ProductRemoteConfigPushAllReq": { "properties": { "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID" ], "title": "ProductRemoteConfigPushAllReq", "type": "object" }, "ProductSchemaCreateReq": { "properties": { "": { "$ref": "#/components/schemas/ProductSchemaInfo" } }, "title": "ProductSchemaCreateReq", "type": "object" }, "ProductSchemaDeleteReq": { "properties": { "identifier": { "description": "标识符", "type": "string" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID", "identifier" ], "title": "ProductSchemaDeleteReq", "type": "object" }, "ProductSchemaIndexReq": { "properties": { "controlMode": { "description": "控制模式: 1: 可以群控,可以单控 2:只能单控", "format": "int64", "type": "integer" }, "funcGroup": { "description": " 功能分类: 1:普通功能 2:系统功能", "format": "int64", "type": "integer" }, "identifier": { "description": "标识符模糊过滤", "type": "string" }, "identifiers": { "description": "过滤标识符列表", "items": { "type": "string" }, "type": "array" }, "isCanSceneLinkage": { "description": "是否可以场景联动", "format": "int64", "type": "integer" }, "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "description": "产品id", "type": "string" }, "propertyMode": { "description": "属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)", "type": "string" }, "tag": { "description": "过滤条件: 物模型标签 1:自定义 2:可选 3:必选", "format": "int64", "type": "integer" }, "type": { "description": "物模型类型 1:property属性 2:event事件 3:action行为", "format": "int64", "type": "integer" }, "types": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "userPerm": { "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)", "format": "int64", "type": "integer" } }, "required": [ "productID" ], "title": "ProductSchemaIndexReq", "type": "object" }, "ProductSchemaIndexResp": { "properties": { "list": { "description": "分页信息,只获取一个则不填", "items": { "$ref": "#/components/schemas/ProductSchemaInfo" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProductSchemaIndexResp", "type": "object" }, "ProductSchemaInfo": { "properties": { "affordance": { "type": "string" }, "controlMode": { "description": "控制模式: 1: 可以群控,可以单控 2:只能单控", "format": "int64", "type": "integer" }, "desc": { "description": "描述", "type": "string" }, "extendConfig": { "description": "拓展参数", "type": "string" }, "funcGroup": { "description": " 功能分类: 1:普通功能 2:系统功能", "format": "int64", "type": "integer" }, "identifier": { "description": "标识符", "type": "string" }, "isCanSceneLinkage": { "description": "是否可以场景联动", "format": "int64", "type": "integer" }, "isPassword": { "description": "是否是密码类型,密码类型需要加掩码", "format": "int64", "type": "integer" }, "name": { "description": "功能名称", "type": "string" }, "order": { "description": " 排序", "format": "int64", "type": "integer" }, "productID": { "description": "产品id 只读", "type": "string" }, "recordMode": { "description": " 1(默认) 记录历史记录 2 只记录差异值 3 不记录历史记录", "format": "int64", "type": "integer" }, "required": { "description": "是否必须 1:是 2:否", "format": "int64", "type": "integer" }, "tag": { "description": "物模型标签 1:自定义 2:可选 3:必选 必选不可删除", "format": "int64", "type": "integer" }, "type": { "description": "物模型类型 1:property属性 2:event事件 3:action行为", "format": "int64", "type": "integer" }, "userPerm": { "description": "用户权限操作: 1:r(只读) 3:rw(可读可写)", "format": "int64", "type": "integer" } }, "required": [ "type", "tag", "identifier" ], "title": "ProductSchemaInfo", "type": "object" }, "ProductSchemaMultiCreateReq": { "properties": { "identifiers": { "description": "导入的标识符列表", "items": { "type": "string" }, "type": "array" }, "list": { "description": "如果没有填标识符列表取这里", "items": { "$ref": "#/components/schemas/ProductSchemaInfo" }, "type": "array" }, "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID" ], "title": "ProductSchemaMultiCreateReq", "type": "object" }, "ProductSchemaTslImportReq": { "properties": { "productID": { "description": "产品id 只读", "type": "string" }, "tsl": { "description": "物模型tsl", "type": "string" } }, "required": [ "productID", "tsl" ], "title": "ProductSchemaTslImportReq", "type": "object" }, "ProductSchemaTslReadReq": { "properties": { "productID": { "description": "产品id", "type": "string" } }, "required": [ "productID" ], "title": "ProductSchemaTslReadReq", "type": "object" }, "ProductSchemaTslReadResp": { "properties": { "tsl": { "description": "物模型tsl", "type": "string" } }, "required": [ "tsl" ], "title": "ProductSchemaTslReadResp", "type": "object" }, "ProductSchemaUpdateReq": { "properties": { "": { "$ref": "#/components/schemas/ProductSchemaInfo" } }, "title": "ProductSchemaUpdateReq", "type": "object" }, "ProtocolConfigField": { "properties": { "group": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "isRequired": { "format": "boolean", "type": "boolean" }, "key": { "type": "string" }, "label": { "type": "string" }, "sort": { "format": "int64", "type": "integer" } }, "required": [ "id", "group", "key", "label", "isRequired", "sort" ], "title": "ProtocolConfigField", "type": "object" }, "ProtocolConfigInfo": { "properties": { "config": { "additionalProperties": { "type": "string" }, "type": "object" }, "desc": { "type": "string" }, "id": { "format": "int64", "type": "integer" } }, "required": [ "id", "config", "desc" ], "title": "ProtocolConfigInfo", "type": "object" }, "ProtocolInfo": { "properties": { "code": { "description": " iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya", "type": "string" }, "configFields": { "description": "配置字段列表,没有可以不传", "items": { "$ref": "#/components/schemas/ProtocolConfigField" }, "type": "array" }, "configInfos": { "description": "配置列表", "items": { "$ref": "#/components/schemas/ProtocolConfigInfo" }, "type": "array" }, "desc": { "type": "string" }, "deviceFields": { "description": "设备级的配置字段列表,没有可以不传", "items": { "$ref": "#/components/schemas/ProtocolConfigField" }, "type": "array" }, "endpoints": { "items": { "type": "string" }, "type": "array" }, "etcdKey": { "type": "string" }, "id": { "format": "int64", "type": "integer" }, "isEnableSyncDevice": { "description": "是否支持主动同步设备信息", "format": "int64", "type": "integer" }, "isEnableSyncProduct": { "description": "是否支持主动同步产品信息", "format": "int64", "type": "integer" }, "name": { "type": "string" }, "productFields": { "description": "产品级的配置字段列表,没有可以不传", "items": { "$ref": "#/components/schemas/ProtocolConfigField" }, "type": "array" }, "transProtocol": { "description": " 传输协议: mqtt,tcp,udp", "type": "string" }, "type": { "description": "协议类型: 普通设备(默认):normal 音视频:media", "type": "string" } }, "required": [ "isEnableSyncProduct", "isEnableSyncDevice" ], "title": "ProtocolInfo", "type": "object" }, "ProtocolInfoIndexReq": { "properties": { "code": { "type": "string" }, "codes": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "transProtocol": { "description": " 传输协议: mqtt,tcp,udp", "type": "string" }, "type": { "description": "协议类型: 普通设备(默认):normal 音视频:media", "type": "string" } }, "title": "ProtocolInfoIndexReq", "type": "object" }, "ProtocolInfoIndexResp": { "properties": { "list": { "description": "自定义协议信息", "items": { "$ref": "#/components/schemas/ProtocolInfo" }, "type": "array" }, "total": { "description": "拥有的总数", "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProtocolInfoIndexResp", "type": "object" }, "ProtocolScript": { "properties": { "createdTime": { "description": "创建时间", "format": "int64", "type": "integer" }, "desc": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "script": { "description": "脚本内容", "type": "string" }, "status": { "description": "状态:是否启用", "format": "int64", "type": "integer" }, "tenantCode": { "description": "租户号,common 为公共的产品,公共的大家都可以看,但是只有default可以修改", "type": "string" }, "triggerDir": { "description": "1:up 2:down", "format": "int64", "type": "integer" }, "triggerHandle": { "description": "对应 mqtt topic的第一个 thing ota config 等等", "type": "string" }, "triggerTimer": { "description": "收到前处理1:before 2:after", "format": "int64", "type": "integer" }, "triggerType": { "description": " 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为", "type": "string" } }, "title": "ProtocolScript", "type": "object" }, "ProtocolScriptDebugReq": { "properties": { "req": { "$ref": "#/components/schemas/PublishMsg" }, "resp": { "$ref": "#/components/schemas/PublishMsg" }, "script": { "description": "脚本内容", "type": "string" }, "triggerDir": { "description": "1:up 2:down", "format": "int64", "type": "integer" }, "triggerTimer": { "description": "收到前处理1:before 2:after", "format": "int64", "type": "integer" } }, "required": [ "triggerDir", "triggerTimer", "script", "req" ], "title": "ProtocolScriptDebugReq", "type": "object" }, "ProtocolScriptDebugResp": { "properties": { "logs": { "items": { "type": "string" }, "type": "array" }, "out": { "$ref": "#/components/schemas/PublishMsg" } }, "required": [ "out", "logs" ], "title": "ProtocolScriptDebugResp", "type": "object" }, "ProtocolScriptDevice": { "properties": { "createdTime": { "description": "创建时间", "format": "int64", "type": "integer" }, "device": { "$ref": "#/components/schemas/DeviceInfo" }, "deviceName": { "type": "string" }, "id": { "type": "string" }, "priority": { "description": "执行优先级", "format": "int64", "type": "integer" }, "product": { "$ref": "#/components/schemas/ProductInfo" }, "productID": { "type": "string" }, "script": { "$ref": "#/components/schemas/ProtocolScript" }, "scriptID": { "format": "int64", "type": "integer" }, "status": { "description": "状态:是否启用", "format": "int64", "type": "integer" }, "tenantCode": { "description": "租户号,common 为公共的产品,公共的大家都可以看,但是只有default可以修改", "type": "string" }, "triggerSrc": { "description": "product:1 device:2", "format": "int64", "type": "integer" } }, "title": "ProtocolScriptDevice", "type": "object" }, "ProtocolScriptDeviceIndexReq": { "properties": { "deviceName": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "productID": { "type": "string" }, "scriptID": { "type": "string" }, "status": { "description": "状态:是否启用", "format": "int64", "type": "integer" }, "triggerSrc": { "description": "product:1 device:2", "format": "int64", "type": "integer" }, "withDevice": { "format": "boolean", "type": "boolean" }, "withScript": { "format": "boolean", "type": "boolean" } }, "title": "ProtocolScriptDeviceIndexReq", "type": "object" }, "ProtocolScriptDeviceIndexResp": { "properties": { "list": { "description": "自定义协议信息", "items": { "$ref": "#/components/schemas/ProtocolScriptDevice" }, "type": "array" }, "total": { "description": "拥有的总数", "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProtocolScriptDeviceIndexResp", "type": "object" }, "ProtocolScriptExportReq": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" } }, "title": "ProtocolScriptExportReq", "type": "object" }, "ProtocolScriptExportResp": { "properties": { "scripts": { "type": "string" } }, "required": [ "scripts" ], "title": "ProtocolScriptExportResp", "type": "object" }, "ProtocolScriptImportReq": { "properties": { "scripts": { "type": "string" } }, "required": [ "scripts" ], "title": "ProtocolScriptImportReq", "type": "object" }, "ProtocolScriptIndexReq": { "properties": { "name": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "status": { "description": "状态:是否启用", "format": "int64", "type": "integer" }, "triggerDir": { "description": "1:up 2:down", "format": "int64", "type": "integer" }, "triggerHandle": { "description": "对应 mqtt topic的第一个 thing ota config 等等", "type": "string" }, "triggerTimer": { "description": "收到前处理1:before 2:after", "format": "int64", "type": "integer" }, "triggerType": { "description": " 操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为", "type": "string" } }, "title": "ProtocolScriptIndexReq", "type": "object" }, "ProtocolScriptIndexResp": { "properties": { "list": { "description": "自定义协议信息", "items": { "$ref": "#/components/schemas/ProtocolScript" }, "type": "array" }, "page": { "description": " 页码", "format": "int64", "type": "integer" }, "pageSize": { "description": " 每页大小", "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProtocolScriptIndexResp", "type": "object" }, "ProtocolService": { "properties": { "code": { "description": "协议code", "type": "string" }, "createdTime": { "description": "首次加入时间", "format": "int64", "type": "integer" }, "id": { "format": "int64", "type": "integer" }, "ip": { "description": " 协议服务的ip地址", "type": "string" }, "port": { "description": "监听的端口,如果没有填0即可", "format": "int64", "type": "integer" }, "status": { "description": "服务状态", "format": "int64", "type": "integer" }, "updatedTime": { "description": "更新时间", "format": "int64", "type": "integer" } }, "required": [ "id", "code", "ip", "port", "status", "updatedTime", "createdTime" ], "title": "ProtocolService", "type": "object" }, "ProtocolServiceIndexReq": { "properties": { "code": { "type": "string" }, "page": { "$ref": "#/components/schemas/PageInfo" } }, "required": [ "code" ], "title": "ProtocolServiceIndexReq", "type": "object" }, "ProtocolServiceIndexResp": { "properties": { "list": { "description": "自定义协议信息", "items": { "$ref": "#/components/schemas/ProtocolService" }, "type": "array" }, "total": { "description": "拥有的总数", "format": "int64", "type": "integer" } }, "required": [ "list" ], "title": "ProtocolServiceIndexResp", "type": "object" }, "ProtocolSyncDeviceReq": { "properties": { "code": { "description": " 协议code", "type": "string" }, "productID": { "type": "string" } }, "required": [ "code", "productID" ], "title": "ProtocolSyncDeviceReq", "type": "object" }, "ProtocolSyncDeviceResp": { "properties": { "deviceNames": { "description": "同步新增的设备ID列表", "items": { "type": "string" }, "type": "array" } }, "required": [ "deviceNames" ], "title": "ProtocolSyncDeviceResp", "type": "object" }, "PublishMsg": { "properties": { "deviceName": { "type": "string" }, "explain": { "description": "内部使用的拓展字段", "type": "string" }, "handle": { "description": "对应 mqtt topic的第一个 thing ota config 等等", "type": "string" }, "payload": { "type": "string" }, "productID": { "type": "string" }, "protocolCode": { "description": "如果有该字段则回复的时候也会带上该字段", "type": "string" }, "timestamp": { "description": "毫秒时间戳", "type": "string" }, "type": { "description": "操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为", "type": "string" } }, "title": "PublishMsg", "type": "object" }, "SchemaAction": { "properties": { "input": { "description": "调用参数", "items": { "$ref": "#/components/schemas/SchemaParam" }, "type": "array" }, "output": { "description": "返回参数", "items": { "$ref": "#/components/schemas/SchemaParam" }, "type": "array" } }, "title": "SchemaAction", "type": "object" }, "SchemaDefine": { "properties": { "arrayInfo": { "$ref": "#/components/schemas/SchemaDefine" }, "mapping": { "additionalProperties": { "type": "string" }, "description": "枚举及bool类型:bool enum", "type": "object" }, "max": { "description": "数值最大值:int string float", "type": "string" }, "min": { "description": "数值最小值:int float", "type": "string" }, "specs": { "description": "结构体:", "items": { "$ref": "#/components/schemas/SchemaSpec" }, "type": "array" }, "start": { "description": "初始值:int float", "type": "string" }, "step": { "description": "步长:int float", "type": "string" }, "type": { "description": "参数类型: bool int string float timestamp array enum", "type": "string" }, "unit": { "description": "单位:int float", "type": "string" } }, "required": [ "type" ], "title": "SchemaDefine", "type": "object" }, "SchemaEvent": { "properties": { "params": { "description": "事件参数", "items": { "$ref": "#/components/schemas/SchemaParam" }, "type": "array" }, "type": { "description": "事件类型: 信息:info 告警alert 故障:fault", "type": "string" } }, "required": [ "type" ], "title": "SchemaEvent", "type": "object" }, "SchemaParam": { "properties": { "define": { "$ref": "#/components/schemas/SchemaDefine" }, "identifier": { "description": "参数标识符", "type": "string" }, "name": { "description": "参数名称", "type": "string" } }, "required": [ "identifier", "name" ], "title": "SchemaParam", "type": "object" }, "SchemaProperty": { "properties": { "define": { "$ref": "#/components/schemas/SchemaDefine" }, "mode": { "description": "读写类型: r(只读) rw(可读可写)", "type": "string" } }, "required": [ "define" ], "title": "SchemaProperty", "type": "object" }, "SchemaSpec": { "properties": { "dataType": { "$ref": "#/components/schemas/SchemaDefine" }, "identifier": { "description": "参数标识符", "type": "string" }, "name": { "description": "参数名称", "type": "string" } }, "required": [ "identifier", "name", "dataType" ], "title": "SchemaSpec", "type": "object" }, "SendOption": { "properties": { "requestTimeout": { "description": "请求超时,超时后会进行重试", "format": "int64", "type": "integer" }, "retryInterval": { "description": "重试间隔", "format": "int64", "type": "integer" }, "timeoutToFail": { "description": "超时失败时间", "format": "int64", "type": "integer" } }, "title": "SendOption", "type": "object" }, "SharePerm": { "properties": { "perm": { "default": "3", "description": "2:读写权限 3读权限", "format": "int64", "type": "integer" } }, "title": "SharePerm", "type": "object" }, "SlotAreaSaveReq": { "properties": { "areaID": { "description": "项目区域id(只读)", "type": "string" }, "parentAreaID": { "description": "上级项目区域id(只读)", "type": "string" }, "projectID": { "description": "项目id(只读)", "type": "string" } }, "title": "SlotAreaSaveReq", "type": "object" }, "SlotUserSubscribe": { "properties": { "code": { "type": "string" }, "params": { "additionalProperties": { "type": "object" }, "type": "object" } }, "required": [ "code", "params" ], "title": "SlotUserSubscribe", "type": "object" }, "SlotUserSubscribeResp": { "properties": { "list": { "items": { "type": "object" }, "type": "array" } }, "required": [ "list" ], "title": "SlotUserSubscribeResp", "type": "object" }, "Tag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ], "title": "Tag", "type": "object" }, "TimeRange": { "properties": { "end": { "description": "结束时间 unix时间戳", "format": "int64", "type": "integer" }, "start": { "description": "开始时间 unix时间戳", "format": "int64", "type": "integer" } }, "title": "TimeRange", "type": "object" }, "UserCollectDeviceInfo": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/DeviceInfo" }, "type": "array" } }, "required": [ "devices" ], "title": "UserCollectDeviceInfo", "type": "object" }, "UserCollectDeviceSave": { "properties": { "devices": { "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" } }, "required": [ "devices" ], "title": "UserCollectDeviceSave", "type": "object" }, "UserCore": { "properties": { "createdTime": { "description": " 创建时间", "type": "string" }, "email": { "description": " 邮箱", "type": "string" }, "headImg": { "description": " 用户头像", "type": "string" }, "lastIP": { "description": " 最后登录ip", "type": "string" }, "nickName": { "description": " 用户的昵称", "type": "string" }, "phone": { "description": " 手机号", "type": "string" }, "regIP": { "description": " 注册ip", "type": "string" }, "userID": { "description": " 用户id", "type": "string" }, "userName": { "description": " 用户名(唯一)", "type": "string" } }, "title": "UserCore", "type": "object" }, "UserDeviceShareIndexReq": { "properties": { "device": { "$ref": "#/components/schemas/DeviceCore" }, "page": { "$ref": "#/components/schemas/PageInfo" }, "withUser": { "description": "同时返回用户信息", "format": "boolean", "type": "boolean" } }, "title": "UserDeviceShareIndexReq", "type": "object" }, "UserDeviceShareIndexResp": { "properties": { "list": { "items": { "$ref": "#/components/schemas/UserDeviceShareInfo" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "title": "UserDeviceShareIndexResp", "type": "object" }, "UserDeviceShareInfo": { "properties": { "accessPerm": { "additionalProperties": { "$ref": "#/components/schemas/SharePerm" }, "description": "系统功能权限 2:读写权限 3读权限", "type": "object" }, "authType": { "description": "授权类型:1:全部授权 2:部分授权", "format": "int64", "type": "integer" }, "createdTime": { "format": "int64", "type": "integer" }, "device": { "$ref": "#/components/schemas/DeviceCore" }, "expTime": { "description": "到期时间", "type": "string" }, "id": { "format": "int64", "type": "integer" }, "projectID": { "type": "string" }, "schemaPerm": { "additionalProperties": { "$ref": "#/components/schemas/SharePerm" }, "description": "普通功能权限 2:读写权限 3读权限", "type": "object" }, "sharedUserAccount": { "type": "string" }, "sharedUserID": { "description": "分享的对象", "type": "string" }, "useBy": { "description": "用途", "type": "string" }, "user": { "$ref": "#/components/schemas/UserCore" } }, "title": "UserDeviceShareInfo", "type": "object" }, "UserDeviceShareMultiAcceptInfo": { "properties": { "devices": { "description": "批量设备信息", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "shareToken": { "description": "分享后的用于生成二维码的字符串", "type": "string" } }, "title": "UserDeviceShareMultiAcceptInfo", "type": "object" }, "UserDeviceShareMultiDeleteReq": { "properties": { "ids": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "projectID": { "type": "string" } }, "title": "UserDeviceShareMultiDeleteReq", "type": "object" }, "UserDeviceShareMultiDeleteTokenReq": { "properties": { "shareToken": { "description": "要删除的分享 Token", "type": "string" } }, "required": [ "shareToken" ], "title": "UserDeviceShareMultiDeleteTokenReq", "type": "object" }, "UserDeviceShareMultiGetTokenListResp": { "properties": { "list": { "description": "Token 列表", "items": { "$ref": "#/components/schemas/UserDeviceShareMultiListItem" }, "type": "array" }, "total": { "description": "总数", "format": "int64", "type": "integer" } }, "title": "UserDeviceShareMultiGetTokenListResp", "type": "object" }, "UserDeviceShareMultiIndexResp": { "properties": { "accessPerm": { "additionalProperties": { "$ref": "#/components/schemas/SharePerm" }, "description": "系统功能权限 2:读写权限 3读权限", "type": "object" }, "authType": { "description": "授权类型:1:全部授权 2:部分授权", "format": "int64", "type": "integer" }, "createdTime": { "format": "int64", "type": "integer" }, "devices": { "description": "批量设备信息", "items": { "$ref": "#/components/schemas/DeviceShareInfo" }, "type": "array" }, "expTime": { "description": "到期时间", "format": "int64", "type": "integer" }, "schemaPerm": { "additionalProperties": { "$ref": "#/components/schemas/SharePerm" }, "description": "普通功能权限 2:读写权限 3读权限", "type": "object" }, "useBy": { "description": "用途", "type": "string" } }, "title": "UserDeviceShareMultiIndexResp", "type": "object" }, "UserDeviceShareMultiInfo": { "properties": { "accessPerm": { "additionalProperties": { "$ref": "#/components/schemas/SharePerm" }, "description": "系统功能权限 2:读写权限 3读权限", "type": "object" }, "authType": { "description": "授权类型:1:全部授权 2:部分授权", "format": "int64", "type": "integer" }, "createdTime": { "format": "int64", "type": "integer" }, "devices": { "description": "批量设备信息", "items": { "$ref": "#/components/schemas/DeviceCore" }, "type": "array" }, "expTime": { "description": "到期时间", "format": "int64", "type": "integer" }, "schemaPerm": { "additionalProperties": { "$ref": "#/components/schemas/SharePerm" }, "description": "普通功能权限 2:读写权限 3读权限", "type": "object" }, "useBy": { "description": "用途", "type": "string" } }, "title": "UserDeviceShareMultiInfo", "type": "object" }, "UserDeviceShareMultiListItem": { "properties": { "authType": { "description": "授权类型", "format": "int64", "type": "integer" }, "createdTime": { "description": "创建时间", "format": "int64", "type": "integer" }, "deviceCount": { "description": "设备数量", "format": "int64", "type": "integer" }, "expTime": { "description": "分享过期时间", "format": "int64", "type": "integer" }, "shareToken": { "description": "分享 Token", "type": "string" }, "useBy": { "description": "用途", "type": "string" } }, "title": "UserDeviceShareMultiListItem", "type": "object" }, "UserDeviceShareMultiToken": { "properties": { "authExpireAt": { "format": "int64", "type": "integer" }, "createdTime": { "format": "int64", "type": "integer" }, "linkExpireAt": { "format": "int64", "type": "integer" }, "shareToken": { "type": "string" } }, "title": "UserDeviceShareMultiToken", "type": "object" }, "UserDeviceShareReadReq": { "properties": { "device": { "$ref": "#/components/schemas/DeviceCore" }, "id": { "format": "int64", "type": "integer" }, "useBy": { "description": "用途", "type": "string" } }, "title": "UserDeviceShareReadReq", "type": "object" }, "UserDeviceShareTokenCheckReq": { "properties": { "shareToken": { "type": "string" } }, "required": [ "shareToken" ], "title": "UserDeviceShareTokenCheckReq", "type": "object" }, "UserDeviceShareTokenCheckResp": { "properties": { "authExpireAt": { "format": "int64", "type": "integer" }, "createdTime": { "format": "int64", "type": "integer" }, "deviceCount": { "format": "int64", "type": "integer" }, "linkExpireAt": { "format": "int64", "type": "integer" }, "reason": { "type": "string" }, "useBy": { "type": "string" }, "valid": { "format": "boolean", "type": "boolean" } }, "required": [ "valid" ], "title": "UserDeviceShareTokenCheckResp", "type": "object" }, "WithID": { "properties": { "id": { "description": " id", "format": "int64", "type": "integer" } }, "title": "WithID", "type": "object" }, "WithIDChildren": { "properties": { "id": { "description": " id", "format": "int64", "type": "integer" }, "withChildren": { "format": "boolean", "type": "boolean" } }, "title": "WithIDChildren", "type": "object" }, "WithIDOrCode": { "properties": { "code": { "type": "string" }, "id": { "description": " id", "format": "int64", "type": "integer" } }, "title": "WithIDOrCode", "type": "object" }, "WithIDStr": { "properties": { "id": { "description": " id", "type": "string" } }, "title": "WithIDStr", "type": "object" }, "WithProfile": { "properties": { "code": { "type": "string" }, "params": { "type": "string" } }, "required": [ "code", "params" ], "title": "WithProfile", "type": "object" } }, "securitySchemes": { "apiKey": { "description": "Enter JWT Bearer token **_only_**", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "title": "things-api", "version": "1.0.2", "x-updated-at": "2026-06-11T20:52:52+08:00" }, "openapi": "3.0.3", "paths": { "/api/v1/things/device/auth/access": { "post": { "operationId": "postApiV1ThingsDeviceAuthAccess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAuthAccessReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备操作认证", "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth/login": { "post": { "operationId": "postApiV1ThingsDeviceAuthLogin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAuthLoginReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备登录认证", "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth/register": { "post": { "operationId": "postApiV1ThingsDeviceAuthRegister", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceRegisterReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceRegisterResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备自动注册", "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth/root-check": { "post": { "operationId": "postApiV1ThingsDeviceAuthRoot-check", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAuthRootCheckReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "鉴定是否是root账号", "tags": [ "things/device/auth", "thingsDeviceAuth" ] } }, "/api/v1/things/device/auth5/access": { "post": { "operationId": "postApiV1ThingsDeviceAuth5Access", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAuth5AccessReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceAuth5AccessResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备操作认证", "tags": [ "things/device/auth5", "thingsDeviceAuth5" ] } }, "/api/v1/things/device/auth5/login": { "post": { "operationId": "postApiV1ThingsDeviceAuth5Login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAuth5LoginReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceAuth5LoginResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备登录认证", "tags": [ "things/device/auth5", "thingsDeviceAuth5" ] } }, "/api/v1/things/device/edge/send/{handle}/{type}": { "post": { "operationId": "postApiV1ThingsDeviceEdgeSend:handle:type", "parameters": [ { "description": "对应 mqtt topic的第一个 thing ota config 等等", "in": "path", "name": "handle", "required": true, "schema": { "type": "string" } }, { "description": "操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为", "in": "path", "name": "type", "required": true, "schema": { "type": "string" } }, { "description": "如果网关类型要操作子设备的topic,需要指定子设备的产品ID和设备ID,如果没有填写则默认是账号里的设备", "in": "header", "name": "productID", "schema": { "type": "string" } }, { "description": "如果网关类型要操作子设备的topic,需要指定子设备的产品ID和设备ID,如果没有填写则默认是账号里的设备", "in": "header", "name": "deviceName", "schema": { "type": "string" } }, { "description": "basic auth 账号密码使用mqtt格式生成的账号密码", "in": "header", "name": "authorization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractEdgeSendReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractEdgeSendResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备使用http协议用云端交互,需要在http头中带上mqtt的账号密码(basic auth)", "tags": [ "things/device/edge", "thingsDeviceEdge" ] } }, "/api/v1/things/device/gateway/index": { "post": { "operationId": "postApiV1ThingsDeviceGatewayIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGateWayIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceGateWayIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取子设备列表", "tags": [ "things/device/gateway", "thingsDeviceGateway" ] } }, "/api/v1/things/device/gateway/multi-create": { "post": { "operationId": "postApiV1ThingsDeviceGatewayMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGateWayMultiCreateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "添加网关子设备", "tags": [ "things/device/gateway", "thingsDeviceGateway" ] } }, "/api/v1/things/device/gateway/multi-delete": { "post": { "operationId": "postApiV1ThingsDeviceGatewayMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGateWayMultiDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "解绑子设备", "tags": [ "things/device/gateway", "thingsDeviceGateway" ] } }, "/api/v1/things/device/group/multi-create": { "post": { "operationId": "postApiV1ThingsDeviceGroupMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroupMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "将设备加到多个分组中", "tags": [ "things/device/group", "thingsDeviceGroup" ] } }, "/api/v1/things/device/group/multi-delete": { "post": { "operationId": "postApiV1ThingsDeviceGroupMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroupMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除设备所在分组", "tags": [ "things/device/group", "thingsDeviceGroup" ] } }, "/api/v1/things/device/group/multi-update": { "post": { "operationId": "postApiV1ThingsDeviceGroupMulti-update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceGroupMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新设备所在分组", "tags": [ "things/device/group", "thingsDeviceGroup" ] } }, "/api/v1/things/device/info/bind": { "post": { "operationId": "postApiV1ThingsDeviceInfoBind", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoBindReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "绑定", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/bind/token/create": { "post": { "operationId": "postApiV1ThingsDeviceInfoBindTokenCreate", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceBindTokenInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建绑定token", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/bind/token/read": { "post": { "operationId": "postApiV1ThingsDeviceInfoBindTokenRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceBindTokenReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceBindTokenInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "绑定token状态查询", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/can-bind": { "post": { "operationId": "postApiV1ThingsDeviceInfoCan-bind", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoCanBindReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "是否可以绑定设备", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/count": { "post": { "operationId": "postApiV1ThingsDeviceInfoCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCountReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceCountResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备统计详情", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/create": { "post": { "operationId": "postApiV1ThingsDeviceInfoCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增设备", "tags": [ "things/device/info", "thingsDeviceInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/device/info/delete": { "post": { "operationId": "postApiV1ThingsDeviceInfoDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除设备", "tags": [ "things/device/info", "thingsDeviceInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/device/info/index": { "post": { "operationId": "postApiV1ThingsDeviceInfoIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInfoIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备列表", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/move": { "post": { "operationId": "postApiV1ThingsDeviceInfoMove", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMoveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "转移设备到新设备上", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-bind": { "post": { "operationId": "postApiV1ThingsDeviceInfoMulti-bind", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoMultiBindReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInfoMultiBindResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量绑定", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-import": { "post": { "operationId": "postApiV1ThingsDeviceInfoMulti-import", "requestBody": { "content": { "application/json": { "schema": { "properties": { "file": { "format": "binary", "type": "string", "x-formData-name": "file" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMultiImportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导入设备", "tags": [ "things/device/info", "thingsDeviceInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/device/info/multi-update": { "post": { "operationId": "postApiV1ThingsDeviceInfoMulti-update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoMultiUpdateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量更新设备", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/multi-update-import": { "post": { "operationId": "postApiV1ThingsDeviceInfoMulti-update-import", "requestBody": { "content": { "application/json": { "schema": { "properties": { "file": { "format": "binary", "type": "string", "x-formData-name": "file" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMultiUpdateImportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "导入批量更新设备", "tags": [ "things/device/info", "thingsDeviceInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/device/info/ota/upgrade": { "post": { "operationId": "postApiV1ThingsDeviceInfoOtaUpgrade", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceOtaUpgradeReq" } } }, "description": " DeviceOtaUpgradeReq OTA升级请求", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceOtaUpgradeResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备升级,获取升级包手动升级", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/read": { "post": { "operationId": "postApiV1ThingsDeviceInfoRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备详情", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/transfer": { "post": { "operationId": "postApiV1ThingsDeviceInfoTransfer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoTransferReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "转让设备", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/unbind": { "post": { "operationId": "postApiV1ThingsDeviceInfoUnbind", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfoUnbindReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "解绑设备", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/info/update": { "post": { "operationId": "postApiV1ThingsDeviceInfoUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新设备", "tags": [ "things/device/info", "thingsDeviceInfo" ] } }, "/api/v1/things/device/interact/action-read": { "post": { "operationId": "postApiV1ThingsDeviceInteractAction-read", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractRespReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractSendActionResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取调用设备行为的结果", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/action-resp": { "post": { "operationId": "postApiV1ThingsDeviceInteractAction-resp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractActionRespReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备回复行为调用结果", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/action-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractAction-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractSendActionReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractSendActionResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "调用设备行为", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/gateway-get-found-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractGateway-get-found-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayGetFoundReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "请求网关上报拓扑关系", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/gateway-notify-bind-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractGateway-notify-bind-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayNotifyBindSendReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "通知网关绑定子设备", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-control-multi-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractProperty-control-multi-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractMultiSendPropertyReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractMultiSendPropertyResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量调用设备属性", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-control-read": { "post": { "operationId": "postApiV1ThingsDeviceInteractProperty-control-read", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractRespReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractSendPropertyResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取调用设备属性的结果", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-control-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractProperty-control-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractSendPropertyReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractSendPropertyResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "调用设备属性", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-get-report-multi-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractProperty-get-report-multi-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractPropertyGetReportMultiSendReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractPropertyGetReportMultiSendResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量请求设备获取设备最新属性", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/interact/property-get-report-send": { "post": { "operationId": "postApiV1ThingsDeviceInteractProperty-get-report-send", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceInteractPropertyGetReportSendReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceInteractPropertyGetReportSendResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "请求设备获取设备最新属性", "tags": [ "things/device/interact", "thingsDeviceInteract" ] } }, "/api/v1/things/device/msg/abnormal-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgAbnormal-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgAbnormalLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgAbnormalLogIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备异常日志", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/event-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgEvent-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgEventLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgEventLogIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取事件历史记录", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/gateway-can-bind-index": { "post": { "operationId": "postApiV1ThingsDeviceMsgGateway-can-bind-index", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayCanBindIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/GatewayCanBindIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取网关可以绑定的子设备列表", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/hub-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgHub-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgHubLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgHubLogIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取云端诊断日志", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-agg/by-device/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-aggBy-deviceIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyAggByDeviceIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "弃用", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-agg/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-aggIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "弃用", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-latest-agg/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-latest-aggIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestAggIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestAggIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "聚合属性最新值", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-latest/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-latestIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取最新属性记录", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log-agg/by-device/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-log-aggBy-deviceIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyAggByDeviceIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "聚合属性历史记录,设备维度", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log-agg/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-log-aggIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyLogAggIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "聚合属性历史记录", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log-latest/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-log-latestIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "弃用", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取单个id属性历史记录", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/property-log/multi-index": { "post": { "operationId": "postApiV1ThingsDeviceMsgProperty-logMulti-index", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLogMultiIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgPropertyMultiIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量获取单个id属性历史记录", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/sdk-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgSdk-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgSdkLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgSdkIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备sdk日志", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/send-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgSend-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgSendLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgSendLogIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备命令日志", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/shadow/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgShadowIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgPropertyLatestIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgShadowIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备影子列表", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/msg/status-log/index": { "post": { "operationId": "postApiV1ThingsDeviceMsgStatus-logIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceMsgStatusLogIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceMsgStatusLogIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备状态日志", "tags": [ "things/device/msg", "thingsDeviceMsg" ] } }, "/api/v1/things/device/info/pair-confirm": { "post": { "description": "校验S01 BLE安全配对grantToken和设备pairAckPayload,成功后复用设备绑定流程完成正式绑定", "operationId": "postApiV1ThingsDeviceInfoPairConfirm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicePairConfirmReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DevicePairConfirmResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "S01 BLE安全配对确认", "tags": [ "things/device/pair", "thingsDevicePair" ] } }, "/api/v1/things/device/info/pair-grant": { "post": { "description": "根据产品ProductSecret前16个ASCII字符为指定设备生成S01 BLE安全配对nonce、authTag和短期grantToken", "operationId": "postApiV1ThingsDeviceInfoPairGrant", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicePairGrantReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DevicePairGrantResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "S01 BLE安全配对授权", "tags": [ "things/device/pair", "thingsDevicePair" ] } }, "/api/v1/things/device/profile/delete": { "post": { "operationId": "postApiV1ThingsDeviceProfileDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceProfileReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除设备配置", "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/profile/index": { "post": { "operationId": "postApiV1ThingsDeviceProfileIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceProfileIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceProfileIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备配置列表", "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/profile/read": { "post": { "operationId": "postApiV1ThingsDeviceProfileRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceProfileReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceProfile" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备配置详情", "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/profile/update": { "post": { "operationId": "postApiV1ThingsDeviceProfileUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceProfile" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新设备配置", "tags": [ "things/device/profile", "thingsDeviceProfile" ] } }, "/api/v1/things/device/schema/create": { "post": { "operationId": "postApiV1ThingsDeviceSchemaCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchema" } } }, "description": "/*物模型条目*/", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建设备物模型", "tags": [ "things/device/schema", "thingsDeviceSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/device/schema/index": { "post": { "operationId": "postApiV1ThingsDeviceSchemaIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchemaIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceSchemaIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备物模型列表", "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/multi-create": { "post": { "operationId": "postApiV1ThingsDeviceSchemaMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchemaMultiCreateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量创建设备物模型", "tags": [ "things/device/schema", "thingsDeviceSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/device/schema/multi-delete": { "post": { "operationId": "postApiV1ThingsDeviceSchemaMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchemaMultiDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量删除设备物模型", "tags": [ "things/device/schema", "thingsDeviceSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/device/schema/tsl-read": { "post": { "operationId": "postApiV1ThingsDeviceSchemaTsl-read", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchemaTslReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceSchemaTslReadResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备物模型tsl", "tags": [ "things/device/schema", "thingsDeviceSchema" ] } }, "/api/v1/things/device/schema/update": { "post": { "operationId": "postApiV1ThingsDeviceSchemaUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceSchema" } } }, "description": "/*物模型条目*/", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新设备物模型", "tags": [ "things/device/schema", "thingsDeviceSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/device/version/index": { "post": { "operationId": "postApiV1ThingsDeviceVersionIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceModuleVersionIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceModuleVersionIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备模块版本详情", "tags": [ "things/device/module/version", "thingsDeviceModuleVersion" ] } }, "/api/v1/things/device/version/read": { "post": { "operationId": "postApiV1ThingsDeviceVersionRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceModuleVersionReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/DeviceModuleVersion" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取设备模块版本列表", "tags": [ "things/device/module/version", "thingsDeviceModuleVersion" ] } }, "/api/v1/things/group/device/multi-create": { "post": { "operationId": "postApiV1ThingsGroupDeviceMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDeviceMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "添加分组设备", "tags": [ "things/group/device", "thingsGroupDevice" ] } }, "/api/v1/things/group/device/multi-delete": { "post": { "operationId": "postApiV1ThingsGroupDeviceMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDeviceMultiDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除分组设备", "tags": [ "things/group/device", "thingsGroupDevice" ] } }, "/api/v1/things/group/device/multi-update": { "post": { "operationId": "postApiV1ThingsGroupDeviceMulti-update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDeviceMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新分组设备", "tags": [ "things/group/device", "thingsGroupDevice" ] } }, "/api/v1/things/group/info/create": { "post": { "operationId": "postApiV1ThingsGroupInfoCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建分组", "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/delete": { "post": { "operationId": "postApiV1ThingsGroupInfoDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除分组", "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/index": { "post": { "operationId": "postApiV1ThingsGroupInfoIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupInfoIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/GroupInfoIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取分组列表", "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/read": { "post": { "operationId": "postApiV1ThingsGroupInfoRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupInfoReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/GroupInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取分组详情信息", "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/group/info/update": { "post": { "operationId": "postApiV1ThingsGroupInfoUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新分组信息", "tags": [ "things/group/info", "thingsGroupInfo" ] } }, "/api/v1/things/ota/firmware/device/cancel": { "post": { "operationId": "postApiV1ThingsOtaFirmwareDeviceCancel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareDeviceCancelReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "取消指定任务下的升级", "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/device/confirm": { "post": { "operationId": "postApiV1ThingsOtaFirmwareDeviceConfirm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareDeviceConfirmReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "确认升级设备", "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/device/index": { "post": { "operationId": "postApiV1ThingsOtaFirmwareDeviceIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareDeviceIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/OtaFirmwareDeviceIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "查询升级设备列表", "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/device/retry": { "post": { "operationId": "postApiV1ThingsOtaFirmwareDeviceRetry", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareDeviceRetryReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "重试设备升级", "tags": [ "things/ota/firmware/device", "thingsOtaFirmwareDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/info/create": { "post": { "operationId": "postApiV1ThingsOtaFirmwareInfoCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareCreateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "添加升级包", "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/info/delete": { "post": { "operationId": "postApiV1ThingsOtaFirmwareInfoDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除升级包", "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/info/index": { "post": { "operationId": "postApiV1ThingsOtaFirmwareInfoIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/FirmwareIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "升级包列表", "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/info/read": { "post": { "operationId": "postApiV1ThingsOtaFirmwareInfoRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/FirmwareInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "查询升级包", "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/info/update": { "post": { "operationId": "postApiV1ThingsOtaFirmwareInfoUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareUpdateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "修改升级包", "tags": [ "things/ota/firmware/info", "thingsOtaFirmwareInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/job/create": { "post": { "operationId": "postApiV1ThingsOtaFirmwareJobCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareJobInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建升级任务", "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/job/index": { "post": { "operationId": "postApiV1ThingsOtaFirmwareJobIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareJobIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/OtaFirmwareJobInfoIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取升级包下的升级任务批次列表", "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/job/read": { "post": { "operationId": "postApiV1ThingsOtaFirmwareJobRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/OtaFirmwareJobInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "查询指定升级批次的详情", "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/firmware/job/update": { "post": { "operationId": "postApiV1ThingsOtaFirmwareJobUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaFirmwareJobInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新升级批次", "tags": [ "things/ota/firmware/job", "thingsOtaFirmwareJob" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/module/info/create": { "post": { "operationId": "postApiV1ThingsOtaModuleInfoCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaModuleInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建模块", "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/module/info/delete": { "post": { "operationId": "postApiV1ThingsOtaModuleInfoDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除模块", "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/module/info/index": { "post": { "operationId": "postApiV1ThingsOtaModuleInfoIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaModuleInfoIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/OtaModuleInfoIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取模块列表", "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/module/info/read": { "post": { "operationId": "postApiV1ThingsOtaModuleInfoRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDOrCode" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/OtaModuleInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "查询模块详情", "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/ota/module/info/update": { "post": { "operationId": "postApiV1ThingsOtaModuleInfoUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OtaModuleInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新模块", "tags": [ "things/ota/module/info", "thingsOtaModuleInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/create": { "post": { "operationId": "postApiV1ThingsProductCategoryCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategory" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增产品品类", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/delete": { "post": { "operationId": "postApiV1ThingsProductCategoryDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除产品品类", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/index": { "post": { "operationId": "postApiV1ThingsProductCategoryIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductCategoryIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品品类列表", "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/multi-export": { "post": { "operationId": "postApiV1ThingsProductCategoryMulti-export", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryExportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductCategoryExportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导出产品品类", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/multi-import": { "post": { "operationId": "postApiV1ThingsProductCategoryMulti-import", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryImportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ImportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导入产品品类", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/read": { "post": { "operationId": "postApiV1ThingsProductCategoryRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDChildren" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductCategory" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品品类详情", "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/schema/index": { "post": { "operationId": "postApiV1ThingsProductCategorySchemaIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategorySchemaIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductCategorySchemaIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品品类物模型列表", "tags": [ "things/product/category", "thingsProductCategory" ] } }, "/api/v1/things/product/category/schema/multi-create": { "post": { "operationId": "postApiV1ThingsProductCategorySchemaMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategorySchemaMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量新增产品品类物模型", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/schema/multi-delete": { "post": { "operationId": "postApiV1ThingsProductCategorySchemaMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategorySchemaMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量删除产品品类物模型", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/schema/multi-update": { "post": { "operationId": "postApiV1ThingsProductCategorySchemaMulti-update", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategorySchemaMultiSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量更新产品品类物模型", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/category/update": { "post": { "operationId": "postApiV1ThingsProductCategoryUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategory" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新产品品类", "tags": [ "things/product/category", "thingsProductCategory" ], "x-auth-type": "admin" } }, "/api/v1/things/product/config/update": { "post": { "operationId": "postApiV1ThingsProductConfigUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductConfig" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新配置", "tags": [ "things/product/config", "thingsProductConfig" ], "x-auth-type": "admin" } }, "/api/v1/things/product/custom/read": { "post": { "operationId": "postApiV1ThingsProductCustomRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCustomReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductCustom" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品自定义信息详情", "tags": [ "things/product/custom", "thingsProductCustom" ] } }, "/api/v1/things/product/custom/update": { "post": { "operationId": "postApiV1ThingsProductCustomUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCustom" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新产品自定义信息", "tags": [ "things/product/custom", "thingsProductCustom" ] } }, "/api/v1/things/product/info/create": { "post": { "operationId": "postApiV1ThingsProductInfoCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增产品", "tags": [ "things/product/info", "thingsProductInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/info/delete": { "post": { "operationId": "postApiV1ThingsProductInfoDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除产品", "tags": [ "things/product/info", "thingsProductInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/info/index": { "post": { "operationId": "postApiV1ThingsProductInfoIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInfoIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductInfoIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品信息列表", "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/init": { "post": { "operationId": "postApiV1ThingsProductInfoInit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInitReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "初始化产品", "tags": [ "things/product/info", "thingsProductInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/info/multi-export": { "post": { "operationId": "postApiV1ThingsProductInfoMulti-export", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInfoExportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductInfoExportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导出产品", "tags": [ "things/product/info", "thingsProductInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/info/multi-import": { "post": { "operationId": "postApiV1ThingsProductInfoMulti-import", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInfoImportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ImportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导入产品", "tags": [ "things/product/info", "thingsProductInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/info/read": { "post": { "operationId": "postApiV1ThingsProductInfoRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInfoReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品详情", "tags": [ "things/product/info", "thingsProductInfo" ] } }, "/api/v1/things/product/info/update": { "post": { "operationId": "postApiV1ThingsProductInfoUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新产品", "tags": [ "things/product/info", "thingsProductInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/product/remote-config/create": { "post": { "operationId": "postApiV1ThingsProductRemote-configCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRemoteConfigCreateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建配置", "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/remote-config/index": { "post": { "operationId": "postApiV1ThingsProductRemote-configIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRemoteConfigIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductRemoteConfigIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取配置列表", "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/remote-config/lastest-read": { "post": { "operationId": "postApiV1ThingsProductRemote-configLastest-read", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRemoteConfigLastestReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductRemoteConfigLastestReadResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取最新配置", "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/remote-config/push-all": { "post": { "operationId": "postApiV1ThingsProductRemote-configPush-all", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRemoteConfigPushAllReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "推送配置", "tags": [ "things/product/remoteConfig", "thingsProductRemoteConfig" ] } }, "/api/v1/things/product/schema/create": { "post": { "operationId": "postApiV1ThingsProductSchemaCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaCreateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "创建产品物模型", "tags": [ "things/product/schema", "thingsProductSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/product/schema/delete": { "post": { "operationId": "postApiV1ThingsProductSchemaDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除产品物模型", "tags": [ "things/product/schema", "thingsProductSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/product/schema/index": { "post": { "operationId": "postApiV1ThingsProductSchemaIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductSchemaIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品物模型", "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/multi-create": { "post": { "operationId": "postApiV1ThingsProductSchemaMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaMultiCreateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量创建产品物模型", "tags": [ "things/product/schema", "thingsProductSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/product/schema/tsl-import": { "post": { "operationId": "postApiV1ThingsProductSchemaTsl-import", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaTslImportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "导入产品物模型tsl", "tags": [ "things/product/schema", "thingsProductSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/product/schema/tsl-read": { "post": { "operationId": "postApiV1ThingsProductSchemaTsl-read", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaTslReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProductSchemaTslReadResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取产品物模型tsl", "tags": [ "things/product/schema", "thingsProductSchema" ] } }, "/api/v1/things/product/schema/update": { "post": { "operationId": "postApiV1ThingsProductSchemaUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSchemaUpdateReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新产品物模型", "tags": [ "things/product/schema", "thingsProductSchema" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/info/create": { "post": { "operationId": "postApiV1ThingsProtocolInfoCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增自定义协议", "tags": [ "things/protocol/info", "thingsProtocolInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/info/delete": { "post": { "operationId": "postApiV1ThingsProtocolInfoDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除自定义协议", "tags": [ "things/protocol/info", "thingsProtocolInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/info/index": { "post": { "operationId": "postApiV1ThingsProtocolInfoIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolInfoIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolInfoIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取自定义协议信息列表", "tags": [ "things/protocol/info", "thingsProtocolInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/info/read": { "post": { "operationId": "postApiV1ThingsProtocolInfoRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDOrCode" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取自定义协议详情", "tags": [ "things/protocol/info", "thingsProtocolInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/info/update": { "post": { "operationId": "postApiV1ThingsProtocolInfoUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新自定义协议", "tags": [ "things/protocol/info", "thingsProtocolInfo" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/create": { "post": { "operationId": "postApiV1ThingsProtocolScriptCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScript" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithIDStr" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增协议脚本", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/debug": { "post": { "operationId": "postApiV1ThingsProtocolScriptDebug", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptDebugReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolScriptDebugResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "协议脚本调试", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/delete": { "post": { "operationId": "postApiV1ThingsProtocolScriptDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDStr" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除协议脚本", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/device/create": { "post": { "operationId": "postApiV1ThingsProtocolScriptDeviceCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptDevice" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithIDStr" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增协议脚本设备", "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/device/delete": { "post": { "operationId": "postApiV1ThingsProtocolScriptDeviceDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDStr" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除协议脚本设备", "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/device/index": { "post": { "operationId": "postApiV1ThingsProtocolScriptDeviceIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptDeviceIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolScriptDeviceIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取协议脚本设备列表", "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/device/read": { "post": { "operationId": "postApiV1ThingsProtocolScriptDeviceRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDStr" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolScriptDevice" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取协议脚本设备详情", "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/device/update": { "post": { "operationId": "postApiV1ThingsProtocolScriptDeviceUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptDevice" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新协议脚本设备", "tags": [ "things/protocol/script/device", "thingsProtocolScriptDevice" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/index": { "post": { "operationId": "postApiV1ThingsProtocolScriptIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolScriptIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取协议脚本列表", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/multi-export": { "post": { "operationId": "postApiV1ThingsProtocolScriptMulti-export", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptExportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolScriptExportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导出协议脚本", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/multi-import": { "post": { "operationId": "postApiV1ThingsProtocolScriptMulti-import", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScriptImportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ImportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导入协议脚本", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/read": { "post": { "operationId": "postApiV1ThingsProtocolScriptRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithIDStr" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolScript" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取协议脚本详情", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/script/update": { "post": { "operationId": "postApiV1ThingsProtocolScriptUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolScript" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新协议脚本", "tags": [ "things/protocol/script", "thingsProtocolScript" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/service/delete": { "post": { "operationId": "postApiV1ThingsProtocolServiceDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithID" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除自定义协议服务器", "tags": [ "things/protocol/service", "thingsProtocolService" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/service/index": { "post": { "operationId": "postApiV1ThingsProtocolServiceIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolServiceIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolServiceIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取自定义协议服务器信息列表", "tags": [ "things/protocol/service", "thingsProtocolService" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/sync/device": { "post": { "operationId": "postApiV1ThingsProtocolSyncDevice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProtocolSyncDeviceReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ProtocolSyncDeviceResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "设备同步(如果该协议不支持会返回不支持)", "tags": [ "things/protocol/sync", "thingsProtocolSync" ], "x-auth-type": "admin" } }, "/api/v1/things/protocol/sync/product": { "post": { "operationId": "postApiV1ThingsProtocolSyncProduct", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "产品同步(如果该协议不支持会返回不支持)", "tags": [ "things/protocol/sync", "thingsProtocolSync" ], "x-auth-type": "admin" } }, "/api/v1/things/schema/common/create": { "post": { "operationId": "postApiV1ThingsSchemaCommonCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSchemaInfo" } } }, "description": "/*物模型条目*/", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "新增通用物模型", "tags": [ "things/schema/common", "thingsSchemaCommon" ], "x-auth-type": "admin" } }, "/api/v1/things/schema/common/delete": { "post": { "operationId": "postApiV1ThingsSchemaCommonDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSchemaDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除通用物模型", "tags": [ "things/schema/common", "thingsSchemaCommon" ], "x-auth-type": "admin" } }, "/api/v1/things/schema/common/index": { "post": { "operationId": "postApiV1ThingsSchemaCommonIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSchemaIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/CommonSchemaIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取通用物模型列表", "tags": [ "things/schema/common", "thingsSchemaCommon" ] } }, "/api/v1/things/schema/common/init": { "post": { "operationId": "postApiV1ThingsSchemaCommonInit", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "初始化通用物模型", "tags": [ "things/schema/common", "thingsSchemaCommon" ], "x-auth-type": "admin" } }, "/api/v1/things/schema/common/multi-export": { "post": { "operationId": "postApiV1ThingsSchemaCommonMulti-export", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSchemaExportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/CommonSchemaExportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导出通用物模型", "tags": [ "things/schema/common", "thingsSchemaCommon" ], "x-auth-type": "admin" } }, "/api/v1/things/schema/common/multi-import": { "post": { "operationId": "postApiV1ThingsSchemaCommonMulti-import", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSchemaImportReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/ImportResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量导入通用物模型", "tags": [ "things/schema/common", "thingsSchemaCommon" ], "x-auth-type": "admin" } }, "/api/v1/things/schema/common/update": { "post": { "operationId": "postApiV1ThingsSchemaCommonUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonSchemaInfo" } } }, "description": "/*物模型条目*/", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新通用物模型", "tags": [ "things/schema/common", "thingsSchemaCommon" ], "x-auth-type": "admin" } }, "/api/v1/things/slot/area/create": { "post": { "operationId": "postApiV1ThingsSlotAreaCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlotAreaSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "插槽区域创建", "tags": [ "things/slot/area", "thingsSlotArea" ] } }, "/api/v1/things/slot/area/delete": { "post": { "operationId": "postApiV1ThingsSlotAreaDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlotAreaSaveReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "插槽区域更新", "tags": [ "things/slot/area", "thingsSlotArea" ] } }, "/api/v1/things/slot/user/subscribe": { "post": { "operationId": "postApiV1ThingsSlotUserSubscribe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlotUserSubscribe" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/SlotUserSubscribeResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "插槽用户订阅", "tags": [ "things/slot/user", "thingsSlotUser" ] } }, "/api/v1/things/user/device/collect/index": { "post": { "operationId": "postApiV1ThingsUserDeviceCollectIndex", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserCollectDeviceInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取收藏设备列表", "tags": [ "things/user/device/collect", "thingsUserDeviceCollect" ] } }, "/api/v1/things/user/device/collect/multi-create": { "post": { "operationId": "postApiV1ThingsUserDeviceCollectMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCollectDeviceSave" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量收藏设备", "tags": [ "things/user/device/collect", "thingsUserDeviceCollect" ] } }, "/api/v1/things/user/device/collect/multi-delete": { "post": { "operationId": "postApiV1ThingsUserDeviceCollectMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCollectDeviceSave" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量取消收藏设备", "tags": [ "things/user/device/collect", "thingsUserDeviceCollect" ] } }, "/api/v1/things/user/device/share/create": { "post": { "operationId": "postApiV1ThingsUserDeviceShareCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/WithID" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "分享设备", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/delete": { "post": { "operationId": "postApiV1ThingsUserDeviceShareDelete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "取消分享设备", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/index": { "post": { "operationId": "postApiV1ThingsUserDeviceShareIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareIndexReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserDeviceShareIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取分享设备列表", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-accept": { "post": { "operationId": "postApiV1ThingsUserDeviceShareMulti-accept", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareMultiAcceptInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "接受批量分享设备", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-create": { "post": { "operationId": "postApiV1ThingsUserDeviceShareMulti-create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareMultiInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserDeviceShareMultiToken" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "生成批量分享设备二维码", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-delete": { "post": { "operationId": "postApiV1ThingsUserDeviceShareMulti-delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareMultiDeleteReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "批量取消分享设备", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-delete-token": { "post": { "operationId": "postApiV1ThingsUserDeviceShareMulti-delete-token", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareMultiDeleteTokenReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "删除批量分享 Token", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-get-token-list": { "post": { "operationId": "postApiV1ThingsUserDeviceShareMulti-get-token-list", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserDeviceShareMultiGetTokenListResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取批量分享 Token 列表", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/multi-index": { "post": { "operationId": "postApiV1ThingsUserDeviceShareMulti-index", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareMultiToken" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserDeviceShareMultiIndexResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取批量分享的设备列表", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/read": { "post": { "operationId": "postApiV1ThingsUserDeviceShareRead", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareReadReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserDeviceShareInfo" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "获取分享设备详情", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/token/check": { "post": { "description": "H5 分享承接页公开查询 shareToken 是否仍有效,只返回过期时间和精简状态,不返回权限详情。", "operationId": "postApiV1ThingsUserDeviceShareTokenCheck", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareTokenCheckReq" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "data": { "$ref": "#/components/schemas/UserDeviceShareTokenCheckResp" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "公开查询批量分享 Token 状态", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } }, "/api/v1/things/user/device/share/update": { "post": { "operationId": "postApiV1ThingsUserDeviceShareUpdate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDeviceShareInfo" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "code": { "default": "200", "title": "返回code", "type": "integer" }, "msg": { "title": "返回的消息", "type": "string" } }, "type": "object" } } }, "description": "A successful response." } }, "summary": "更新分享设备信息", "tags": [ "things/user/device/share", "thingsUserDeviceShare" ] } } } }