kris/datai

Fork 0

Kris 3d290a8dd1 feat：归档当前所有文件

2026-01-28 18:23:25 +08:00

3.6 KiB

Raw Blame History

接口文档：导出对象字段信息列表

接口信息

接口名称: 导出对象字段信息列表
接口路径: /integration/field/export
请求方法: POST
模块归属: integration
版本号: v1.0
创建日期: 2026-01-09
最后更新: 2026-01-09

功能描述

导出对象字段信息列表到Excel文件，支持根据筛选条件导出指定的对象字段信息。

请求参数

请求体 (Form Data)

参数名	类型	必填	描述	示例
objectId	Integer	否	对象ID	123
fieldName	String	否	字段名称	AccountName
fieldType	String	否	字段类型	string
isRequired	Integer	否	是否必填，0-否，1-是	1
isIndexed	Integer	否	是否索引，0-否，1-是	0
startTime	String	否	开始时间，格式：yyyy-MM-dd HH:mm:ss	2026-01-01 00:00:00
endTime	String	否	结束时间，格式：yyyy-MM-dd HH:mm:ss	2026-01-07 23:59:59

响应数据

成功响应

HTTP 状态码: 200 OK

响应类型: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

响应内容: Excel文件二进制数据

失败响应

HTTP 状态码: 403 Forbidden

{
  "code": 403,
  "message": "无权限执行此操作",
  "data": null
}

错误码	错误信息	描述
403	无权限执行此操作	当用户没有integration:field:export权限时
500	导出失败	服务器内部错误导致导出失败

接口示例

请求示例

curl -X POST "http://localhost:8080/integration/field/export" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Authorization: Bearer [token]" \
  -d "objectId=123&fieldType=string&startTime=2026-01-01%2000:00:00&endTime=2026-01-07%2023:59:59"

响应示例

成功:

返回Excel文件下载

失败:

{
  "code": 403,
  "message": "无权限执行此操作",
  "data": null
}

错误处理

403 Forbidden: 用户无权限执行此操作
500 Internal Server Error: 服务器内部错误导致导出失败

注意事项

导出操作可能耗时较长，取决于数据量大小
导出文件包含对象字段的详细信息，包括字段名称、类型、是否必填、是否索引等
建议在非高峰期执行大量数据的导出操作
导出文件的文件名格式为：对象字段信息数据_yyyyMMddHHmmss.xlsx

实现细节

接口通过调用dataiIntegrationFieldService.selectDataiIntegrationFieldList()方法获取数据
使用ExcelUtil工具类将数据转换为Excel文件
通过HttpServletResponse直接输出Excel文件到客户端
导出操作会被记录到系统日志中

测试信息

测试环境

环境: 开发环境
版本: v1.0

测试用例

测试场景	输入参数	预期结果	实际结果	状态
导出全部对象字段信息	无参数	操作成功，下载Excel文件	操作成功，下载Excel文件	通过
导出筛选对象字段信息	objectId=123	操作成功，下载包含筛选结果的Excel文件	操作成功，下载包含筛选结果的Excel文件	通过
无权限导出	任意参数	操作失败，返回403错误	操作失败，返回403错误	通过

3.6 KiB Raw Blame History Unescape Escape