1. 导入导出API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 1.1 | excel文件导入 | /v1/stream/import | 1.0 |
| 1.2 | 错误数据导出 | /v1/stream/error-file | 1.0 |
| 1.3 | excel模板下载 | /v1/stream/template-download | 1.0 |
| 1.4 | excel导出 | /v1/stream/export | 1.0 |
| 1.5 | 导入轮询结果 | /v1/stream/schedule | 1.0 |
API调用
1.1: excel文件导入
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/stream/import
方法：POST
请求参数
form-data
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| file | File | y | 具体文件 | |
| orgId | string | y | 业务组织id | |
| module | String | y | 功能名称 DEVICE:设备；COMMUNITY:项目; ORG_ADMIN:行政组织; ORG_BIZ:业务组织; QUA_CATEGORY:专业目录分类; QUA_CHECK:品质检查项; SPACE:空间; TASK:任务；CUSTOMER:客户, ADMIN员工 |
请求Body描述(Form表单数据)
file:"/aa/bb.xlsx"
orgId:"123454"
module:"ORG_ADMIN"
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | String | N | 数据key。用于轮询导入的结果和进度 |
返回结果示例
{
"code": "200",
"data": "SPACE:099add03-b49a-4e6a-b580-104a7e16b2e8_1647949449715",
"message": "导入成功"
}
1.2: 错误数据导出
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/stream/error-file
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| errorFile | 顶层 | String | N | 错误数据key , 如果有错误数据，返回key, 用于作为下载标识 |
请求Body描述(非Form表单数据)
{
"errorFile": "ORG_BIZ13018a943-06f6-4f7d-9267-87c20bfa4445:1645431381930"
}
返回信息
返回参数类型
JSON
返回参数
如果出误异常， 则返回json异常信息, 否则, 返回正常的excel文件流
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
返回结果示例
{
"code": "1",
"message": "数据已过期"
}
1.3: excel模板下载
描述
请求信息
HTTP协议：HTTP,HTTPS
uri： /v1/stream/template-download
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| module | String | y | 功能名称 DEVICE:设备；TASK:任务；COMMUNITY:项目; SPACE:空间;ORG_ADMIN:行政组织; ORG_BIZ:业务组织; QUA_CATEGORY:专业目录分类; QUA_CHECK:品质检查项; CUSTOMER:客户 ADMIN:员工 |
请求Body描述(非Form表单数据)
{
"module":"ORG_ADMIN"
}
返回信息
返回参数类型
JSON
返回参数
如果出误异常， 则返回json异常信息, 否则, 返回正常的excel文件流
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
返回结果示例
{
"code": "1",
"message": "数据已过期"
}
1.4: excel导出
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/stream/export
方法：POST
请求参数
form-data
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| module | String | y | 功能名称 DEVICE:设备；COMMUNITY:项目; ORG_ADMIN:行政组织; ORG_BIZ:业务组织; QUA_CATEGORY:专业目录分类; QUA_CHECK:品质检查项; SPACE:空间; TASK:任务；CUSTOMER:客户 |
请求Body描述(Form表单数据)
请求参数与页面分页列表的传参一致再加一个module ,分页参数查询头10000条
{module:"ORG_ADMIN"，
}
返回信息
返回参数类型
JSON
返回参数
如果出误异常， 则返回json异常信息, 否则, 返回正常的excel文件流
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
返回结果示例
{
"code": "1",
"message": "数据已过期"
}
1.5: 导入结果轮询
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/stream/schedule
方法：POST
请求参数
请求Body描述(Form表单数据)
请求参数与页面分页列表的传参一致再加一个module ,分页参数查询头10000条
{
"redisKey":"SPACE:099add03-b49a-4e6a-b580-104a7e16b2e8_1647949449715"
}
返回信息
返回参数类型
JSON
返回参数
如果出误异常， 则返回json异常信息, 否则, 返回正常的excel文件流
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识。200标识查询请求成功 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 结果和进度 |
| code | JSONObject | STRING | 否 | 异步导入结果：200标识导入成功；1标识导入失败 |
| message | JSONObject | STRING | 否 | 导入结果文本消息 |
| schedule | JSONObject | STRING | 是 | 进度 1代表100% ；0.5代表50% |
| errorFile | JSONObject | STRING | 否 | 错误文件key |
返回结果示例
-- 进度80%
{
"code": "200",
"data": {
"schedule": "0.8"
},
"message": "成功"
}
-- 进度100% ，导入成功，有错误文件
{
"code": "200",
"data": {
"schedule": "1",
"message": "文件数据有误，请下载文档查看错误明细",
"code": "200",
"errorFile": "SPACE:9b13b1bc-d1a9-4371-a2ab-6ca11d7fc26f_1647951101552"
},
"message": "成功"
}
-- 全部导入成功，无错误文件
{
"code": "200",
"data": {
"code": "200",
"message": "导入成功",
"schedule": "1"
},
"message": "成功"
}
-- 进度100% ，导入失败
{
"code": "200",
"data": {
"schedule": "1",
"message": "错误信息",
"code": "1"
},
"message": "成功"
}