diff --git a/动态指标.md b/动态指标.md new file mode 100644 index 0000000..e69de29 diff --git a/通用指标.md b/通用指标.md index e69de29..bbb8b17 100644 --- a/通用指标.md +++ b/通用指标.md @@ -0,0 +1,94 @@ +# 接口名称:物联数据源 + +- 接口路径:`POST /api/BusinessThing/GetThingTreeChild` +- 适用范围:云端 / 客户现场 +- 最早版本:v1.0.0 +- 最新变更:v1.2.0 +- 负责人:@开发或@实施 + +## 授权方式 +`authorization`:`Bearer xxx` + +## 请求参数 +1. 参数定义 + +| 参数 | 类型 | 必填 | 说明 | +|----|----|----|----| +| projectId | long | 是 | 项目ID | +| parentId | long | 是 | 父Id | + +2. 请求实例 +```json +{"projectId":513483640334377,"parentId":0} +``` + +## 请求`Header` +projectid:123 + +## 返回结果 +1. 参数定义 + +| 参数 | 类型 | 必填 | 说明 | +|----|----|----|----| +| thingId | long | 是 | 物属性Id | +| code | string | 是 | Project项目 Building建筑 Equipment设备 Point参数| +| parentId | long | 是 | 父Id | +| status | short | 是 | 状态0离线、1在线,针对参数 | +| icons | string | 是 | 图标 | +| paramCode | string | 是 | 标签 | +| children | object | 是 | 子节点 | + +2. 返回实例 +```json +{ + "code": 200, + "msg": "操作成功", + "innerMsg": null, + "data": [ + { + "thingId": 513483640334377, + "code": "Project", + "name": "奥捷大厦智慧能源管理中心", + "parentId": 0, + "status": 0, + "icons": "iconxiangmu", + "paramCode": null, + "flvUrl": "", + "children": [ + { + "thingId": 542191051518496, + "code": "Building", + "name": "10层", + "parentId": 513483640334377, + "status": 0, + "icons": "iconjianzhu_o", + "paramCode": null, + "flvUrl": "", + "children": [], + "childCount": 44, + "qualityRuleCount": 0 + } + ], + "childCount": 18, + "qualityRuleCount": 0 + } + ] +} +``` +## 使用说明 + +* 何时调用 +1. 获取项目的层级结构 +2. 获取项目的空间、设备和参数 +* 执行方式 +无 +* 注意事项 +无 +* 客户差异说明 +无 + +## 变更历史 + +* v1.2.0: +> 优化成懒加载 +* v1.0.0:初版 \ No newline at end of file