浏览代码

增加excel数据导入的接口文档

luoguangyi 2 年之前
父节点
当前提交
f71641809b
共有 1 个文件被更改,包括 106 次插入1 次删除
  1. 106 1
      docs/iot/iot.md

+ 106 - 1
docs/iot/iot.md

@@ -277,7 +277,6 @@ websocket端口是单独的端口,和服务端口不是同一个;
 | result    | 结果标识:成功标识:success,失败标识:fail | string         |                |
 | timestamp | 响应时间戳                                 | integer(int64) | integer(int64) |
 
-
 **响应示例**:
 
 ```json
@@ -2607,7 +2606,113 @@ websocket端口是单独的端口,和服务端口不是同一个;
 
 
 
+## iot数据导入
+
+
+### Excel在线导入
+
+
+**接口地址**:`/iot-collect/importOnline`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`multipart/form-data`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:
+
+
+**请求参数**:
+
+
+| 参数名称          | 参数说明                                                     | 请求类型 | 是否必须 | 数据类型       | 默认值值 |
+| ----------------- | ------------------------------------------------------------ | -------- | -------- | -------------- | -------- |
+| file              | file,要上传的excel,sheet名称为不带Pj的10位项目ID             | body     | true     | string         |          |
+| consumerBatchSize | 批量写入excel行数                                            | query    | false    | integer(int32) | 10       |
+| dynamicTime       | 哪个时间以后的数据动态导入,dynamicTimeEnable=true才有意义,dynamicTime时间前的静态,时间后的动态 | query    | false    | string         |          |
+| dynamicTimeEnable | 是否开启动态导入,动态导入会随着时间推移慢慢的发数据,静态会一股脑导入 | query    | false    | boolean        | false    |
+| startTime         | 限制导入时间的范围,开始时间                                  | query    | false    | string         | 空       |
+| endTime           | 限制导入时间开始围,结束时间                                  | query    | false    | string         | 空       |
+| headRowNumber     | 从那一行开始读                                               | query    | false    | integer(int32) | 0        |
+| sheetNo           | 使用第几个sheet                                              | query    | false    | integer(int32) | 0        |
+
+**响应参数**:
+
+
+| 参数名称  | 参数说明                                   | 类型           | schema         |
+| --------- | ------------------------------------------ | -------------- | -------------- |
+| code      | 结果码.00000是成功,其他都是失败            | string         |                |
+| data      | 响应数据                                   | object         |                |
+| message   | 错误提示信息                               | string         |                |
+| result    | 结果标识:成功标识:success,失败标识:fail | string         |                |
+| timestamp | 响应时间戳                                 | integer(int64) | integer(int64) |
+
+**响应示例**:
+
+```javascript
+{
+	"code": "",
+	"data": {},
+	"message": "",
+	"result": "",
+	"timestamp": 0
+}
+```
+
+
+### 终止所有动态导入
+
+
+**接口地址**:`/iot-collect/stopImportIot`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:
+
+
+**请求参数**:
+
+
+{}
+
+**响应参数**:
+
+
+| 参数名称  | 参数说明                                   | 类型           | schema         |
+| --------- | ------------------------------------------ | -------------- | -------------- |
+| code      | 结果码.00000是成功,其他都是失败            | string         |                |
+| data      | 响应数据                                   | object         |                |
+| message   | 错误提示信息                               | string         |                |
+| result    | 结果标识:成功标识:success,失败标识:fail | string         |                |
+| timestamp | 响应时间戳                                 | integer(int64) | integer(int64) |
+
+**响应示例**:
+
+```javascript
+{
+	"code": "",
+	"data": {},
+	"message": "",
+	"result": "",
+	"timestamp": 0
+}
+```
+
 
+# 
 
 ## metadat-web habse接口