diff --git a/docs/api/data.md b/docs/api/data.md index 6cf7b7e1..1aa56b13 100644 --- a/docs/api/data.md +++ b/docs/api/data.md @@ -20,6 +20,68 @@ POST 请求接口 请求参数 +```json +[ + { + "deviceId":"129476828342323", + "attributes":["power","windSpeed","dailyUsageHours","monthlyUsageHours"] + }, + { + "deviceId":"129476828342324", + "attributes":["power","windSpeed","dailyUsageHours","monthlyUsageHours"] + } + ...... +] + +``` +入参描述 + +| 参数名 | 参数类型 | 可选 | 描述 | +| ------------ | -------- | ---- |------| +| deviceId | String | no | 设备ID | +| attributes | StringArray | no | 要查询实时数据的设备属性列表 | + +> PS: 当attributes为空时,返回所有属性。 + +返回报文 + +```json +{ + "code": 200, + "msg": "操作成功", + "success": true, + "data": { + "129476828342323":{ + "power": 56.2, + "windSpeed": 45.3, + "dailyUsageHours": 20, + "monthlyUsageHours": 78, + .... + }, + "129476828342324":{ + "power": 53.2, + "windSpeed": 35.3, + "dailyUsageHours": 10, + "monthlyUsageHours": 48, + .... + } + } +} +``` +返参描述 + +data 中以字典的方式,返回查询的每个设备的属性的实时值。 + + +### 历史区间数据查询 + +POST 请求接口 + +> /api/data/history + +请求参数 + + ```json { "deviceId":"129476828342323", @@ -51,4 +113,4 @@ POST 请求接口 ``` 返参描述 -data 中以字典的方式,返回查询的属性的实时值。 +data 中以字典的方式,返回查询的属性的实时值。 \ No newline at end of file