Browse Source

重新生成 API 接口文档并同步开发文档

- 依据最新 api.json 重新生成 docs/api,路径统一为单前缀 /gd_dataserver,接口数 278 → 282

- 新增 4 个接口:数据分析首页-核心指标概览/待办与预警/近7日趋势与最新上报,积分规则-按等级查询 rulesByLevel

- 更新 README、catalog、schemas 及各模块文档;page-api-map 改为单前缀并补充新接口映射

- 追加 docs/development 的当前状态与开发日志
master
DU 4 days ago
parent
commit
c325354e5d
  1. 11
      docs/api/README.md
  2. 1060
      docs/api/catalog.json
  3. 8
      docs/api/modules/00-common-controller.md
  4. 20
      docs/api/modules/00-test-controller.md
  5. 320
      docs/api/modules/01-hazard-management.md
  6. 58
      docs/api/modules/02-hazard-flow.md
  7. 54
      docs/api/modules/03-hazard-flow-config.md
  8. 60
      docs/api/modules/04-points-balance.md
  9. 81
      docs/api/modules/05-points-transaction.md
  10. 246
      docs/api/modules/06-points-rule.md
  11. 104
      docs/api/modules/07-points-appeal.md
  12. 63
      docs/api/modules/08-exchange-order.md
  13. 56
      docs/api/modules/09-exchange-item.md
  14. 56
      docs/api/modules/10-exchange-order-track.md
  15. 64
      docs/api/modules/11-exchange-config.md
  16. 56
      docs/api/modules/12-exchange-operation-log.md
  17. 72
      docs/api/modules/13-anti-farm-config.md
  18. 16
      docs/api/modules/14-mall-integration.md
  19. 136
      docs/api/modules/15-data-analysis.md
  20. 52
      docs/api/modules/16-audit-log.md
  21. 44
      docs/api/modules/17-flow-definition.md
  22. 92
      docs/api/modules/18-flow-task.md
  23. 16
      docs/api/modules/19-flow-instance.md
  24. 4
      docs/api/modules/20-flow-common.md
  25. 8
      docs/api/modules/21-flow-sign-task.md
  26. 6
      docs/api/modules/22-flow-sign.md
  27. 22
      docs/api/modules/23-user-message.md
  28. 4
      docs/api/modules/24-message.md
  29. 8
      docs/api/modules/25-system-tool.md
  30. 62
      docs/api/modules/99-module-28.md
  31. 86
      docs/api/page-api-map.md
  32. 29
      docs/api/schemas.md
  33. 40
      docs/development/CURRENT_STATUS.md
  34. 724
      docs/development/CURRENT_TASK.md
  35. 196
      docs/development/DEVELOPMENT_LOG.md

11
docs/api/README.md

@ -9,7 +9,7 @@
- 文档版本:版本号:3.8.7 - 文档版本:版本号:3.8.7
- 服务地址:`http://www.bjsdqc.cn:10090` - 服务地址:`http://www.bjsdqc.cn:10090`
- 鉴权定义:`X-Access-Token`(apiKey,header: X-Access-Token) - 鉴权定义:`X-Access-Token`(apiKey,header: X-Access-Token)
- 接口数量:278 - 接口数量:282
- 数据模型:32 - 数据模型:32
## 开发时怎么查 ## 开发时怎么查
@ -25,12 +25,12 @@
| --- | --- | --- | | --- | --- | --- |
| common-controller | 2 | [打开](./modules/00-common-controller.md) | | common-controller | 2 | [打开](./modules/00-common-controller.md) |
| test-controller-1 | 5 | [打开](./modules/00-test-controller.md) | | test-controller-1 | 5 | [打开](./modules/00-test-controller.md) |
| 隐患信息管理 | 21 | [打开](./modules/01-hazard-management.md) | | 隐患信息管理 | 22 | [打开](./modules/01-hazard-management.md) |
| 隐患上报流程 | 6 | [打开](./modules/02-hazard-flow.md) | | 隐患上报流程 | 5 | [打开](./modules/02-hazard-flow.md) |
| 隐患流程模板配置 | 6 | [打开](./modules/03-hazard-flow-config.md) | | 隐患流程模板配置 | 6 | [打开](./modules/03-hazard-flow-config.md) |
| 用户积分账户 | 15 | [打开](./modules/04-points-balance.md) | | 用户积分账户 | 15 | [打开](./modules/04-points-balance.md) |
| 积分流水明细 | 14 | [打开](./modules/05-points-transaction.md) | | 积分流水明细 | 14 | [打开](./modules/05-points-transaction.md) |
| 积分规则配置 | 14 | [打开](./modules/06-points-rule.md) | | 积分规则配置 | 13 | [打开](./modules/06-points-rule.md) |
| 积分申诉管理 | 21 | [打开](./modules/07-points-appeal.md) | | 积分申诉管理 | 21 | [打开](./modules/07-points-appeal.md) |
| 积分兑换订单管理 | 14 | [打开](./modules/08-exchange-order.md) | | 积分兑换订单管理 | 14 | [打开](./modules/08-exchange-order.md) |
| 兑换物品管理 | 14 | [打开](./modules/09-exchange-item.md) | | 兑换物品管理 | 14 | [打开](./modules/09-exchange-item.md) |
@ -39,7 +39,7 @@
| 兑换操作日志 | 14 | [打开](./modules/12-exchange-operation-log.md) | | 兑换操作日志 | 14 | [打开](./modules/12-exchange-operation-log.md) |
| 防刷分管控配置 | 18 | [打开](./modules/13-anti-farm-config.md) | | 防刷分管控配置 | 18 | [打开](./modules/13-anti-farm-config.md) |
| 商城端接口对接 | 4 | [打开](./modules/14-mall-integration.md) | | 商城端接口对接 | 4 | [打开](./modules/14-mall-integration.md) |
| 数据分析 | 17 | [打开](./modules/15-data-analysis.md) | | 数据分析 | 20 | [打开](./modules/15-data-analysis.md) |
| 操作审计日志 | 13 | [打开](./modules/16-audit-log.md) | | 操作审计日志 | 13 | [打开](./modules/16-audit-log.md) |
| 流程定义 | 11 | [打开](./modules/17-flow-definition.md) | | 流程定义 | 11 | [打开](./modules/17-flow-definition.md) |
| 工作流流程任务管理 | 23 | [打开](./modules/18-flow-task.md) | | 工作流流程任务管理 | 23 | [打开](./modules/18-flow-task.md) |
@ -50,6 +50,7 @@
| 用户消息中心 | 5 | [打开](./modules/23-user-message.md) | | 用户消息中心 | 5 | [打开](./modules/23-user-message.md) |
| 消息处理接口 | 1 | [打开](./modules/24-message.md) | | 消息处理接口 | 1 | [打开](./modules/24-message.md) |
| 系统工具 | 2 | [打开](./modules/25-system-tool.md) | | 系统工具 | 2 | [打开](./modules/25-system-tool.md) |
| sys-dept-controller | 2 | [打开](./modules/99-module-28.md) |
## 更新文档 ## 更新文档

1060
docs/api/catalog.json

File diff suppressed because it is too large Load Diff

8
docs/api/modules/00-common-controller.md

@ -12,8 +12,8 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 文件删除接口 | POST | `/gd_dataserver/gd_dataserver/common/deletefile` | - | | 文件删除接口 | POST | `/gd_dataserver/common/deletefile` | - |
| 文件删除接口 | POST | `/gd_dataserver/gd_dataserver/common/deletefilelist` | - | | 文件删除接口 | POST | `/gd_dataserver/common/deletefilelist` | - |
## 接口详情 ## 接口详情
@ -23,7 +23,7 @@
### 文件删除接口 ### 文件删除接口
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/common/deletefile` - **请求:** `POST /gd_dataserver/common/deletefile`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deletefileUsingPOST` - **operationId:** `deletefileUsingPOST`
@ -47,7 +47,7 @@
### 文件删除接口 ### 文件删除接口
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/common/deletefilelist` - **请求:** `POST /gd_dataserver/common/deletefilelist`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deletefilelistUsingPOST` - **operationId:** `deletefilelistUsingPOST`

20
docs/api/modules/00-test-controller.md

@ -12,11 +12,11 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 获取用户列表 | GET | `/gd_dataserver/gd_dataserver/test/user/list` | - | | 获取用户列表 | GET | `/gd_dataserver/test/user/list` | - |
| 新增用户 | POST | `/gd_dataserver/gd_dataserver/test/user/save` | - | | 新增用户 | POST | `/gd_dataserver/test/user/save` | - |
| 更新用户 | PUT | `/gd_dataserver/gd_dataserver/test/user/update` | - | | 更新用户 | PUT | `/gd_dataserver/test/user/update` | - |
| 获取用户详细 | GET | `/gd_dataserver/gd_dataserver/test/user/{userId}` | - | | 获取用户详细 | GET | `/gd_dataserver/test/user/{userId}` | - |
| 删除用户信息 | DELETE | `/gd_dataserver/gd_dataserver/test/user/{userId}` | - | | 删除用户信息 | DELETE | `/gd_dataserver/test/user/{userId}` | - |
## 接口详情 ## 接口详情
@ -26,7 +26,7 @@
### 获取用户列表 ### 获取用户列表
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/test/user/list` - **请求:** `GET /gd_dataserver/test/user/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `userListUsingGET_1` - **operationId:** `userListUsingGET_1`
@ -47,7 +47,7 @@ _无_
### 新增用户 ### 新增用户
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/test/user/save` - **请求:** `POST /gd_dataserver/test/user/save`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `saveUsingPOST_2` - **operationId:** `saveUsingPOST_2`
@ -74,7 +74,7 @@ _无_
### 更新用户 ### 更新用户
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `PUT /gd_dataserver/gd_dataserver/test/user/update` - **请求:** `PUT /gd_dataserver/test/user/update`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateUsingPUT` - **operationId:** `updateUsingPUT`
@ -110,7 +110,7 @@ _无_
### 获取用户详细 ### 获取用户详细
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/test/user/{userId}` - **请求:** `GET /gd_dataserver/test/user/{userId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getUserUsingGET` - **operationId:** `getUserUsingGET`
@ -133,7 +133,7 @@ _无_
### 删除用户信息 ### 删除用户信息
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `DELETE /gd_dataserver/gd_dataserver/test/user/{userId}` - **请求:** `DELETE /gd_dataserver/test/user/{userId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingDELETE_2` - **operationId:** `deleteUsingDELETE_2`

320
docs/api/modules/01-hazard-management.md

@ -2,7 +2,7 @@
本模块共 21 个接口。源文件:`api.json`。 本模块共 22 个接口。源文件:`api.json`。
@ -12,27 +12,28 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/hazard/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/hazard/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/hazard/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/hazard/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/hazard/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/hazard/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 删除附件 | DELETE | `/gd_dataserver/gd_dataserver/business/hazard/attachment/{ids}` | 返回 data 为 boolean,true-删除成功。 | | 删除附件 | DELETE | `/gd_dataserver/business/hazard/attachment/{ids}` | 返回 data 为 boolean,true-删除成功。 |
| 按隐患ID查附件列表 | GET | `/gd_dataserver/gd_dataserver/business/hazard/attachment/{reportId}` | 返回 data 为 HazardAttachment 数组。每个元素包含:id-附件ID、reportId-隐患ID、fileName-文件名、fileUrl-文件访问URL、fileType-文件类型、fileSize-文件大小。 | | 按隐患ID查附件列表 | GET | `/gd_dataserver/business/hazard/attachment/{reportId}` | 返回 data 为 HazardAttachment 数组。每个元素包含:id-附件ID、reportId-隐患ID、fileName-文件名、fileUrl-文件访问URL、fileType-文件类型、fileSize-文件大小。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/hazard/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/hazard/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/hazard/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/hazard/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/hazard/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/hazard/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 导出隐患列表Excel | POST | `/gd_dataserver/gd_dataserver/business/hazard/export` | 直接返回 Excel 文件流(Content-Type: application/octet-stream),前端需以 Blob 方式接收并下载。 | | 导出隐患列表Excel | POST | `/gd_dataserver/business/hazard/export` | 超级管理员导出所有厂区;非超级管理员仅导出本厂区。直接返回 Excel 文件流,前端以 Blob 方式接收下载。 |
| 生成隐患编号 | POST | `/gd_dataserver/gd_dataserver/business/hazard/generateReportNo` | 返回 data 为 String 类型的隐患编号,格式如 HR20260827001。 | | 生成隐患编号 | POST | `/gd_dataserver/business/hazard/generateReportNo` | 返回 data 为 String 类型的隐患编号,格式如 HR20260827001。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/hazard/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/hazard/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/hazard/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 隐患台账分页查询 | GET | `/gd_dataserver/business/hazard/getListByPage` | 超级管理员返回所有厂区隐患;非超级管理员自动过滤为所属厂区的隐患。返回 data 为 PageInfo 分页对象,其中 list 为 HazardReport 数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/hazard/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/hazard/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 查隐患详情 | GET | `/gd_dataserver/gd_dataserver/business/hazard/info/{id}` | 返回 data 为 HazardReport 对象。主要字段:id-主键、reportNo-隐患编号、hazardName-隐患名称、description-隐患描述、unitName-单位名称、departmentName-部门名称、hazardLevelName-隐患级别名称、hazardCategoryName-隐患分类名称、status-状态编码(0待提交/1审核中/2整改中/3已通过/4已驳回)、statusName-状态名称、reporterName-上报人姓名、chargePersonName-整改负责人姓名、pointsAwarded-奖励积分、flowStatus-流程状态(0未开始/1进行中/2已完成)、canApprove-当前用户是否可审批、isInitiator-当前用户是否为此流程发起人。 | | 查隐患详情 | GET | `/gd_dataserver/business/hazard/info/{id}` | 返回 data 为 HazardReport 对象。主要字段:id-主键、reportNo-隐患编号、hazardName-隐患名称、description-隐患描述、unitName-单位名称、departmentName-部门名称、hazardLevelName-隐患级别名称、hazardCategoryName-隐患分类名称、status-状态编码(draft待提交/reviewing审核中/rectifying整改中/approved已通过/rejected已驳回)、statusName-状态名称、reporterName-上报人姓名、chargePersonName-整改负责人姓名、pointsAwarded-奖励积分、flowStatus-流程状态(0未开始/1进行中/2已完成)、canApprove-当前用户是否可审批、isInitiator-当前用户是否为此流程发起人。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/hazard/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/hazard/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询我的上报记录(APP端) | GET | `/gd_dataserver/gd_dataserver/business/hazard/myList` | 分页查询当前登录用户已上报的隐患记录列表。返回 data 为 PageInfo 分页对象,包含 total/list/pageNum/pageSize 等。list 中每条记录为 HazardReport 对象,主要字段:id、reportNo、hazardName、status-状态编码、statusName-状态名称、hazardLevelName-级别名称、pointsAwarded-奖励积分、createTime-创建时间。 | | 查询我的上报记录(APP端) | GET | `/gd_dataserver/business/hazard/myList` | 分页查询当前登录用户已上报的隐患记录列表。返回 data 为 PageInfo 分页对象,包含 total/list/pageNum/pageSize 等。list 中每条记录为 HazardReport 对象,主要字段:id、reportNo、hazardName、status-状态编码、statusName-状态名称、hazardLevelName-级别名称、pointsAwarded-奖励积分、createTime-创建时间。 |
| 首页今日概览-我的隐患统计(APP端) | GET | `/gd_dataserver/gd_dataserver/business/hazard/myStats` | 按状态分类统计当前登录用户的隐患数量。返回字段说明:todayReportCount-今日上报数、pendingAuditCount-待审核数、rectifyingCount-整改中数、rejectedCount-已驳回数。 | | 首页今日概览-我的隐患统计(APP端) | GET | `/gd_dataserver/business/hazard/myStats` | 按状态分类统计当前登录用户的隐患数量。返回字段说明:todayReportCount-今日上报数、pendingAuditCount-待审核数、rectifyingCount-整改中数、rejectedCount-已驳回数。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/hazard/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/hazard/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 保存隐患信息(草稿,不启动流程) | POST | `/gd_dataserver/gd_dataserver/business/hazard/save` | 保存隐患记录及附件,不启动审批流程。返回 data 为 HazardReport 对象,包含 id、reportNo 等完整隐患字段。 | | 保存隐患信息(草稿,不启动流程) | POST | `/gd_dataserver/business/hazard/save` | 保存隐患记录及附件,不启动审批流程。返回 data 为 HazardReport 对象,包含 id、reportNo 等完整隐患字段。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/hazard/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/hazard/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
| 删除隐患(级联删除附件) | DELETE | `/gd_dataserver/gd_dataserver/business/hazard/{ids}` | 返回 data 为 boolean,true-删除成功,false-删除失败。同时级联删除关联的附件记录。 | | 上传隐患附件文件 | POST | `/gd_dataserver/business/hazard/uploadAttachment` | 上传文件到服务器,返回 data 为 HazardAttachment 数组,每个元素包含:id、fileName-文件名、filePath-文件路径、fileSize-文件大小、fileType-MIME类型、attachmentType-附件类型。前端在调用 save 或 submitFlow 时将附件数据传入 |
| 删除隐患(级联删除附件) | DELETE | `/gd_dataserver/business/hazard/{ids}` | 返回 data 为 boolean,true-删除成功,false-删除失败。同时级联删除关联的附件记录。 |
## 接口详情 ## 接口详情
@ -42,7 +43,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/add` - **请求:** `POST /gd_dataserver/business/hazard/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_8` - **operationId:** `addOneUsingPOST_8`
@ -59,10 +60,11 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actualCompleteTime | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | 否 | string / date-time | 实际完成时间 | - |
| attachments | 否 | array<隐患附件> | 附件列表 | - |
| auditRemark | 否 | string | 审核备注 | - | | auditRemark | 否 | string | 审核备注 | - |
| auditTime | 否 | string / date-time | 审核时间 | - | | auditTime | 否 | string / date-time | 审核时间 | - |
| auditUserId | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | 否 | string | 审核人姓名 | - | | auditUserName | 否 | string | 审核人姓名 | - |
| auditUserUsername | 否 | string | 审核人账号 | - | | auditUserUsername | 否 | string | 审核人账号 | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| causeAnalysis | 否 | string | 原因分析 | - | | causeAnalysis | 否 | string | 原因分析 | - |
@ -71,6 +73,8 @@ _无_
| chargePersonUsername | 否 | string | 整改负责人账号 | - | | chargePersonUsername | 否 | string | 整改负责人账号 | - |
| createBy | 否 | string | 创建者 | - | | createBy | 否 | string | 创建者 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| criteriaIds | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | 否 | string | 判定标准名称 | - |
| currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | 否 | integer / int64 | 部门ID | - | | departmentId | 否 | integer / int64 | 部门ID | - |
| departmentName | 否 | string | 部门名称 | - | | departmentName | 否 | string | 部门名称 | - |
@ -79,6 +83,10 @@ _无_
| discoverTime | 否 | string / date-time | 发现时间 | - | | discoverTime | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - | | factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | 否 | string | 流程实例id | - | | flowInstanceId | 否 | string | 流程实例id | - |
| flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | 否 | string | 资金来源编码 | - | | fundsSource | 否 | string | 资金来源编码 | - |
@ -87,9 +95,10 @@ _无_
| governanceType | 否 | string | 治理类型编码 | - | | governanceType | 否 | string | 治理类型编码 | - |
| governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | 否 | string | 治理类型名称 | - | | governanceTypeName | 否 | string | 治理类型名称 | - |
| hazardCategory | 否 | string | 隐患分类编码 | - | | hazardCategory | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | 否 | string | 隐患分类名称 | - | | hazardCategoryName | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | 否 | string | 管理级别编码 | - | | hazardLevel | 否 | string | 管理级别编码 | - |
| hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | 否 | string | 管理级别名称 | - | | hazardLevelName | 否 | string | 管理级别名称 | - |
@ -152,7 +161,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/addBatch` - **请求:** `POST /gd_dataserver/business/hazard/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_8` - **operationId:** `addBatchUsingPOST_8`
@ -180,7 +189,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/addReturn` - **请求:** `POST /gd_dataserver/business/hazard/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_8` - **operationId:** `addReturnUsingPOST_8`
@ -197,10 +206,11 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actualCompleteTime | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | 否 | string / date-time | 实际完成时间 | - |
| attachments | 否 | array<隐患附件> | 附件列表 | - |
| auditRemark | 否 | string | 审核备注 | - | | auditRemark | 否 | string | 审核备注 | - |
| auditTime | 否 | string / date-time | 审核时间 | - | | auditTime | 否 | string / date-time | 审核时间 | - |
| auditUserId | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | 否 | string | 审核人姓名 | - | | auditUserName | 否 | string | 审核人姓名 | - |
| auditUserUsername | 否 | string | 审核人账号 | - | | auditUserUsername | 否 | string | 审核人账号 | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| causeAnalysis | 否 | string | 原因分析 | - | | causeAnalysis | 否 | string | 原因分析 | - |
@ -209,6 +219,8 @@ _无_
| chargePersonUsername | 否 | string | 整改负责人账号 | - | | chargePersonUsername | 否 | string | 整改负责人账号 | - |
| createBy | 否 | string | 创建者 | - | | createBy | 否 | string | 创建者 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| criteriaIds | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | 否 | string | 判定标准名称 | - |
| currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | 否 | integer / int64 | 部门ID | - | | departmentId | 否 | integer / int64 | 部门ID | - |
| departmentName | 否 | string | 部门名称 | - | | departmentName | 否 | string | 部门名称 | - |
@ -217,6 +229,10 @@ _无_
| discoverTime | 否 | string / date-time | 发现时间 | - | | discoverTime | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - | | factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | 否 | string | 流程实例id | - | | flowInstanceId | 否 | string | 流程实例id | - |
| flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | 否 | string | 资金来源编码 | - | | fundsSource | 否 | string | 资金来源编码 | - |
@ -225,9 +241,10 @@ _无_
| governanceType | 否 | string | 治理类型编码 | - | | governanceType | 否 | string | 治理类型编码 | - |
| governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | 否 | string | 治理类型名称 | - | | governanceTypeName | 否 | string | 治理类型名称 | - |
| hazardCategory | 否 | string | 隐患分类编码 | - | | hazardCategory | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | 否 | string | 隐患分类名称 | - | | hazardCategoryName | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | 否 | string | 管理级别编码 | - | | hazardLevel | 否 | string | 管理级别编码 | - |
| hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | 否 | string | 管理级别名称 | - | | hazardLevelName | 否 | string | 管理级别名称 | - |
@ -290,7 +307,7 @@ _无_
### 删除附件 ### 删除附件
- **用途:** 返回 data 为 boolean,true-删除成功。 - **用途:** 返回 data 为 boolean,true-删除成功。
- **请求:** `DELETE /gd_dataserver/gd_dataserver/business/hazard/attachment/{ids}` - **请求:** `DELETE /gd_dataserver/business/hazard/attachment/{ids}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `removeAttachmentUsingDELETE` - **operationId:** `removeAttachmentUsingDELETE`
@ -313,7 +330,7 @@ _无_
### 按隐患ID查附件列表 ### 按隐患ID查附件列表
- **用途:** 返回 data 为 HazardAttachment 数组。每个元素包含:id-附件ID、reportId-隐患ID、fileName-文件名、fileUrl-文件访问URL、fileType-文件类型、fileSize-文件大小。 - **用途:** 返回 data 为 HazardAttachment 数组。每个元素包含:id-附件ID、reportId-隐患ID、fileName-文件名、fileUrl-文件访问URL、fileType-文件类型、fileSize-文件大小。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/attachment/{reportId}` - **请求:** `GET /gd_dataserver/business/hazard/attachment/{reportId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `listAttachmentsUsingGET` - **operationId:** `listAttachmentsUsingGET`
@ -336,7 +353,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/delete` - **请求:** `GET /gd_dataserver/business/hazard/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_8` - **operationId:** `deleteUsingGET_8`
@ -345,10 +362,27 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - |
| attachments[0].attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
| attachments[0].createBy | query | 否 | string | 创建者 | - |
| attachments[0].createTime | query | 否 | string / date-time | 创建时间 | - |
| attachments[0].fileName | query | 否 | string | 文件原始名称 | - |
| attachments[0].filePath | query | 否 | string | 文件存储路径 | - |
| attachments[0].fileSize | query | 否 | integer / int64 | 文件大小(字节) | - |
| attachments[0].fileType | query | 否 | string | 文件MIME类型 | - |
| attachments[0].fileUrl | query | 否 | string | 文件访问URL | - |
| attachments[0].id | query | 否 | integer / int64 | 主键ID | - |
| attachments[0].remark | query | 否 | string | 备注 | - |
| attachments[0].reportId | query | 否 | integer / int64 | 关联隐患ID | - |
| attachments[0].sortOrder | query | 否 | integer / int32 | 排序 | - |
| attachments[0].suffix | query | 否 | string | 文件后缀 | - |
| attachments[0].updateBy | query | 否 | string | 更新者 | - |
| attachments[0].updateTime | query | 否 | string / date-time | 更新时间 | - |
| attachments[0].uploadUserId | query | 否 | string | 上传人用户ID | - |
| attachments[0].uploadUserName | query | 否 | string | 上传人姓名 | - |
| auditRemark | query | 否 | string | 审核备注 | - | | auditRemark | query | 否 | string | 审核备注 | - |
| auditTime | query | 否 | string / date-time | 审核时间 | - | | auditTime | query | 否 | string / date-time | 审核时间 | - |
| auditUserId | query | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | query | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | query | 否 | string | 审核人姓名 | - | | auditUserName | query | 否 | string | 审核人姓名 | - |
| auditUserUsername | query | 否 | string | 审核人账号 | - | | auditUserUsername | query | 否 | string | 审核人账号 | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| causeAnalysis | query | 否 | string | 原因分析 | - | | causeAnalysis | query | 否 | string | 原因分析 | - |
@ -357,6 +391,8 @@ _无_
| chargePersonUsername | query | 否 | string | 整改负责人账号 | - | | chargePersonUsername | query | 否 | string | 整改负责人账号 | - |
| createBy | query | 否 | string | 创建者 | - | | createBy | query | 否 | string | 创建者 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| criteriaIds | query | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | query | 否 | string | 判定标准名称 | - |
| currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | query | 否 | integer / int64 | 部门ID | - | | departmentId | query | 否 | integer / int64 | 部门ID | - |
| departmentName | query | 否 | string | 部门名称 | - | | departmentName | query | 否 | string | 部门名称 | - |
@ -365,6 +401,10 @@ _无_
| discoverTime | query | 否 | string / date-time | 发现时间 | - | | discoverTime | query | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - | | factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | query | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | query | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | query | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | query | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | query | 否 | string | 流程实例id | - | | flowInstanceId | query | 否 | string | 流程实例id | - |
| flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | query | 否 | string | 资金来源编码 | - | | fundsSource | query | 否 | string | 资金来源编码 | - |
@ -373,9 +413,10 @@ _无_
| governanceType | query | 否 | string | 治理类型编码 | - | | governanceType | query | 否 | string | 治理类型编码 | - |
| governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | query | 否 | string | 治理类型名称 | - | | governanceTypeName | query | 否 | string | 治理类型名称 | - |
| hazardCategory | query | 否 | string | 隐患分类编码 | - | | hazardCategory | query | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | query | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | query | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | query | 否 | string | 隐患分类名称 | - | | hazardCategoryName | query | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | query | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | query | 否 | string | 管理级别编码 | - | | hazardLevel | query | 否 | string | 管理级别编码 | - |
| hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | query | 否 | string | 管理级别名称 | - | | hazardLevelName | query | 否 | string | 管理级别名称 | - |
@ -436,7 +477,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/deleteById` - **请求:** `GET /gd_dataserver/business/hazard/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_8` - **operationId:** `deleteOneUsingGET_8`
@ -459,7 +500,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/deleteByIds` - **请求:** `GET /gd_dataserver/business/hazard/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_17` - **operationId:** `deleteListUsingGET_17`
@ -481,8 +522,8 @@ _无_
### 导出隐患列表Excel ### 导出隐患列表Excel
- **用途:** 直接返回 Excel 文件流(Content-Type: application/octet-stream),前端需以 Blob 方式接收并下载。 - **用途:** 超级管理员导出所有厂区;非超级管理员仅导出本厂区。直接返回 Excel 文件流,前端以 Blob 方式接收下载。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/export` - **请求:** `POST /gd_dataserver/business/hazard/export`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `exportUsingPOST` - **operationId:** `exportUsingPOST`
@ -491,10 +532,27 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - |
| attachments[0].attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
| attachments[0].createBy | query | 否 | string | 创建者 | - |
| attachments[0].createTime | query | 否 | string / date-time | 创建时间 | - |
| attachments[0].fileName | query | 否 | string | 文件原始名称 | - |
| attachments[0].filePath | query | 否 | string | 文件存储路径 | - |
| attachments[0].fileSize | query | 否 | integer / int64 | 文件大小(字节) | - |
| attachments[0].fileType | query | 否 | string | 文件MIME类型 | - |
| attachments[0].fileUrl | query | 否 | string | 文件访问URL | - |
| attachments[0].id | query | 否 | integer / int64 | 主键ID | - |
| attachments[0].remark | query | 否 | string | 备注 | - |
| attachments[0].reportId | query | 否 | integer / int64 | 关联隐患ID | - |
| attachments[0].sortOrder | query | 否 | integer / int32 | 排序 | - |
| attachments[0].suffix | query | 否 | string | 文件后缀 | - |
| attachments[0].updateBy | query | 否 | string | 更新者 | - |
| attachments[0].updateTime | query | 否 | string / date-time | 更新时间 | - |
| attachments[0].uploadUserId | query | 否 | string | 上传人用户ID | - |
| attachments[0].uploadUserName | query | 否 | string | 上传人姓名 | - |
| auditRemark | query | 否 | string | 审核备注 | - | | auditRemark | query | 否 | string | 审核备注 | - |
| auditTime | query | 否 | string / date-time | 审核时间 | - | | auditTime | query | 否 | string / date-time | 审核时间 | - |
| auditUserId | query | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | query | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | query | 否 | string | 审核人姓名 | - | | auditUserName | query | 否 | string | 审核人姓名 | - |
| auditUserUsername | query | 否 | string | 审核人账号 | - | | auditUserUsername | query | 否 | string | 审核人账号 | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| causeAnalysis | query | 否 | string | 原因分析 | - | | causeAnalysis | query | 否 | string | 原因分析 | - |
@ -503,6 +561,8 @@ _无_
| chargePersonUsername | query | 否 | string | 整改负责人账号 | - | | chargePersonUsername | query | 否 | string | 整改负责人账号 | - |
| createBy | query | 否 | string | 创建者 | - | | createBy | query | 否 | string | 创建者 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| criteriaIds | query | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | query | 否 | string | 判定标准名称 | - |
| currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | query | 否 | integer / int64 | 部门ID | - | | departmentId | query | 否 | integer / int64 | 部门ID | - |
| departmentName | query | 否 | string | 部门名称 | - | | departmentName | query | 否 | string | 部门名称 | - |
@ -511,6 +571,10 @@ _无_
| discoverTime | query | 否 | string / date-time | 发现时间 | - | | discoverTime | query | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - | | factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | query | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | query | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | query | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | query | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | query | 否 | string | 流程实例id | - | | flowInstanceId | query | 否 | string | 流程实例id | - |
| flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | query | 否 | string | 资金来源编码 | - | | fundsSource | query | 否 | string | 资金来源编码 | - |
@ -519,9 +583,10 @@ _无_
| governanceType | query | 否 | string | 治理类型编码 | - | | governanceType | query | 否 | string | 治理类型编码 | - |
| governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | query | 否 | string | 治理类型名称 | - | | governanceTypeName | query | 否 | string | 治理类型名称 | - |
| hazardCategory | query | 否 | string | 隐患分类编码 | - | | hazardCategory | query | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | query | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | query | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | query | 否 | string | 隐患分类名称 | - | | hazardCategoryName | query | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | query | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | query | 否 | string | 管理级别编码 | - | | hazardLevel | query | 否 | string | 管理级别编码 | - |
| hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | query | 否 | string | 管理级别名称 | - | | hazardLevelName | query | 否 | string | 管理级别名称 | - |
@ -583,7 +648,7 @@ _无_
### 生成隐患编号 ### 生成隐患编号
- **用途:** 返回 data 为 String 类型的隐患编号,格式如 HR20260827001。 - **用途:** 返回 data 为 String 类型的隐患编号,格式如 HR20260827001。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/generateReportNo` - **请求:** `POST /gd_dataserver/business/hazard/generateReportNo`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `generateReportNoUsingPOST` - **operationId:** `generateReportNoUsingPOST`
@ -605,7 +670,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/getAll` - **请求:** `GET /gd_dataserver/business/hazard/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_8` - **operationId:** `getAllUsingGET_8`
@ -623,10 +688,10 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 分页查询 ### 隐患台账分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 超级管理员返回所有厂区隐患;非超级管理员自动过滤为所属厂区的隐患。返回 data 为 PageInfo 分页对象,其中 list 为 HazardReport 数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/getListByPage` - **请求:** `GET /gd_dataserver/business/hazard/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_8` - **operationId:** `getListByPageUsingGET_8`
@ -635,10 +700,27 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - |
| attachments[0].attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
| attachments[0].createBy | query | 否 | string | 创建者 | - |
| attachments[0].createTime | query | 否 | string / date-time | 创建时间 | - |
| attachments[0].fileName | query | 否 | string | 文件原始名称 | - |
| attachments[0].filePath | query | 否 | string | 文件存储路径 | - |
| attachments[0].fileSize | query | 否 | integer / int64 | 文件大小(字节) | - |
| attachments[0].fileType | query | 否 | string | 文件MIME类型 | - |
| attachments[0].fileUrl | query | 否 | string | 文件访问URL | - |
| attachments[0].id | query | 否 | integer / int64 | 主键ID | - |
| attachments[0].remark | query | 否 | string | 备注 | - |
| attachments[0].reportId | query | 否 | integer / int64 | 关联隐患ID | - |
| attachments[0].sortOrder | query | 否 | integer / int32 | 排序 | - |
| attachments[0].suffix | query | 否 | string | 文件后缀 | - |
| attachments[0].updateBy | query | 否 | string | 更新者 | - |
| attachments[0].updateTime | query | 否 | string / date-time | 更新时间 | - |
| attachments[0].uploadUserId | query | 否 | string | 上传人用户ID | - |
| attachments[0].uploadUserName | query | 否 | string | 上传人姓名 | - |
| auditRemark | query | 否 | string | 审核备注 | - | | auditRemark | query | 否 | string | 审核备注 | - |
| auditTime | query | 否 | string / date-time | 审核时间 | - | | auditTime | query | 否 | string / date-time | 审核时间 | - |
| auditUserId | query | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | query | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | query | 否 | string | 审核人姓名 | - | | auditUserName | query | 否 | string | 审核人姓名 | - |
| auditUserUsername | query | 否 | string | 审核人账号 | - | | auditUserUsername | query | 否 | string | 审核人账号 | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| causeAnalysis | query | 否 | string | 原因分析 | - | | causeAnalysis | query | 否 | string | 原因分析 | - |
@ -647,6 +729,8 @@ _无_
| chargePersonUsername | query | 否 | string | 整改负责人账号 | - | | chargePersonUsername | query | 否 | string | 整改负责人账号 | - |
| createBy | query | 否 | string | 创建者 | - | | createBy | query | 否 | string | 创建者 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| criteriaIds | query | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | query | 否 | string | 判定标准名称 | - |
| currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | query | 否 | integer / int64 | 部门ID | - | | departmentId | query | 否 | integer / int64 | 部门ID | - |
| departmentName | query | 否 | string | 部门名称 | - | | departmentName | query | 否 | string | 部门名称 | - |
@ -655,6 +739,10 @@ _无_
| discoverTime | query | 否 | string / date-time | 发现时间 | - | | discoverTime | query | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - | | factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | query | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | query | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | query | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | query | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | query | 否 | string | 流程实例id | - | | flowInstanceId | query | 否 | string | 流程实例id | - |
| flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | query | 否 | string | 资金来源编码 | - | | fundsSource | query | 否 | string | 资金来源编码 | - |
@ -663,9 +751,10 @@ _无_
| governanceType | query | 否 | string | 治理类型编码 | - | | governanceType | query | 否 | string | 治理类型编码 | - |
| governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | query | 否 | string | 治理类型名称 | - | | governanceTypeName | query | 否 | string | 治理类型名称 | - |
| hazardCategory | query | 否 | string | 隐患分类编码 | - | | hazardCategory | query | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | query | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | query | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | query | 否 | string | 隐患分类名称 | - | | hazardCategoryName | query | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | query | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | query | 否 | string | 管理级别编码 | - | | hazardLevel | query | 否 | string | 管理级别编码 | - |
| hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | query | 否 | string | 管理级别名称 | - | | hazardLevelName | query | 否 | string | 管理级别名称 | - |
@ -728,7 +817,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/info` - **请求:** `GET /gd_dataserver/business/hazard/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_8` - **operationId:** `infoUsingGET_8`
@ -750,8 +839,8 @@ _无_
### 查隐患详情 ### 查隐患详情
- **用途:** 返回 data 为 HazardReport 对象。主要字段:id-主键、reportNo-隐患编号、hazardName-隐患名称、description-隐患描述、unitName-单位名称、departmentName-部门名称、hazardLevelName-隐患级别名称、hazardCategoryName-隐患分类名称、status-状态编码(0待提交/1审核中/2整改中/3已通过/4已驳回)、statusName-状态名称、reporterName-上报人姓名、chargePersonName-整改负责人姓名、pointsAwarded-奖励积分、flowStatus-流程状态(0未开始/1进行中/2已完成)、canApprove-当前用户是否可审批、isInitiator-当前用户是否为此流程发起人。 - **用途:** 返回 data 为 HazardReport 对象。主要字段:id-主键、reportNo-隐患编号、hazardName-隐患名称、description-隐患描述、unitName-单位名称、departmentName-部门名称、hazardLevelName-隐患级别名称、hazardCategoryName-隐患分类名称、status-状态编码(draft待提交/reviewing审核中/rectifying整改中/approved已通过/rejected已驳回)、statusName-状态名称、reporterName-上报人姓名、chargePersonName-整改负责人姓名、pointsAwarded-奖励积分、flowStatus-流程状态(0未开始/1进行中/2已完成)、canApprove-当前用户是否可审批、isInitiator-当前用户是否为此流程发起人。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/info/{id}` - **请求:** `GET /gd_dataserver/business/hazard/info/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getInfoUsingGET` - **operationId:** `getInfoUsingGET`
@ -774,7 +863,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/list` - **请求:** `GET /gd_dataserver/business/hazard/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_8` - **operationId:** `getListUsingGET_8`
@ -783,10 +872,27 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - |
| attachments[0].attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
| attachments[0].createBy | query | 否 | string | 创建者 | - |
| attachments[0].createTime | query | 否 | string / date-time | 创建时间 | - |
| attachments[0].fileName | query | 否 | string | 文件原始名称 | - |
| attachments[0].filePath | query | 否 | string | 文件存储路径 | - |
| attachments[0].fileSize | query | 否 | integer / int64 | 文件大小(字节) | - |
| attachments[0].fileType | query | 否 | string | 文件MIME类型 | - |
| attachments[0].fileUrl | query | 否 | string | 文件访问URL | - |
| attachments[0].id | query | 否 | integer / int64 | 主键ID | - |
| attachments[0].remark | query | 否 | string | 备注 | - |
| attachments[0].reportId | query | 否 | integer / int64 | 关联隐患ID | - |
| attachments[0].sortOrder | query | 否 | integer / int32 | 排序 | - |
| attachments[0].suffix | query | 否 | string | 文件后缀 | - |
| attachments[0].updateBy | query | 否 | string | 更新者 | - |
| attachments[0].updateTime | query | 否 | string / date-time | 更新时间 | - |
| attachments[0].uploadUserId | query | 否 | string | 上传人用户ID | - |
| attachments[0].uploadUserName | query | 否 | string | 上传人姓名 | - |
| auditRemark | query | 否 | string | 审核备注 | - | | auditRemark | query | 否 | string | 审核备注 | - |
| auditTime | query | 否 | string / date-time | 审核时间 | - | | auditTime | query | 否 | string / date-time | 审核时间 | - |
| auditUserId | query | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | query | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | query | 否 | string | 审核人姓名 | - | | auditUserName | query | 否 | string | 审核人姓名 | - |
| auditUserUsername | query | 否 | string | 审核人账号 | - | | auditUserUsername | query | 否 | string | 审核人账号 | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| causeAnalysis | query | 否 | string | 原因分析 | - | | causeAnalysis | query | 否 | string | 原因分析 | - |
@ -795,6 +901,8 @@ _无_
| chargePersonUsername | query | 否 | string | 整改负责人账号 | - | | chargePersonUsername | query | 否 | string | 整改负责人账号 | - |
| createBy | query | 否 | string | 创建者 | - | | createBy | query | 否 | string | 创建者 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| criteriaIds | query | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | query | 否 | string | 判定标准名称 | - |
| currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | query | 否 | integer / int64 | 部门ID | - | | departmentId | query | 否 | integer / int64 | 部门ID | - |
| departmentName | query | 否 | string | 部门名称 | - | | departmentName | query | 否 | string | 部门名称 | - |
@ -803,6 +911,10 @@ _无_
| discoverTime | query | 否 | string / date-time | 发现时间 | - | | discoverTime | query | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - | | factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | query | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | query | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | query | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | query | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | query | 否 | string | 流程实例id | - | | flowInstanceId | query | 否 | string | 流程实例id | - |
| flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | query | 否 | string | 资金来源编码 | - | | fundsSource | query | 否 | string | 资金来源编码 | - |
@ -811,9 +923,10 @@ _无_
| governanceType | query | 否 | string | 治理类型编码 | - | | governanceType | query | 否 | string | 治理类型编码 | - |
| governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | query | 否 | string | 治理类型名称 | - | | governanceTypeName | query | 否 | string | 治理类型名称 | - |
| hazardCategory | query | 否 | string | 隐患分类编码 | - | | hazardCategory | query | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | query | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | query | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | query | 否 | string | 隐患分类名称 | - | | hazardCategoryName | query | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | query | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | query | 否 | string | 管理级别编码 | - | | hazardLevel | query | 否 | string | 管理级别编码 | - |
| hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | query | 否 | string | 管理级别名称 | - | | hazardLevelName | query | 否 | string | 管理级别名称 | - |
@ -874,7 +987,7 @@ _无_
### 查询我的上报记录(APP端) ### 查询我的上报记录(APP端)
- **用途:** 分页查询当前登录用户已上报的隐患记录列表。返回 data 为 PageInfo 分页对象,包含 total/list/pageNum/pageSize 等。list 中每条记录为 HazardReport 对象,主要字段:id、reportNo、hazardName、status-状态编码、statusName-状态名称、hazardLevelName-级别名称、pointsAwarded-奖励积分、createTime-创建时间。 - **用途:** 分页查询当前登录用户已上报的隐患记录列表。返回 data 为 PageInfo 分页对象,包含 total/list/pageNum/pageSize 等。list 中每条记录为 HazardReport 对象,主要字段:id、reportNo、hazardName、status-状态编码、statusName-状态名称、hazardLevelName-级别名称、pointsAwarded-奖励积分、createTime-创建时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/myList` - **请求:** `GET /gd_dataserver/business/hazard/myList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myListUsingGET_1` - **operationId:** `myListUsingGET_1`
@ -883,10 +996,27 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | query | 否 | string / date-time | 实际完成时间 | - |
| attachments[0].attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
| attachments[0].createBy | query | 否 | string | 创建者 | - |
| attachments[0].createTime | query | 否 | string / date-time | 创建时间 | - |
| attachments[0].fileName | query | 否 | string | 文件原始名称 | - |
| attachments[0].filePath | query | 否 | string | 文件存储路径 | - |
| attachments[0].fileSize | query | 否 | integer / int64 | 文件大小(字节) | - |
| attachments[0].fileType | query | 否 | string | 文件MIME类型 | - |
| attachments[0].fileUrl | query | 否 | string | 文件访问URL | - |
| attachments[0].id | query | 否 | integer / int64 | 主键ID | - |
| attachments[0].remark | query | 否 | string | 备注 | - |
| attachments[0].reportId | query | 否 | integer / int64 | 关联隐患ID | - |
| attachments[0].sortOrder | query | 否 | integer / int32 | 排序 | - |
| attachments[0].suffix | query | 否 | string | 文件后缀 | - |
| attachments[0].updateBy | query | 否 | string | 更新者 | - |
| attachments[0].updateTime | query | 否 | string / date-time | 更新时间 | - |
| attachments[0].uploadUserId | query | 否 | string | 上传人用户ID | - |
| attachments[0].uploadUserName | query | 否 | string | 上传人姓名 | - |
| auditRemark | query | 否 | string | 审核备注 | - | | auditRemark | query | 否 | string | 审核备注 | - |
| auditTime | query | 否 | string / date-time | 审核时间 | - | | auditTime | query | 否 | string / date-time | 审核时间 | - |
| auditUserId | query | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | query | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | query | 否 | string | 审核人姓名 | - | | auditUserName | query | 否 | string | 审核人姓名 | - |
| auditUserUsername | query | 否 | string | 审核人账号 | - | | auditUserUsername | query | 否 | string | 审核人账号 | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| causeAnalysis | query | 否 | string | 原因分析 | - | | causeAnalysis | query | 否 | string | 原因分析 | - |
@ -895,6 +1025,8 @@ _无_
| chargePersonUsername | query | 否 | string | 整改负责人账号 | - | | chargePersonUsername | query | 否 | string | 整改负责人账号 | - |
| createBy | query | 否 | string | 创建者 | - | | createBy | query | 否 | string | 创建者 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| criteriaIds | query | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | query | 否 | string | 判定标准名称 | - |
| currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | query | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | query | 否 | integer / int64 | 部门ID | - | | departmentId | query | 否 | integer / int64 | 部门ID | - |
| departmentName | query | 否 | string | 部门名称 | - | | departmentName | query | 否 | string | 部门名称 | - |
@ -903,6 +1035,10 @@ _无_
| discoverTime | query | 否 | string / date-time | 发现时间 | - | | discoverTime | query | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - | | factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | query | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | query | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | query | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | query | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | query | 否 | string | 流程实例id | - | | flowInstanceId | query | 否 | string | 流程实例id | - |
| flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | query | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | query | 否 | string | 资金来源编码 | - | | fundsSource | query | 否 | string | 资金来源编码 | - |
@ -911,9 +1047,10 @@ _无_
| governanceType | query | 否 | string | 治理类型编码 | - | | governanceType | query | 否 | string | 治理类型编码 | - |
| governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | query | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | query | 否 | string | 治理类型名称 | - | | governanceTypeName | query | 否 | string | 治理类型名称 | - |
| hazardCategory | query | 否 | string | 隐患分类编码 | - | | hazardCategory | query | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | query | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | query | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | query | 否 | string | 隐患分类名称 | - | | hazardCategoryName | query | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | query | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | query | 否 | string | 管理级别编码 | - | | hazardLevel | query | 否 | string | 管理级别编码 | - |
| hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | query | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | query | 否 | string | 管理级别名称 | - | | hazardLevelName | query | 否 | string | 管理级别名称 | - |
@ -976,7 +1113,7 @@ _无_
### 首页今日概览-我的隐患统计(APP端) ### 首页今日概览-我的隐患统计(APP端)
- **用途:** 按状态分类统计当前登录用户的隐患数量。返回字段说明:todayReportCount-今日上报数、pendingAuditCount-待审核数、rectifyingCount-整改中数、rejectedCount-已驳回数。 - **用途:** 按状态分类统计当前登录用户的隐患数量。返回字段说明:todayReportCount-今日上报数、pendingAuditCount-待审核数、rectifyingCount-整改中数、rejectedCount-已驳回数。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/myStats` - **请求:** `GET /gd_dataserver/business/hazard/myStats`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myStatsUsingGET` - **operationId:** `myStatsUsingGET`
@ -997,7 +1134,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/hazard/removeById` - **请求:** `GET /gd_dataserver/business/hazard/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_16` - **operationId:** `deleteListUsingGET_16`
@ -1020,7 +1157,7 @@ _无_
### 保存隐患信息(草稿,不启动流程) ### 保存隐患信息(草稿,不启动流程)
- **用途:** 保存隐患记录及附件,不启动审批流程。返回 data 为 HazardReport 对象,包含 id、reportNo 等完整隐患字段。 - **用途:** 保存隐患记录及附件,不启动审批流程。返回 data 为 HazardReport 对象,包含 id、reportNo 等完整隐患字段。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/save` - **请求:** `POST /gd_dataserver/business/hazard/save`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `saveUsingPOST_1` - **operationId:** `saveUsingPOST_1`
@ -1054,7 +1191,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/hazard/updateById` - **请求:** `POST /gd_dataserver/business/hazard/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_8` - **operationId:** `updateByIdUsingPOST_8`
@ -1071,10 +1208,11 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actualCompleteTime | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | 否 | string / date-time | 实际完成时间 | - |
| attachments | 否 | array<隐患附件> | 附件列表 | - |
| auditRemark | 否 | string | 审核备注 | - | | auditRemark | 否 | string | 审核备注 | - |
| auditTime | 否 | string / date-time | 审核时间 | - | | auditTime | 否 | string / date-time | 审核时间 | - |
| auditUserId | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | 否 | string | 审核人姓名 | - | | auditUserName | 否 | string | 审核人姓名 | - |
| auditUserUsername | 否 | string | 审核人账号 | - | | auditUserUsername | 否 | string | 审核人账号 | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| causeAnalysis | 否 | string | 原因分析 | - | | causeAnalysis | 否 | string | 原因分析 | - |
@ -1083,6 +1221,8 @@ _无_
| chargePersonUsername | 否 | string | 整改负责人账号 | - | | chargePersonUsername | 否 | string | 整改负责人账号 | - |
| createBy | 否 | string | 创建者 | - | | createBy | 否 | string | 创建者 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| criteriaIds | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | 否 | string | 判定标准名称 | - |
| currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | 否 | integer / int64 | 部门ID | - | | departmentId | 否 | integer / int64 | 部门ID | - |
| departmentName | 否 | string | 部门名称 | - | | departmentName | 否 | string | 部门名称 | - |
@ -1091,6 +1231,10 @@ _无_
| discoverTime | 否 | string / date-time | 发现时间 | - | | discoverTime | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - | | factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | 否 | string | 流程实例id | - | | flowInstanceId | 否 | string | 流程实例id | - |
| flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | 否 | string | 资金来源编码 | - | | fundsSource | 否 | string | 资金来源编码 | - |
@ -1099,9 +1243,10 @@ _无_
| governanceType | 否 | string | 治理类型编码 | - | | governanceType | 否 | string | 治理类型编码 | - |
| governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | 否 | string | 治理类型名称 | - | | governanceTypeName | 否 | string | 治理类型名称 | - |
| hazardCategory | 否 | string | 隐患分类编码 | - | | hazardCategory | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | 否 | string | 隐患分类名称 | - | | hazardCategoryName | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | 否 | string | 管理级别编码 | - | | hazardLevel | 否 | string | 管理级别编码 | - |
| hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | 否 | string | 管理级别名称 | - | | hazardLevelName | 否 | string | 管理级别名称 | - |
@ -1161,10 +1306,43 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 上传隐患附件文件
- **用途:** 上传文件到服务器,返回 data 为 HazardAttachment 数组,每个元素包含:id、fileName-文件名、filePath-文件路径、fileSize-文件大小、fileType-MIME类型、attachmentType-附件类型。前端在调用 save 或 submitFlow 时将附件数据传入
- **请求:** `POST /gd_dataserver/business/hazard/uploadAttachment`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `uploadAttachmentUsingPOST`
参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
请求体:
- Content-Type:`application/json`
- 模型:`string / binary`
- 必填:文档未标记
- Content-Type:`application/octet-stream`
- 模型:`string / binary`
- 必填:文档未标记
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
### 删除隐患(级联删除附件) ### 删除隐患(级联删除附件)
- **用途:** 返回 data 为 boolean,true-删除成功,false-删除失败。同时级联删除关联的附件记录。 - **用途:** 返回 data 为 boolean,true-删除成功,false-删除失败。同时级联删除关联的附件记录。
- **请求:** `DELETE /gd_dataserver/gd_dataserver/business/hazard/{ids}` - **请求:** `DELETE /gd_dataserver/business/hazard/{ids}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `removeUsingDELETE` - **operationId:** `removeUsingDELETE`

58
docs/api/modules/02-hazard-flow.md

@ -2,7 +2,7 @@
本模块共 6 个接口。源文件:`api.json`。 本模块共 5 个接口。源文件:`api.json`。
@ -12,12 +12,11 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 审批隐患流程 | POST | `/gd_dataserver/gd_dataserver/flowable/hazard/complete` | 审批通过或驳回,需携带taskId、comment、result等信息。成功返回 data 为 null;失败返回 error 信息。 | | 审批隐患流程 | POST | `/gd_dataserver/flowable/hazard/complete` | 审批通过或驳回,需携带taskId、comment、result等信息。成功返回 data 为 null;失败返回 error 信息。 |
| 隐患流程详情 | GET | `/gd_dataserver/gd_dataserver/flowable/hazard/detail/{id}` | 返回 data 为 HazardReport 对象,包含完整隐患字段及流程状态信息。主要字段:id、reportNo、hazardName、status-状态编码、flowStatus-流程状态、canApprove-是否可审批。 | | 隐患流程详情 | GET | `/gd_dataserver/flowable/hazard/detail/{id}` | 返回 data 为 HazardReport 对象,包含完整隐患字段及流程状态信息。主要字段:id、reportNo、hazardName、status-状态编码、flowStatus-流程状态、canApprove-是否可审批。 |
| 上报隐患并提交流程 | POST | `/gd_dataserver/gd_dataserver/flowable/hazard/submitFlow` | 先调用uploadAttachment上传附件,再将report和attachments一起提交。成功返回 data 为流程实例ID字符串;失败返回 error 信息。 | | 上报隐患并提交流程 | POST | `/gd_dataserver/flowable/hazard/submitFlow` | 先调用uploadAttachment上传附件,再将report和attachments一起提交。成功返回 data 为对象,包含:reportId-隐患记录ID、reportNo-隐患编号、flowInstanceId-流程实例ID、message-提示信息。失败返回 error 字段含错误原因。 |
| 切换隐患流程等级 | POST | `/gd_dataserver/gd_dataserver/flowable/hazard/switchLevel` | 审批过程中重新评估隐患等级,作废当前流程并以新等级重新启动审批。等级编码:general-一般隐患 / major-较大隐患 / critical-重大隐患。返回新流程实例ID。 | | 切换隐患流程等级 | POST | `/gd_dataserver/flowable/hazard/switchLevel` | 审批过程中重新评估隐患等级,作废当前流程并以新等级重新启动审批。等级编码:general-一般隐患 / major-较大隐患 / critical-重大隐患。返回新流程实例ID。 |
| 隐患流程待办/已办列表 | GET | `/gd_dataserver/gd_dataserver/flowable/hazard/todoList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 HazardReport 对象,包含 id、reportNo、hazardName、status、createTime 等字段。支持 pageNum、pageSize 等筛选参数。 | | 隐患流程待办/已办列表 | GET | `/gd_dataserver/flowable/hazard/todoList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 HazardReport 对象,包含 id、reportNo、hazardName、status、createTime 等字段。支持 pageNum、pageSize 等筛选参数。 |
| 上传隐患附件文件 | POST | `/gd_dataserver/gd_dataserver/flowable/hazard/uploadAttachment` | 上传文件到服务器,返回 data 为 HazardAttachment 数组,每个元素包含:id、fileName-文件名、filePath-文件路径、fileSize-文件大小、fileType-MIME类型、attachmentType-附件类型。前端在调用submitFlow时将附件数据传入 |
## 接口详情 ## 接口详情
@ -27,7 +26,7 @@
### 审批隐患流程 ### 审批隐患流程
- **用途:** 审批通过或驳回,需携带taskId、comment、result等信息。成功返回 data 为 null;失败返回 error 信息。 - **用途:** 审批通过或驳回,需携带taskId、comment、result等信息。成功返回 data 为 null;失败返回 error 信息。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/hazard/complete` - **请求:** `POST /gd_dataserver/flowable/hazard/complete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `completeUsingPOST_2` - **operationId:** `completeUsingPOST_2`
@ -79,7 +78,7 @@ _无_
### 隐患流程详情 ### 隐患流程详情
- **用途:** 返回 data 为 HazardReport 对象,包含完整隐患字段及流程状态信息。主要字段:id、reportNo、hazardName、status-状态编码、flowStatus-流程状态、canApprove-是否可审批。 - **用途:** 返回 data 为 HazardReport 对象,包含完整隐患字段及流程状态信息。主要字段:id、reportNo、hazardName、status-状态编码、flowStatus-流程状态、canApprove-是否可审批。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/hazard/detail/{id}` - **请求:** `GET /gd_dataserver/flowable/hazard/detail/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `detailUsingGET` - **operationId:** `detailUsingGET`
@ -101,8 +100,8 @@ _无_
### 上报隐患并提交流程 ### 上报隐患并提交流程
- **用途:** 先调用uploadAttachment上传附件,再将report和attachments一起提交。成功返回 data 为流程实例ID字符串;失败返回 error 信息。 - **用途:** 先调用uploadAttachment上传附件,再将report和attachments一起提交。成功返回 data 为对象,包含:reportId-隐患记录ID、reportNo-隐患编号、flowInstanceId-流程实例ID、message-提示信息。失败返回 error 字段含错误原因。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/hazard/submitFlow` - **请求:** `POST /gd_dataserver/flowable/hazard/submitFlow`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `submitFlowUsingPOST` - **operationId:** `submitFlowUsingPOST`
@ -136,7 +135,7 @@ _无_
### 切换隐患流程等级 ### 切换隐患流程等级
- **用途:** 审批过程中重新评估隐患等级,作废当前流程并以新等级重新启动审批。等级编码:general-一般隐患 / major-较大隐患 / critical-重大隐患。返回新流程实例ID。 - **用途:** 审批过程中重新评估隐患等级,作废当前流程并以新等级重新启动审批。等级编码:general-一般隐患 / major-较大隐患 / critical-重大隐患。返回新流程实例ID。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/hazard/switchLevel` - **请求:** `POST /gd_dataserver/flowable/hazard/switchLevel`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `switchLevelUsingPOST` - **operationId:** `switchLevelUsingPOST`
@ -162,7 +161,7 @@ _无_
### 隐患流程待办/已办列表 ### 隐患流程待办/已办列表
- **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 HazardReport 对象,包含 id、reportNo、hazardName、status、createTime 等字段。支持 pageNum、pageSize 等筛选参数。 - **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 HazardReport 对象,包含 id、reportNo、hazardName、status、createTime 等字段。支持 pageNum、pageSize 等筛选参数。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/hazard/todoList` - **请求:** `GET /gd_dataserver/flowable/hazard/todoList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `todoListUsingGET_1` - **operationId:** `todoListUsingGET_1`
@ -180,36 +179,3 @@ _无_
| 401 | Unauthorized | - | | 401 | Unauthorized | - |
| 403 | Forbidden | - | | 403 | Forbidden | - |
| 404 | Not Found | - | | 404 | Not Found | - |
### 上传隐患附件文件
- **用途:** 上传文件到服务器,返回 data 为 HazardAttachment 数组,每个元素包含:id、fileName-文件名、filePath-文件路径、fileSize-文件大小、fileType-MIME类型、attachmentType-附件类型。前端在调用submitFlow时将附件数据传入
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/hazard/uploadAttachment`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `uploadAttachmentUsingPOST`
参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| attachmentType | query | 否 | string | 附件类型:IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他 | - |
请求体:
- Content-Type:`application/json`
- 模型:`string / binary`
- 必填:文档未标记
- Content-Type:`application/octet-stream`
- 模型:`string / binary`
- 必填:文档未标记
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |

54
docs/api/modules/03-hazard-flow-config.md

@ -12,12 +12,12 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 修改流程模板配置 | PUT | `/gd_dataserver/gd_dataserver/flowable/hazardFlowConfig` | 修改流程Key、流程名称等信息。不可修改厂区ID和隐患等级。 | | 修改流程模板配置 | PUT | `/gd_dataserver/flowable/hazardFlowConfig` | 修改流程Key、流程名称等信息。不可修改厂区ID和隐患等级。请求体字段:id-配置ID(必填)、flowKey-流程定义Key、flowName-流程名称、hazardLevelName-隐患等级名称等可修改字段。非超级管理员只能修改自己厂区的配置,否则返回错误。返回 data 为提示字符串,如"修改成功"。 |
| 新增流程模板配置 | POST | `/gd_dataserver/gd_dataserver/flowable/hazardFlowConfig` | 配置某个厂区的某个隐患等级对应的Flowable流程Key。二级管理员无需传deptId/deptName,系统自动填充所属厂区。每个厂区的每个等级只能配置一条(唯一约束)。 | | 新增流程模板配置 | POST | `/gd_dataserver/flowable/hazardFlowConfig` | 配置某个厂区、某业务类型、某隐患等级对应的Flowable流程Key。二级管理员无需传deptId/deptName,系统自动填充所属厂区。每个厂区的同一业务类型同一等级只能配置一条(唯一约束 dept_id+biz_type+hazard_level)。请求体字段:deptId-厂区部门ID(超级管理员必填,二级管理员自动填充)、deptName-厂区名称(同上)、bizType-业务类型(report/appeal/rectify/verify,不传默认report)、hazardLevel-隐患等级编码(report类型必填general/major/critical;非report类型无需传,后端会无条件强制置为default,传了也会被忽略)、hazardLevelName-隐患等级名称、flowKey-流程定义Key(必填)、flowName-流程名称。返回 data 为提示字符串,如"新增成功"。 |
| 查询流程模板配置列表 | GET | `/gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/list` | 系统管理员返回所有配置;二级管理员自动过滤为所属厂区的配置。可选按厂区ID、隐患等级筛选。 | | 查询流程模板配置列表 | GET | `/gd_dataserver/flowable/hazardFlowConfig/list` | 系统管理员返回所有配置;二级管理员自动过滤为所属厂区的配置。可选按厂区ID、业务类型、隐患等级、状态筛选。返回 data 为 PageInfo 分页对象,包含 total/list/pageNum/pageSize。list 中每条记录为 QcHazardFlowConfig 对象,主要字段:id-主键、deptId-厂区部门ID、deptName-厂区名称、bizType-业务类型(report/appeal/rectify/verify)、hazardLevel-隐患等级编码(report类型为general/major/critical,其余类型为default)、hazardLevelName-隐患等级名称、flowKey-流程定义Key、flowName-流程名称、status-状态(0停用/1正常)、createBy-创建者、createTime-创建时间。 |
| 获取当前厂区已配置的流程模板 | GET | `/gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/myFactoryConfigs` | 前端上报隐患时调用,返回当前用户所属厂区已配置的隐患等级和对应流程信息,用于前端展示可选的隐患等级下拉。 | | 获取当前厂区已配置的上报流程模板 | GET | `/gd_dataserver/flowable/hazardFlowConfig/myFactoryConfigs` | 前端上报隐患时调用,仅返回当前用户所属厂区 bizType=report 的配置(申诉/整改/验收不会返回),用于前端展示可选的隐患等级下拉。返回 data 为 QcHazardFlowConfig 数组,每条记录包含:id-主键、deptId-厂区部门ID、deptName-厂区名称、bizType-业务类型(固定report)、hazardLevel-隐患等级编码、hazardLevelName-隐患等级名称、flowKey-流程定义Key、flowName-流程名称。若当前用户未分配厂区部门则返回错误。 |
| 获取流程模板配置详情 | GET | `/gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/{id}` | - | | 获取流程模板配置详情 | GET | `/gd_dataserver/flowable/hazardFlowConfig/{id}` | 根据ID查询单条流程模板配置的完整信息。返回 data 为 QcHazardFlowConfig 对象,字段:id-主键、deptId-厂区部门ID、deptName-厂区名称、bizType-业务类型(report/appeal/rectify/verify)、hazardLevel-隐患等级编码、hazardLevelName-隐患等级名称、flowKey-流程定义Key、flowName-流程名称、status-状态(0停用/1正常)、createBy-创建者、createTime-创建时间、updateBy-更新者、updateTime-更新时间。非超级管理员无权查看其他厂区的配置。 |
| 删除流程模板配置 | DELETE | `/gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/{id}` | 逻辑删除,将状态置为停用。 | | 删除流程模板配置 | DELETE | `/gd_dataserver/flowable/hazardFlowConfig/{id}` | 逻辑删除(设置del_flag=1),不做物理删除。非超级管理员只能删除自己厂区的配置,否则返回错误。返回 data 为提示字符串,如"删除成功"。 |
## 接口详情 ## 接口详情
@ -26,8 +26,8 @@
### 修改流程模板配置 ### 修改流程模板配置
- **用途:** 修改流程Key、流程名称等信息。不可修改厂区ID和隐患等级。 - **用途:** 修改流程Key、流程名称等信息。不可修改厂区ID和隐患等级。请求体字段:id-配置ID(必填)、flowKey-流程定义Key、flowName-流程名称、hazardLevelName-隐患等级名称等可修改字段。非超级管理员只能修改自己厂区的配置,否则返回错误。返回 data 为提示字符串,如"修改成功"。
- **请求:** `PUT /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig` - **请求:** `PUT /gd_dataserver/flowable/hazardFlowConfig`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `editUsingPUT` - **operationId:** `editUsingPUT`
@ -43,6 +43,7 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| bizType | 是 | string | 业务类型(report-上报/appeal-申诉/rectify-整改/verify-验收),不传默认report | report |
| createBy | 否 | string | - | - | | createBy | 否 | string | - | - |
| createByName | 否 | string | - | - | | createByName | 否 | string | - | - |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
@ -50,7 +51,7 @@ _无_
| deptName | 否 | string | 部门名称 | 一厂 | | deptName | 否 | string | 部门名称 | 一厂 |
| flowKey | 是 | string | Flowable流程定义Key | hazard_general_flow | | flowKey | 是 | string | Flowable流程定义Key | hazard_general_flow |
| flowName | 否 | string | 流程名称 | 一般隐患奖励审批流程 | | flowName | 否 | string | 流程名称 | 一般隐患奖励审批流程 |
| hazardLevel | 是 | string | 隐患等级编码(general-一般/major-较大/critical-重大) | general | | hazardLevel | 是 | string | 隐患等级编码(report类型:general-一般/major-较大/critical-重大;appeal/rectify/verify等非report类型固定为default,新增时后端会无条件强制置为default) | general |
| hazardLevelName | 否 | string | 隐患等级名称 | 一般隐患 | | hazardLevelName | 否 | string | 隐患等级名称 | 一般隐患 |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| params | 否 | object | - | - | | params | 否 | object | - | - |
@ -73,10 +74,10 @@ _无_
### 新增流程模板配置 ### 新增流程模板配置
- **用途:** 配置某个厂区的某个隐患等级对应的Flowable流程Key。二级管理员无需传deptId/deptName,系统自动填充所属厂区。每个厂区的每个等级只能配置一条(唯一约束)。 - **用途:** 配置某个厂区、某业务类型、某隐患等级对应的Flowable流程Key。二级管理员无需传deptId/deptName,系统自动填充所属厂区。每个厂区的同一业务类型同一等级只能配置一条(唯一约束 dept_id+biz_type+hazard_level)。请求体字段:deptId-厂区部门ID(超级管理员必填,二级管理员自动填充)、deptName-厂区名称(同上)、bizType-业务类型(report/appeal/rectify/verify,不传默认report)、hazardLevel-隐患等级编码(report类型必填general/major/critical;非report类型无需传,后端会无条件强制置为default,传了也会被忽略)、hazardLevelName-隐患等级名称、flowKey-流程定义Key(必填)、flowName-流程名称。返回 data 为提示字符串,如"新增成功"。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig` - **请求:** `POST /gd_dataserver/flowable/hazardFlowConfig`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addUsingPOST` - **operationId:** `addUsingPOST_1`
参数: 参数:
@ -90,6 +91,7 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| bizType | 是 | string | 业务类型(report-上报/appeal-申诉/rectify-整改/verify-验收),不传默认report | report |
| createBy | 否 | string | - | - | | createBy | 否 | string | - | - |
| createByName | 否 | string | - | - | | createByName | 否 | string | - | - |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
@ -97,7 +99,7 @@ _无_
| deptName | 否 | string | 部门名称 | 一厂 | | deptName | 否 | string | 部门名称 | 一厂 |
| flowKey | 是 | string | Flowable流程定义Key | hazard_general_flow | | flowKey | 是 | string | Flowable流程定义Key | hazard_general_flow |
| flowName | 否 | string | 流程名称 | 一般隐患奖励审批流程 | | flowName | 否 | string | 流程名称 | 一般隐患奖励审批流程 |
| hazardLevel | 是 | string | 隐患等级编码(general-一般/major-较大/critical-重大) | general | | hazardLevel | 是 | string | 隐患等级编码(report类型:general-一般/major-较大/critical-重大;appeal/rectify/verify等非report类型固定为default,新增时后端会无条件强制置为default) | general |
| hazardLevelName | 否 | string | 隐患等级名称 | 一般隐患 | | hazardLevelName | 否 | string | 隐患等级名称 | 一般隐患 |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| params | 否 | object | - | - | | params | 否 | object | - | - |
@ -120,10 +122,10 @@ _无_
### 查询流程模板配置列表 ### 查询流程模板配置列表
- **用途:** 系统管理员返回所有配置;二级管理员自动过滤为所属厂区的配置。可选按厂区ID、隐患等级筛选。 - **用途:** 系统管理员返回所有配置;二级管理员自动过滤为所属厂区的配置。可选按厂区ID、业务类型、隐患等级、状态筛选。返回 data 为 PageInfo 分页对象,包含 total/list/pageNum/pageSize。list 中每条记录为 QcHazardFlowConfig 对象,主要字段:id-主键、deptId-厂区部门ID、deptName-厂区名称、bizType-业务类型(report/appeal/rectify/verify)、hazardLevel-隐患等级编码(report类型为general/major/critical,其余类型为default)、hazardLevelName-隐患等级名称、flowKey-流程定义Key、flowName-流程名称、status-状态(0停用/1正常)、createBy-创建者、createTime-创建时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/list` - **请求:** `GET /gd_dataserver/flowable/hazardFlowConfig/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `listUsingGET_1` - **operationId:** `listUsingGET_2`
参数: 参数:
@ -131,8 +133,10 @@ _无_
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| pageNum | query | 是 | integer / int32 | 当前页码 | - | | pageNum | query | 是 | integer / int32 | 当前页码 | - |
| pageSize | query | 是 | integer / int32 | 每页条数 | - | | pageSize | query | 是 | integer / int32 | 每页条数 | - |
| deptId | query | 否 | string | 厂区部门ID(不传则按当前用户权限自动过滤) | - | | deptId | query | 否 | string | 厂区部门ID(不传则按当前用户权限自动过滤,超级管理员不传返回全部) | - |
| hazardLevel | query | 否 | string | 隐患等级编码(general/major/critical) | - | | bizType | query | 否 | string | 业务类型(report-上报/appeal-申诉/rectify-整改/verify-验收,不传则不过滤) | - |
| hazardLevel | query | 否 | string | 隐患等级编码(general-一般/major-较大/critical-重大,不传则不过滤) | - |
| status | query | 否 | string | 状态(0-停用/1-正常,不传则查全部状态) | - |
响应: 响应:
@ -144,10 +148,10 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 获取当前厂区已配置的流程模板 ### 获取当前厂区已配置的上报流程模板
- **用途:** 前端上报隐患时调用,返回当前用户所属厂区已配置的隐患等级和对应流程信息,用于前端展示可选的隐患等级下拉。 - **用途:** 前端上报隐患时调用,仅返回当前用户所属厂区 bizType=report 的配置(申诉/整改/验收不会返回),用于前端展示可选的隐患等级下拉。返回 data 为 QcHazardFlowConfig 数组,每条记录包含:id-主键、deptId-厂区部门ID、deptName-厂区名称、bizType-业务类型(固定report)、hazardLevel-隐患等级编码、hazardLevelName-隐患等级名称、flowKey-流程定义Key、flowName-流程名称。若当前用户未分配厂区部门则返回错误。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/myFactoryConfigs` - **请求:** `GET /gd_dataserver/flowable/hazardFlowConfig/myFactoryConfigs`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myFactoryConfigsUsingGET` - **operationId:** `myFactoryConfigsUsingGET`
@ -167,8 +171,8 @@ _无_
### 获取流程模板配置详情 ### 获取流程模板配置详情
- **用途:** 接口文档未提供用途说明。 - **用途:** 根据ID查询单条流程模板配置的完整信息。返回 data 为 QcHazardFlowConfig 对象,字段:id-主键、deptId-厂区部门ID、deptName-厂区名称、bizType-业务类型(report/appeal/rectify/verify)、hazardLevel-隐患等级编码、hazardLevelName-隐患等级名称、flowKey-流程定义Key、flowName-流程名称、status-状态(0停用/1正常)、createBy-创建者、createTime-创建时间、updateBy-更新者、updateTime-更新时间。非超级管理员无权查看其他厂区的配置。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/{id}` - **请求:** `GET /gd_dataserver/flowable/hazardFlowConfig/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getInfoUsingGET_1` - **operationId:** `getInfoUsingGET_1`
@ -190,8 +194,8 @@ _无_
### 删除流程模板配置 ### 删除流程模板配置
- **用途:** 逻辑删除,将状态置为停用。 - **用途:** 逻辑删除(设置del_flag=1),不做物理删除。非超级管理员只能删除自己厂区的配置,否则返回错误。返回 data 为提示字符串,如"删除成功"。
- **请求:** `DELETE /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/{id}` - **请求:** `DELETE /gd_dataserver/flowable/hazardFlowConfig/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `removeUsingDELETE_1` - **operationId:** `removeUsingDELETE_1`

60
docs/api/modules/04-points-balance.md

@ -12,21 +12,21 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/balance/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/balance/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/balance/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/balance/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/balance/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/balance/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 手动调整积分(PC管理端) | POST | `/gd_dataserver/gd_dataserver/business/points/balance/adjust` | 管理员手动补发或扣减指定用户的积分。points为正数补发,为负数扣减。操作会同时生成积分流水(bizType=MANUAL_ADD/MANUAL_DEDUCT)和审计日志。返回 data 为 boolean,true-调整成功。 | | 手动调整积分(PC管理端) | POST | `/gd_dataserver/business/points/balance/adjust` | 管理员手动补发或扣减指定用户的积分。points为正数补发,为负数扣减。操作会同时生成积分流水(bizType=MANUAL_ADD/MANUAL_DEDUCT)和审计日志。返回 data 为 boolean,true-调整成功。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/balance/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/balance/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/balance/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/balance/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 查询用户积分账户 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/getByUserId/{userId}` | 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。 | | 查询用户积分账户 | GET | `/gd_dataserver/business/points/balance/getByUserId/{userId}` | 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/balance/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/balance/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/balance/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询当前用户积分账户(APP端) | GET | `/gd_dataserver/gd_dataserver/business/points/balance/my` | 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。 | | 查询当前用户积分账户(APP端) | GET | `/gd_dataserver/business/points/balance/my` | 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/balance/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/balance/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/balance/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/balance/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
## 接口详情 ## 接口详情
@ -36,7 +36,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/balance/add` - **请求:** `POST /gd_dataserver/business/points/balance/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST` - **operationId:** `addOneUsingPOST`
@ -77,7 +77,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/balance/addBatch` - **请求:** `POST /gd_dataserver/business/points/balance/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST` - **operationId:** `addBatchUsingPOST`
@ -105,7 +105,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/balance/addReturn` - **请求:** `POST /gd_dataserver/business/points/balance/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST` - **operationId:** `addReturnUsingPOST`
@ -146,7 +146,7 @@ _无_
### 手动调整积分(PC管理端) ### 手动调整积分(PC管理端)
- **用途:** 管理员手动补发或扣减指定用户的积分。points为正数补发,为负数扣减。操作会同时生成积分流水(bizType=MANUAL_ADD/MANUAL_DEDUCT)和审计日志。返回 data 为 boolean,true-调整成功。 - **用途:** 管理员手动补发或扣减指定用户的积分。points为正数补发,为负数扣减。操作会同时生成积分流水(bizType=MANUAL_ADD/MANUAL_DEDUCT)和审计日志。返回 data 为 boolean,true-调整成功。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/balance/adjust` - **请求:** `POST /gd_dataserver/business/points/balance/adjust`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `adjustPointsUsingPOST` - **operationId:** `adjustPointsUsingPOST`
@ -174,7 +174,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/delete` - **请求:** `GET /gd_dataserver/business/points/balance/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET` - **operationId:** `deleteUsingGET`
@ -205,7 +205,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/deleteById` - **请求:** `GET /gd_dataserver/business/points/balance/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET` - **operationId:** `deleteOneUsingGET`
@ -228,7 +228,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/balance/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_1` - **operationId:** `deleteListUsingGET_1`
@ -251,7 +251,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/getAll` - **请求:** `GET /gd_dataserver/business/points/balance/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET` - **operationId:** `getAllUsingGET`
@ -272,7 +272,7 @@ _无_
### 查询用户积分账户 ### 查询用户积分账户
- **用途:** 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。 - **用途:** 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/getByUserId/{userId}` - **请求:** `GET /gd_dataserver/business/points/balance/getByUserId/{userId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getByUserIdUsingGET` - **operationId:** `getByUserIdUsingGET`
@ -295,7 +295,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/getListByPage` - **请求:** `GET /gd_dataserver/business/points/balance/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET` - **operationId:** `getListByPageUsingGET`
@ -328,7 +328,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/info` - **请求:** `GET /gd_dataserver/business/points/balance/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET` - **operationId:** `infoUsingGET`
@ -351,7 +351,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/list` - **请求:** `GET /gd_dataserver/business/points/balance/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET` - **operationId:** `getListUsingGET`
@ -382,7 +382,7 @@ _无_
### 查询当前用户积分账户(APP端) ### 查询当前用户积分账户(APP端)
- **用途:** 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。 - **用途:** 返回 data 为 AccountBalance 对象。字段:userId-用户ID、availableBalance-可用积分余额、frozenBalance-冻结积分、totalIncome-历史总入账、totalOutcome-历史总出账。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/my` - **请求:** `GET /gd_dataserver/business/points/balance/my`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myBalanceUsingGET` - **operationId:** `myBalanceUsingGET`
@ -403,7 +403,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/balance/removeById` - **请求:** `GET /gd_dataserver/business/points/balance/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET` - **operationId:** `deleteListUsingGET`
@ -426,7 +426,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/balance/updateById` - **请求:** `POST /gd_dataserver/business/points/balance/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST` - **operationId:** `updateByIdUsingPOST`

81
docs/api/modules/05-points-transaction.md

@ -12,20 +12,20 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/transaction/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/transaction/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/transaction/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/transaction/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/transaction/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/transaction/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/transaction/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/transaction/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/transaction/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/transaction/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/transaction/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/transaction/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/transaction/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询我的积分流水(APP端) | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsTransactionLog 对象,主要字段:txnNo-流水号、userId-用户ID、bizId-业务单号、bizType-业务类型(REPORT-上报奖励/EXCHANGE-兑换扣减/REFUND-退款/APPEAL_ADD-申诉补发/APPEAL_DEDUCT-申诉扣减/MALL_DEDUCT-商城扣减/MALL_REFUND-商城退款)、amount-变动积分(正=入账,负=出账)、beforeBalance-变动前余额、afterBalance-变动后余额、status-状态(1有效/2已冲正)、createTime-创建时间。 | | 查询我的积分流水(APP端) | GET | `/gd_dataserver/business/points/transaction/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsTransactionLog 对象,主要字段:txnNo-流水号、userId-用户ID、bizId-业务单号、bizType-业务类型(REPORT-上报奖励/EXCHANGE-兑换扣减/REFUND-退款/APPEAL_ADD-申诉补发/APPEAL_DEDUCT-申诉扣减/MALL_DEDUCT-商城扣减/MALL_REFUND-商城退款)、amount-变动积分(正=入账,负=出账)、beforeBalance-变动前余额、afterBalance-变动后余额、status-状态(1有效/2已冲正)、createTime-创建时间。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/transaction/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/transaction/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 积分冲正 | POST | `/gd_dataserver/gd_dataserver/business/points/transaction/reverse/{logId}` | 根据流水ID冲正该笔积分变动,原流水标记为已冲正(status=2),并生成反向流水。返回 data 为 boolean,true-冲正成功。 | | 积分冲正 | POST | `/gd_dataserver/business/points/transaction/reverse/{logId}` | 根据流水ID冲正该笔积分变动,原流水标记为已冲正(status=2),并生成反向流水。返回 data 为 boolean,true-冲正成功。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/transaction/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/transaction/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
## 接口详情 ## 接口详情
@ -35,9 +35,9 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/transaction/add` - **请求:** `POST /gd_dataserver/business/points/transaction/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_11` - **operationId:** `addOneUsingPOST_10`
参数: 参数:
@ -59,6 +59,7 @@ _无_
| bizId | 否 | string | 业务单号 | - | | bizId | 否 | string | 业务单号 | - |
| bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| operator | 否 | string | 操作人 | - | | operator | 否 | string | 操作人 | - |
| remark | 否 | string | 备注 | - | | remark | 否 | string | 备注 | - |
@ -81,9 +82,9 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/transaction/addBatch` - **请求:** `POST /gd_dataserver/business/points/transaction/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_11` - **operationId:** `addBatchUsingPOST_10`
参数: 参数:
@ -109,9 +110,9 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/transaction/addReturn` - **请求:** `POST /gd_dataserver/business/points/transaction/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_11` - **operationId:** `addReturnUsingPOST_10`
参数: 参数:
@ -133,6 +134,7 @@ _无_
| bizId | 否 | string | 业务单号 | - | | bizId | 否 | string | 业务单号 | - |
| bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| operator | 否 | string | 操作人 | - | | operator | 否 | string | 操作人 | - |
| remark | 否 | string | 备注 | - | | remark | 否 | string | 备注 | - |
@ -155,9 +157,9 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/delete` - **请求:** `GET /gd_dataserver/business/points/transaction/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_11` - **operationId:** `deleteUsingGET_10`
参数: 参数:
@ -171,6 +173,7 @@ _无_
| bizId | query | 否 | string | 业务单号 | - | | bizId | query | 否 | string | 业务单号 | - |
| bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| operator | query | 否 | string | 操作人 | - | | operator | query | 否 | string | 操作人 | - |
| remark | query | 否 | string | 备注 | - | | remark | query | 否 | string | 备注 | - |
@ -191,9 +194,9 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/deleteById` - **请求:** `GET /gd_dataserver/business/points/transaction/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_11` - **operationId:** `deleteOneUsingGET_10`
参数: 参数:
@ -214,9 +217,9 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/transaction/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_23` - **operationId:** `deleteListUsingGET_21`
参数: 参数:
@ -237,9 +240,9 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/getAll` - **请求:** `GET /gd_dataserver/business/points/transaction/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_11` - **operationId:** `getAllUsingGET_10`
参数: 参数:
@ -258,7 +261,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/getListByPage` - **请求:** `GET /gd_dataserver/business/points/transaction/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_11` - **operationId:** `getListByPageUsingGET_11`
@ -274,6 +277,7 @@ _无_
| bizId | query | 否 | string | 业务单号 | - | | bizId | query | 否 | string | 业务单号 | - |
| bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| operator | query | 否 | string | 操作人 | - | | operator | query | 否 | string | 操作人 | - |
| pageNum | query | 是 | integer / int32 | 页码 | - | | pageNum | query | 是 | integer / int32 | 页码 | - |
@ -296,7 +300,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/info` - **请求:** `GET /gd_dataserver/business/points/transaction/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_11` - **operationId:** `infoUsingGET_11`
@ -319,9 +323,9 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/list` - **请求:** `GET /gd_dataserver/business/points/transaction/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_11` - **operationId:** `getListUsingGET_10`
参数: 参数:
@ -335,6 +339,7 @@ _无_
| bizId | query | 否 | string | 业务单号 | - | | bizId | query | 否 | string | 业务单号 | - |
| bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| operator | query | 否 | string | 操作人 | - | | operator | query | 否 | string | 操作人 | - |
| remark | query | 否 | string | 备注 | - | | remark | query | 否 | string | 备注 | - |
@ -355,7 +360,7 @@ _无_
### 查询我的积分流水(APP端) ### 查询我的积分流水(APP端)
- **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsTransactionLog 对象,主要字段:txnNo-流水号、userId-用户ID、bizId-业务单号、bizType-业务类型(REPORT-上报奖励/EXCHANGE-兑换扣减/REFUND-退款/APPEAL_ADD-申诉补发/APPEAL_DEDUCT-申诉扣减/MALL_DEDUCT-商城扣减/MALL_REFUND-商城退款)、amount-变动积分(正=入账,负=出账)、beforeBalance-变动前余额、afterBalance-变动后余额、status-状态(1有效/2已冲正)、createTime-创建时间。 - **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsTransactionLog 对象,主要字段:txnNo-流水号、userId-用户ID、bizId-业务单号、bizType-业务类型(REPORT-上报奖励/EXCHANGE-兑换扣减/REFUND-退款/APPEAL_ADD-申诉补发/APPEAL_DEDUCT-申诉扣减/MALL_DEDUCT-商城扣减/MALL_REFUND-商城退款)、amount-变动积分(正=入账,负=出账)、beforeBalance-变动前余额、afterBalance-变动后余额、status-状态(1有效/2已冲正)、createTime-创建时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/myList` - **请求:** `GET /gd_dataserver/business/points/transaction/myList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myListUsingGET_3` - **operationId:** `myListUsingGET_3`
@ -371,6 +376,7 @@ _无_
| bizId | query | 否 | string | 业务单号 | - | | bizId | query | 否 | string | 业务单号 | - |
| bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | query | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| operator | query | 否 | string | 操作人 | - | | operator | query | 否 | string | 操作人 | - |
| pageNum | query | 否 | integer / int32 | 页码 | - | | pageNum | query | 否 | integer / int32 | 页码 | - |
@ -393,9 +399,9 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/transaction/removeById` - **请求:** `GET /gd_dataserver/business/points/transaction/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_22` - **operationId:** `deleteListUsingGET_20`
参数: 参数:
@ -416,7 +422,7 @@ _无_
### 积分冲正 ### 积分冲正
- **用途:** 根据流水ID冲正该笔积分变动,原流水标记为已冲正(status=2),并生成反向流水。返回 data 为 boolean,true-冲正成功。 - **用途:** 根据流水ID冲正该笔积分变动,原流水标记为已冲正(status=2),并生成反向流水。返回 data 为 boolean,true-冲正成功。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/transaction/reverse/{logId}` - **请求:** `POST /gd_dataserver/business/points/transaction/reverse/{logId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `reverseTransactionUsingPOST` - **operationId:** `reverseTransactionUsingPOST`
@ -442,7 +448,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/transaction/updateById` - **请求:** `POST /gd_dataserver/business/points/transaction/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_11` - **operationId:** `updateByIdUsingPOST_11`
@ -466,6 +472,7 @@ _无_
| bizId | 否 | string | 业务单号 | - | | bizId | 否 | string | 业务单号 | - |
| bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| operator | 否 | string | 操作人 | - | | operator | 否 | string | 操作人 | - |
| remark | 否 | string | 备注 | - | | remark | 否 | string | 备注 | - |

246
docs/api/modules/06-points-rule.md

@ -2,7 +2,7 @@
本模块共 14 个接口。源文件:`api.json`。 本模块共 13 个接口。源文件:`api.json`。
@ -12,32 +12,31 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/rule/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增积分规则 | POST | `/gd_dataserver/business/points/rule/add` | 二级管理员自动填充厂区信息,且不可创建全局兜底规则;超级管理员可指定 deptId(为空表示全局兜底规则)。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/rule/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 计算积分 | GET | `/gd_dataserver/business/points/rule/calculatePoints` | 根据厂区、隐患等级和类别查询对应奖励积分。二级管理员调用时 deptId 自动填充为所属厂区,超管可传任意厂区(不传则匹配全局兜底)。返回 data 为 Integer 类型的积分数值。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/rule/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 删除积分规则 | GET | `/gd_dataserver/business/points/rule/deleteById` | 根据主键ID物理删除。二级管理员只能删除本厂区规则;全局兜底规则仅超级管理员可删除。 |
| 计算积分 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/calculatePoints` | 根据隐患等级和类别查询对应奖励积分。返回 data 为 Integer 类型的积分数值,如 50。 | | 分页查询积分规则(兼容旧路径) | GET | `/gd_dataserver/business/points/rule/getListByPage` | 同 /list 接口,保留用于前端旧路径兼容。二级管理员自动过滤本厂区。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 获取积分规则详情 | GET | `/gd_dataserver/business/points/rule/info` | 根据主键ID查询规则详情。二级管理员访问非本厂区规则或全局兜底规则时返回错误。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 分页查询积分规则列表 | GET | `/gd_dataserver/business/points/rule/list` | 超级管理员返回所有厂区规则(可按deptId筛选,传global表示查询全局兜底规则);二级管理员自动过滤为所属厂区规则。返回 data 为 PageInfo 分页对象。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 查询当前厂区所有积分规则 | GET | `/gd_dataserver/business/points/rule/myFactoryRules` | 返回当前登录用户所属厂区的规则列表,同时包含全局兜底规则(dept_id 为 NULL)。返回 data 为 PointsRuleConfig 数组。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 获取隐患分类根规则列表 | GET | `/gd_dataserver/business/points/rule/rootRules` | 返回当前用户厂区每个大类(一般/较大/重大)的最高优先级根规则,用于 APP 上报时隐患分类下拉选择。返回 data 为 PointsRuleConfig 数组(最多3条)。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 获取积分规则树形结构 | GET | `/gd_dataserver/business/points/rule/ruleTree` | 返回当前用户厂区的积分规则树形结构,按大类(一般/较大/重大)分组,每个大类下包含子规则列表,用于审批时选择具体档次。返回 data 为数组,每项含 id/hazardLevel/hazardLevelName/ruleName/points/children。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 获取指定等级下的积分规则列表 | GET | `/gd_dataserver/business/points/rule/rulesByLevel` | 根据隐患等级编码(general/major/critical)返回当前厂区该等级下的根规则和子档位列表,用于审批人在当前等级内选择具体档次。返回 data 为对象,包含 hazardLevel-等级编码、hazardLevelName-等级名称、root-根规则对象(可为null)、children-子档位规则数组。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 启用/禁用积分规则 | POST | `/gd_dataserver/business/points/rule/toggleEnabled` | enabled=1 启用,enabled=0 禁用。二级管理员只能操作本厂区规则。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 积分规则试算 | GET | `/gd_dataserver/business/points/rule/trialCalculate` | 模拟积分计算过程,返回匹配的规则详情和计算结果。返回 data 为对象:deptId-生效厂区、hazardLevel-输入的隐患等级、hazardCategory-输入的隐患类别、matchedRule-匹配到的规则对象或null、calculatedPoints-计算得到的积分数值(无匹配时为0)、matchScope-命中范围(FACTORY-厂区专属/GLOBAL-全局兜底/NONE-未命中)。 |
| 积分规则试算 | GET | `/gd_dataserver/gd_dataserver/business/points/rule/trialCalculate` | 模拟积分计算过程,返回匹配的规则详情和计算结果。返回 data 为对象,包含:hazardLevel-输入的隐患等级、hazardCategory-输入的隐患类别、matchedRule-匹配到的规则对象{id,ruleName,points,priority}或null、calculatedPoints-计算得到的积分数值(无匹配时为0)。 | | 修改积分规则 | POST | `/gd_dataserver/business/points/rule/updateById` | 二级管理员只能修改本厂区规则,不可变更所属厂区;超级管理员可任意修改。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/rule/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
## 接口详情 ## 接口详情
### 新增 ### 新增积分规则
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 二级管理员自动填充厂区信息,且不可创建全局兜底规则;超级管理员可指定 deptId(为空表示全局兜底规则)。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/rule/add` - **请求:** `POST /gd_dataserver/business/points/rule/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_10` - **operationId:** `addUsingPOST`
参数: 参数:
@ -52,9 +51,11 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| deptId | 否 | string | 所属厂区部门ID(NULL表示全局兜底规则,二级管理员新增时自动填充) | 100 |
| deptName | 否 | string | 所属厂区部门名称 | 一厂 |
| enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - | | enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| hazardCategory | 否 | string | 隐患类别 | - | | hazardCategory | 否 | string | 隐患类别 | - |
| hazardLevel | 否 | integer / int32 | 隐患等级 | - | | hazardLevel | 否 | string | 隐患等级编码(general/major/critical) | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| points | 否 | integer / int32 | 奖励积分 | - | | points | 否 | integer / int32 | 奖励积分 | - |
| priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - | | priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |
@ -75,90 +76,43 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 批量新增 ### 计算积分
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/rule/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_10`
参数:
_无_
请求体:
- Content-Type:`application/json`
- 模型:`array<积分规则配置>`
- 必填:文档未标记
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 根据厂区、隐患等级和类别查询对应奖励积分。二级管理员调用时 deptId 自动填充为所属厂区,超管可传任意厂区(不传则匹配全局兜底)。返回 data 为 Integer 类型的积分数值。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/rule/addReturn` - **请求:** `GET /gd_dataserver/business/points/rule/calculatePoints`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_10` - **operationId:** `calculatePointsUsingGET`
参数: 参数:
_无_ | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
请求体: | deptId | query | 否 | string | 厂区部门ID(二级管理员忽略此参数) | - |
| hazardLevel | query | 是 | string | 隐患等级编码 | - |
- Content-Type:`application/json` | hazardCategory | query | 是 | string | 隐患类别编码 | - |
- 模型:`积分规则配置`
- 必填:文档未标记
| 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | 创建时间 | - |
| enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| hazardCategory | 否 | string | 隐患类别 | - |
| hazardLevel | 否 | integer / int32 | 隐患等级 | - |
| id | 否 | integer / int64 | 主键ID | - |
| points | 否 | integer / int32 | 奖励积分 | - |
| priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |
| remark | 否 | string | 备注 | - |
| ruleCode | 否 | string | 规则编码 | - |
| ruleName | 否 | string | 规则名称 | - |
| updateTime | 否 | string / date-time | 更新时间 | - |
响应: 响应:
| 状态码 | 说明 | 响应模型 | | 状态码 | 说明 | 响应模型 |
| --- | --- | --- | | --- | --- | --- |
| 200 | OK | */*: object<string, object> | | 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - | | 401 | Unauthorized | - |
| 403 | Forbidden | - | | 403 | Forbidden | - |
| 404 | Not Found | - | | 404 | Not Found | - |
### 计算积分 ### 删除积分规则
- **用途:** 根据隐患等级和类别查询对应奖励积分。返回 data 为 Integer 类型的积分数值,如 50。 - **用途:** 根据主键ID物理删除。二级管理员只能删除本厂区规则;全局兜底规则仅超级管理员可删除。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/calculatePoints` - **请求:** `GET /gd_dataserver/business/points/rule/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `calculatePointsUsingGET` - **operationId:** `deleteByIdUsingGET`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| hazardLevel | query | 是 | string | 隐患等级编码 | - | | id | query | 是 | string | 主键ID | - |
| hazardCategory | query | 是 | string | 隐患类别编码 | - |
响应: 响应:
@ -170,28 +124,32 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 根据属性删除 ### 分页查询积分规则(兼容旧路径)
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 同 /list 接口,保留用于前端旧路径兼容。二级管理员自动过滤本厂区。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/delete` - **请求:** `GET /gd_dataserver/business/points/rule/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_10` - **operationId:** `getListByPageUsingGET_10`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| deptId | query | 否 | string | 所属厂区部门ID(NULL表示全局兜底规则,二级管理员新增时自动填充) | - |
| deptName | query | 否 | string | 所属厂区部门名称 | - |
| enabled | query | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - | | enabled | query | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| hazardCategory | query | 否 | string | 隐患类别 | - | | hazardCategory | query | 否 | string | 隐患类别 | - |
| hazardLevel | query | 否 | integer / int32 | 隐患等级 | - | | hazardLevel | query | 否 | string | 隐患等级编码(general/major/critical) | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| pageNum | query | 否 | integer / int32 | 页码 | - |
| points | query | 否 | integer / int32 | 奖励积分 | - | | points | query | 否 | integer / int32 | 奖励积分 | - |
| priority | query | 否 | integer / int32 | 优先级(数字越大优先级越高) | - | | priority | query | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |
| remark | query | 否 | string | 备注 | - | | remark | query | 否 | string | 备注 | - |
| ruleCode | query | 否 | string | 规则编码 | - | | ruleCode | query | 否 | string | 规则编码 | - |
| ruleName | query | 否 | string | 规则名称 | - | | ruleName | query | 否 | string | 规则名称 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - | | updateTime | query | 否 | string / date-time | 更新时间 | - |
| pageSize | query | 否 | integer / int32 | 每页条数 | - |
响应: 响应:
@ -203,12 +161,12 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 主键删除 ### 获取积分规则详情
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID查询规则详情。二级管理员访问非本厂区规则或全局兜底规则时返回错误。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/deleteById` - **请求:** `GET /gd_dataserver/business/points/rule/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_10` - **operationId:** `infoUsingGET_10`
参数: 参数:
@ -226,18 +184,24 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 批量删除 ### 分页查询积分规则列表
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 超级管理员返回所有厂区规则(可按deptId筛选,传global表示查询全局兜底规则);二级管理员自动过滤为所属厂区规则。返回 data 为 PageInfo 分页对象。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/rule/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_21` - **operationId:** `listUsingGET_1`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| ids | query | 是 | string | ID列表(逗号分隔) | - | | pageNum | query | 是 | integer / int32 | 页码 | - |
| pageSize | query | 是 | integer / int32 | 每页条数 | - |
| deptId | query | 否 | string | 厂区部门ID(超管可传,二级管理员忽略;传 global 表示查询全局兜底规则) | - |
| hazardLevel | query | 否 | string | 隐患等级编码(general/major/critical) | - |
| hazardCategory | query | 否 | string | 隐患类别 | - |
| enabled | query | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| ruleName | query | 否 | string | 规则名称(模糊匹配) | - |
响应: 响应:
@ -249,12 +213,12 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 查询所有 ### 查询当前厂区所有积分规则
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 返回当前登录用户所属厂区的规则列表,同时包含全局兜底规则(dept_id 为 NULL)。返回 data 为 PointsRuleConfig 数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/getAll` - **请求:** `GET /gd_dataserver/business/points/rule/myFactoryRules`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_10` - **operationId:** `myFactoryRulesUsingGET`
参数: 参数:
@ -270,30 +234,16 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 分页查询 ### 获取隐患分类根规则列表
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 返回当前用户厂区每个大类(一般/较大/重大)的最高优先级根规则,用于 APP 上报时隐患分类下拉选择。返回 data 为 PointsRuleConfig 数组(最多3条)。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/getListByPage` - **请求:** `GET /gd_dataserver/business/points/rule/rootRules`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_10` - **operationId:** `rootRulesUsingGET`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | _无_
| --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | 创建时间 | - |
| enabled | query | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| hazardCategory | query | 否 | string | 隐患类别 | - |
| hazardLevel | query | 否 | integer / int32 | 隐患等级 | - |
| id | query | 否 | integer / int64 | 主键ID | - |
| pageNum | query | 是 | integer / int32 | 页码 | - |
| points | query | 否 | integer / int32 | 奖励积分 | - |
| priority | query | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |
| remark | query | 否 | string | 备注 | - |
| ruleCode | query | 否 | string | 规则编码 | - |
| ruleName | query | 否 | string | 规则名称 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - |
| pageSize | query | 是 | integer / int32 | 每页条数 | - |
响应: 响应:
@ -305,18 +255,16 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 详情 ### 获取积分规则树形结构
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 返回当前用户厂区的积分规则树形结构,按大类(一般/较大/重大)分组,每个大类下包含子规则列表,用于审批时选择具体档次。返回 data 为数组,每项含 id/hazardLevel/hazardLevelName/ruleName/points/children。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/info` - **请求:** `GET /gd_dataserver/business/points/rule/ruleTree`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_10` - **operationId:** `ruleTreeUsingGET`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | _无_
| --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 主键ID | - |
响应: 响应:
@ -328,28 +276,19 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 条件查询 ### 获取指定等级下的积分规则列表
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据隐患等级编码(general/major/critical)返回当前厂区该等级下的根规则和子档位列表,用于审批人在当前等级内选择具体档次。返回 data 为对象,包含 hazardLevel-等级编码、hazardLevelName-等级名称、root-根规则对象(可为null)、children-子档位规则数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/list` - **请求:** `GET /gd_dataserver/business/points/rule/rulesByLevel`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_10` - **operationId:** `rulesByLevelUsingGET`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | 创建时间 | - | | hazardLevel | query | 是 | string | 隐患等级编码(general/major/critical) | - |
| enabled | query | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - | | deptId | query | 否 | string | 厂区部门ID(仅超级管理员生效:传具体ID查看该厂区+全局,传global仅查看全局兜底,不传查看全部厂区) | - |
| hazardCategory | query | 否 | string | 隐患类别 | - |
| hazardLevel | query | 否 | integer / int32 | 隐患等级 | - |
| id | query | 否 | integer / int64 | 主键ID | - |
| points | query | 否 | integer / int32 | 奖励积分 | - |
| priority | query | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |
| remark | query | 否 | string | 备注 | - |
| ruleCode | query | 否 | string | 规则编码 | - |
| ruleName | query | 否 | string | 规则名称 | - |
| updateTime | query | 否 | string / date-time | 更新时间 | - |
响应: 响应:
@ -361,24 +300,26 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 逻辑删除 ### 启用/禁用积分规则
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** enabled=1 启用,enabled=0 禁用。二级管理员只能操作本厂区规则。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/removeById` - **请求:** `POST /gd_dataserver/business/points/rule/toggleEnabled`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_20` - **operationId:** `toggleEnabledUsingPOST`
参数: 参数:
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| id | query | 是 | string | 主键ID | - | | id | query | 是 | integer / int64 | 规则ID | - |
| enabled | query | 是 | integer / int32 | 启用状态:0-禁用 1-启用 | - |
响应: 响应:
| 状态码 | 说明 | 响应模型 | | 状态码 | 说明 | 响应模型 |
| --- | --- | --- | | --- | --- | --- |
| 200 | OK | */*: object<string, object> | | 200 | OK | */*: object<string, object> |
| 201 | Created | - |
| 401 | Unauthorized | - | | 401 | Unauthorized | - |
| 403 | Forbidden | - | | 403 | Forbidden | - |
| 404 | Not Found | - | | 404 | Not Found | - |
@ -386,8 +327,8 @@ _无_
### 积分规则试算 ### 积分规则试算
- **用途:** 模拟积分计算过程,返回匹配的规则详情和计算结果。返回 data 为对象,包含:hazardLevel-输入的隐患等级、hazardCategory-输入的隐患类别、matchedRule-匹配到的规则对象{id,ruleName,points,priority}或null、calculatedPoints-计算得到的积分数值(无匹配时为0)。 - **用途:** 模拟积分计算过程,返回匹配的规则详情和计算结果。返回 data 为对象:deptId-生效厂区、hazardLevel-输入的隐患等级、hazardCategory-输入的隐患类别、matchedRule-匹配到的规则对象或null、calculatedPoints-计算得到的积分数值(无匹配时为0)、matchScope-命中范围(FACTORY-厂区专属/GLOBAL-全局兜底/NONE-未命中)。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/rule/trialCalculate` - **请求:** `GET /gd_dataserver/business/points/rule/trialCalculate`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `trialCalculateUsingGET` - **operationId:** `trialCalculateUsingGET`
@ -395,6 +336,7 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| deptId | query | 否 | string | 厂区部门ID(二级管理员忽略此参数) | - |
| hazardLevel | query | 是 | string | 隐患等级编码 | - | | hazardLevel | query | 是 | string | 隐患等级编码 | - |
| hazardCategory | query | 是 | string | 隐患类别编码 | - | | hazardCategory | query | 是 | string | 隐患类别编码 | - |
@ -408,10 +350,10 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 修改 ### 修改积分规则
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 二级管理员只能修改本厂区规则,不可变更所属厂区;超级管理员可任意修改。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/rule/updateById` - **请求:** `POST /gd_dataserver/business/points/rule/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_10` - **operationId:** `updateByIdUsingPOST_10`
@ -428,9 +370,11 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| deptId | 否 | string | 所属厂区部门ID(NULL表示全局兜底规则,二级管理员新增时自动填充) | 100 |
| deptName | 否 | string | 所属厂区部门名称 | 一厂 |
| enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - | | enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| hazardCategory | 否 | string | 隐患类别 | - | | hazardCategory | 否 | string | 隐患类别 | - |
| hazardLevel | 否 | integer / int32 | 隐患等级 | - | | hazardLevel | 否 | string | 隐患等级编码(general/major/critical) | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| points | 否 | integer / int32 | 奖励积分 | - | | points | 否 | integer / int32 | 奖励积分 | - |
| priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - | | priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |

104
docs/api/modules/07-points-appeal.md

@ -12,27 +12,27 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 受理申诉 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/accept/{id}` | 将申诉状态从待受理(0)改为处理中(1)。返回 data 为 boolean。 | | 受理申诉 | POST | `/gd_dataserver/business/points/appeal/accept/{id}` | 将申诉状态从待受理(0)改为处理中(1)。返回 data 为 boolean。 |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/appeal/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/appeal/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/appeal/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 审批申诉流程 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/completeFlow` | 审批通过或驳回申诉流程节点。成功返回 data 为 null;失败返回 error 信息。 | | 审批申诉流程 | POST | `/gd_dataserver/business/points/appeal/completeFlow` | 审批通过或驳回申诉流程节点。成功返回 data 为 null;失败返回 error 信息。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/appeal/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/appeal/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/appeal/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 获取申诉详情 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/detail/{id}` | 返回 data 为 PointsAppeal 对象,包含完整申诉字段及流程进度信息。 | | 获取申诉详情 | GET | `/gd_dataserver/business/points/appeal/detail/{id}` | 返回 data 为 PointsAppeal 对象,包含完整申诉字段及流程进度信息。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/appeal/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/appeal/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 处理申诉 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/handle/{id}` | 通过或驳回申诉,可选调整积分。approved=true时状态改为已通过(2),approved=false时改为已驳回(3)。adjustPoints为正数补发积分,负数扣减积分,不传则不调整。返回 data 为 boolean。 | | 处理申诉 | POST | `/gd_dataserver/business/points/appeal/handle/{id}` | 通过或驳回申诉,可选调整积分。approved=true时状态改为已通过(2),approved=false时改为已驳回(3)。adjustPoints为正数补发积分,负数扣减积分,不传则不调整。返回 data 为 boolean。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/appeal/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/appeal/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询我的申诉记录(APP端) | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,主要字段:id、appealNo-申诉编号、appealType-申诉类型(REJECT/POINTS/OTHER)、status-状态(0待受理/1处理中/2已通过/3已驳回/4已撤回)、statusName-状态名称、handleRemark-处理意见、adjustPoints-调整积分、createTime。 | | 查询我的申诉记录(APP端) | GET | `/gd_dataserver/business/points/appeal/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,主要字段:id、appealNo-申诉编号、appealType-申诉类型(REJECT/POINTS/OTHER)、status-状态(0待受理/1处理中/2已通过/3已驳回/4已撤回)、statusName-状态名称、handleRemark-处理意见、adjustPoints-调整积分、createTime。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/appeal/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 提交申诉(APP端) | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/submit` | 填写申诉类型、理由等信息,申诉人信息从登录用户获取。返回 data 为 PointsAppeal 对象,包含 id、appealNo-申诉编号、status-状态(0待受理)。 | | 提交申诉(APP端) | POST | `/gd_dataserver/business/points/appeal/submit` | 填写申诉类型、理由等信息,申诉人信息从登录用户获取。返回 data 为 PointsAppeal 对象,包含 id、appealNo-申诉编号、status-状态(0待受理)。 |
| 提交申诉并启动流程(APP端) | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/submitFlow` | 提交申诉并自动启动 Flowable 审批流程。成功返回 data 为流程实例ID字符串;失败返回 error 信息。 | | 提交申诉并启动流程(APP端) | POST | `/gd_dataserver/business/points/appeal/submitFlow` | 提交申诉并自动启动 Flowable 审批流程。后端自动解析申诉人所属厂区,按 (厂区, biz_type=appeal) 从 qc_hazard_flow_config 匹配流程Key并带厂区tenantId启动;若该厂区未配置申诉流程则回退到全局默认 appeal.flow.key。申诉人信息、factoryDeptId/factoryDeptName 均由后端自动填充,无需前端传。成功返回 data 为流程实例ID字符串;失败返回 error 信息。 |
| 申诉流程待办列表 | GET | `/gd_dataserver/gd_dataserver/business/points/appeal/todoList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,包含 id、appealNo、userName、appealType-申诉类型、appealReason-申诉理由、status-状态、createTime。 | | 申诉流程待办列表 | GET | `/gd_dataserver/business/points/appeal/todoList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,包含 id、appealNo、userName、appealType-申诉类型、appealReason-申诉理由、status-状态、createTime。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/appeal/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
| 撤回申诉(APP端) | POST | `/gd_dataserver/gd_dataserver/business/points/appeal/withdraw/{id}` | 仅待受理状态(status=0)可撤回,撤回后状态改为已撤回(4)。返回 data 为 boolean。 | | 撤回申诉(APP端) | POST | `/gd_dataserver/business/points/appeal/withdraw/{id}` | 仅待受理状态(status=0)可撤回,撤回后状态改为已撤回(4)。返回 data 为 boolean。 |
## 接口详情 ## 接口详情
@ -42,7 +42,7 @@
### 受理申诉 ### 受理申诉
- **用途:** 将申诉状态从待受理(0)改为处理中(1)。返回 data 为 boolean。 - **用途:** 将申诉状态从待受理(0)改为处理中(1)。返回 data 为 boolean。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/accept/{id}` - **请求:** `POST /gd_dataserver/business/points/appeal/accept/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `acceptAppealUsingPOST` - **operationId:** `acceptAppealUsingPOST`
@ -66,7 +66,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/add` - **请求:** `POST /gd_dataserver/business/points/appeal/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_9` - **operationId:** `addOneUsingPOST_9`
@ -89,6 +89,8 @@ _无_
| attachmentUrls | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | 否 | string | 附件URL(JSON数组) | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | 否 | string | 流程实例ID(预留) | - |
| flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | 否 | string | 处理意见/结果说明 | - | | handleRemark | 否 | string | 处理意见/结果说明 | - |
@ -120,7 +122,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/addBatch` - **请求:** `POST /gd_dataserver/business/points/appeal/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_9` - **operationId:** `addBatchUsingPOST_9`
@ -148,7 +150,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/addReturn` - **请求:** `POST /gd_dataserver/business/points/appeal/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_9` - **operationId:** `addReturnUsingPOST_9`
@ -171,6 +173,8 @@ _无_
| attachmentUrls | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | 否 | string | 附件URL(JSON数组) | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | 否 | string | 流程实例ID(预留) | - |
| flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | 否 | string | 处理意见/结果说明 | - | | handleRemark | 否 | string | 处理意见/结果说明 | - |
@ -202,7 +206,7 @@ _无_
### 审批申诉流程 ### 审批申诉流程
- **用途:** 审批通过或驳回申诉流程节点。成功返回 data 为 null;失败返回 error 信息。 - **用途:** 审批通过或驳回申诉流程节点。成功返回 data 为 null;失败返回 error 信息。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/completeFlow` - **请求:** `POST /gd_dataserver/business/points/appeal/completeFlow`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `completeFlowUsingPOST` - **operationId:** `completeFlowUsingPOST`
@ -254,7 +258,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/delete` - **请求:** `GET /gd_dataserver/business/points/appeal/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_9` - **operationId:** `deleteUsingGET_9`
@ -269,6 +273,8 @@ _无_
| attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | query | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | query | 否 | string | 流程实例ID(预留) | - |
| flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | query | 否 | string | 处理意见/结果说明 | - | | handleRemark | query | 否 | string | 处理意见/结果说明 | - |
@ -298,7 +304,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/deleteById` - **请求:** `GET /gd_dataserver/business/points/appeal/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_9` - **operationId:** `deleteOneUsingGET_9`
@ -321,7 +327,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/appeal/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_19` - **operationId:** `deleteListUsingGET_19`
@ -344,7 +350,7 @@ _无_
### 获取申诉详情 ### 获取申诉详情
- **用途:** 返回 data 为 PointsAppeal 对象,包含完整申诉字段及流程进度信息。 - **用途:** 返回 data 为 PointsAppeal 对象,包含完整申诉字段及流程进度信息。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/detail/{id}` - **请求:** `GET /gd_dataserver/business/points/appeal/detail/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getDetailUsingGET` - **operationId:** `getDetailUsingGET`
@ -367,7 +373,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/getAll` - **请求:** `GET /gd_dataserver/business/points/appeal/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_9` - **operationId:** `getAllUsingGET_9`
@ -388,7 +394,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/getListByPage` - **请求:** `GET /gd_dataserver/business/points/appeal/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_9` - **operationId:** `getListByPageUsingGET_9`
@ -403,6 +409,8 @@ _无_
| attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | query | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | query | 否 | string | 流程实例ID(预留) | - |
| flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | query | 否 | string | 处理意见/结果说明 | - | | handleRemark | query | 否 | string | 处理意见/结果说明 | - |
@ -434,7 +442,7 @@ _无_
### 处理申诉 ### 处理申诉
- **用途:** 通过或驳回申诉,可选调整积分。approved=true时状态改为已通过(2),approved=false时改为已驳回(3)。adjustPoints为正数补发积分,负数扣减积分,不传则不调整。返回 data 为 boolean。 - **用途:** 通过或驳回申诉,可选调整积分。approved=true时状态改为已通过(2),approved=false时改为已驳回(3)。adjustPoints为正数补发积分,负数扣减积分,不传则不调整。返回 data 为 boolean。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/handle/{id}` - **请求:** `POST /gd_dataserver/business/points/appeal/handle/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `handleAppealUsingPOST` - **operationId:** `handleAppealUsingPOST`
@ -461,7 +469,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/info` - **请求:** `GET /gd_dataserver/business/points/appeal/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_9` - **operationId:** `infoUsingGET_9`
@ -484,7 +492,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/list` - **请求:** `GET /gd_dataserver/business/points/appeal/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_9` - **operationId:** `getListUsingGET_9`
@ -499,6 +507,8 @@ _无_
| attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | query | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | query | 否 | string | 流程实例ID(预留) | - |
| flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | query | 否 | string | 处理意见/结果说明 | - | | handleRemark | query | 否 | string | 处理意见/结果说明 | - |
@ -528,7 +538,7 @@ _无_
### 查询我的申诉记录(APP端) ### 查询我的申诉记录(APP端)
- **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,主要字段:id、appealNo-申诉编号、appealType-申诉类型(REJECT/POINTS/OTHER)、status-状态(0待受理/1处理中/2已通过/3已驳回/4已撤回)、statusName-状态名称、handleRemark-处理意见、adjustPoints-调整积分、createTime。 - **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,主要字段:id、appealNo-申诉编号、appealType-申诉类型(REJECT/POINTS/OTHER)、status-状态(0待受理/1处理中/2已通过/3已驳回/4已撤回)、statusName-状态名称、handleRemark-处理意见、adjustPoints-调整积分、createTime。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/myList` - **请求:** `GET /gd_dataserver/business/points/appeal/myList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myListUsingGET_2` - **operationId:** `myListUsingGET_2`
@ -543,6 +553,8 @@ _无_
| attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | query | 否 | string | 附件URL(JSON数组) | - |
| canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - | | canApprove | query | 否 | boolean | 当前用户是否可审批此流程 | - |
| createTime | query | 否 | string / date-time | 创建时间 | - | | createTime | query | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | query | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | query | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | query | 否 | string | 流程实例ID(预留) | - |
| flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | query | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | query | 否 | string | 处理意见/结果说明 | - | | handleRemark | query | 否 | string | 处理意见/结果说明 | - |
@ -574,7 +586,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/removeById` - **请求:** `GET /gd_dataserver/business/points/appeal/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_18` - **operationId:** `deleteListUsingGET_18`
@ -597,7 +609,7 @@ _无_
### 提交申诉(APP端) ### 提交申诉(APP端)
- **用途:** 填写申诉类型、理由等信息,申诉人信息从登录用户获取。返回 data 为 PointsAppeal 对象,包含 id、appealNo-申诉编号、status-状态(0待受理)。 - **用途:** 填写申诉类型、理由等信息,申诉人信息从登录用户获取。返回 data 为 PointsAppeal 对象,包含 id、appealNo-申诉编号、status-状态(0待受理)。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/submit` - **请求:** `POST /gd_dataserver/business/points/appeal/submit`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `submitAppealUsingPOST` - **operationId:** `submitAppealUsingPOST`
@ -620,6 +632,8 @@ _无_
| attachmentUrls | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | 否 | string | 附件URL(JSON数组) | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | 否 | string | 流程实例ID(预留) | - |
| flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | 否 | string | 处理意见/结果说明 | - | | handleRemark | 否 | string | 处理意见/结果说明 | - |
@ -650,8 +664,8 @@ _无_
### 提交申诉并启动流程(APP端) ### 提交申诉并启动流程(APP端)
- **用途:** 提交申诉并自动启动 Flowable 审批流程。成功返回 data 为流程实例ID字符串;失败返回 error 信息。 - **用途:** 提交申诉并自动启动 Flowable 审批流程。后端自动解析申诉人所属厂区,按 (厂区, biz_type=appeal) 从 qc_hazard_flow_config 匹配流程Key并带厂区tenantId启动;若该厂区未配置申诉流程则回退到全局默认 appeal.flow.key。申诉人信息、factoryDeptId/factoryDeptName 均由后端自动填充,无需前端传。成功返回 data 为流程实例ID字符串;失败返回 error 信息。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/submitFlow` - **请求:** `POST /gd_dataserver/business/points/appeal/submitFlow`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `submitAppealFlowUsingPOST` - **operationId:** `submitAppealFlowUsingPOST`
@ -674,6 +688,8 @@ _无_
| attachmentUrls | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | 否 | string | 附件URL(JSON数组) | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | 否 | string | 流程实例ID(预留) | - |
| flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | 否 | string | 处理意见/结果说明 | - | | handleRemark | 否 | string | 处理意见/结果说明 | - |
@ -705,7 +721,7 @@ _无_
### 申诉流程待办列表 ### 申诉流程待办列表
- **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,包含 id、appealNo、userName、appealType-申诉类型、appealReason-申诉理由、status-状态、createTime。 - **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 PointsAppeal 对象,包含 id、appealNo、userName、appealType-申诉类型、appealReason-申诉理由、status-状态、createTime。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/appeal/todoList` - **请求:** `GET /gd_dataserver/business/points/appeal/todoList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `todoListUsingGET_2` - **operationId:** `todoListUsingGET_2`
@ -728,7 +744,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/updateById` - **请求:** `POST /gd_dataserver/business/points/appeal/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_9` - **operationId:** `updateByIdUsingPOST_9`
@ -751,6 +767,8 @@ _无_
| attachmentUrls | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | 否 | string | 附件URL(JSON数组) | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | 否 | string | 流程实例ID(预留) | - |
| flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | 否 | string | 处理意见/结果说明 | - | | handleRemark | 否 | string | 处理意见/结果说明 | - |
@ -782,7 +800,7 @@ _无_
### 撤回申诉(APP端) ### 撤回申诉(APP端)
- **用途:** 仅待受理状态(status=0)可撤回,撤回后状态改为已撤回(4)。返回 data 为 boolean。 - **用途:** 仅待受理状态(status=0)可撤回,撤回后状态改为已撤回(4)。返回 data 为 boolean。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/appeal/withdraw/{id}` - **请求:** `POST /gd_dataserver/business/points/appeal/withdraw/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `withdrawAppealUsingPOST` - **operationId:** `withdrawAppealUsingPOST`

63
docs/api/modules/08-exchange-order.md

@ -12,20 +12,20 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/exchange/order/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/exchange/order/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/exchange/order/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/exchange/order/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/exchange/order/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/exchange/order/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/exchange/order/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/exchange/order/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/exchange/order/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/exchange/order/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/exchange/order/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/exchange/order/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/exchange/order/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询我的兑换记录(APP端) | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 ExchangeOrder 对象,主要字段:id、orderNo-订单号、userId-用户ID、itemName-物品名称、itemPrice-单价积分、quantity-数量、totalPoints-总消耗积分、status-订单状态(0待处理/1处理中/2兑换成功/3兑换失败/4已退款/5已关闭)、createTime-创建时间、finishTime-完成时间。 | | 查询我的兑换记录(APP端) | GET | `/gd_dataserver/business/exchange/order/myList` | 返回 data 为 PageInfo 分页对象。list 中每条记录为 ExchangeOrder 对象,主要字段:id、orderNo-订单号、userId-用户ID、itemName-物品名称、itemPrice-单价积分、quantity-数量、totalPoints-总消耗积分、status-订单状态(0待处理/1处理中/2兑换成功/3兑换失败/4已退款/5已关闭)、createTime-创建时间、finishTime-完成时间。 |
| 退款(管理端操作) | POST | `/gd_dataserver/gd_dataserver/business/exchange/order/refund/{orderId}` | 将订单状态改为已退款(4),并退回积分到用户账户。返回 data 为 boolean。 | | 退款(管理端操作) | POST | `/gd_dataserver/business/exchange/order/refund/{orderId}` | 将订单状态改为已退款(4),并退回积分到用户账户。返回 data 为 boolean。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/order/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/exchange/order/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/exchange/order/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/exchange/order/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
## 接口详情 ## 接口详情
@ -35,7 +35,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/order/add` - **请求:** `POST /gd_dataserver/business/exchange/order/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_6` - **operationId:** `addOneUsingPOST_6`
@ -52,6 +52,7 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - | | finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - | | itemId | 否 | integer / int64 | 兑换物品ID | - |
@ -81,7 +82,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/order/addBatch` - **请求:** `POST /gd_dataserver/business/exchange/order/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_6` - **operationId:** `addBatchUsingPOST_6`
@ -109,7 +110,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/order/addReturn` - **请求:** `POST /gd_dataserver/business/exchange/order/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_6` - **operationId:** `addReturnUsingPOST_6`
@ -126,6 +127,7 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - | | finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - | | itemId | 否 | integer / int64 | 兑换物品ID | - |
@ -155,7 +157,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/delete` - **请求:** `GET /gd_dataserver/business/exchange/order/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_6` - **operationId:** `deleteUsingGET_6`
@ -164,6 +166,7 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - | | createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - | | finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - | | itemId | query | 否 | integer / int64 | 兑换物品ID | - |
@ -191,7 +194,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/deleteById` - **请求:** `GET /gd_dataserver/business/exchange/order/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_6` - **operationId:** `deleteOneUsingGET_6`
@ -214,7 +217,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/deleteByIds` - **请求:** `GET /gd_dataserver/business/exchange/order/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_13` - **operationId:** `deleteListUsingGET_13`
@ -237,7 +240,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/getAll` - **请求:** `GET /gd_dataserver/business/exchange/order/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_6` - **operationId:** `getAllUsingGET_6`
@ -258,7 +261,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/getListByPage` - **请求:** `GET /gd_dataserver/business/exchange/order/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_6` - **operationId:** `getListByPageUsingGET_6`
@ -267,6 +270,7 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - | | createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - | | finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - | | itemId | query | 否 | integer / int64 | 兑换物品ID | - |
@ -296,7 +300,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/info` - **请求:** `GET /gd_dataserver/business/exchange/order/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_6` - **operationId:** `infoUsingGET_6`
@ -319,7 +323,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/list` - **请求:** `GET /gd_dataserver/business/exchange/order/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_6` - **operationId:** `getListUsingGET_6`
@ -328,6 +332,7 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - | | createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - | | finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - | | itemId | query | 否 | integer / int64 | 兑换物品ID | - |
@ -355,7 +360,7 @@ _无_
### 查询我的兑换记录(APP端) ### 查询我的兑换记录(APP端)
- **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 ExchangeOrder 对象,主要字段:id、orderNo-订单号、userId-用户ID、itemName-物品名称、itemPrice-单价积分、quantity-数量、totalPoints-总消耗积分、status-订单状态(0待处理/1处理中/2兑换成功/3兑换失败/4已退款/5已关闭)、createTime-创建时间、finishTime-完成时间。 - **用途:** 返回 data 为 PageInfo 分页对象。list 中每条记录为 ExchangeOrder 对象,主要字段:id、orderNo-订单号、userId-用户ID、itemName-物品名称、itemPrice-单价积分、quantity-数量、totalPoints-总消耗积分、status-订单状态(0待处理/1处理中/2兑换成功/3兑换失败/4已退款/5已关闭)、createTime-创建时间、finishTime-完成时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/myList` - **请求:** `GET /gd_dataserver/business/exchange/order/myList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myListUsingGET` - **operationId:** `myListUsingGET`
@ -364,6 +369,7 @@ _无_
| 字段 | 位置 | 必填 | 类型 | 说明 | 示例 | | 字段 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- | --- |
| createTime | query | 否 | string / date-time | - | - | | createTime | query | 否 | string / date-time | - | - |
| factoryDeptId | query | 否 | string | 所属厂区部门ID | - |
| finishTime | query | 否 | string / date-time | 完成时间 | - | | finishTime | query | 否 | string / date-time | 完成时间 | - |
| id | query | 否 | integer / int64 | 主键ID | - | | id | query | 否 | integer / int64 | 主键ID | - |
| itemId | query | 否 | integer / int64 | 兑换物品ID | - | | itemId | query | 否 | integer / int64 | 兑换物品ID | - |
@ -393,7 +399,7 @@ _无_
### 退款(管理端操作) ### 退款(管理端操作)
- **用途:** 将订单状态改为已退款(4),并退回积分到用户账户。返回 data 为 boolean。 - **用途:** 将订单状态改为已退款(4),并退回积分到用户账户。返回 data 为 boolean。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/order/refund/{orderId}` - **请求:** `POST /gd_dataserver/business/exchange/order/refund/{orderId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `refundOrderUsingPOST` - **operationId:** `refundOrderUsingPOST`
@ -418,7 +424,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/order/removeById` - **请求:** `GET /gd_dataserver/business/exchange/order/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_12` - **operationId:** `deleteListUsingGET_12`
@ -441,7 +447,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/order/updateById` - **请求:** `POST /gd_dataserver/business/exchange/order/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_6` - **operationId:** `updateByIdUsingPOST_6`
@ -458,6 +464,7 @@ _无_
| 字段 | 必填 | 类型 | 说明 | 示例 | | 字段 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - | | finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - | | itemId | 否 | integer / int64 | 兑换物品ID | - |

56
docs/api/modules/09-exchange-item.md

@ -12,20 +12,20 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/exchange/item/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/exchange/item/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/exchange/item/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/exchange/item/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/exchange/item/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/exchange/item/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/exchange/item/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/exchange/item/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/exchange/item/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/exchange/item/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/exchange/item/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/exchange/item/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/exchange/item/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询上架物品列表 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/listOnShelf` | 前端展示用,返回 status=1 的物品,按 sortOrder 降序。返回 data 为 ExchangeItem 数组,每个元素包含:id、itemName-物品名称、itemPrice-所需积分、itemImage-物品图片URL、description-描述、stock-库存。 | | 查询上架物品列表 | GET | `/gd_dataserver/business/exchange/item/listOnShelf` | 前端展示用,返回 status=1 的物品,按 sortOrder 降序。返回 data 为 ExchangeItem 数组,每个元素包含:id、itemName-物品名称、itemPrice-所需积分、itemImage-物品图片URL、description-描述、stock-库存。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/exchange/item/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/exchange/item/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/exchange/item/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/exchange/item/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
| 上下架操作 | POST | `/gd_dataserver/gd_dataserver/business/exchange/item/updateStatus` | status=0 下架,status=1 上架。返回 data 为 boolean。 | | 上下架操作 | POST | `/gd_dataserver/business/exchange/item/updateStatus` | status=0 下架,status=1 上架。返回 data 为 boolean。 |
## 接口详情 ## 接口详情
@ -35,7 +35,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/item/add` - **请求:** `POST /gd_dataserver/business/exchange/item/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_4` - **operationId:** `addOneUsingPOST_4`
@ -80,7 +80,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/item/addBatch` - **请求:** `POST /gd_dataserver/business/exchange/item/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_4` - **operationId:** `addBatchUsingPOST_4`
@ -108,7 +108,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/item/addReturn` - **请求:** `POST /gd_dataserver/business/exchange/item/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_4` - **operationId:** `addReturnUsingPOST_4`
@ -153,7 +153,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/delete` - **请求:** `GET /gd_dataserver/business/exchange/item/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_4` - **operationId:** `deleteUsingGET_4`
@ -188,7 +188,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/deleteById` - **请求:** `GET /gd_dataserver/business/exchange/item/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_4` - **operationId:** `deleteOneUsingGET_4`
@ -211,7 +211,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/deleteByIds` - **请求:** `GET /gd_dataserver/business/exchange/item/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_9` - **operationId:** `deleteListUsingGET_9`
@ -234,7 +234,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/getAll` - **请求:** `GET /gd_dataserver/business/exchange/item/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_4` - **operationId:** `getAllUsingGET_4`
@ -255,7 +255,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/getListByPage` - **请求:** `GET /gd_dataserver/business/exchange/item/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_4` - **operationId:** `getListByPageUsingGET_4`
@ -292,7 +292,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/info` - **请求:** `GET /gd_dataserver/business/exchange/item/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_4` - **operationId:** `infoUsingGET_4`
@ -315,7 +315,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/list` - **请求:** `GET /gd_dataserver/business/exchange/item/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_4` - **operationId:** `getListUsingGET_4`
@ -350,7 +350,7 @@ _无_
### 查询上架物品列表 ### 查询上架物品列表
- **用途:** 前端展示用,返回 status=1 的物品,按 sortOrder 降序。返回 data 为 ExchangeItem 数组,每个元素包含:id、itemName-物品名称、itemPrice-所需积分、itemImage-物品图片URL、description-描述、stock-库存。 - **用途:** 前端展示用,返回 status=1 的物品,按 sortOrder 降序。返回 data 为 ExchangeItem 数组,每个元素包含:id、itemName-物品名称、itemPrice-所需积分、itemImage-物品图片URL、description-描述、stock-库存。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/listOnShelf` - **请求:** `GET /gd_dataserver/business/exchange/item/listOnShelf`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `listOnShelfUsingGET` - **operationId:** `listOnShelfUsingGET`
@ -371,7 +371,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/exchange/item/removeById` - **请求:** `GET /gd_dataserver/business/exchange/item/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_8` - **operationId:** `deleteListUsingGET_8`
@ -394,7 +394,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/item/updateById` - **请求:** `POST /gd_dataserver/business/exchange/item/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_4` - **operationId:** `updateByIdUsingPOST_4`
@ -439,7 +439,7 @@ _无_
### 上下架操作 ### 上下架操作
- **用途:** status=0 下架,status=1 上架。返回 data 为 boolean。 - **用途:** status=0 下架,status=1 上架。返回 data 为 boolean。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/exchange/item/updateStatus` - **请求:** `POST /gd_dataserver/business/exchange/item/updateStatus`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateStatusUsingPOST` - **operationId:** `updateStatusUsingPOST`

56
docs/api/modules/10-exchange-order-track.md

@ -12,20 +12,20 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/order/track/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/order/track/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/order/track/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/order/track/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/order/track/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/order/track/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/order/track/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/order/track/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/order/track/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/order/track/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/order/track/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/order/track/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/order/track/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询订单追踪记录(按订单ID) | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/list/{orderId}` | 返回 data 为 ExchangeOrderTrack 数组,每个元素包含:id、orderId-订单ID、orderNo-订单号、fromStatus-原状态、toStatus-新状态、trackType-追踪类型、remark-备注、operator-操作人、createTime-操作时间。 | | 查询订单追踪记录(按订单ID) | GET | `/gd_dataserver/business/points/order/track/list/{orderId}` | 返回 data 为 ExchangeOrderTrack 数组,每个元素包含:id、orderId-订单ID、orderNo-订单号、fromStatus-原状态、toStatus-新状态、trackType-追踪类型、remark-备注、operator-操作人、createTime-操作时间。 |
| 查询订单追踪记录(按订单号) | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/listByNo/{orderNo}` | 返回 data 为 ExchangeOrderTrack 数组,字段同上。 | | 查询订单追踪记录(按订单号) | GET | `/gd_dataserver/business/points/order/track/listByNo/{orderNo}` | 返回 data 为 ExchangeOrderTrack 数组,字段同上。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/order/track/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/order/track/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/order/track/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/order/track/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
## 接口详情 ## 接口详情
@ -35,7 +35,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/order/track/add` - **请求:** `POST /gd_dataserver/business/points/order/track/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_7` - **operationId:** `addOneUsingPOST_7`
@ -78,7 +78,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/order/track/addBatch` - **请求:** `POST /gd_dataserver/business/points/order/track/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_7` - **operationId:** `addBatchUsingPOST_7`
@ -106,7 +106,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/order/track/addReturn` - **请求:** `POST /gd_dataserver/business/points/order/track/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_7` - **operationId:** `addReturnUsingPOST_7`
@ -149,7 +149,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/delete` - **请求:** `GET /gd_dataserver/business/points/order/track/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_7` - **operationId:** `deleteUsingGET_7`
@ -182,7 +182,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/deleteById` - **请求:** `GET /gd_dataserver/business/points/order/track/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_7` - **operationId:** `deleteOneUsingGET_7`
@ -205,7 +205,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/order/track/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_15` - **operationId:** `deleteListUsingGET_15`
@ -228,7 +228,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/getAll` - **请求:** `GET /gd_dataserver/business/points/order/track/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_7` - **operationId:** `getAllUsingGET_7`
@ -249,7 +249,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/getListByPage` - **请求:** `GET /gd_dataserver/business/points/order/track/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_7` - **operationId:** `getListByPageUsingGET_7`
@ -284,7 +284,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/info` - **请求:** `GET /gd_dataserver/business/points/order/track/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_7` - **operationId:** `infoUsingGET_7`
@ -307,7 +307,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/list` - **请求:** `GET /gd_dataserver/business/points/order/track/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_7` - **operationId:** `getListUsingGET_7`
@ -340,7 +340,7 @@ _无_
### 查询订单追踪记录(按订单ID) ### 查询订单追踪记录(按订单ID)
- **用途:** 返回 data 为 ExchangeOrderTrack 数组,每个元素包含:id、orderId-订单ID、orderNo-订单号、fromStatus-原状态、toStatus-新状态、trackType-追踪类型、remark-备注、operator-操作人、createTime-操作时间。 - **用途:** 返回 data 为 ExchangeOrderTrack 数组,每个元素包含:id、orderId-订单ID、orderNo-订单号、fromStatus-原状态、toStatus-新状态、trackType-追踪类型、remark-备注、operator-操作人、createTime-操作时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/list/{orderId}` - **请求:** `GET /gd_dataserver/business/points/order/track/list/{orderId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getTracksByOrderIdUsingGET` - **operationId:** `getTracksByOrderIdUsingGET`
@ -363,7 +363,7 @@ _无_
### 查询订单追踪记录(按订单号) ### 查询订单追踪记录(按订单号)
- **用途:** 返回 data 为 ExchangeOrderTrack 数组,字段同上。 - **用途:** 返回 data 为 ExchangeOrderTrack 数组,字段同上。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/listByNo/{orderNo}` - **请求:** `GET /gd_dataserver/business/points/order/track/listByNo/{orderNo}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getTracksByOrderNoUsingGET` - **operationId:** `getTracksByOrderNoUsingGET`
@ -386,7 +386,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/order/track/removeById` - **请求:** `GET /gd_dataserver/business/points/order/track/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_14` - **operationId:** `deleteListUsingGET_14`
@ -409,7 +409,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/order/track/updateById` - **请求:** `POST /gd_dataserver/business/points/order/track/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_7` - **operationId:** `updateByIdUsingPOST_7`

64
docs/api/modules/11-exchange-config.md

@ -12,22 +12,22 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 获取当前启用的兑换配置 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/active` | 无请求参数。返回 data 为 ExchangeConfig 对象(数据库无记录时返回默认配置)。字段:pointsRatio-积分比例(N积分=1元)、singleMaxPoints-单笔最大积分、singleMinPoints-单笔最小积分、dailyLimitPerUser-每人每日兑换上限、monthlyLimitPerUser-每月上限、yearlyLimitPerUser-每年上限、dailyOrderCountLimit-每日兑换次数上限、rapidExchangeThreshold-短时间兑换次数阈值、rapidExchangeWindowMinutes-快速兑换检测窗口(分钟)、largeAmountThreshold-大额预警阈值、largeAmountNeedApproval-大额是否需审批(1是/0否)、antiFarmEnabled-隐患上报防刷检测开关(1启用/0禁用)。当安全开关关闭(enabled=0)时返回 null。 | | 获取当前启用的兑换配置 | GET | `/gd_dataserver/business/points/exchange/config/active` | 无请求参数。返回 data 为 ExchangeConfig 对象(数据库无记录时返回默认配置)。字段:pointsRatio-积分比例(N积分=1元)、singleMaxPoints-单笔最大积分、singleMinPoints-单笔最小积分、dailyLimitPerUser-每人每日兑换上限、monthlyLimitPerUser-每月上限、yearlyLimitPerUser-每年上限、dailyOrderCountLimit-每日兑换次数上限、rapidExchangeThreshold-短时间兑换次数阈值、rapidExchangeWindowMinutes-快速兑换检测窗口(分钟)、largeAmountThreshold-大额预警阈值、largeAmountNeedApproval-大额是否需审批(1是/0否)、antiFarmEnabled-隐患上报防刷检测开关(1启用/0禁用)。当安全开关关闭(enabled=0)时返回 null。 |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/exchange/config/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/exchange/config/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/exchange/config/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/exchange/config/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/exchange/config/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/exchange/config/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/exchange/config/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/exchange/config/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/exchange/config/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/exchange/config/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/exchange/config/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/exchange/config/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/exchange/config/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/exchange/config/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 查询兑换安全开关状态 | GET | `/gd_dataserver/gd_dataserver/business/points/exchange/config/switch/status` | 无请求参数。返回 data 为 boolean,true-启用安全校验,false-已关闭。判断逻辑:数据库无配置记录时默认启用;有记录时根据 enabled 字段(1启用/0禁用)决定。 | | 查询兑换安全开关状态 | GET | `/gd_dataserver/business/points/exchange/config/switch/status` | 无请求参数。返回 data 为 boolean,true-启用安全校验,false-已关闭。判断逻辑:数据库无配置记录时默认启用;有记录时根据 enabled 字段(1启用/0禁用)决定。 |
| 切换兑换安全开关(管理端) | POST | `/gd_dataserver/gd_dataserver/business/points/exchange/config/switch/toggle` | 请求参数:enabled-true启用/false禁用(Boolean,必填)。返回 data 为 boolean,true-切换成功,false-切换失败。若数据库无配置记录且传入true,会自动创建默认配置。 | | 切换兑换安全开关(管理端) | POST | `/gd_dataserver/business/points/exchange/config/switch/toggle` | 请求参数:enabled-true启用/false禁用(Boolean,必填)。返回 data 为 boolean,true-切换成功,false-切换失败。若数据库无配置记录且传入true,会自动创建默认配置。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/exchange/config/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/exchange/config/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
| 校验兑换请求(APP端) | POST | `/gd_dataserver/gd_dataserver/business/points/exchange/config/validate` | 在下单前调用,校验是否满足安全规则。请求参数:totalPoints-兑换总积分(int,必填)。返回 data 为对象,包含:passed-是否通过(boolean)、errors-错误信息数组(如'单笔兑换不能超过5000积分')、warnings-警告信息数组、securityEnabled-安全开关是否启用(boolean)、config-当前启用的兑换配置对象(开关关闭时为null)。前端根据 passed 判断能否兑换,errors 为空表示校验通过。当安全开关关闭时,passed=true、securityEnabled=false。 | | 校验兑换请求(APP端) | POST | `/gd_dataserver/business/points/exchange/config/validate` | 在下单前调用,校验是否满足安全规则。请求参数:totalPoints-兑换总积分(int,必填)。返回 data 为对象,包含:passed-是否通过(boolean)、errors-错误信息数组(如'单笔兑换不能超过5000积分')、warnings-警告信息数组、securityEnabled-安全开关是否启用(boolean)、config-当前启用的兑换配置对象(开关关闭时为null)。前端根据 passed 判断能否兑换,errors 为空表示校验通过。当安全开关关闭时,passed=true、securityEnabled=false。 |
## 接口详情 ## 接口详情
@ -37,7 +37,7 @@
### 获取当前启用的兑换配置 ### 获取当前启用的兑换配置
- **用途:** 无请求参数。返回 data 为 ExchangeConfig 对象(数据库无记录时返回默认配置)。字段:pointsRatio-积分比例(N积分=1元)、singleMaxPoints-单笔最大积分、singleMinPoints-单笔最小积分、dailyLimitPerUser-每人每日兑换上限、monthlyLimitPerUser-每月上限、yearlyLimitPerUser-每年上限、dailyOrderCountLimit-每日兑换次数上限、rapidExchangeThreshold-短时间兑换次数阈值、rapidExchangeWindowMinutes-快速兑换检测窗口(分钟)、largeAmountThreshold-大额预警阈值、largeAmountNeedApproval-大额是否需审批(1是/0否)、antiFarmEnabled-隐患上报防刷检测开关(1启用/0禁用)。当安全开关关闭(enabled=0)时返回 null。 - **用途:** 无请求参数。返回 data 为 ExchangeConfig 对象(数据库无记录时返回默认配置)。字段:pointsRatio-积分比例(N积分=1元)、singleMaxPoints-单笔最大积分、singleMinPoints-单笔最小积分、dailyLimitPerUser-每人每日兑换上限、monthlyLimitPerUser-每月上限、yearlyLimitPerUser-每年上限、dailyOrderCountLimit-每日兑换次数上限、rapidExchangeThreshold-短时间兑换次数阈值、rapidExchangeWindowMinutes-快速兑换检测窗口(分钟)、largeAmountThreshold-大额预警阈值、largeAmountNeedApproval-大额是否需审批(1是/0否)、antiFarmEnabled-隐患上报防刷检测开关(1启用/0禁用)。当安全开关关闭(enabled=0)时返回 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/active` - **请求:** `GET /gd_dataserver/business/points/exchange/config/active`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getActiveConfigUsingGET_1` - **operationId:** `getActiveConfigUsingGET_1`
@ -58,7 +58,7 @@ _无_
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/exchange/config/add` - **请求:** `POST /gd_dataserver/business/points/exchange/config/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_3` - **operationId:** `addOneUsingPOST_3`
@ -108,7 +108,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/exchange/config/addBatch` - **请求:** `POST /gd_dataserver/business/points/exchange/config/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_3` - **operationId:** `addBatchUsingPOST_3`
@ -136,7 +136,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/exchange/config/addReturn` - **请求:** `POST /gd_dataserver/business/points/exchange/config/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_3` - **operationId:** `addReturnUsingPOST_3`
@ -186,7 +186,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/delete` - **请求:** `GET /gd_dataserver/business/points/exchange/config/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_3` - **operationId:** `deleteUsingGET_3`
@ -226,7 +226,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/deleteById` - **请求:** `GET /gd_dataserver/business/points/exchange/config/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_3` - **operationId:** `deleteOneUsingGET_3`
@ -249,7 +249,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/exchange/config/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_7` - **operationId:** `deleteListUsingGET_7`
@ -272,7 +272,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/getAll` - **请求:** `GET /gd_dataserver/business/points/exchange/config/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_3` - **operationId:** `getAllUsingGET_3`
@ -293,7 +293,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/getListByPage` - **请求:** `GET /gd_dataserver/business/points/exchange/config/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_3` - **operationId:** `getListByPageUsingGET_3`
@ -335,7 +335,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/info` - **请求:** `GET /gd_dataserver/business/points/exchange/config/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_3` - **operationId:** `infoUsingGET_3`
@ -358,7 +358,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/list` - **请求:** `GET /gd_dataserver/business/points/exchange/config/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_3` - **operationId:** `getListUsingGET_3`
@ -398,7 +398,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/removeById` - **请求:** `GET /gd_dataserver/business/points/exchange/config/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_6` - **operationId:** `deleteListUsingGET_6`
@ -421,7 +421,7 @@ _无_
### 查询兑换安全开关状态 ### 查询兑换安全开关状态
- **用途:** 无请求参数。返回 data 为 boolean,true-启用安全校验,false-已关闭。判断逻辑:数据库无配置记录时默认启用;有记录时根据 enabled 字段(1启用/0禁用)决定。 - **用途:** 无请求参数。返回 data 为 boolean,true-启用安全校验,false-已关闭。判断逻辑:数据库无配置记录时默认启用;有记录时根据 enabled 字段(1启用/0禁用)决定。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/exchange/config/switch/status` - **请求:** `GET /gd_dataserver/business/points/exchange/config/switch/status`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getSwitchStatusUsingGET` - **operationId:** `getSwitchStatusUsingGET`
@ -442,7 +442,7 @@ _无_
### 切换兑换安全开关(管理端) ### 切换兑换安全开关(管理端)
- **用途:** 请求参数:enabled-true启用/false禁用(Boolean,必填)。返回 data 为 boolean,true-切换成功,false-切换失败。若数据库无配置记录且传入true,会自动创建默认配置。 - **用途:** 请求参数:enabled-true启用/false禁用(Boolean,必填)。返回 data 为 boolean,true-切换成功,false-切换失败。若数据库无配置记录且传入true,会自动创建默认配置。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/exchange/config/switch/toggle` - **请求:** `POST /gd_dataserver/business/points/exchange/config/switch/toggle`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `toggleSwitchUsingPOST` - **operationId:** `toggleSwitchUsingPOST`
@ -466,7 +466,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/exchange/config/updateById` - **请求:** `POST /gd_dataserver/business/points/exchange/config/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_3` - **operationId:** `updateByIdUsingPOST_3`
@ -516,7 +516,7 @@ _无_
### 校验兑换请求(APP端) ### 校验兑换请求(APP端)
- **用途:** 在下单前调用,校验是否满足安全规则。请求参数:totalPoints-兑换总积分(int,必填)。返回 data 为对象,包含:passed-是否通过(boolean)、errors-错误信息数组(如'单笔兑换不能超过5000积分')、warnings-警告信息数组、securityEnabled-安全开关是否启用(boolean)、config-当前启用的兑换配置对象(开关关闭时为null)。前端根据 passed 判断能否兑换,errors 为空表示校验通过。当安全开关关闭时,passed=true、securityEnabled=false。 - **用途:** 在下单前调用,校验是否满足安全规则。请求参数:totalPoints-兑换总积分(int,必填)。返回 data 为对象,包含:passed-是否通过(boolean)、errors-错误信息数组(如'单笔兑换不能超过5000积分')、warnings-警告信息数组、securityEnabled-安全开关是否启用(boolean)、config-当前启用的兑换配置对象(开关关闭时为null)。前端根据 passed 判断能否兑换,errors 为空表示校验通过。当安全开关关闭时,passed=true、securityEnabled=false。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/exchange/config/validate` - **请求:** `POST /gd_dataserver/business/points/exchange/config/validate`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `validateExchangeUsingPOST` - **operationId:** `validateExchangeUsingPOST`

56
docs/api/modules/12-exchange-operation-log.md

@ -12,20 +12,20 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/operation/log/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/operation/log/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/operation/log/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/operation/log/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/operation/log/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/operation/log/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/operation/log/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/operation/log/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/operation/log/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/operation/log/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/operation/log/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/operation/log/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/operation/log/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 查询订单操作日志 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/order/{orderId}` | 返回 data 为 ExchangeOperationLog 数组,字段同上。 | | 查询订单操作日志 | GET | `/gd_dataserver/business/points/operation/log/order/{orderId}` | 返回 data 为 ExchangeOperationLog 数组,字段同上。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/operation/log/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/operation/log/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/operation/log/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
| 查询用户操作日志 | GET | `/gd_dataserver/gd_dataserver/business/points/operation/log/user/{userId}` | 返回 data 为 ExchangeOperationLog 数组,每个元素包含:id、userId-用户ID、orderId-订单ID、orderNo-订单号、operationType-操作类型、operationDetail-操作详情、result-结果、createTime。 | | 查询用户操作日志 | GET | `/gd_dataserver/business/points/operation/log/user/{userId}` | 返回 data 为 ExchangeOperationLog 数组,每个元素包含:id、userId-用户ID、orderId-订单ID、orderNo-订单号、operationType-操作类型、operationDetail-操作详情、result-结果、createTime。 |
## 接口详情 ## 接口详情
@ -35,7 +35,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/operation/log/add` - **请求:** `POST /gd_dataserver/business/points/operation/log/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_5` - **operationId:** `addOneUsingPOST_5`
@ -81,7 +81,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/operation/log/addBatch` - **请求:** `POST /gd_dataserver/business/points/operation/log/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_5` - **operationId:** `addBatchUsingPOST_5`
@ -109,7 +109,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/operation/log/addReturn` - **请求:** `POST /gd_dataserver/business/points/operation/log/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_5` - **operationId:** `addReturnUsingPOST_5`
@ -155,7 +155,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/delete` - **请求:** `GET /gd_dataserver/business/points/operation/log/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_5` - **operationId:** `deleteUsingGET_5`
@ -191,7 +191,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/deleteById` - **请求:** `GET /gd_dataserver/business/points/operation/log/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_5` - **operationId:** `deleteOneUsingGET_5`
@ -214,7 +214,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/operation/log/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_11` - **operationId:** `deleteListUsingGET_11`
@ -237,7 +237,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/getAll` - **请求:** `GET /gd_dataserver/business/points/operation/log/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_5` - **operationId:** `getAllUsingGET_5`
@ -258,7 +258,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/getListByPage` - **请求:** `GET /gd_dataserver/business/points/operation/log/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_5` - **operationId:** `getListByPageUsingGET_5`
@ -296,7 +296,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/info` - **请求:** `GET /gd_dataserver/business/points/operation/log/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_5` - **operationId:** `infoUsingGET_5`
@ -319,7 +319,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/list` - **请求:** `GET /gd_dataserver/business/points/operation/log/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_5` - **operationId:** `getListUsingGET_5`
@ -355,7 +355,7 @@ _无_
### 查询订单操作日志 ### 查询订单操作日志
- **用途:** 返回 data 为 ExchangeOperationLog 数组,字段同上。 - **用途:** 返回 data 为 ExchangeOperationLog 数组,字段同上。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/order/{orderId}` - **请求:** `GET /gd_dataserver/business/points/operation/log/order/{orderId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getLogsByOrderIdUsingGET` - **operationId:** `getLogsByOrderIdUsingGET`
@ -378,7 +378,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/removeById` - **请求:** `GET /gd_dataserver/business/points/operation/log/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_10` - **operationId:** `deleteListUsingGET_10`
@ -401,7 +401,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/operation/log/updateById` - **请求:** `POST /gd_dataserver/business/points/operation/log/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_5` - **operationId:** `updateByIdUsingPOST_5`
@ -447,7 +447,7 @@ _无_
### 查询用户操作日志 ### 查询用户操作日志
- **用途:** 返回 data 为 ExchangeOperationLog 数组,每个元素包含:id、userId-用户ID、orderId-订单ID、orderNo-订单号、operationType-操作类型、operationDetail-操作详情、result-结果、createTime。 - **用途:** 返回 data 为 ExchangeOperationLog 数组,每个元素包含:id、userId-用户ID、orderId-订单ID、orderNo-订单号、operationType-操作类型、operationDetail-操作详情、result-结果、createTime。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/operation/log/user/{userId}` - **请求:** `GET /gd_dataserver/business/points/operation/log/user/{userId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getLogsByUserIdUsingGET` - **operationId:** `getLogsByUserIdUsingGET`

72
docs/api/modules/13-anti-farm-config.md

@ -12,24 +12,24 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 获取启用的防刷配置 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/active` | 返回 data 为 AntiFarmConfig 对象,包含当前生效的防刷规则配置。 | | 获取启用的防刷配置 | GET | `/gd_dataserver/business/points/anti/farm/active` | 返回 data 为 AntiFarmConfig 对象,包含当前生效的防刷规则配置。 |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/points/anti/farm/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/points/anti/farm/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/points/anti/farm/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/points/anti/farm/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/points/anti/farm/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/points/anti/farm/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/points/anti/farm/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/points/anti/farm/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/points/anti/farm/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 异常行为一键检测 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/detectAll` | 对指定用户执行全维度异常行为检测,聚合4类防刷校验(上报/积分获取/兑换)。返回 data 为对象,包含:userId-被检测用户ID、reportCheck-上报检测结果{passed-是否通过,reason-原因}、pointsEarnCheck-积分获取检测结果{passed,reason}、exchangeCheck-兑换检测结果{passed,reason}、overallPassed-综合是否通过(boolean)。 | | 异常行为一键检测 | GET | `/gd_dataserver/business/points/anti/farm/detectAll` | 对指定用户执行全维度异常行为检测,聚合4类防刷校验(上报/积分获取/兑换)。返回 data 为对象,包含:userId-被检测用户ID、reportCheck-上报检测结果{passed-是否通过,reason-原因}、pointsEarnCheck-积分获取检测结果{passed,reason}、exchangeCheck-兑换检测结果{passed,reason}、overallPassed-综合是否通过(boolean)。 |
| 检测自报自审行为 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/detectSelfAudit` | 检测上报人和审核人是否为同一人。返回 data 为字符串,检测到异常时返回'检测到自报自审行为',正常时返回'未检测到异常'。 | | 检测自报自审行为 | GET | `/gd_dataserver/business/points/anti/farm/detectSelfAudit` | 检测上报人和审核人是否为同一人。返回 data 为字符串,检测到异常时返回'检测到自报自审行为',正常时返回'未检测到异常'。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/points/anti/farm/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/points/anti/farm/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/points/anti/farm/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/points/anti/farm/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/points/anti/farm/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/points/anti/farm/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/points/anti/farm/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
| 校验兑换是否触发防刷 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/validateExchange` | 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。 | | 校验兑换是否触发防刷 | GET | `/gd_dataserver/business/points/anti/farm/validateExchange` | 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。 |
| 校验积分获取是否触发防刷 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/validatePointsEarn` | 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。 | | 校验积分获取是否触发防刷 | GET | `/gd_dataserver/business/points/anti/farm/validatePointsEarn` | 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。 |
| 校验上报是否触发防刷 | GET | `/gd_dataserver/gd_dataserver/business/points/anti/farm/validateReport` | 返回 data 为对象,包含:triggered-是否触发(boolean)、reason-触发原因。前端在上报前调用,若 triggered=true 则提示用户。 | | 校验上报是否触发防刷 | GET | `/gd_dataserver/business/points/anti/farm/validateReport` | 返回 data 为对象,包含:triggered-是否触发(boolean)、reason-触发原因。前端在上报前调用,若 triggered=true 则提示用户。 |
## 接口详情 ## 接口详情
@ -39,7 +39,7 @@
### 获取启用的防刷配置 ### 获取启用的防刷配置
- **用途:** 返回 data 为 AntiFarmConfig 对象,包含当前生效的防刷规则配置。 - **用途:** 返回 data 为 AntiFarmConfig 对象,包含当前生效的防刷规则配置。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/active` - **请求:** `GET /gd_dataserver/business/points/anti/farm/active`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getActiveConfigUsingGET` - **operationId:** `getActiveConfigUsingGET`
@ -60,7 +60,7 @@ _无_
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/anti/farm/add` - **请求:** `POST /gd_dataserver/business/points/anti/farm/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_1` - **operationId:** `addOneUsingPOST_1`
@ -106,7 +106,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/anti/farm/addBatch` - **请求:** `POST /gd_dataserver/business/points/anti/farm/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_1` - **operationId:** `addBatchUsingPOST_1`
@ -134,7 +134,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/anti/farm/addReturn` - **请求:** `POST /gd_dataserver/business/points/anti/farm/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_1` - **operationId:** `addReturnUsingPOST_1`
@ -180,7 +180,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/delete` - **请求:** `GET /gd_dataserver/business/points/anti/farm/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_1` - **operationId:** `deleteUsingGET_1`
@ -216,7 +216,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/deleteById` - **请求:** `GET /gd_dataserver/business/points/anti/farm/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_1` - **operationId:** `deleteOneUsingGET_1`
@ -239,7 +239,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/deleteByIds` - **请求:** `GET /gd_dataserver/business/points/anti/farm/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_3` - **operationId:** `deleteListUsingGET_3`
@ -262,7 +262,7 @@ _无_
### 异常行为一键检测 ### 异常行为一键检测
- **用途:** 对指定用户执行全维度异常行为检测,聚合4类防刷校验(上报/积分获取/兑换)。返回 data 为对象,包含:userId-被检测用户ID、reportCheck-上报检测结果{passed-是否通过,reason-原因}、pointsEarnCheck-积分获取检测结果{passed,reason}、exchangeCheck-兑换检测结果{passed,reason}、overallPassed-综合是否通过(boolean)。 - **用途:** 对指定用户执行全维度异常行为检测,聚合4类防刷校验(上报/积分获取/兑换)。返回 data 为对象,包含:userId-被检测用户ID、reportCheck-上报检测结果{passed-是否通过,reason-原因}、pointsEarnCheck-积分获取检测结果{passed,reason}、exchangeCheck-兑换检测结果{passed,reason}、overallPassed-综合是否通过(boolean)。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/detectAll` - **请求:** `GET /gd_dataserver/business/points/anti/farm/detectAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `detectAllUsingGET` - **operationId:** `detectAllUsingGET`
@ -285,7 +285,7 @@ _无_
### 检测自报自审行为 ### 检测自报自审行为
- **用途:** 检测上报人和审核人是否为同一人。返回 data 为字符串,检测到异常时返回'检测到自报自审行为',正常时返回'未检测到异常'。 - **用途:** 检测上报人和审核人是否为同一人。返回 data 为字符串,检测到异常时返回'检测到自报自审行为',正常时返回'未检测到异常'。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/detectSelfAudit` - **请求:** `GET /gd_dataserver/business/points/anti/farm/detectSelfAudit`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `detectSelfAuditUsingGET` - **operationId:** `detectSelfAuditUsingGET`
@ -309,7 +309,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/getAll` - **请求:** `GET /gd_dataserver/business/points/anti/farm/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_1` - **operationId:** `getAllUsingGET_1`
@ -330,7 +330,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/getListByPage` - **请求:** `GET /gd_dataserver/business/points/anti/farm/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_1` - **operationId:** `getListByPageUsingGET_1`
@ -368,7 +368,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/info` - **请求:** `GET /gd_dataserver/business/points/anti/farm/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_1` - **operationId:** `infoUsingGET_1`
@ -391,7 +391,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/list` - **请求:** `GET /gd_dataserver/business/points/anti/farm/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_1` - **operationId:** `getListUsingGET_1`
@ -427,7 +427,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/removeById` - **请求:** `GET /gd_dataserver/business/points/anti/farm/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_2` - **operationId:** `deleteListUsingGET_2`
@ -450,7 +450,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/points/anti/farm/updateById` - **请求:** `POST /gd_dataserver/business/points/anti/farm/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_1` - **operationId:** `updateByIdUsingPOST_1`
@ -496,7 +496,7 @@ _无_
### 校验兑换是否触发防刷 ### 校验兑换是否触发防刷
- **用途:** 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。 - **用途:** 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/validateExchange` - **请求:** `GET /gd_dataserver/business/points/anti/farm/validateExchange`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `validateExchangeUsingGET` - **operationId:** `validateExchangeUsingGET`
@ -521,7 +521,7 @@ _无_
### 校验积分获取是否触发防刷 ### 校验积分获取是否触发防刷
- **用途:** 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。 - **用途:** 返回 data 为对象,包含:triggered-是否触发、reason-触发原因。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/validatePointsEarn` - **请求:** `GET /gd_dataserver/business/points/anti/farm/validatePointsEarn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `validatePointsEarnUsingGET` - **operationId:** `validatePointsEarnUsingGET`
@ -544,7 +544,7 @@ _无_
### 校验上报是否触发防刷 ### 校验上报是否触发防刷
- **用途:** 返回 data 为对象,包含:triggered-是否触发(boolean)、reason-触发原因。前端在上报前调用,若 triggered=true 则提示用户。 - **用途:** 返回 data 为对象,包含:triggered-是否触发(boolean)、reason-触发原因。前端在上报前调用,若 triggered=true 则提示用户。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/anti/farm/validateReport` - **请求:** `GET /gd_dataserver/business/points/anti/farm/validateReport`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `validateReportUsingGET` - **operationId:** `validateReportUsingGET`

16
docs/api/modules/14-mall-integration.md

@ -12,10 +12,10 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 扣减积分 | POST | `/gd_dataserver/gd_dataserver/mall/api/points/deduct` | 商城端在用户下单成功后调用此接口扣减积分,具有幂等性,同一orderNum多次调用只扣减一次 | | 扣减积分 | POST | `/gd_dataserver/mall/api/points/deduct` | 商城端在用户下单成功后调用此接口扣减积分,具有幂等性,同一orderNum多次调用只扣减一次 |
| 退还积分 | POST | `/gd_dataserver/gd_dataserver/mall/api/points/refund` | 商城端在用户退款时调用此接口退还积分,具有幂等性,同一orderNum多次调用只退还一次 | | 退还积分 | POST | `/gd_dataserver/mall/api/points/refund` | 商城端在用户退款时调用此接口退还积分,具有幂等性,同一orderNum多次调用只退还一次 |
| 根据Token获取用户信息 | POST | `/gd_dataserver/gd_dataserver/mall/api/user/info` | 商城端通过请求头中的Token获取用户基本信息,包括姓名、手机号、SAP编号等 | | 根据Token获取用户信息 | POST | `/gd_dataserver/mall/api/user/info` | 商城端通过请求头中的Token获取用户基本信息,包括姓名、手机号、SAP编号等 |
| 根据Token获取用户积分信息 | POST | `/gd_dataserver/gd_dataserver/mall/api/user/points` | 商城端通过请求头中的Token及Body中的sap获取用户积分余额,包括可用积分、冻结积分等 | | 根据Token获取用户积分信息 | POST | `/gd_dataserver/mall/api/user/points` | 商城端通过请求头中的Token及Body中的sap获取用户积分余额,包括可用积分、冻结积分等 |
## 接口详情 ## 接口详情
@ -25,7 +25,7 @@
### 扣减积分 ### 扣减积分
- **用途:** 商城端在用户下单成功后调用此接口扣减积分,具有幂等性,同一orderNum多次调用只扣减一次 - **用途:** 商城端在用户下单成功后调用此接口扣减积分,具有幂等性,同一orderNum多次调用只扣减一次
- **请求:** `POST /gd_dataserver/gd_dataserver/mall/api/points/deduct` - **请求:** `POST /gd_dataserver/mall/api/points/deduct`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deductPointsUsingPOST` - **operationId:** `deductPointsUsingPOST`
@ -62,7 +62,7 @@
### 退还积分 ### 退还积分
- **用途:** 商城端在用户退款时调用此接口退还积分,具有幂等性,同一orderNum多次调用只退还一次 - **用途:** 商城端在用户退款时调用此接口退还积分,具有幂等性,同一orderNum多次调用只退还一次
- **请求:** `POST /gd_dataserver/gd_dataserver/mall/api/points/refund` - **请求:** `POST /gd_dataserver/mall/api/points/refund`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `refundPointsUsingPOST` - **operationId:** `refundPointsUsingPOST`
@ -99,7 +99,7 @@
### 根据Token获取用户信息 ### 根据Token获取用户信息
- **用途:** 商城端通过请求头中的Token获取用户基本信息,包括姓名、手机号、SAP编号等 - **用途:** 商城端通过请求头中的Token获取用户基本信息,包括姓名、手机号、SAP编号等
- **请求:** `POST /gd_dataserver/gd_dataserver/mall/api/user/info` - **请求:** `POST /gd_dataserver/mall/api/user/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getUserInfoUsingPOST` - **operationId:** `getUserInfoUsingPOST`
@ -123,7 +123,7 @@
### 根据Token获取用户积分信息 ### 根据Token获取用户积分信息
- **用途:** 商城端通过请求头中的Token及Body中的sap获取用户积分余额,包括可用积分、冻结积分等 - **用途:** 商城端通过请求头中的Token及Body中的sap获取用户积分余额,包括可用积分、冻结积分等
- **请求:** `POST /gd_dataserver/gd_dataserver/mall/api/user/points` - **请求:** `POST /gd_dataserver/mall/api/user/points`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getUserPointsUsingPOST` - **operationId:** `getUserPointsUsingPOST`

136
docs/api/modules/15-data-analysis.md

@ -2,7 +2,7 @@
本模块共 17 个接口。源文件:`api.json`。 本模块共 20 个接口。源文件:`api.json`。
@ -12,23 +12,26 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 首页数据看板 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/dashboard` | 返回 data 为对象,包含:totalHazard-隐患总数、monthHazard-本月新增隐患、pendingHazard-待处理隐患、totalPoints-积分总量、monthPoints-本月发放积分、onTimeRate-准时率(%)、todayExchangeCount-今日兑换单数、todayPointsIssued-今日发放积分数。 | | 首页数据看板 | GET | `/gd_dataserver/business/points/analysis/dashboard` | 返回 data 为对象,包含:totalHazard-隐患总数、monthHazard-本月新增隐患、pendingHazard-待处理隐患、totalPoints-积分总量、monthPoints-本月发放积分、onTimeRate-准时率(%)、todayExchangeCount-今日兑换单数、todayPointsIssued-今日发放积分数。 |
| 隐患热力图-按部门统计 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/heatmap/department` | 返回 data 为数组,每个元素包含:departmentId-部门ID、departmentName-部门名称、hazardCount-隐患数量。 | | 隐患热力图-按部门统计 | GET | `/gd_dataserver/business/points/analysis/heatmap/department` | 返回 data 为数组,每个元素包含:departmentId-部门ID、departmentName-部门名称、hazardCount-隐患数量。 |
| 隐患热力图-按单位统计 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/heatmap/unit` | 返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、hazardCount-隐患数量。 | | 隐患热力图-按单位统计 | GET | `/gd_dataserver/business/points/analysis/heatmap/unit` | 返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、hazardCount-隐患数量。 |
| 兑换排行统计(按单位) | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/ranking/exchange` | 按单位统计兑换数据,仅统计兑换成功(status=2)的订单。返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、orderCount-兑换单数、totalPoints-消耗积分总量、userCount-兑换人数。 | | 首页-核心指标概览 | GET | `/gd_dataserver/business/points/analysis/home/overview` | 按账户权限统计(管理员全部、其它账户仅本厂区)。返回 data 为对象,包含:pendingAuditCount-待审核数、monthClosedCount-本月已闭环数、todayReportCount-今日新增上报数、todayExchangeCount-今日兑换单数、todayPointsIssued-今日发放积分数。 |
| 积分排行榜-本月获取 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/ranking/monthlyPoints` | 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、monthIncome-本月获取积分、rank-排名。 | | 首页-待办与预警 | GET | `/gd_dataserver/business/points/analysis/home/todo-warning` | 按账户权限统计(管理员全部、其它账户仅本厂区)。返回 data 为对象,包含:pendingAuditOver24hCount-待审核超24h条数、riskWarningCount-风控预警(集中兑换)条数、pendingAppealCount-申诉待处理条数。 |
| 我的积分排名(APP端) | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/ranking/myRank` | 查询当前登录用户的积分排名,返回userId、totalIncome、rank | | 首页-近7日趋势与最新上报 | GET | `/gd_dataserver/business/points/analysis/home/trend-latest` | 按账户权限统计(管理员全部、其它账户仅本厂区)。返回 data 为对象,trend7d-近7日每日上报数组(元素含date、count),latestReports-最新上报前5条(含id、reportNo、hazardName、hazardLevelName、status、statusName、reporterName、factoryDeptName、createTime)。 |
| 积分排行榜-总入账 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/ranking/points` | 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、totalIncome-总入账积分、rank-排名。按 totalIncome 降序排列。 | | 兑换排行统计(按单位) | GET | `/gd_dataserver/business/points/analysis/ranking/exchange` | 按单位统计兑换数据,仅统计兑换成功(status=2)的订单。返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、orderCount-兑换单数、totalPoints-消耗积分总量、userCount-兑换人数。 |
| 上报积分排行 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/ranking/report` | 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、reportCount-上报次数、rank-排名。按上报次数降序。 | | 积分排行榜-本月获取 | GET | `/gd_dataserver/business/points/analysis/ranking/monthlyPoints` | 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、monthIncome-本月获取积分、rank-排名。 |
| 月度安全运营报告(JSON) | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/report/monthly` | 查询指定月份的运营数据,支持查询全年或单月。month=0 表示查询全年各月数据,month=1~12 表示查询指定月份。返回 data 为 MonthlyReportVO 数组,每个元素包含:month-月份、hazardCount-隐患总数、approvedCount-已通过数、rejectedCount-已驳回数、pointsIssued-发放积分、avgProcessHours-平均处理时长(小时)、onTimeRate-准时率(%)、exchangeOrderCount-兑换单数、exchangePoints-兑换消耗积分。 | | 我的积分排名(APP端) | GET | `/gd_dataserver/business/points/analysis/ranking/myRank` | 查询当前登录用户的积分排名,返回userId、totalIncome、rank |
| 月度安全运营报告导出(Excel) | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/report/monthly/export` | 导出指定月份的运营数据为 Excel 文件。month=0 表示导出全年各月数据,month=1~12 表示导出指定月份。直接下载 Excel 文件,无需解析返回数据。 | | 积分排行榜-总入账 | GET | `/gd_dataserver/business/points/analysis/ranking/points` | 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、totalIncome-总入账积分、rank-排名。按 totalIncome 降序排列。 |
| 隐患统计-按分类 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/stats/category` | 返回 data 为数组,每个元素包含:categoryName-隐患分类名称、count-数量。用于饼图展示。 | | 上报积分排行 | GET | `/gd_dataserver/business/points/analysis/ranking/report` | 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、reportCount-上报次数、rank-排名。按上报次数降序。 |
| 隐患统计-按级别 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/stats/level` | 返回 data 为数组,每个元素包含:levelName-隐患级别名称、count-数量。用于饼图展示。 | | 月度安全运营报告(JSON) | GET | `/gd_dataserver/business/points/analysis/report/monthly` | 查询指定月份的运营数据,支持查询全年或单月。month=0 表示查询全年各月数据,month=1~12 表示查询指定月份。返回 data 为 MonthlyReportVO 数组,每个元素包含:month-月份、hazardCount-隐患总数、approvedCount-已通过数、rejectedCount-已驳回数、pointsIssued-发放积分、avgProcessHours-平均处理时长(小时)、onTimeRate-准时率(%)、exchangeOrderCount-兑换单数、exchangePoints-兑换消耗积分。 |
| 处理时效-按级别 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/timeliness/level` | 返回 data 为数组,每个元素包含:levelName-级别名称、avgHours-平均处理时长、completedCount-已完成数。 | | 月度安全运营报告导出(Excel) | GET | `/gd_dataserver/business/points/analysis/report/monthly/export` | 导出指定月份的运营数据为 Excel 文件。month=0 表示导出全年各月数据,month=1~12 表示导出指定月份。直接下载 Excel 文件,无需解析返回数据。 |
| 超期未处理列表 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/timeliness/overdue` | 返回 data 为 HazardReport 数组,每条记录包含 id、reportNo、hazardName、unitName、hazardLevelName、limitedCompleteTime-限定完成时间、status-状态 等字段。 | | 隐患统计-按分类 | GET | `/gd_dataserver/business/points/analysis/stats/category` | 返回 data 为数组,每个元素包含:categoryName-隐患分类名称、count-数量。用于饼图展示。 |
| 处理时效总览 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/timeliness/overview` | 返回 data 为对象,包含:avgHours-平均处理时长(小时)、maxHours-最大处理时长、minHours-最小处理时长、onTimeRate-准时率(%)、totalCount-总隐患数、completedCount-已完成数、pendingCount-待处理数。 | | 隐患统计-按级别 | GET | `/gd_dataserver/business/points/analysis/stats/level` | 返回 data 为数组,每个元素包含:levelName-隐患级别名称、count-数量。用于饼图展示。 |
| 处理时效-按单位 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/timeliness/unit` | 返回 data 为数组,每个元素包含:unitName-单位名称、avgHours-平均处理时长、completedCount-已完成数。 | | 处理时效-按级别 | GET | `/gd_dataserver/business/points/analysis/timeliness/level` | 返回 data 为数组,每个元素包含:levelName-级别名称、avgHours-平均处理时长、completedCount-已完成数。 |
| 隐患趋势-按月份 | GET | `/gd_dataserver/gd_dataserver/business/points/analysis/trend/month` | 返回 data 为数组,每个元素包含:month-月份(如'2026-01')、count-当月隐患数量。用于折线图展示。 | | 超期未处理列表 | GET | `/gd_dataserver/business/points/analysis/timeliness/overdue` | 返回 data 为 HazardReport 数组,每条记录包含 id、reportNo、hazardName、unitName、hazardLevelName、limitedCompleteTime-限定完成时间、status-状态 等字段。 |
| 处理时效总览 | GET | `/gd_dataserver/business/points/analysis/timeliness/overview` | 返回 data 为对象,包含:avgHours-平均处理时长(小时)、maxHours-最大处理时长、minHours-最小处理时长、onTimeRate-准时率(%)、totalCount-总隐患数、completedCount-已完成数、pendingCount-待处理数。 |
| 处理时效-按单位 | GET | `/gd_dataserver/business/points/analysis/timeliness/unit` | 返回 data 为数组,每个元素包含:unitName-单位名称、avgHours-平均处理时长、completedCount-已完成数。 |
| 隐患趋势-按月份 | GET | `/gd_dataserver/business/points/analysis/trend/month` | 返回 data 为数组,每个元素包含:month-月份(如'2026-01')、count-当月隐患数量。用于折线图展示。 |
## 接口详情 ## 接口详情
@ -38,7 +41,7 @@
### 首页数据看板 ### 首页数据看板
- **用途:** 返回 data 为对象,包含:totalHazard-隐患总数、monthHazard-本月新增隐患、pendingHazard-待处理隐患、totalPoints-积分总量、monthPoints-本月发放积分、onTimeRate-准时率(%)、todayExchangeCount-今日兑换单数、todayPointsIssued-今日发放积分数。 - **用途:** 返回 data 为对象,包含:totalHazard-隐患总数、monthHazard-本月新增隐患、pendingHazard-待处理隐患、totalPoints-积分总量、monthPoints-本月发放积分、onTimeRate-准时率(%)、todayExchangeCount-今日兑换单数、todayPointsIssued-今日发放积分数。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/dashboard` - **请求:** `GET /gd_dataserver/business/points/analysis/dashboard`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `dashboardUsingGET` - **operationId:** `dashboardUsingGET`
@ -59,7 +62,7 @@ _无_
### 隐患热力图-按部门统计 ### 隐患热力图-按部门统计
- **用途:** 返回 data 为数组,每个元素包含:departmentId-部门ID、departmentName-部门名称、hazardCount-隐患数量。 - **用途:** 返回 data 为数组,每个元素包含:departmentId-部门ID、departmentName-部门名称、hazardCount-隐患数量。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/heatmap/department` - **请求:** `GET /gd_dataserver/business/points/analysis/heatmap/department`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `heatmapByDepartmentUsingGET` - **operationId:** `heatmapByDepartmentUsingGET`
@ -84,7 +87,7 @@ _无_
### 隐患热力图-按单位统计 ### 隐患热力图-按单位统计
- **用途:** 返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、hazardCount-隐患数量。 - **用途:** 返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、hazardCount-隐患数量。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/heatmap/unit` - **请求:** `GET /gd_dataserver/business/points/analysis/heatmap/unit`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `heatmapByUnitUsingGET` - **operationId:** `heatmapByUnitUsingGET`
@ -105,10 +108,73 @@ _无_
| 404 | Not Found | - | | 404 | Not Found | - |
### 首页-核心指标概览
- **用途:** 按账户权限统计(管理员全部、其它账户仅本厂区)。返回 data 为对象,包含:pendingAuditCount-待审核数、monthClosedCount-本月已闭环数、todayReportCount-今日新增上报数、todayExchangeCount-今日兑换单数、todayPointsIssued-今日发放积分数。
- **请求:** `GET /gd_dataserver/business/points/analysis/home/overview`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `homeOverviewUsingGET`
参数:
_无_
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
### 首页-待办与预警
- **用途:** 按账户权限统计(管理员全部、其它账户仅本厂区)。返回 data 为对象,包含:pendingAuditOver24hCount-待审核超24h条数、riskWarningCount-风控预警(集中兑换)条数、pendingAppealCount-申诉待处理条数。
- **请求:** `GET /gd_dataserver/business/points/analysis/home/todo-warning`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `homeTodoWarningUsingGET`
参数:
_无_
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
### 首页-近7日趋势与最新上报
- **用途:** 按账户权限统计(管理员全部、其它账户仅本厂区)。返回 data 为对象,trend7d-近7日每日上报数组(元素含date、count),latestReports-最新上报前5条(含id、reportNo、hazardName、hazardLevelName、status、statusName、reporterName、factoryDeptName、createTime)。
- **请求:** `GET /gd_dataserver/business/points/analysis/home/trend-latest`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `homeTrendAndLatestUsingGET`
参数:
_无_
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
### 兑换排行统计(按单位) ### 兑换排行统计(按单位)
- **用途:** 按单位统计兑换数据,仅统计兑换成功(status=2)的订单。返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、orderCount-兑换单数、totalPoints-消耗积分总量、userCount-兑换人数。 - **用途:** 按单位统计兑换数据,仅统计兑换成功(status=2)的订单。返回 data 为数组,每个元素包含:unitId-单位ID、unitName-单位名称、orderCount-兑换单数、totalPoints-消耗积分总量、userCount-兑换人数。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/ranking/exchange` - **请求:** `GET /gd_dataserver/business/points/analysis/ranking/exchange`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `exchangeRankingByUnitUsingGET` - **operationId:** `exchangeRankingByUnitUsingGET`
@ -132,7 +198,7 @@ _无_
### 积分排行榜-本月获取 ### 积分排行榜-本月获取
- **用途:** 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、monthIncome-本月获取积分、rank-排名。 - **用途:** 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、monthIncome-本月获取积分、rank-排名。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/ranking/monthlyPoints` - **请求:** `GET /gd_dataserver/business/points/analysis/ranking/monthlyPoints`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `monthlyPointsRankingUsingGET` - **operationId:** `monthlyPointsRankingUsingGET`
@ -155,7 +221,7 @@ _无_
### 我的积分排名(APP端) ### 我的积分排名(APP端)
- **用途:** 查询当前登录用户的积分排名,返回userId、totalIncome、rank - **用途:** 查询当前登录用户的积分排名,返回userId、totalIncome、rank
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/ranking/myRank` - **请求:** `GET /gd_dataserver/business/points/analysis/ranking/myRank`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myRankUsingGET` - **operationId:** `myRankUsingGET`
@ -176,7 +242,7 @@ _无_
### 积分排行榜-总入账 ### 积分排行榜-总入账
- **用途:** 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、totalIncome-总入账积分、rank-排名。按 totalIncome 降序排列。 - **用途:** 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、totalIncome-总入账积分、rank-排名。按 totalIncome 降序排列。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/ranking/points` - **请求:** `GET /gd_dataserver/business/points/analysis/ranking/points`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `pointsRankingUsingGET` - **operationId:** `pointsRankingUsingGET`
@ -199,7 +265,7 @@ _无_
### 上报积分排行 ### 上报积分排行
- **用途:** 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、reportCount-上报次数、rank-排名。按上报次数降序。 - **用途:** 返回 data 为数组,每个元素包含:userId-用户ID、userName-用户姓名、reportCount-上报次数、rank-排名。按上报次数降序。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/ranking/report` - **请求:** `GET /gd_dataserver/business/points/analysis/ranking/report`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `reportPointsRankingUsingGET` - **operationId:** `reportPointsRankingUsingGET`
@ -222,7 +288,7 @@ _无_
### 月度安全运营报告(JSON) ### 月度安全运营报告(JSON)
- **用途:** 查询指定月份的运营数据,支持查询全年或单月。month=0 表示查询全年各月数据,month=1~12 表示查询指定月份。返回 data 为 MonthlyReportVO 数组,每个元素包含:month-月份、hazardCount-隐患总数、approvedCount-已通过数、rejectedCount-已驳回数、pointsIssued-发放积分、avgProcessHours-平均处理时长(小时)、onTimeRate-准时率(%)、exchangeOrderCount-兑换单数、exchangePoints-兑换消耗积分。 - **用途:** 查询指定月份的运营数据,支持查询全年或单月。month=0 表示查询全年各月数据,month=1~12 表示查询指定月份。返回 data 为 MonthlyReportVO 数组,每个元素包含:month-月份、hazardCount-隐患总数、approvedCount-已通过数、rejectedCount-已驳回数、pointsIssued-发放积分、avgProcessHours-平均处理时长(小时)、onTimeRate-准时率(%)、exchangeOrderCount-兑换单数、exchangePoints-兑换消耗积分。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/report/monthly` - **请求:** `GET /gd_dataserver/business/points/analysis/report/monthly`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `monthlyReportUsingGET` - **operationId:** `monthlyReportUsingGET`
@ -246,7 +312,7 @@ _无_
### 月度安全运营报告导出(Excel) ### 月度安全运营报告导出(Excel)
- **用途:** 导出指定月份的运营数据为 Excel 文件。month=0 表示导出全年各月数据,month=1~12 表示导出指定月份。直接下载 Excel 文件,无需解析返回数据。 - **用途:** 导出指定月份的运营数据为 Excel 文件。month=0 表示导出全年各月数据,month=1~12 表示导出指定月份。直接下载 Excel 文件,无需解析返回数据。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/report/monthly/export` - **请求:** `GET /gd_dataserver/business/points/analysis/report/monthly/export`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `exportMonthlyReportUsingGET` - **operationId:** `exportMonthlyReportUsingGET`
@ -270,7 +336,7 @@ _无_
### 隐患统计-按分类 ### 隐患统计-按分类
- **用途:** 返回 data 为数组,每个元素包含:categoryName-隐患分类名称、count-数量。用于饼图展示。 - **用途:** 返回 data 为数组,每个元素包含:categoryName-隐患分类名称、count-数量。用于饼图展示。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/stats/category` - **请求:** `GET /gd_dataserver/business/points/analysis/stats/category`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `statsByCategoryUsingGET` - **operationId:** `statsByCategoryUsingGET`
@ -294,7 +360,7 @@ _无_
### 隐患统计-按级别 ### 隐患统计-按级别
- **用途:** 返回 data 为数组,每个元素包含:levelName-隐患级别名称、count-数量。用于饼图展示。 - **用途:** 返回 data 为数组,每个元素包含:levelName-隐患级别名称、count-数量。用于饼图展示。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/stats/level` - **请求:** `GET /gd_dataserver/business/points/analysis/stats/level`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `statsByLevelUsingGET` - **operationId:** `statsByLevelUsingGET`
@ -318,7 +384,7 @@ _无_
### 处理时效-按级别 ### 处理时效-按级别
- **用途:** 返回 data 为数组,每个元素包含:levelName-级别名称、avgHours-平均处理时长、completedCount-已完成数。 - **用途:** 返回 data 为数组,每个元素包含:levelName-级别名称、avgHours-平均处理时长、completedCount-已完成数。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/timeliness/level` - **请求:** `GET /gd_dataserver/business/points/analysis/timeliness/level`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `timelinessByLevelUsingGET` - **operationId:** `timelinessByLevelUsingGET`
@ -342,7 +408,7 @@ _无_
### 超期未处理列表 ### 超期未处理列表
- **用途:** 返回 data 为 HazardReport 数组,每条记录包含 id、reportNo、hazardName、unitName、hazardLevelName、limitedCompleteTime-限定完成时间、status-状态 等字段。 - **用途:** 返回 data 为 HazardReport 数组,每条记录包含 id、reportNo、hazardName、unitName、hazardLevelName、limitedCompleteTime-限定完成时间、status-状态 等字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/timeliness/overdue` - **请求:** `GET /gd_dataserver/business/points/analysis/timeliness/overdue`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `overdueListUsingGET` - **operationId:** `overdueListUsingGET`
@ -363,7 +429,7 @@ _无_
### 处理时效总览 ### 处理时效总览
- **用途:** 返回 data 为对象,包含:avgHours-平均处理时长(小时)、maxHours-最大处理时长、minHours-最小处理时长、onTimeRate-准时率(%)、totalCount-总隐患数、completedCount-已完成数、pendingCount-待处理数。 - **用途:** 返回 data 为对象,包含:avgHours-平均处理时长(小时)、maxHours-最大处理时长、minHours-最小处理时长、onTimeRate-准时率(%)、totalCount-总隐患数、completedCount-已完成数、pendingCount-待处理数。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/timeliness/overview` - **请求:** `GET /gd_dataserver/business/points/analysis/timeliness/overview`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `timelinessOverviewUsingGET` - **operationId:** `timelinessOverviewUsingGET`
@ -387,7 +453,7 @@ _无_
### 处理时效-按单位 ### 处理时效-按单位
- **用途:** 返回 data 为数组,每个元素包含:unitName-单位名称、avgHours-平均处理时长、completedCount-已完成数。 - **用途:** 返回 data 为数组,每个元素包含:unitName-单位名称、avgHours-平均处理时长、completedCount-已完成数。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/timeliness/unit` - **请求:** `GET /gd_dataserver/business/points/analysis/timeliness/unit`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `timelinessByUnitUsingGET` - **operationId:** `timelinessByUnitUsingGET`
@ -411,7 +477,7 @@ _无_
### 隐患趋势-按月份 ### 隐患趋势-按月份
- **用途:** 返回 data 为数组,每个元素包含:month-月份(如'2026-01')、count-当月隐患数量。用于折线图展示。 - **用途:** 返回 data 为数组,每个元素包含:month-月份(如'2026-01')、count-当月隐患数量。用于折线图展示。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/points/analysis/trend/month` - **请求:** `GET /gd_dataserver/business/points/analysis/trend/month`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `trendByMonthUsingGET` - **operationId:** `trendByMonthUsingGET`

52
docs/api/modules/16-audit-log.md

@ -12,19 +12,19 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 新增 | POST | `/gd_dataserver/gd_dataserver/business/audit/log/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 | | 新增 | POST | `/gd_dataserver/business/audit/log/add` | 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 |
| 批量新增 | POST | `/gd_dataserver/gd_dataserver/business/audit/log/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 | | 批量新增 | POST | `/gd_dataserver/business/audit/log/addBatch` | 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 |
| 新增并返回保存的数据 | POST | `/gd_dataserver/gd_dataserver/business/audit/log/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 | | 新增并返回保存的数据 | POST | `/gd_dataserver/business/audit/log/addReturn` | 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 |
| 按业务单号查询审计日志 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/biz/{bizId}` | 根据业务单号(如隐患ID、订单ID)查询关联的所有审计日志,按时间倒序。返回 data 为 AuditLog 数组,每个元素包含:id、operator-操作人、operatorIp-操作人IP、operationType-操作类型(AUDIT_PASS/POINTS_ADJUST/EXCHANGE_REFUND)、bizId-业务单号、beforeData-操作前数据(JSON)、afterData-操作后数据(JSON)、remark-备注、createTime-操作时间。 | | 按业务单号查询审计日志 | GET | `/gd_dataserver/business/audit/log/biz/{bizId}` | 根据业务单号(如隐患ID、订单ID)查询关联的所有审计日志,按时间倒序。返回 data 为 AuditLog 数组,每个元素包含:id、operator-操作人、operatorIp-操作人IP、operationType-操作类型(AUDIT_PASS/POINTS_ADJUST/EXCHANGE_REFUND)、bizId-业务单号、beforeData-操作前数据(JSON)、afterData-操作后数据(JSON)、remark-备注、createTime-操作时间。 |
| 根据属性删除 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 | | 根据属性删除 | GET | `/gd_dataserver/business/audit/log/delete` | 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 |
| 主键删除 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 | | 主键删除 | GET | `/gd_dataserver/business/audit/log/deleteById` | 根据主键ID删除单条记录,成功返回 data 为 null。 |
| 批量删除 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 | | 批量删除 | GET | `/gd_dataserver/business/audit/log/deleteByIds` | 根据ID列表批量删除记录,成功返回 data 为 null。 |
| 查询所有 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 | | 查询所有 | GET | `/gd_dataserver/business/audit/log/getAll` | 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 |
| 分页查询 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 | | 分页查询 | GET | `/gd_dataserver/business/audit/log/getListByPage` | 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 |
| 详情 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 | | 详情 | GET | `/gd_dataserver/business/audit/log/info` | 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 |
| 条件查询 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 | | 条件查询 | GET | `/gd_dataserver/business/audit/log/list` | 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 |
| 逻辑删除 | GET | `/gd_dataserver/gd_dataserver/business/audit/log/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 | | 逻辑删除 | GET | `/gd_dataserver/business/audit/log/removeById` | 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 |
| 修改 | POST | `/gd_dataserver/gd_dataserver/business/audit/log/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 | | 修改 | POST | `/gd_dataserver/business/audit/log/updateById` | 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 |
## 接口详情 ## 接口详情
@ -34,7 +34,7 @@
### 新增 ### 新增
- **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。 - **用途:** 新增单条记录,请求体为实体类对象(字段说明见对应实体模型)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/audit/log/add` - **请求:** `POST /gd_dataserver/business/audit/log/add`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addOneUsingPOST_2` - **operationId:** `addOneUsingPOST_2`
@ -75,7 +75,7 @@ _无_
### 批量新增 ### 批量新增
- **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。 - **用途:** 批量新增多条记录,请求体为实体类数组。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/audit/log/addBatch` - **请求:** `POST /gd_dataserver/business/audit/log/addBatch`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addBatchUsingPOST_2` - **operationId:** `addBatchUsingPOST_2`
@ -103,7 +103,7 @@ _无_
### 新增并返回保存的数据 ### 新增并返回保存的数据
- **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。 - **用途:** 新增单条记录并返回保存后的数据(含自增ID),请求体为实体类对象。成功返回 data 为保存的实体对象。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/audit/log/addReturn` - **请求:** `POST /gd_dataserver/business/audit/log/addReturn`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addReturnUsingPOST_2` - **operationId:** `addReturnUsingPOST_2`
@ -144,7 +144,7 @@ _无_
### 按业务单号查询审计日志 ### 按业务单号查询审计日志
- **用途:** 根据业务单号(如隐患ID、订单ID)查询关联的所有审计日志,按时间倒序。返回 data 为 AuditLog 数组,每个元素包含:id、operator-操作人、operatorIp-操作人IP、operationType-操作类型(AUDIT_PASS/POINTS_ADJUST/EXCHANGE_REFUND)、bizId-业务单号、beforeData-操作前数据(JSON)、afterData-操作后数据(JSON)、remark-备注、createTime-操作时间。 - **用途:** 根据业务单号(如隐患ID、订单ID)查询关联的所有审计日志,按时间倒序。返回 data 为 AuditLog 数组,每个元素包含:id、operator-操作人、operatorIp-操作人IP、operationType-操作类型(AUDIT_PASS/POINTS_ADJUST/EXCHANGE_REFUND)、bizId-业务单号、beforeData-操作前数据(JSON)、afterData-操作后数据(JSON)、remark-备注、createTime-操作时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/biz/{bizId}` - **请求:** `GET /gd_dataserver/business/audit/log/biz/{bizId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `listByBizIdUsingGET` - **operationId:** `listByBizIdUsingGET`
@ -167,7 +167,7 @@ _无_
### 根据属性删除 ### 根据属性删除
- **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。 - **用途:** 根据实体属性条件删除记录,请求体为实体类对象。成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/delete` - **请求:** `GET /gd_dataserver/business/audit/log/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingGET_2` - **operationId:** `deleteUsingGET_2`
@ -198,7 +198,7 @@ _无_
### 主键删除 ### 主键删除
- **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/deleteById` - **请求:** `GET /gd_dataserver/business/audit/log/deleteById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteOneUsingGET_2` - **operationId:** `deleteOneUsingGET_2`
@ -221,7 +221,7 @@ _无_
### 批量删除 ### 批量删除
- **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。 - **用途:** 根据ID列表批量删除记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/deleteByIds` - **请求:** `GET /gd_dataserver/business/audit/log/deleteByIds`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_5` - **operationId:** `deleteListUsingGET_5`
@ -244,7 +244,7 @@ _无_
### 查询所有 ### 查询所有
- **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。 - **用途:** 查询所有记录(无分页、无条件)。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/getAll` - **请求:** `GET /gd_dataserver/business/audit/log/getAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getAllUsingGET_2` - **operationId:** `getAllUsingGET_2`
@ -265,7 +265,7 @@ _无_
### 分页查询 ### 分页查询
- **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。 - **用途:** 分页查询记录列表,查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象,其中 list 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/getListByPage` - **请求:** `GET /gd_dataserver/business/audit/log/getListByPage`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListByPageUsingGET_2` - **operationId:** `getListByPageUsingGET_2`
@ -298,7 +298,7 @@ _无_
### 详情 ### 详情
- **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。 - **用途:** 根据主键ID查询单条记录详情。成功返回 data 为实体类对象,包含该实体所有字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/info` - **请求:** `GET /gd_dataserver/business/audit/log/info`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `infoUsingGET_2` - **operationId:** `infoUsingGET_2`
@ -321,7 +321,7 @@ _无_
### 条件查询 ### 条件查询
- **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。 - **用途:** 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/list` - **请求:** `GET /gd_dataserver/business/audit/log/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_2` - **operationId:** `getListUsingGET_2`
@ -352,7 +352,7 @@ _无_
### 逻辑删除 ### 逻辑删除
- **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。 - **用途:** 根据主键ID逻辑删除单条记录,成功返回 data 为 null。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/audit/log/removeById` - **请求:** `GET /gd_dataserver/business/audit/log/removeById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteListUsingGET_4` - **operationId:** `deleteListUsingGET_4`
@ -375,7 +375,7 @@ _无_
### 修改 ### 修改
- **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。 - **用途:** 根据主键ID修改记录,请求体为实体类对象(需包含id字段)。成功返回 data 为 null。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/audit/log/updateById` - **请求:** `POST /gd_dataserver/business/audit/log/updateById`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateByIdUsingPOST_2` - **operationId:** `updateByIdUsingPOST_2`

44
docs/api/modules/17-flow-definition.md

@ -12,17 +12,17 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 指定流程达式列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/expList` | - | | 指定流程达式列表 | GET | `/gd_dataserver/flowable/definition/expList` | - |
| 导入流程文件 | POST | `/gd_dataserver/gd_dataserver/flowable/definition/import` | 上传bpmn20的xml文件 | | 导入流程文件 | POST | `/gd_dataserver/flowable/definition/import` | 上传bpmn20的xml文件 |
| 流程定义列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/list` | - | | 流程定义列表 | GET | `/gd_dataserver/flowable/definition/list` | - |
| 读取图片文件 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/readImage/{deployId}` | - | | 读取图片文件 | GET | `/gd_dataserver/flowable/definition/readImage/{deployId}` | - |
| 读取xml文件 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/readXml/{deployId}` | - | | 读取xml文件 | GET | `/gd_dataserver/flowable/definition/readXml/{deployId}` | - |
| 指定流程办理组列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/roleList` | - | | 指定流程办理组列表 | GET | `/gd_dataserver/flowable/definition/roleList` | - |
| 保存流程设计器内的xml文件 | POST | `/gd_dataserver/gd_dataserver/flowable/definition/save` | - | | 保存流程设计器内的xml文件 | POST | `/gd_dataserver/flowable/definition/save` | - |
| 发起流程 | POST | `/gd_dataserver/gd_dataserver/flowable/definition/start/{procDefId}` | - | | 发起流程 | POST | `/gd_dataserver/flowable/definition/start/{procDefId}` | - |
| 激活或挂起流程定义 | PUT | `/gd_dataserver/gd_dataserver/flowable/definition/updateState` | - | | 激活或挂起流程定义 | PUT | `/gd_dataserver/flowable/definition/updateState` | - |
| 指定流程办理人员列表 | GET | `/gd_dataserver/gd_dataserver/flowable/definition/userList` | - | | 指定流程办理人员列表 | GET | `/gd_dataserver/flowable/definition/userList` | - |
| 删除流程 | DELETE | `/gd_dataserver/gd_dataserver/flowable/definition/{deployIds}` | - | | 删除流程 | DELETE | `/gd_dataserver/flowable/definition/{deployIds}` | - |
## 接口详情 ## 接口详情
@ -32,7 +32,7 @@
### 指定流程达式列表 ### 指定流程达式列表
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/definition/expList` - **请求:** `GET /gd_dataserver/flowable/definition/expList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `expListUsingGET` - **operationId:** `expListUsingGET`
@ -67,7 +67,7 @@
### 导入流程文件 ### 导入流程文件
- **用途:** 上传bpmn20的xml文件 - **用途:** 上传bpmn20的xml文件
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/definition/import` - **请求:** `POST /gd_dataserver/flowable/definition/import`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `importFileUsingPOST` - **operationId:** `importFileUsingPOST`
@ -101,7 +101,7 @@
### 流程定义列表 ### 流程定义列表
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/definition/list` - **请求:** `GET /gd_dataserver/flowable/definition/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `listUsingGET` - **operationId:** `listUsingGET`
@ -126,7 +126,7 @@
### 读取图片文件 ### 读取图片文件
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/definition/readImage/{deployId}` - **请求:** `GET /gd_dataserver/flowable/definition/readImage/{deployId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `readImageUsingGET` - **operationId:** `readImageUsingGET`
@ -149,7 +149,7 @@
### 读取xml文件 ### 读取xml文件
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/definition/readXml/{deployId}` - **请求:** `GET /gd_dataserver/flowable/definition/readXml/{deployId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `readXmlUsingGET` - **operationId:** `readXmlUsingGET`
@ -172,7 +172,7 @@
### 指定流程办理组列表 ### 指定流程办理组列表
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/definition/roleList` - **请求:** `GET /gd_dataserver/flowable/definition/roleList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `roleListUsingGET` - **operationId:** `roleListUsingGET`
@ -217,7 +217,7 @@
### 保存流程设计器内的xml文件 ### 保存流程设计器内的xml文件
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/definition/save` - **请求:** `POST /gd_dataserver/flowable/definition/save`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `saveUsingPOST` - **operationId:** `saveUsingPOST`
@ -252,7 +252,7 @@ _无_
### 发起流程 ### 发起流程
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/definition/start/{procDefId}` - **请求:** `POST /gd_dataserver/flowable/definition/start/{procDefId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `startUsingPOST` - **operationId:** `startUsingPOST`
@ -282,7 +282,7 @@ _无_
### 激活或挂起流程定义 ### 激活或挂起流程定义
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `PUT /gd_dataserver/gd_dataserver/flowable/definition/updateState` - **请求:** `PUT /gd_dataserver/flowable/definition/updateState`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateStateUsingPUT` - **operationId:** `updateStateUsingPUT`
@ -307,7 +307,7 @@ _无_
### 指定流程办理人员列表 ### 指定流程办理人员列表
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/definition/userList` - **请求:** `GET /gd_dataserver/flowable/definition/userList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `userListUsingGET` - **operationId:** `userListUsingGET`
@ -399,7 +399,7 @@ _无_
### 删除流程 ### 删除流程
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `DELETE /gd_dataserver/gd_dataserver/flowable/definition/{deployIds}` - **请求:** `DELETE /gd_dataserver/flowable/definition/{deployIds}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingDELETE` - **operationId:** `deleteUsingDELETE`

92
docs/api/modules/18-flow-task.md

@ -12,29 +12,29 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 多实例加签 | POST | `/gd_dataserver/gd_dataserver/flowable/task/addMultiInstanceExecution` | - | | 多实例加签 | POST | `/gd_dataserver/flowable/task/addMultiInstanceExecution` | - |
| 转办任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/assignTask` | - | | 转办任务 | POST | `/gd_dataserver/flowable/task/assignTask` | - |
| 认领/签收任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/claim` | - | | 认领/签收任务 | POST | `/gd_dataserver/flowable/task/claim` | - |
| 审批任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/complete` | - | | 审批任务 | POST | `/gd_dataserver/flowable/task/complete` | - |
| 委派任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/delegateTask` | - | | 委派任务 | POST | `/gd_dataserver/flowable/task/delegateTask` | - |
| 删除任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/delete` | - | | 删除任务 | POST | `/gd_dataserver/flowable/task/delete` | - |
| 清空任务 | GET | `/gd_dataserver/gd_dataserver/flowable/task/deleteAll` | - | | 清空任务 | GET | `/gd_dataserver/flowable/task/deleteAll` | - |
| 多实例减签 | POST | `/gd_dataserver/gd_dataserver/flowable/task/deleteMultiInstanceExecution` | - | | 多实例减签 | POST | `/gd_dataserver/flowable/task/deleteMultiInstanceExecution` | - |
| 获取已办任务 | GET | `/gd_dataserver/gd_dataserver/flowable/task/finishedList` | - | | 获取已办任务 | GET | `/gd_dataserver/flowable/task/finishedList` | - |
| 流程初始化表单 | GET | `/gd_dataserver/gd_dataserver/flowable/task/flowFormData` | - | | 流程初始化表单 | GET | `/gd_dataserver/flowable/task/flowFormData` | - |
| 流程历史流转记录 | GET | `/gd_dataserver/gd_dataserver/flowable/task/flowRecord` | - | | 流程历史流转记录 | GET | `/gd_dataserver/flowable/task/flowRecord` | - |
| 我发起的流程 | GET | `/gd_dataserver/gd_dataserver/flowable/task/myProcess` | - | | 我发起的流程 | GET | `/gd_dataserver/flowable/task/myProcess` | - |
| 获取下一节点 | POST | `/gd_dataserver/gd_dataserver/flowable/task/nextFlowNode` | - | | 获取下一节点 | POST | `/gd_dataserver/flowable/task/nextFlowNode` | - |
| 流程发起时获取下一节点 | POST | `/gd_dataserver/gd_dataserver/flowable/task/nextFlowNodeByStart` | - | | 流程发起时获取下一节点 | POST | `/gd_dataserver/flowable/task/nextFlowNodeByStart` | - |
| 获取流程变量 | GET | `/gd_dataserver/gd_dataserver/flowable/task/processVariables/{taskId}` | - | | 获取流程变量 | GET | `/gd_dataserver/flowable/task/processVariables/{taskId}` | - |
| 驳回任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/reject` | - | | 驳回任务 | POST | `/gd_dataserver/flowable/task/reject` | - |
| 任务归还 | POST | `/gd_dataserver/gd_dataserver/flowable/task/resolveTask` | - | | 任务归还 | POST | `/gd_dataserver/flowable/task/resolveTask` | - |
| 退回任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/return` | - | | 退回任务 | POST | `/gd_dataserver/flowable/task/return` | - |
| 获取所有可回退的节点 | POST | `/gd_dataserver/gd_dataserver/flowable/task/returnList` | - | | 获取所有可回退的节点 | POST | `/gd_dataserver/flowable/task/returnList` | - |
| 撤回流程 | POST | `/gd_dataserver/gd_dataserver/flowable/task/revokeProcess` | - | | 撤回流程 | POST | `/gd_dataserver/flowable/task/revokeProcess` | - |
| 取消申请 | POST | `/gd_dataserver/gd_dataserver/flowable/task/stopProcess` | - | | 取消申请 | POST | `/gd_dataserver/flowable/task/stopProcess` | - |
| 获取待办列表 | GET | `/gd_dataserver/gd_dataserver/flowable/task/todoList` | - | | 获取待办列表 | GET | `/gd_dataserver/flowable/task/todoList` | - |
| 取消认领/签收任务 | POST | `/gd_dataserver/gd_dataserver/flowable/task/unClaim` | - | | 取消认领/签收任务 | POST | `/gd_dataserver/flowable/task/unClaim` | - |
## 接口详情 ## 接口详情
@ -44,7 +44,7 @@
### 多实例加签 ### 多实例加签
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/addMultiInstanceExecution` - **请求:** `POST /gd_dataserver/flowable/task/addMultiInstanceExecution`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `addMultiInstanceExecutionUsingPOST` - **operationId:** `addMultiInstanceExecutionUsingPOST`
@ -90,7 +90,7 @@ _无_
### 转办任务 ### 转办任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/assignTask` - **请求:** `POST /gd_dataserver/flowable/task/assignTask`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `assignUsingPOST` - **operationId:** `assignUsingPOST`
@ -136,7 +136,7 @@ _无_
### 认领/签收任务 ### 认领/签收任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/claim` - **请求:** `POST /gd_dataserver/flowable/task/claim`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `claimUsingPOST` - **operationId:** `claimUsingPOST`
@ -182,7 +182,7 @@ _无_
### 审批任务 ### 审批任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/complete` - **请求:** `POST /gd_dataserver/flowable/task/complete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `completeUsingPOST_1` - **operationId:** `completeUsingPOST_1`
@ -228,7 +228,7 @@ _无_
### 委派任务 ### 委派任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/delegateTask` - **请求:** `POST /gd_dataserver/flowable/task/delegateTask`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `delegateUsingPOST` - **operationId:** `delegateUsingPOST`
@ -274,7 +274,7 @@ _无_
### 删除任务 ### 删除任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/delete` - **请求:** `POST /gd_dataserver/flowable/task/delete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingPOST` - **operationId:** `deleteUsingPOST`
@ -320,7 +320,7 @@ _无_
### 清空任务 ### 清空任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/deleteAll` - **请求:** `GET /gd_dataserver/flowable/task/deleteAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteAllUsingGET` - **operationId:** `deleteAllUsingGET`
@ -341,7 +341,7 @@ _无_
### 多实例减签 ### 多实例减签
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/deleteMultiInstanceExecution` - **请求:** `POST /gd_dataserver/flowable/task/deleteMultiInstanceExecution`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteMultiInstanceExecutionUsingPOST` - **operationId:** `deleteMultiInstanceExecutionUsingPOST`
@ -387,7 +387,7 @@ _无_
### 获取已办任务 ### 获取已办任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/finishedList` - **请求:** `GET /gd_dataserver/flowable/task/finishedList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `finishedListUsingGET` - **operationId:** `finishedListUsingGET`
@ -417,7 +417,7 @@ _无_
### 流程初始化表单 ### 流程初始化表单
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/flowFormData` - **请求:** `GET /gd_dataserver/flowable/task/flowFormData`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `flowFormDataUsingGET` - **operationId:** `flowFormDataUsingGET`
@ -440,7 +440,7 @@ _无_
### 流程历史流转记录 ### 流程历史流转记录
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/flowRecord` - **请求:** `GET /gd_dataserver/flowable/task/flowRecord`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `flowRecordUsingGET` - **operationId:** `flowRecordUsingGET`
@ -464,7 +464,7 @@ _无_
### 我发起的流程 ### 我发起的流程
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/myProcess` - **请求:** `GET /gd_dataserver/flowable/task/myProcess`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myProcessUsingGET` - **operationId:** `myProcessUsingGET`
@ -494,7 +494,7 @@ _无_
### 获取下一节点 ### 获取下一节点
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/nextFlowNode` - **请求:** `POST /gd_dataserver/flowable/task/nextFlowNode`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getNextFlowNodeUsingPOST` - **operationId:** `getNextFlowNodeUsingPOST`
@ -540,7 +540,7 @@ _无_
### 流程发起时获取下一节点 ### 流程发起时获取下一节点
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/nextFlowNodeByStart` - **请求:** `POST /gd_dataserver/flowable/task/nextFlowNodeByStart`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getNextFlowNodeByStartUsingPOST` - **operationId:** `getNextFlowNodeByStartUsingPOST`
@ -586,7 +586,7 @@ _无_
### 获取流程变量 ### 获取流程变量
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/processVariables/{taskId}` - **请求:** `GET /gd_dataserver/flowable/task/processVariables/{taskId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `processVariablesUsingGET` - **operationId:** `processVariablesUsingGET`
@ -609,7 +609,7 @@ _无_
### 驳回任务 ### 驳回任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/reject` - **请求:** `POST /gd_dataserver/flowable/task/reject`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `taskRejectUsingPOST` - **operationId:** `taskRejectUsingPOST`
@ -655,7 +655,7 @@ _无_
### 任务归还 ### 任务归还
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/resolveTask` - **请求:** `POST /gd_dataserver/flowable/task/resolveTask`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `resolveTaskUsingPOST` - **operationId:** `resolveTaskUsingPOST`
@ -701,7 +701,7 @@ _无_
### 退回任务 ### 退回任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/return` - **请求:** `POST /gd_dataserver/flowable/task/return`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `taskReturnUsingPOST` - **operationId:** `taskReturnUsingPOST`
@ -747,7 +747,7 @@ _无_
### 获取所有可回退的节点 ### 获取所有可回退的节点
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/returnList` - **请求:** `POST /gd_dataserver/flowable/task/returnList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `findReturnTaskListUsingPOST` - **operationId:** `findReturnTaskListUsingPOST`
@ -793,7 +793,7 @@ _无_
### 撤回流程 ### 撤回流程
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/revokeProcess` - **请求:** `POST /gd_dataserver/flowable/task/revokeProcess`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `revokeProcessUsingPOST` - **operationId:** `revokeProcessUsingPOST`
@ -839,7 +839,7 @@ _无_
### 取消申请 ### 取消申请
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/stopProcess` - **请求:** `POST /gd_dataserver/flowable/task/stopProcess`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `stopProcessUsingPOST` - **operationId:** `stopProcessUsingPOST`
@ -885,7 +885,7 @@ _无_
### 获取待办列表 ### 获取待办列表
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/task/todoList` - **请求:** `GET /gd_dataserver/flowable/task/todoList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `todoListUsingGET` - **operationId:** `todoListUsingGET`
@ -915,7 +915,7 @@ _无_
### 取消认领/签收任务 ### 取消认领/签收任务
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/task/unClaim` - **请求:** `POST /gd_dataserver/flowable/task/unClaim`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `unClaimUsingPOST` - **operationId:** `unClaimUsingPOST`

16
docs/api/modules/19-flow-instance.md

@ -12,10 +12,10 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 删除流程实例 | DELETE | `/gd_dataserver/gd_dataserver/flowable/instance/delete/{instanceIds}` | - | | 删除流程实例 | DELETE | `/gd_dataserver/flowable/instance/delete/{instanceIds}` | - |
| 根据流程定义id启动流程实例 | POST | `/gd_dataserver/gd_dataserver/flowable/instance/startBy/{procDefId}` | - | | 根据流程定义id启动流程实例 | POST | `/gd_dataserver/flowable/instance/startBy/{procDefId}` | - |
| 结束流程实例 | POST | `/gd_dataserver/gd_dataserver/flowable/instance/stopProcessInstance` | - | | 结束流程实例 | POST | `/gd_dataserver/flowable/instance/stopProcessInstance` | - |
| 激活或挂起流程实例 | POST | `/gd_dataserver/gd_dataserver/flowable/instance/updateState` | - | | 激活或挂起流程实例 | POST | `/gd_dataserver/flowable/instance/updateState` | - |
## 接口详情 ## 接口详情
@ -25,7 +25,7 @@
### 删除流程实例 ### 删除流程实例
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `DELETE /gd_dataserver/gd_dataserver/flowable/instance/delete/{instanceIds}` - **请求:** `DELETE /gd_dataserver/flowable/instance/delete/{instanceIds}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `deleteUsingDELETE_1` - **operationId:** `deleteUsingDELETE_1`
@ -49,7 +49,7 @@
### 根据流程定义id启动流程实例 ### 根据流程定义id启动流程实例
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/instance/startBy/{procDefId}` - **请求:** `POST /gd_dataserver/flowable/instance/startBy/{procDefId}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `startByIdUsingPOST` - **operationId:** `startByIdUsingPOST`
@ -79,7 +79,7 @@
### 结束流程实例 ### 结束流程实例
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/instance/stopProcessInstance` - **请求:** `POST /gd_dataserver/flowable/instance/stopProcessInstance`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `stopProcessInstanceUsingPOST` - **operationId:** `stopProcessInstanceUsingPOST`
@ -125,7 +125,7 @@ _无_
### 激活或挂起流程实例 ### 激活或挂起流程实例
- **用途:** 接口文档未提供用途说明。 - **用途:** 接口文档未提供用途说明。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/instance/updateState` - **请求:** `POST /gd_dataserver/flowable/instance/updateState`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `updateStateUsingPOST` - **operationId:** `updateStateUsingPOST`

4
docs/api/modules/20-flow-common.md

@ -12,7 +12,7 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 获取流程详情 | GET | `/gd_dataserver/gd_dataserver/flowable/busiInfo/getProcessDetail` | 根据流程实例ID查询流程详细信息,返回 data 包含流程节点、审批记录、当前状态等。 | | 获取流程详情 | GET | `/gd_dataserver/flowable/busiInfo/getProcessDetail` | 根据流程实例ID查询流程详细信息,返回 data 包含流程节点、审批记录、当前状态等。 |
## 接口详情 ## 接口详情
@ -22,7 +22,7 @@
### 获取流程详情 ### 获取流程详情
- **用途:** 根据流程实例ID查询流程详细信息,返回 data 包含流程节点、审批记录、当前状态等。 - **用途:** 根据流程实例ID查询流程详细信息,返回 data 包含流程节点、审批记录、当前状态等。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/busiInfo/getProcessDetail` - **请求:** `GET /gd_dataserver/flowable/busiInfo/getProcessDetail`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getProcessDetailUsingGET` - **operationId:** `getProcessDetailUsingGET`

8
docs/api/modules/21-flow-sign-task.md

@ -12,8 +12,8 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 审批任务 | POST | `/gd_dataserver/gd_dataserver/flowable/busiTask/complete` | 审批通过或驳回,需携带taskId、result、comment等信息。成功返回 data 为 null;失败返回 error 信息。 | | 审批任务 | POST | `/gd_dataserver/flowable/busiTask/complete` | 审批通过或驳回,需携带taskId、result、comment等信息。成功返回 data 为 null;失败返回 error 信息。 |
| 获取当前节点信息 | GET | `/gd_dataserver/gd_dataserver/flowable/busiTask/getCurrentNode` | 根据任务ID查询当前节点详情,返回 data 为节点信息字符串。 | | 获取当前节点信息 | GET | `/gd_dataserver/flowable/busiTask/getCurrentNode` | 根据任务ID查询当前节点详情,返回 data 为节点信息字符串。 |
## 接口详情 ## 接口详情
@ -23,7 +23,7 @@
### 审批任务 ### 审批任务
- **用途:** 审批通过或驳回,需携带taskId、result、comment等信息。成功返回 data 为 null;失败返回 error 信息。 - **用途:** 审批通过或驳回,需携带taskId、result、comment等信息。成功返回 data 为 null;失败返回 error 信息。
- **请求:** `POST /gd_dataserver/gd_dataserver/flowable/busiTask/complete` - **请求:** `POST /gd_dataserver/flowable/busiTask/complete`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `completeUsingPOST` - **operationId:** `completeUsingPOST`
@ -75,7 +75,7 @@ _无_
### 获取当前节点信息 ### 获取当前节点信息
- **用途:** 根据任务ID查询当前节点详情,返回 data 为节点信息字符串。 - **用途:** 根据任务ID查询当前节点详情,返回 data 为节点信息字符串。
- **请求:** `GET /gd_dataserver/gd_dataserver/flowable/busiTask/getCurrentNode` - **请求:** `GET /gd_dataserver/flowable/busiTask/getCurrentNode`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getCurrentNodeUsingGET` - **operationId:** `getCurrentNodeUsingGET`

6
docs/api/modules/22-flow-sign.md

@ -12,7 +12,7 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 查询签字记录列表 | GET | `/gd_dataserver/gd_dataserver/business/flowqz/getList` | 支持按条件筛选签字记录 | | 查询签字记录列表 | GET | `/gd_dataserver/business/flowqz/getList` | 支持按条件筛选签字记录 |
## 接口详情 ## 接口详情
@ -22,9 +22,9 @@
### 查询签字记录列表 ### 查询签字记录列表
- **用途:** 支持按条件筛选签字记录 - **用途:** 支持按条件筛选签字记录
- **请求:** `GET /gd_dataserver/gd_dataserver/business/flowqz/getList` - **请求:** `GET /gd_dataserver/business/flowqz/getList`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getListUsingGET_12` - **operationId:** `getListUsingGET_11`
参数: 参数:

22
docs/api/modules/23-user-message.md

@ -12,11 +12,11 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 消息详情 | GET | `/gd_dataserver/gd_dataserver/business/message/detail/{id}` | 查看后自动标记为已读。返回 data 为 UserMessage 对象,包含 id、msgType、title、content、bizId、createTime。 | | 消息详情 | GET | `/gd_dataserver/business/message/detail/{id}` | 查看后自动标记为已读。返回 data 为 UserMessage 对象,包含 id、msgType、title、content、bizId、createTime。 |
| 分页查询我的消息列表 | GET | `/gd_dataserver/gd_dataserver/business/message/list` | 返回 data 为 Page 分页对象。list 中每条记录为 UserMessage 对象,主要字段:id、userId-用户ID、msgType-消息类型(如points_award/hazard_audit/appeal_result)、title-消息标题、content-消息内容、bizId-关联业务ID、isRead-是否已读(0未读/1已读)、createTime-创建时间。 | | 分页查询我的消息列表 | GET | `/gd_dataserver/business/message/list` | 返回 data 为 Page 分页对象。list 中每条记录为 UserMessage 对象,主要字段:id、userId-用户ID、msgType-消息类型(如points_award/hazard_audit/appeal_result)、title-消息标题、content-消息内容、bizId-关联业务ID、isRead-是否已读(0未读/1已读)、createTime-创建时间。 |
| 标记消息已读 | POST | `/gd_dataserver/gd_dataserver/business/message/read/{id}` | 将指定消息标记为已读。返回 data 为 null,成功时 code=200。 | | 标记消息已读 | POST | `/gd_dataserver/business/message/read/{id}` | 将指定消息标记为已读。返回 data 为 null,成功时 code=200。 |
| 全部标记已读 | POST | `/gd_dataserver/gd_dataserver/business/message/readAll` | 将当前用户所有未读消息标记为已读。返回 data 为 null,成功时 code=200。 | | 全部标记已读 | POST | `/gd_dataserver/business/message/readAll` | 将当前用户所有未读消息标记为已读。返回 data 为 null,成功时 code=200。 |
| 获取未读消息数量 | GET | `/gd_dataserver/gd_dataserver/business/message/unread-count` | 返回 data 为 Long 类型的未读消息数量,如 5。用于APP端消息红点展示。 | | 获取未读消息数量 | GET | `/gd_dataserver/business/message/unread-count` | 返回 data 为 Long 类型的未读消息数量,如 5。用于APP端消息红点展示。 |
## 接口详情 ## 接口详情
@ -26,7 +26,7 @@
### 消息详情 ### 消息详情
- **用途:** 查看后自动标记为已读。返回 data 为 UserMessage 对象,包含 id、msgType、title、content、bizId、createTime。 - **用途:** 查看后自动标记为已读。返回 data 为 UserMessage 对象,包含 id、msgType、title、content、bizId、createTime。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/message/detail/{id}` - **请求:** `GET /gd_dataserver/business/message/detail/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `detailUsingGET_1` - **operationId:** `detailUsingGET_1`
@ -49,9 +49,9 @@
### 分页查询我的消息列表 ### 分页查询我的消息列表
- **用途:** 返回 data 为 Page 分页对象。list 中每条记录为 UserMessage 对象,主要字段:id、userId-用户ID、msgType-消息类型(如points_award/hazard_audit/appeal_result)、title-消息标题、content-消息内容、bizId-关联业务ID、isRead-是否已读(0未读/1已读)、createTime-创建时间。 - **用途:** 返回 data 为 Page 分页对象。list 中每条记录为 UserMessage 对象,主要字段:id、userId-用户ID、msgType-消息类型(如points_award/hazard_audit/appeal_result)、title-消息标题、content-消息内容、bizId-关联业务ID、isRead-是否已读(0未读/1已读)、createTime-创建时间。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/message/list` - **请求:** `GET /gd_dataserver/business/message/list`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `listUsingGET_2` - **operationId:** `listUsingGET_3`
参数: 参数:
@ -75,7 +75,7 @@
### 标记消息已读 ### 标记消息已读
- **用途:** 将指定消息标记为已读。返回 data 为 null,成功时 code=200。 - **用途:** 将指定消息标记为已读。返回 data 为 null,成功时 code=200。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/message/read/{id}` - **请求:** `POST /gd_dataserver/business/message/read/{id}`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `markReadUsingPOST` - **operationId:** `markReadUsingPOST`
@ -99,7 +99,7 @@
### 全部标记已读 ### 全部标记已读
- **用途:** 将当前用户所有未读消息标记为已读。返回 data 为 null,成功时 code=200。 - **用途:** 将当前用户所有未读消息标记为已读。返回 data 为 null,成功时 code=200。
- **请求:** `POST /gd_dataserver/gd_dataserver/business/message/readAll` - **请求:** `POST /gd_dataserver/business/message/readAll`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `markAllReadUsingPOST` - **operationId:** `markAllReadUsingPOST`
@ -121,7 +121,7 @@ _无_
### 获取未读消息数量 ### 获取未读消息数量
- **用途:** 返回 data 为 Long 类型的未读消息数量,如 5。用于APP端消息红点展示。 - **用途:** 返回 data 为 Long 类型的未读消息数量,如 5。用于APP端消息红点展示。
- **请求:** `GET /gd_dataserver/gd_dataserver/business/message/unread-count` - **请求:** `GET /gd_dataserver/business/message/unread-count`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `unreadCountUsingGET` - **operationId:** `unreadCountUsingGET`

4
docs/api/modules/24-message.md

@ -12,7 +12,7 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| MQTT消息发送 | GET | `/gd_dataserver/gd_dataserver/business/mqtt/sendMqttMsg` | 向指定主题发送MQTT消息 | | MQTT消息发送 | GET | `/gd_dataserver/business/mqtt/sendMqttMsg` | 向指定主题发送MQTT消息 |
## 接口详情 ## 接口详情
@ -22,7 +22,7 @@
### MQTT消息发送 ### MQTT消息发送
- **用途:** 向指定主题发送MQTT消息 - **用途:** 向指定主题发送MQTT消息
- **请求:** `GET /gd_dataserver/gd_dataserver/business/mqtt/sendMqttMsg` - **请求:** `GET /gd_dataserver/business/mqtt/sendMqttMsg`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `sendMqttMsgUsingGET` - **operationId:** `sendMqttMsgUsingGET`

8
docs/api/modules/25-system-tool.md

@ -12,8 +12,8 @@
| 接口名称 | 方法 | 路径 | 用途 | | 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 获取组织架构(部门-人员树) | GET | `/gd_dataserver/gd_dataserver/system/getOrgUsers` | 返回 data 为树形数组,每个节点包含 id-部门ID、label-部门名称、children-子节点数组。子节点包含部门或人员,人员节点包含 id-用户ID、label-用户姓名。 | | 获取组织架构(部门-人员树) | GET | `/gd_dataserver/system/getOrgUsers` | 返回 data 为树形数组,每个节点包含 id-部门ID、label-部门名称、children-子节点数组。子节点包含部门或人员,人员节点包含 id-用户ID、label-用户姓名。 |
| 获取当前登录用户信息 | GET | `/gd_dataserver/gd_dataserver/system/getTokenUser` | 返回 data 为 SysUser 对象,包含 userId-用户ID、userName-用户名、nickName-昵称、phonenumber-手机号、email-邮箱、dept-部门对象{deptId,deptName}等字段。 | | 获取当前登录用户信息 | GET | `/gd_dataserver/system/getTokenUser` | 返回 data 为 SysUser 对象,包含 userId-用户ID、userName-用户名、nickName-昵称、phonenumber-手机号、email-邮箱、dept-部门对象{deptId,deptName}等字段。 |
## 接口详情 ## 接口详情
@ -23,7 +23,7 @@
### 获取组织架构(部门-人员树) ### 获取组织架构(部门-人员树)
- **用途:** 返回 data 为树形数组,每个节点包含 id-部门ID、label-部门名称、children-子节点数组。子节点包含部门或人员,人员节点包含 id-用户ID、label-用户姓名。 - **用途:** 返回 data 为树形数组,每个节点包含 id-部门ID、label-部门名称、children-子节点数组。子节点包含部门或人员,人员节点包含 id-用户ID、label-用户姓名。
- **请求:** `GET /gd_dataserver/gd_dataserver/system/getOrgUsers` - **请求:** `GET /gd_dataserver/system/getOrgUsers`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getOrgUsersUsingGET` - **operationId:** `getOrgUsersUsingGET`
@ -44,7 +44,7 @@ _无_
### 获取当前登录用户信息 ### 获取当前登录用户信息
- **用途:** 返回 data 为 SysUser 对象,包含 userId-用户ID、userName-用户名、nickName-昵称、phonenumber-手机号、email-邮箱、dept-部门对象{deptId,deptName}等字段。 - **用途:** 返回 data 为 SysUser 对象,包含 userId-用户ID、userName-用户名、nickName-昵称、phonenumber-手机号、email-邮箱、dept-部门对象{deptId,deptName}等字段。
- **请求:** `GET /gd_dataserver/gd_dataserver/system/getTokenUser` - **请求:** `GET /gd_dataserver/system/getTokenUser`
- **鉴权:** `X-Access-Token`(以接口定义为准) - **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `getTokenUserUsingGET` - **operationId:** `getTokenUserUsingGET`

62
docs/api/modules/99-module-28.md

@ -0,0 +1,62 @@
# sys-dept-controller
本模块共 2 个接口。源文件:`api.json`。
## 快速索引
| 接口名称 | 方法 | 路径 | 用途 |
| --- | --- | --- | --- |
| 获取所有厂区级部门列表 | GET | `/gd_dataserver/system/dept/factoryList` | 返回部门树中第二层(二级)的所有部门,供超级管理员在下拉框中选择厂区。厂区级定义:父节点为根级部门(parentId=0)的部门。 |
| 获取当前用户所属厂区部门 | GET | `/gd_dataserver/system/dept/myFactory` | 根据当前登录用户的部门信息,向上回溯到厂区级(二级)部门并返回。适用于非超级管理员获取自己所属厂区。返回 data 为 SysDept 对象,包含 deptId、deptName 等字段。 |
## 接口详情
### 获取所有厂区级部门列表
- **用途:** 返回部门树中第二层(二级)的所有部门,供超级管理员在下拉框中选择厂区。厂区级定义:父节点为根级部门(parentId=0)的部门。
- **请求:** `GET /gd_dataserver/system/dept/factoryList`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `factoryListUsingGET`
参数:
_无_
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
### 获取当前用户所属厂区部门
- **用途:** 根据当前登录用户的部门信息,向上回溯到厂区级(二级)部门并返回。适用于非超级管理员获取自己所属厂区。返回 data 为 SysDept 对象,包含 deptId、deptName 等字段。
- **请求:** `GET /gd_dataserver/system/dept/myFactory`
- **鉴权:** `X-Access-Token`(以接口定义为准)
- **operationId:** `myFactoryUsingGET`
参数:
_无_
响应:
| 状态码 | 说明 | 响应模型 |
| --- | --- | --- |
| 200 | OK | */*: object<string, object> |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |

86
docs/api/page-api-map.md

@ -2,7 +2,7 @@
本文件按前端页面整理接口用途和页面字段。后续开发页面时,先从这里定位接口,再到 [API 接口资料中心](./README.md) 的对应模块查看完整参数。 本文件按前端页面整理接口用途和页面字段。后续开发页面时,先从这里定位接口,再到 [API 接口资料中心](./README.md) 的对应模块查看完整参数。
> 接口路径按 `api.json` 原样记录。实际请求时需要结合项目 `VUE_APP_BASE_API` 判断是否移除重复的 `/gd_dataserver` 前缀。 > 接口路径按 `api.json` 原样记录(单前缀 `/gd_dataserver`)。实际请求时结合项目 `VUE_APP_BASE_API` 拼接,前端 `src/api` 通常只写业务段路径。
## 隐患审核 ## 隐患审核
@ -10,11 +10,13 @@
| 场景 | 接口名称 | 方法与路径 | 页面建议字段 | | 场景 | 接口名称 | 方法与路径 | 页面建议字段 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 待办/已办分页列表 | 隐患流程待办/已办列表 | `GET /gd_dataserver/gd_dataserver/flowable/hazard/todoList` | `id`、`reportNo`、`hazardName`、`status/statusName`、`hazardLevelName`、`reporterName`、`departmentName`、`createTime`、`canApprove` | | 待办/已办分页列表 | 隐患流程待办/已办列表 | `GET /gd_dataserver/flowable/hazard/todoList` | `id`、`reportNo`、`hazardName`、`status/statusName`、`hazardLevelName`、`reporterName`、`departmentName`、`createTime`、`canApprove` |
| 查看审批详情 | 隐患流程详情 | `GET /gd_dataserver/gd_dataserver/flowable/hazard/detail/{id}` | 隐患完整字段、`flowStatus`、`canApprove`、`isInitiator` | | 查看审批详情 | 隐患流程详情 | `GET /gd_dataserver/flowable/hazard/detail/{id}` | 隐患完整字段、`flowStatus`、`canApprove`、`isInitiator` |
| 同意/驳回 | 审批隐患流程 | `POST /gd_dataserver/gd_dataserver/flowable/hazard/complete` | 请求体重点:`taskId`、`comment`、`result`;`result=1` 同意,`result=2` 退回 | | 获取当前审批任务 | 获取流程详情 | `GET /gd_dataserver/flowable/busiInfo/getProcessDetail` | query `id=flowInstanceId`;从当前任务中取 `taskId/taskName/taskDefKey/executionId` |
| 切换隐患等级 | 切换隐患流程等级 | `POST /gd_dataserver/gd_dataserver/flowable/hazard/switchLevel` | `reportId`、`newHazardLevel`、`switchReason` | | 同意/驳回 | 审批隐患流程 | `POST /gd_dataserver/flowable/hazard/complete` | 请求体重点:`taskId`、`comment`、`result`;`result=1` 同意,`result=2` 退回 |
| 查看附件 | 按隐患ID查附件列表 | `GET /gd_dataserver/gd_dataserver/business/hazard/attachment/{reportId}` | `fileName`、`filePath`、`fileSize`、`fileType`、`attachmentType` | | 切换隐患等级 | 切换隐患流程等级 | `POST /gd_dataserver/flowable/hazard/switchLevel` | `reportId`、`newHazardLevel`、`switchReason` |
| 上传附件 | 上传隐患附件文件 | `POST /gd_dataserver/business/hazard/uploadAttachment` | query `attachmentType`;请求体为 `multipart/form-data`,文件字段为 `files` |
| 查看附件 | 按隐患ID查附件列表 | `GET /gd_dataserver/business/hazard/attachment/{reportId}` | `fileName`、`filePath`、`fileSize`、`fileType`、`attachmentType` |
建议筛选字段:待办/已办类型、隐患编号、隐患名称、隐患等级、状态、上报人、上报时间。 建议筛选字段:待办/已办类型、隐患编号、隐患名称、隐患等级、状态、上报人、上报时间。
@ -24,30 +26,48 @@
| 场景 | 接口名称 | 方法与路径 | 页面建议字段 | | 场景 | 接口名称 | 方法与路径 | 页面建议字段 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 台账分页列表 | 分页查询 | `GET /gd_dataserver/gd_dataserver/business/hazard/getListByPage` | `reportNo`、`hazardName`、`hazardLevelName`、`hazardCategoryName`、`unitName`、`departmentName`、`reporterName`、`statusName`、`pointsAwarded`、`createTime` | | 台账分页列表 | 隐患流程待办/已办列表 | `GET /gd_dataserver/flowable/hazard/todoList` | `reportNo`、`hazardName`、`hazardLevelName`、`hazardCategoryName`、`unitName`、`departmentName`、`reporterName`、`statusName`、`pointsAwarded`、`createTime`、`flowInstanceId`、`canApprove` |
| 查看详情 | 查隐患详情 | `GET /gd_dataserver/gd_dataserver/business/hazard/info/{id}` | `description`、整改信息、审核信息、流程状态和所有台账字段 | | 查看详情 | 查隐患详情 | `GET /gd_dataserver/business/hazard/info/{id}` | `description`、整改信息、审核信息、流程状态和所有台账字段 |
| 导出 | 导出隐患列表Excel | `POST /gd_dataserver/gd_dataserver/business/hazard/export` | 复用列表筛选条件,响应按 Blob 下载 | | 导出 | 导出隐患列表Excel | `POST /gd_dataserver/business/hazard/export` | 复用列表筛选条件,响应按 Blob 下载 |
| 删除 | 删除隐患(级联删除附件) | `DELETE /gd_dataserver/gd_dataserver/business/hazard/{ids}` | `ids`,支持批量;这是破坏性操作,需要二次确认 | | 删除 | 删除隐患(级联删除附件) | `DELETE /gd_dataserver/business/hazard/{ids}` | `ids`,支持批量;这是破坏性操作,需要二次确认 |
| 查看附件 | 按隐患ID查附件列表 | `GET /gd_dataserver/gd_dataserver/business/hazard/attachment/{reportId}` | 附件名称、类型、大小和下载地址 | | 查看附件 | 按隐患ID查附件列表 | `GET /gd_dataserver/business/hazard/attachment/{reportId}` | 附件名称、类型、大小和下载地址 |
当前页面实际使用:`getListByPage`(分页)、`info/{id}`、`attachment/{reportId}`。导出入口暂时隐藏,`export` 封装保留供后续恢复。原始 `api.json` 没有“重试同步/重新推送”接口,台账页面点击该操作时会提示接口缺失,不伪造请求结果;待后端提供路径后替换 `src/api/hazard/ledger.js` 的封装即可。 当前页面实际使用:`getListByPage`(分页)、`info/{id}`、`attachment/{reportId}`。导出入口暂时隐藏,`export` 封装保留供后续恢复。原始 `api.json` 没有“重试同步/重新推送”接口,台账页面点击该操作时会提示接口缺失,不伪造请求结果;待后端提供路径后替换 `src/api/hazard/ledger.js` 的封装即可。
单位筛选项来源(2026-10-08 调整):超级管理员展示“单位”下拉并调用 `GET /system/dept/factoryList`;非管理员隐藏该筛选项,调用 `GET /system/dept/myFactory` 取本厂区并静默作为 `unitId` 过滤;不再使用 `GET /system/user/deptTree`(非管理员无权限)。
建议筛选字段:隐患编号、名称、单位、部门、等级、分类、状态、上报人、发现时间、创建时间。 建议筛选字段:隐患编号、名称、单位、部门、等级、分类、状态、上报人、发现时间、创建时间。
## 积分管理 ## 积分管理
页面位置:`src/views/points/management/index.vue` 页面位置:`src/views/points/management/index.vue`
此名称可能指“账户余额管理”,也可能包含“积分流水”。建议页面使用账户列表为主表,流水放详情抽屉或页签。 当前规划:进入后展示“积分规则、申诉处理、手动调整、流水冲正”四个 Tab,默认展示积分规则;后三个 Tab 暂不可切换。本次先实现积分规则配置,UI 按实际需求调整,不按原型稿强制还原。
| 场景 | 接口名称 | 方法与路径 | 页面建议字段 | | 场景 | 接口名称 | 方法与路径 | 页面建议字段 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 账户分页列表 | 分页查询 | `GET /gd_dataserver/gd_dataserver/business/points/balance/getListByPage` | `userId`、`availableBalance`、`frozenBalance`、`totalIncome`、`totalOutcome`、`updateTime`、`version` | | 规则分页列表 | 分页查询积分规则列表 | `GET /gd_dataserver/business/points/rule/list` | `deptId`、`deptName`、`hazardLevel`(general/major/critical)、`hazardCategory`(A/B/C…档位)、`points`、`enabled`、操作;厂区优先显示名称、其次 ID、均无显示“全局规则”;展示顺序按等级后档位排序 |
| 查询指定用户 | 查询用户积分账户 | `GET /gd_dataserver/gd_dataserver/business/points/balance/getByUserId/{userId}` | 用户积分账户全部字段 | | 指定等级规则列表 | 获取指定等级下的积分规则列表 | `GET /gd_dataserver/business/points/rule/rulesByLevel` | query `hazardLevel`(general/major/critical,必填)、`deptId`(选填,超管可用,传具体ID查该厂区+全局、传 global 仅全局兜底、不传全部厂区);响应 `hazardLevel`、`hazardLevelName`、`root`、`children` |
| 手动补发/扣减 | 手动调整积分(PC管理端) | `POST /gd_dataserver/gd_dataserver/business/points/balance/adjust` | 文档说明需要指定用户及 `points`,但 OpenAPI 请求体只声明单个整数,字段定义不完整;实现前必须与后端确认真实提交格式 | | 厂区筛选 | 获取所有厂区级部门列表 | `GET /gd_dataserver/system/dept/factoryList` | `deptId`、`deptName`;仅超级管理员显示,全部返回数据展开选择 |
| 流水分页列表 | 分页查询 | `GET /gd_dataserver/gd_dataserver/business/points/transaction/getListByPage` | `txnNo`、`userId`、`amount`、`beforeBalance`、`afterBalance`、`bizType`、`bizId`、`operator`、`status`、`createTime` | | 当前厂区 | 获取当前用户所属厂区部门 | `GET /gd_dataserver/system/dept/myFactory` | `deptId`、`deptName`;厂区管理员新增时展示并锁定,加载失败时禁止提交;列表权限由后端自动过滤 |
| 积分冲正 | 积分冲正 | `POST /gd_dataserver/gd_dataserver/business/points/transaction/reverse/{logId}` | `logId` | | 启用/停用 | 启用/禁用积分规则 | `POST /gd_dataserver/business/points/rule/toggleEnabled` | query:`id`、`enabled`(0/1) |
| 积分规则 | 分页查询 | `GET /gd_dataserver/gd_dataserver/business/points/rule/getListByPage` | `ruleCode`、`ruleName`、`hazardLevel`、`hazardCategory`、`points`、`priority`、`enabled` | | 删除 | 删除积分规则 | `GET /gd_dataserver/business/points/rule/deleteById` | query:`id`;二次确认 |
| 详情 | 获取积分规则详情 | `GET /gd_dataserver/business/points/rule/info` | query:`id`;弹窗展示规则对象 |
| 新增 | 新增积分规则 | `POST /gd_dataserver/business/points/rule/add` | JSON:`hazardLevel`、`hazardCategory`、`points`、`ruleName` 必填,`enabled` 默认 1;超级管理员提交所选 `deptId/deptName`,厂区管理员不发送厂区字段并由后端自动填充;`priority` 前端计算当前等级最大值+1但可修改;不传 `createTime/updateTime/id`,`ruleCode` 非必填 |
当前页面超级管理员显示厂区筛选并可选择新增规则所属厂区;厂区管理员不显示厂区筛选,列表请求不传 `deptId`,可以新增、启停和删除本厂区规则。申诉处理、手动调整、流水冲正 Tab 暂不接入接口,保持禁用状态;积分规则不提供编辑功能。
> 前端 `src/api` 请求路径按运行时 `BASE_API` 约定只写业务段路径,例如 `/business/points/rule/list`、`/system/dept/factoryList`;不要重复拼接 `/gd_dataserver`。
## APP 首页数据看板
页面位置:`zhongyouApp/src/screens/home/HomeDashboardScreen.tsx`(数据分析模块)
| 场景 | 接口名称 | 方法与路径 | 页面建议字段 |
| --- | --- | --- | --- |
| 核心指标概览 | 首页-核心指标概览 | `GET /gd_dataserver/business/points/analysis/home/overview` | `pendingAuditCount`、`monthClosedCount`、`todayReportCount`、`todayExchangeCount`、`todayPointsIssued`;管理员统计全部、其它账户仅本厂区 |
| 待办与预警 | 首页-待办与预警 | `GET /gd_dataserver/business/points/analysis/home/todo-warning` | `pendingAuditOver24hCount`、`riskWarningCount`(集中兑换风控预警)、`pendingAppealCount` |
| 近7日趋势与最新上报 | 首页-近7日趋势与最新上报 | `GET /gd_dataserver/business/points/analysis/home/trend-latest` | `trend7d[].date/count`、`latestReports[].id/reportNo/hazardName/hazardLevelName/status/statusName/reporterName/factoryDeptName/createTime`(最新前5条) |
## 隐患流程配置 ## 隐患流程配置
@ -55,12 +75,16 @@
| 场景 | 接口名称 | 方法与路径 | 页面建议字段 | | 场景 | 接口名称 | 方法与路径 | 页面建议字段 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 配置分页列表 | 查询流程模板配置列表 | `GET /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/list` | `id`、`deptName`、`hazardLevelName`、`flowKey`、`flowName`、`status`、`createTime`、`updateTime` | | 配置分页列表 | 查询流程模板配置列表 | `GET /gd_dataserver/flowable/hazardFlowConfig/list` | `id`、`deptName`、`hazardLevelName`、`flowKey`、`flowName`、`status`、`createTime`、`updateTime` |
| 查看详情 | 获取流程模板配置详情 | `GET /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/{id}` | 配置模型全部字段 | | 查看详情 | 获取流程模板配置详情 | `GET /gd_dataserver/flowable/hazardFlowConfig/{id}` | 配置模型全部字段 |
| 新增配置 | 新增流程模板配置 | `POST /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig` | 必填:`deptId`、`hazardLevel`、`flowKey`;可填 `deptName`、`hazardLevelName`、`flowName`、`status` | | 新增配置 | 新增流程模板配置 | `POST /gd_dataserver/flowable/hazardFlowConfig` | 必填:`deptId`、`hazardLevel`、`flowKey`;可填 `deptName`、`hazardLevelName`、`flowName`、`status` |
| 修改配置 | 修改流程模板配置 | `PUT /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig` | 后端说明不可修改厂区ID和隐患等级,编辑时应禁用对应控件 | | 修改配置 | 修改流程模板配置 | `PUT /gd_dataserver/flowable/hazardFlowConfig` | 后端说明不可修改厂区ID和隐患等级,编辑时应禁用对应控件 |
| 停用配置 | 删除流程模板配置 | `DELETE /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/{id}` | 逻辑删除,页面操作文案建议使用“停用” | | 停用配置 | 删除流程模板配置 | `DELETE /gd_dataserver/flowable/hazardFlowConfig/{id}` | 逻辑删除,页面操作文案建议使用“停用” |
| 当前厂区可用配置 | 获取当前厂区已配置的流程模板 | `GET /gd_dataserver/gd_dataserver/flowable/hazardFlowConfig/myFactoryConfigs` | 用于隐患上报时选择等级/流程 | | 当前厂区可用配置 | 获取当前厂区已配置的流程模板 | `GET /gd_dataserver/flowable/hazardFlowConfig/myFactoryConfigs` | 用于隐患上报时选择等级/流程 |
| 超级管理员厂区选项 | 获取所有厂区级部门列表 | `GET /gd_dataserver/system/dept/factoryList` | `deptId`、`deptName`,供筛选和新增弹窗选择 |
| 二级管理员当前厂区 | 获取当前用户所属厂区部门 | `GET /gd_dataserver/system/dept/myFactory` | 回填并禁用厂区控件;新增时不主动提交厂区字段 |
当前页面已实际接入列表、详情、新增、修改、删除和两个厂区接口。列表请求发送 `status` 进行状态筛选;状态列仅以绿色“正常”/灰色“停用”Tag 展示,启停通过编辑弹窗和修改接口更新 `status`;删除仍按现有接口执行。真实分页响应为 `data.list` 和字符串 `data.total`,页面将总数转为数字后交给分页组件。
## 切换日志 ## 切换日志
@ -72,9 +96,9 @@
| 场景 | 接口名称 | 方法与路径 | 备注 | | 场景 | 接口名称 | 方法与路径 | 备注 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 执行切换 | 切换隐患流程等级 | `POST /gd_dataserver/gd_dataserver/flowable/hazard/switchLevel` | 参数:`reportId`、`newHazardLevel`、`switchReason` | | 执行切换 | 切换隐患流程等级 | `POST /gd_dataserver/flowable/hazard/switchLevel` | 参数:`reportId`、`newHazardLevel`、`switchReason` |
| 尝试查询关联审计记录 | 按业务单号查询审计日志 | `GET /gd_dataserver/gd_dataserver/business/audit/log/biz/{bizId}` | 需后端确认流程等级切换是否写入审计日志,以及 `bizId` 是否等于隐患ID | | 尝试查询关联审计记录 | 按业务单号查询审计日志 | `GET /gd_dataserver/business/audit/log/biz/{bizId}` | 需后端确认流程等级切换是否写入审计日志,以及 `bizId` 是否等于隐患ID |
| 通用审计分页 | 分页查询 | `GET /gd_dataserver/gd_dataserver/business/audit/log/getListByPage` | 当前 `operationType` 文档只列举审核通过、积分调整、兑换退款,没有流程切换类型 | | 通用审计分页 | 分页查询 | `GET /gd_dataserver/business/audit/log/getListByPage` | 当前 `operationType` 文档只列举审核通过、积分调整、兑换退款,没有流程切换类型 |
在后端补充/确认接口前,该页面只能保持空白或展示已确认写入审计日志的数据,不能假设存在切换日志字段。 在后端补充/确认接口前,该页面只能保持空白或展示已确认写入审计日志的数据,不能假设存在切换日志字段。
@ -84,10 +108,10 @@
| 场景 | 接口名称 | 方法与路径 | 主要字段 | | 场景 | 接口名称 | 方法与路径 | 主要字段 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| Token查用户 | 根据Token获取用户信息 | `POST /gd_dataserver/gd_dataserver/mall/api/user/info` | 响应:`id`、`userName`、`phone`、`email`、`sex`、`sap` | | Token查用户 | 根据Token获取用户信息 | `POST /gd_dataserver/mall/api/user/info` | 响应:`id`、`userName`、`phone`、`email`、`sex`、`sap` |
| Token查积分 | 根据Token获取用户积分信息 | `POST /gd_dataserver/gd_dataserver/mall/api/user/points` | 请求:`sap`;响应:`integral` 等用户信息 | | Token查积分 | 根据Token获取用户积分信息 | `POST /gd_dataserver/mall/api/user/points` | 请求:`sap`;响应:`integral` 等用户信息 |
| 商城扣积分 | 扣减积分 | `POST /gd_dataserver/gd_dataserver/mall/api/points/deduct` | `sap`、`orderNum`、`integralValue`,同一订单号幂等 | | 商城扣积分 | 扣减积分 | `POST /gd_dataserver/mall/api/points/deduct` | `sap`、`orderNum`、`integralValue`,同一订单号幂等 |
| 商城退款积分 | 退还积分 | `POST /gd_dataserver/gd_dataserver/mall/api/points/refund` | `sap`、`orderNum`、`integralValue`,同一订单号幂等 | | 商城退款积分 | 退还积分 | `POST /gd_dataserver/mall/api/points/refund` | `sap`、`orderNum`、`integralValue`,同一订单号幂等 |
商城接口同时出现全局 `X-Access-Token` 和接口参数 `token` 请求头,实现前需确认是否都必须传。 商城接口同时出现全局 `X-Access-Token` 和接口参数 `token` 请求头,实现前需确认是否都必须传。

29
docs/api/schemas.md

@ -325,6 +325,7 @@
| 字段 | 必填 | 类型 | 说明 | 示例/枚举 | | 字段 | 必填 | 类型 | 说明 | 示例/枚举 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| finishTime | 否 | string / date-time | 完成时间 | - | | finishTime | 否 | string / date-time | 完成时间 | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| itemId | 否 | integer / int64 | 兑换物品ID | - | | itemId | 否 | integer / int64 | 兑换物品ID | - |
@ -351,6 +352,7 @@
| bizId | 否 | string | 业务单号 | - | | bizId | 否 | string | 业务单号 | - |
| bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - | | bizType | 否 | string | 业务类型:REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| operator | 否 | string | 操作人 | - | | operator | 否 | string | 操作人 | - |
| remark | 否 | string | 备注 | - | | remark | 否 | string | 备注 | - |
@ -369,6 +371,8 @@
| attachmentUrls | 否 | string | 附件URL(JSON数组) | - | | attachmentUrls | 否 | string | 附件URL(JSON数组) | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| flowInstanceId | 否 | string | 流程实例ID(预留) | - | | flowInstanceId | 否 | string | 流程实例ID(预留) | - |
| flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - | | flowStatus | 否 | integer / int32 | 流程状态:0-无流程 1-进行中 2-已完成 | - |
| handleRemark | 否 | string | 处理意见/结果说明 | - | | handleRemark | 否 | string | 处理意见/结果说明 | - |
@ -390,9 +394,11 @@
| 字段 | 必填 | 类型 | 说明 | 示例/枚举 | | 字段 | 必填 | 类型 | 说明 | 示例/枚举 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| deptId | 否 | string | 所属厂区部门ID(NULL表示全局兜底规则,二级管理员新增时自动填充) | 100 |
| deptName | 否 | string | 所属厂区部门名称 | 一厂 |
| enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - | | enabled | 否 | integer / int32 | 是否启用:0-禁用 1-启用 | - |
| hazardCategory | 否 | string | 隐患类别 | - | | hazardCategory | 否 | string | 隐患类别 | - |
| hazardLevel | 否 | integer / int32 | 隐患等级 | - | | hazardLevel | 否 | string | 隐患等级编码(general/major/critical) | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| points | 否 | integer / int32 | 奖励积分 | - | | points | 否 | integer / int32 | 奖励积分 | - |
| priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - | | priority | 否 | integer / int32 | 优先级(数字越大优先级越高) | - |
@ -439,10 +445,11 @@
| 字段 | 必填 | 类型 | 说明 | 示例/枚举 | | 字段 | 必填 | 类型 | 说明 | 示例/枚举 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| actualCompleteTime | 否 | string / date-time | 实际完成时间 | - | | actualCompleteTime | 否 | string / date-time | 实际完成时间 | - |
| attachments | 否 | array<隐患附件> | 附件列表 | - |
| auditRemark | 否 | string | 审核备注 | - | | auditRemark | 否 | string | 审核备注 | - |
| auditTime | 否 | string / date-time | 审核时间 | - | | auditTime | 否 | string / date-time | 审核时间 | - |
| auditUserId | 否 | integer / int64 | 审核人用户ID | - | | auditUserId | 否 | integer / int64 | 审核人用户ID | - |
| auditUserNameName | 否 | string | 审核人姓名 | - | | auditUserName | 否 | string | 审核人姓名 | - |
| auditUserUsername | 否 | string | 审核人账号 | - | | auditUserUsername | 否 | string | 审核人账号 | - |
| canApprove | 否 | boolean | 当前用户是否可审批此流程 | false | | canApprove | 否 | boolean | 当前用户是否可审批此流程 | false |
| causeAnalysis | 否 | string | 原因分析 | - | | causeAnalysis | 否 | string | 原因分析 | - |
@ -451,6 +458,8 @@
| chargePersonUsername | 否 | string | 整改负责人账号 | - | | chargePersonUsername | 否 | string | 整改负责人账号 | - |
| createBy | 否 | string | 创建者 | - | | createBy | 否 | string | 创建者 | - |
| createTime | 否 | string / date-time | 创建时间 | - | | createTime | 否 | string / date-time | 创建时间 | - |
| criteriaIds | 否 | string | 判定标准ID(多选,逗号分隔) | - |
| criteriaNames | 否 | string | 判定标准名称 | - |
| currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - | | currentFlowLevel | 否 | string | 当前流程等级编码(general/major/critical) | - |
| departmentId | 否 | integer / int64 | 部门ID | - | | departmentId | 否 | integer / int64 | 部门ID | - |
| departmentName | 否 | string | 部门名称 | - | | departmentName | 否 | string | 部门名称 | - |
@ -459,6 +468,10 @@
| discoverTime | 否 | string / date-time | 发现时间 | - | | discoverTime | 否 | string / date-time | 发现时间 | - |
| factoryDeptId | 否 | string | 所属厂区部门ID | - | | factoryDeptId | 否 | string | 所属厂区部门ID | - |
| factoryDeptName | 否 | string | 所属厂区部门名称 | - | | factoryDeptName | 否 | string | 所属厂区部门名称 | - |
| factoryManagerId | 否 | integer / int64 | 厂区管理员用户ID | - |
| factoryManagerName | 否 | string | 厂区管理员姓名 | - |
| finalFlowLevel | 否 | string | 审批最终等级名称(如一般-A档) | - |
| finalFlowLevelId | 否 | integer / int64 | 审批最终积分规则ID(关联积分规则表) | - |
| flowInstanceId | 否 | string | 流程实例id | - | | flowInstanceId | 否 | string | 流程实例id | - |
| flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - | | flowStatus | 否 | integer / int32 | 流程状态(0-未开始 1-进行中 2-已完成) | - |
| fundsSource | 否 | string | 资金来源编码 | - | | fundsSource | 否 | string | 资金来源编码 | - |
@ -467,9 +480,10 @@
| governanceType | 否 | string | 治理类型编码 | - | | governanceType | 否 | string | 治理类型编码 | - |
| governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - | | governanceTypeId | 否 | integer / int64 | 治理类型字典ID | - |
| governanceTypeName | 否 | string | 治理类型名称 | - | | governanceTypeName | 否 | string | 治理类型名称 | - |
| hazardCategory | 否 | string | 隐患分类编码 | - | | hazardCategory | 否 | string | 隐患分类编码(general/major/critical) | - |
| hazardCategoryId | 否 | integer / int64 | 隐患分类字典ID | - | | hazardCategoryId | 否 | integer / int64 | 隐患分类根规则ID(关联积分规则表) | - |
| hazardCategoryName | 否 | string | 隐患分类名称 | - | | hazardCategoryName | 否 | string | 隐患分类名称 | - |
| hazardClassificationStandard | 否 | string | 隐患分类标准(文本说明,用于隐患分类的说明) | - |
| hazardLevel | 否 | string | 管理级别编码 | - | | hazardLevel | 否 | string | 管理级别编码 | - |
| hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - | | hazardLevelId | 否 | integer / int64 | 管理级别字典ID | - |
| hazardLevelName | 否 | string | 管理级别名称 | - | | hazardLevelName | 否 | string | 管理级别名称 | - |
@ -521,6 +535,7 @@
| 字段 | 必填 | 类型 | 说明 | 示例/枚举 | | 字段 | 必填 | 类型 | 说明 | 示例/枚举 |
| --- | --- | --- | --- | --- | | --- | --- | --- | --- | --- |
| bizType | 是 | string | 业务类型(report-上报/appeal-申诉/rectify-整改/verify-验收),不传默认report | report |
| createBy | 否 | string | - | - | | createBy | 否 | string | - | - |
| createByName | 否 | string | - | - | | createByName | 否 | string | - | - |
| createTime | 否 | string / date-time | - | - | | createTime | 否 | string / date-time | - | - |
@ -528,7 +543,7 @@
| deptName | 否 | string | 部门名称 | 一厂 | | deptName | 否 | string | 部门名称 | 一厂 |
| flowKey | 是 | string | Flowable流程定义Key | hazard_general_flow | | flowKey | 是 | string | Flowable流程定义Key | hazard_general_flow |
| flowName | 否 | string | 流程名称 | 一般隐患奖励审批流程 | | flowName | 否 | string | 流程名称 | 一般隐患奖励审批流程 |
| hazardLevel | 是 | string | 隐患等级编码(general-一般/major-较大/critical-重大) | general | | hazardLevel | 是 | string | 隐患等级编码(report类型:general-一般/major-较大/critical-重大;appeal/rectify/verify等非report类型固定为default,新增时后端会无条件强制置为default) | general |
| hazardLevelName | 否 | string | 隐患等级名称 | 一般隐患 | | hazardLevelName | 否 | string | 隐患等级名称 | 一般隐患 |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| params | 否 | object | - | - | | params | 否 | object | - | - |
@ -548,6 +563,7 @@
| filePath | 否 | string | 文件存储路径 | - | | filePath | 否 | string | 文件存储路径 | - |
| fileSize | 否 | integer / int64 | 文件大小(字节) | - | | fileSize | 否 | integer / int64 | 文件大小(字节) | - |
| fileType | 否 | string | 文件MIME类型 | - | | fileType | 否 | string | 文件MIME类型 | - |
| fileUrl | 否 | string | 文件访问URL | - |
| id | 否 | integer / int64 | 主键ID | - | | id | 否 | integer / int64 | 主键ID | - |
| remark | 否 | string | 备注 | - | | remark | 否 | string | 备注 | - |
| reportId | 否 | integer / int64 | 关联隐患ID | - | | reportId | 否 | integer / int64 | 关联隐患ID | - |
@ -555,4 +571,5 @@
| suffix | 否 | string | 文件后缀 | - | | suffix | 否 | string | 文件后缀 | - |
| updateBy | 否 | string | 更新者 | - | | updateBy | 否 | string | 更新者 | - |
| updateTime | 否 | string / date-time | 更新时间 | - | | updateTime | 否 | string / date-time | 更新时间 | - |
| uploadUserId | 否 | integer / int64 | 上传人用户ID | - | | uploadUserId | 否 | string | 上传人用户ID | - |
| uploadUserName | 否 | string | 上传人姓名 | - |

40
docs/development/CURRENT_STATUS.md

@ -1,36 +1,52 @@
# 当前开发状态 # 当前开发状态
更新时间:2026-09-05 更新时间:2026-10-08
## 已完成的基础改造 ## 已完成的基础改造
- 已完成管理后台原型视觉统一第一阶段:移除固定 1920×1080 全局缩放,后台恢复流式布局。
- 登录页已移除固定 1920×1080 登录画布和负边距定位,登录框改为视口 Flex 居中,并补充窄屏安全边距和低高度滚动。
- Token 过期、获取用户信息失败和主动退出已不再回跳废弃的 `/index`;登录页会过滤历史无效回跳地址,默认进入 `/hazard/ledger`。
- 默认浅色布局已统一为 212px 左侧栏、52px Header、`#F0F2F5` 页面背景和紧凑型菜单密度。
- 新增共享原型主题样式,统一 Card、Table、Form、Input、Button、Tag、Dialog、Switch 和 Pagination;默认表格字号改为 12px。
- 积分管理、隐患台账和隐患审核页面已同步修正旧的 84px 顶部高度、背景色和局部文字颜色;隐患台账主列表已进一步切换为新版 `DataListPanel` Card Table,保留全部业务并支持列宽拖拽。
- 用户管理已完成 Card 列表试点:保留左侧部门树,右侧使用顶部筛选和批量操作、无竖向单元格线、紧凑分页、统一按钮和状态标签。
- 角色管理列表已完成 Card 列表改造:保留原有全宽列表结构和全部功能,不增加用户管理的左侧部门树;筛选、批量操作、表格、状态开关、行内操作和分页与用户管理统一。
- 角色管理行末已恢复省略号“更多操作”入口,继续提供数据权限和分配用户;`DataListPanel` 新增默认关闭的 `modern-table` 模式,隐患台账加入后共 17 个新版 Card 主列表显式开启并保持无竖线视觉及表头拖拽,旧表格默认样式不受影响。
- 系统监控下未改新版 UI 的在线用户、定时任务、调度日志和缓存列表已显式恢复 Element UI 旧式竖线及表头列宽拖拽;操作日志和登录日志继续使用新版无竖线模式。
- 菜单、部门、岗位、字典、参数、通知公告、操作日志、登录日志已完成 Card 列表 UI 替换;各页面原有树形层级、分页、排序、缓存刷新、清空、解锁、详情、弹窗和权限逻辑均保持不变。
- 积分管理的积分规则列表已统一为 `DataListPanel` Card 风格;规则匹配说明位于标题下,底部版本按钮及档位标准说明已按确认稿完成布局和主次配色,按钮仍为未接接口提示。
- 积分规则现支持厂区管理员新增、启停和删除本厂区规则;新增弹窗展示并锁定当前厂区,后端自动填充归属,规则名称为必填。列表已增加厂区列,超级管理员原厂区筛选和选择逻辑保持不变。
- 流程管理下流程监听、流程定义、表单配置、流程表达式的主列表已统一为 `DataListPanel` Card 风格;原筛选、分页、操作、权限、弹窗及流程定义页子表格保持不变。
- 隐患流程配置已完成 `DataListPanel` Card 列表、厂区/等级/状态筛选、分页、新增、修改和删除;列表状态使用绿色/灰色 Tag 展示,超级管理员可选择全部厂区,二级管理员展示并锁定所属厂区。
- 隐患台账单位筛选已按角色分流:超级管理员显示单位下拉并用 `GET /system/dept/factoryList`,非管理员隐藏单位筛选并按 `GET /system/dept/myFactory` 静默过滤本厂区,不再请求非管理员无权限的 `/system/user/deptTree`;`/system/dept/factoryList`、`/system/dept/myFactory` 封装已归位到 `src/api/system/dept.js` 并去重。
- 新增跨业务 `DataListPanel` 公共组件,后续系统管理列表可以直接复用筛选、操作、列表和分页插槽结构。
- 页面布局已改为左侧导航:一级、二级菜单都在左侧。 - 页面布局已改为左侧导航:一级、二级菜单都在左侧。
- Logo 已移动到左侧菜单顶部。 - Logo 已移动到左侧菜单顶部。
- Header 保留折叠按钮、面包屑、消息、APK 和用户区域。 - Header 保留折叠按钮、面包屑、消息、APK 和用户区域。
- 默认使用浅色主题,同时保留布局设置中的明暗主题切换。 - 默认使用浅色主题,同时保留布局设置中的明暗主题切换。
- 已处理展开、折叠和移动端 Header 宽度联动。 - 已处理展开、折叠和移动端 Header 宽度联动。
- 生产构建脚本已加入 Node 22/OpenSSL 3 兼容参数。 - 生产构建脚本已加入 Node 22/OpenSSL 3 兼容参数。
- `api.json` 已生成 27 个模块、278 个接口和 32 个模型的本地文档。 - `api.json` 已生成 28 个模块、278 个接口和 32 个模型的本地文档(2026-09-08 重新生成)。
- 登录成功且无指定回跳地址时,默认进入隐患台账 `/hazard/ledger`;根路径也统一重定向至该页面,并以隐藏基础路由保证首次登录时可解析。
## 已创建但尚未开发业务功能的页面 ## 重点业务页面状态
| 页面 | 文件 | 菜单组件路径 | 当前状态 | | 页面 | 文件 | 菜单组件路径 | 当前状态 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| 隐患审核 | `src/views/hazard/audit/index.vue` | `hazard/audit/index` | 空白页面,未封装接口 | | 隐患审核 | `src/views/hazard/audit/index.vue` | `hazard/audit/index` | 已完成隐患详情/附件展示、平台字段补录、通过/驳回/等级切换,并接入 `getProcessDetail` 自动补齐审批 `taskId`;已在左侧菜单隐藏,仅由台账“去审核”等入口携带参数进入 |
| 隐患台账 | `src/views/hazard/ledger/index.vue` | `hazard/ledger/index` | 已完成台账分页、筛选、详情弹窗、附件和审核入口;生产构建已通过;同步重试等待后端接口 | | 隐患台账 | `src/views/hazard/ledger/index.vue` | `hazard/ledger/index` | 已完成新版 Card Table、五态筛选/Tag、分页、详情弹窗和审核入口;列表已切换为 `/flowable/hazard/todoList`;单位筛选按角色使用 `factoryList`/`myFactory`;附件九宫格支持大图预览;平台同步列暂时隐藏;同步重试等待后端接口 |
| 积分管理 | `src/views/points/management/index.vue` | `points/management/index` | 空白页面,未封装接口 | | 积分管理 | `src/views/points/management/index.vue` | `points/management/index` | 已完成积分规则 Tab、统一 Card 列表、厂区列、分页、详情、新增、启停和删除;超管可筛选/选择厂区,厂区管理员可管理本厂区规则;其余 Tab 暂禁用 |
| 隐患流程配置 | `src/views/flowable/hazardConfig/index.vue` | `flowable/hazardConfig/index` | 空白页面,未封装接口 | | 隐患流程配置 | `src/views/flowable/hazardConfig/index.vue` | `flowable/hazardConfig/index` | 已完成列表、筛选、分页、新增、修改、状态 Tag、删除和厂区权限展示;新增“流程类型”字段(`bizType`,字典 `flow_biz_type`)并在列表以 Tag 展示;分页按真实 `data.list/data.total` 解析 |
| 切换日志 | `src/views/flowable/switchLog/index.vue` | `flowable/switchLog/index` | 空白页面,无明确列表接口 | | 切换日志 | `src/views/flowable/switchLog/index.vue` | `flowable/switchLog/index` | 空白页面,无明确列表接口 |
以上页面均有同级 `components/` 目录,用于放页面专用组件。 以上页面均有同级 `components/` 目录,用于放页面专用组件。
## 建议开发顺序 ## 建议开发顺序
1. 隐患流程配置:接口最完整,包含列表、详情、新增、修改和停用。 1. 隐患审核:需要确认待办/已办筛选参数和审批真实响应。
2. 隐患台账:列表、详情、附件和导出接口较完整。 2. 切换日志:等待后端提供日志列表接口,或确认流程切换已经写入操作审计日志。
3. 隐患审核:需要确认待办/已办筛选参数和审批真实响应。 3. 积分管理其余 Tab:确认申诉、手动调整和流水冲正的具体范围与请求结构。
4. 积分管理:先确认页面范围是账户、流水、规则中的哪些模块,并确认手动调整积分请求格式。
5. 切换日志:等待后端提供日志列表接口,或确认流程切换已经写入操作审计日志。
## 已知风险和待确认项 ## 已知风险和待确认项

724
docs/development/CURRENT_TASK.md

@ -1,6 +1,728 @@
# 当前开发任务 # 当前开发任务
状态:隐患台账页面已完成,生产构建已验证(2026-09-05;同步重试接口待后端提供) ## 隐患审核积分档位按厂区查询(2026-10-08)
### 1. 问题
- 审核页“积分档位”下拉为空,且显示裸规则ID(如 `2108048530124234754`)。
- 根因:`rulesByLevel` 未按隐患所属厂区查询;超级管理员没有厂区上下文 → 返回空 `children`,`el-select` 无匹配项时退化为显示绑定值(规则ID)。而 `trialCalculate` 带了 `deptId = report.factoryDeptId` 所以能命中规则。
### 2. 实施
- `src/api/points/rule.js`:`getRulesByLevel(params)` 改为接收参数对象,支持传入 `deptId`。
- `src/views/hazard/audit/components/AuditActionForm.vue`:调用 `rulesByLevel` 时补传 `deptId = report.factoryDeptId`(与 `trialCalculate` 口径一致);新增 `applyTierFallback()`,当档位列表为空但详情已有 `finalFlowLevelId` 时,用详情档位兜底成一个 option,避免显示裸 ID。
### 3. 完成结果
- 完成内容:档位下拉按隐患所属厂区查询;列表为空时用详情档位兜底展示;`trialCalculate` 取 `data.calculatedPoints` 的既有逻辑不变。
- 实际使用接口:`GET /business/points/rule/rulesByLevel`(新增 `deptId` 参数)、`GET /business/points/rule/trialCalculate`。
- 依赖:后端已为 `rulesByLevel` 增加 `deptId`(客户确认线上已更新)。
- 验证:无诊断错误,`npm run build:prod` 通过,仅有既有资源体积 warning。
## 左侧菜单隐藏“隐患审核”(2026-10-08)
### 1. 用户目标
- 在左侧菜单隐藏“隐患治理 → 隐患审核”;页面本身仍通过台账“去审核”等入口携带参数进入。
### 2. 实施与结果
- 菜单由后端菜单接口下发,前端在 `src/store/modules/permission.js` 的 `GenerateRoutes` 中,对“仅用于侧栏展示”的路由副本调用新增的 `filterHiddenSidebarRoutes()`,按组件路径 `hazard/audit/index`(或标题“隐患审核”)剔除。
- 未改动 `rewriteRoutes` 的路由注册,`/hazard/audit` 及基础路由 `/hazard/audit/detail` 仍可跳转,台账“去审核”不受影响。
- 验证:无诊断错误,`npm run build:prod` 通过,仅有既有资源体积 warning。
## 隐患流程配置新增“流程类型”字段并列表展示(2026-10-08)
### 1. 用户目标
- 在新增/修改弹窗中新增“流程类型”字段 `bizType`,下拉选项来自字典 `flow_biz_type`,提交时取字典项键值。
- 列表新增“流程类型”列,用 Tag 展示;旧数据无该字段或为空时显示 `-`。
### 2. 接口字段
- `api.json` 中 `隐患流程模板配置` 请求体字段为 `bizType`(report-上报/appeal-申诉/rectify-整改/verify-验收,不传默认 report),非下划线 `biz_type`。
- 提交接口 `POST /flowable/hazardFlowConfig`、`PUT /flowable/hazardFlowConfig`;列表/详情返回含 `bizType`。
### 3. 完成结果
- 弹窗新增“流程类型”下拉(字典 `flow_biz_type`,值取字典项 `value`),组件注册 `dicts: ['flow_biz_type']`;`createEmptyForm`/`normalizeForm`/`formRules`/`buildPayload` 均已纳入 `bizType`。
- 列表在“厂区名称”后新增“流程类型”列,Tag 展示;`bizTypeLabel(row)` 用字典 `flow_biz_type` 反查 label,字段为空时返回空串由模板显示 `-`。
- 验证结果:无诊断错误,`npm run build:prod` 通过,仅有既有资源体积 warning。
## 隐患台账非管理员单位筛选改用 myFactory 并归位 /system/dept 封装(2026-10-08)
### 1. 用户目标
- 修复非管理员进入隐患台账时右上角弹窗提示“当前操作没有权限”。
- 非管理员只看本厂区,不再查询部门树;改用 `/system/dept/myFactory` 直接取当前用户所属厂区并填入单位筛选。
- 顺带把 `/system/dept/factoryList`、`/system/dept/myFactory` 的封装从业务文件归位到 `src/api/system/dept.js`,消除重复定义。
### 2. 原因
- `src/views/hazard/ledger/index.vue` 的 `getUnits()` 调用 `deptTreeSelect()`(`GET /system/user/deptTree`),该接口属用户管理权限(`system:user:list`),非管理员无权访问;且该路径不在最新 `api.json` 中。
- 后端返回 `code=403 / msg="当前操作没有权限"`,请求拦截器在 `code !== 200` 分支用 `Notification.error` 展示,即右上角弹窗。
### 3. 接口计划
| 页面动作 | 接口名称 | 方法 | 前端请求路径 | 确认状态 |
| --- | --- | --- | --- | --- |
| 管理员单位下拉 | 获取所有厂区级部门列表 | GET | `/system/dept/factoryList` | 已确认 |
| 非管理员单位 | 获取当前用户所属厂区部门 | GET | `/system/dept/myFactory` | 已确认 |
| 台账分页 | 隐患流程待办/已办列表 | GET | `/flowable/hazard/todoList` | 不变 |
| ~~单位来源(旧)~~ | ~~用户部门树~~ | GET | ~~`/system/user/deptTree`~~ | 移除,非管理员无权限且不在 api.json |
### 4. 实施步骤
1. 在 `src/api/system/dept.js` 新增 `listFactoryDepartments()`、`getMyFactoryDepartment()`。
2. 从 `src/api/flowable/hazardConfig.js`、`src/api/points/rule.js` 删除重复定义。
3. 更新 `flowable/hazardConfig/index.vue`、`points/management/index.vue` 的 import 指向 `@/api/system/dept`。
4. 台账页 `getUnits()` 按角色分流:管理员用 `factoryList`,非管理员用 `myFactory`;非管理员隐藏“单位”筛选项,仅静默按本厂区过滤。
5. `created` 改为先取厂区再 `getList()`,保证非管理员首屏查询带上 `unitId`。
### 5. 完成结果
- 实际完成:台账页非管理员不再请求 `/system/user/deptTree`,单位筛选项直接隐藏并静默按 `myFactory` 本厂区过滤;管理员使用 `factoryList`;两个 dept 封装已归位去重。
- 实际使用接口:`GET /system/dept/myFactory`(非管理员)、`GET /system/dept/factoryList`(管理员);台账列表仍为 `GET /flowable/hazard/todoList`。
- 验证结果:相关文件无诊断错误,`npm run build:prod` 通过,仅有项目既有资源体积 warning。
- 待联调确认:后端 `todoList` 是否接受并按 `unitId` 过滤非管理员数据。
## 隐患台账切换待办接口并自动补齐审批 taskId(2026-09-19)
### 1. 用户目标
- 隐患台账列表改用后端提供的 `/flowable/hazard/todoList`。
- “去审核”不再要求或传 `taskId`,只传隐患 `id`。
- 审核页加载详情后,通过 `flowInstanceId` 调 `getProcessDetail` 自动补齐当前审批任务的 `taskId`。
### 2. 已实施
- `src/api/hazard/ledger.js` 的 `listHazardLedger` 由 `/business/hazard/getListByPage` 改为 `/flowable/hazard/todoList`。
- `src/views/hazard/ledger/index.vue` 的 `goAudit` 只携带 `id`。
- `src/api/hazard/audit.js` 新增 `getHazardProcessDetail(flowInstanceId)`,路径 `/flowable/busiInfo/getProcessDetail`。
- `src/views/hazard/audit/index.vue` 在详情加载后按 `canApprove` 和 `flowInstanceId` 调流程详情,补齐 `taskId`;缺失时仅禁用审批动作,不阻断详情展示。
- 台账跳转补充 `canApprove/flowInstanceId`;Web 审核页上传附件改为 `/business/hazard/uploadAttachment` 的 `multipart/form-data` 请求;App 上传同步改为 multipart,字段名使用 `files`。
### 3. 待联调确认
- `getProcessDetail` 真实响应结构(数组或 `list/rows/records/tasks/taskList/flowList/data`)及“当前任务”筛选规则。
- `complete` 是否需要除 `taskId/instanceId/comment/result` 外的 `taskName/userId/userName/variables/candidateUsers` 等 `TaskVo` 字段。
## 积分规则支持厂区管理员管理并增加厂区列(2026-09-18)
### 1. 用户目标
- 厂区管理员可以管理自己厂区的积分规则,包括新增、启用/停用和删除;超级管理员继续按现有方式筛选厂区并在新增时选择厂区。
- 积分规则列表增加“厂区”列,依次使用 `deptName`、`deptId` 展示,无厂区信息时显示“全局规则”。
- 新建积分规则时“规则名称”改为必填,并继续通过现有 `ruleName` 字段提交。
- 不增加积分规则编辑能力,不改动其余积分管理 Tab、分页和现有前端排序逻辑。
### 2. 当前代码状态
- 页面 `src/views/points/management/index.vue` 仅向超级管理员显示“新建”,新增弹窗只使用 `factoryList`,厂区管理员无法选择或展示所属厂区。
- `src/api/points/rule.js` 已封装规则列表、新增、详情、启停、删除和全部厂区接口,尚未封装当前用户所属厂区接口。
- 启停和删除按钮已向页面用户开放,后端接口按登录用户校验规则归属;页面无需增加前端归属判断。
- 工作区已有 API 文档、开发文档、隐患台账和登录页等用户改动;本任务只增量修改积分规则页面、对应 API 和指定交接文档,不回退或格式化无关文件。
### 3. 接口计划
| 页面动作 | 接口名称 | 方法 | 前端请求路径 | 请求字段 | 响应字段 | 确认状态 |
| --- | --- | --- | --- | --- | --- | --- |
| 规则分页 | 分页查询积分规则列表 | GET | `/business/points/rule/list` | `pageNum/pageSize/hazardLevel/enabled`;仅超级管理员可传 `deptId` | `data.list/rows`、`data.total/totalCount`,规则含 `deptId/deptName` | 已确认;二级管理员由后端自动过滤本厂区 |
| 全部厂区 | 获取所有厂区级部门列表 | GET | `/system/dept/factoryList` | 无 | 厂区数组,字段 `deptId/deptName` | 已确认;仅超级管理员调用 |
| 当前厂区 | 获取当前用户所属厂区部门 | GET | `/system/dept/myFactory` | 无 | `data` 为含 `deptId/deptName` 的部门对象 | 已确认;厂区管理员展示新增所属厂区 |
| 新增规则 | 新增积分规则 | POST | `/business/points/rule/add` | 规则字段;超级管理员附带 `deptId/deptName`,厂区管理员不发送厂区字段 | 通用响应 | 已确认;厂区管理员由后端自动填充厂区 |
| 启停规则 | 启用/禁用积分规则 | POST | `/business/points/rule/toggleEnabled` | query:`id/enabled` | 通用响应 | 已确认;后端校验本厂区归属 |
| 删除规则 | 删除积分规则 | GET | `/business/points/rule/deleteById` | query:`id` | 通用响应 | 已确认;后端校验本厂区归属 |
### 4. 页面字段映射
| UI 文案 | 前端字段 | 接口字段 | 展示/编辑规则 | 字典或枚举 |
| --- | --- | --- | --- | --- |
| 厂区 | `deptName/deptId` | `deptName/deptId` | 列表优先名称、其次 ID、均无则“全局规则”;超管新增可选,厂区管理员显示当前厂区并禁用 | 无 |
| 隐患等级 | `hazardLevel` | `hazardLevel` | 保持原下拉、Tag 和排序 | `general/major/critical` |
| 档位 | `hazardCategory` | `hazardCategory` | 保持原字母生成、校验和排序 | A-Z、AA… |
| 积分/状态 | `points/enabled` | `points/enabled` | 保持原整数输入与启停 Switch | `enabled` 为 0/1 |
| 规则名称 | `ruleName` | `ruleName` | 新建必填,去除首尾空格后提交 | 无 |
### 5. 实施步骤
1. 在积分规则 API 中增加 `getMyFactoryDepartment()`,复用现有请求封装约定。
2. 页面统一开放新增入口;按角色加载全部厂区或当前厂区,并在厂区管理员新增弹窗中回填、禁用所属厂区。
3. 非超级管理员列表请求删除 `deptId`,新增 payload 不包含 `deptId/deptName`;当前厂区未成功加载时阻止提交。
4. 表格增加厂区列,保留其余 Tab、分页、排序、详情、启停和删除逻辑。
5. 完成定向静态检查、生产构建和 `git diff --check`,更新状态、日志和页面接口映射。
### 6. 风险与待确认
- 厂区管理员的真实菜单授权和后端数据权限需要使用实际账号联调;本任务只按已确认接口契约接入,不声称完成真实账号验证。
- 列表响应可能只返回 `deptId`;页面按要求回退展示 ID。两者都不存在时按全局规则展示,不据此前端推断权限。
- 当前厂区接口失败时页面会保留明确错误提示并禁止厂区管理员提交新增,避免发出归属不明确的请求。
### 7. 验收方式
- [x] 超级管理员保留厂区筛选、全部厂区加载和新增时选择厂区的现有行为。
- [x] 厂区管理员可以打开新增弹窗,看到禁用的所属厂区;新增请求不发送 `deptId/deptName`,所属厂区加载失败时不能提交。
- [x] 厂区管理员列表查询不发送 `deptId`,启停和删除继续调用原接口。
- [x] 列表新增厂区列,名称、ID 和全局规则三种展示兜底正确。
- [x] 不出现编辑入口或更新接口,其余 Tab、分页和排序逻辑不变。
- [x] 新建表单未填写规则名称时不能提交,并显示必填提示。
- [x] 定向静态检查、生产构建和 `git diff --check` 完成。
- [x] `CURRENT_STATUS.md`、`DEVELOPMENT_LOG.md` 和 `page-api-map.md` 已更新。
### 8. 完成结果
- 实际完成:新增入口已对厂区管理员开放;按角色加载全部厂区或当前厂区,厂区管理员的新增厂区只读且加载失败时无法提交;列表增加厂区列;规则名称改为必填。未增加规则编辑能力。
- 实际使用接口:新增接入 `GET /system/dept/myFactory`;继续使用规则列表、新增、详情、启停、删除和超级管理员 `factoryList` 接口。厂区管理员列表与新增请求均不发送厂区字段。
- 验证结果:API 文件定向 ESLint 通过,生产构建和 `git diff --check` 通过;构建仅有项目既有 warning。积分页面整文件 ESLint 仍报告既有压缩模板及双引号/分号等格式问题,本次未做无关格式化。
- 遗留事项:尚未使用真实超级管理员和厂区管理员账号完成端到端联调,需要测试环境核对菜单权限、后端数据过滤和归属校验。
## 隐患台账状态与附件展示调整(2026-09-15)
### 1. 目标与范围
- 列表状态改为后端字典实际值:`draft`=待提交、`reviewing`=审核中、`rectifying`=整改中、`approved`=已通过、`rejected`=已驳回。
- 仅审核中记录显示“去审核”,筛选项、状态 Tag、当前页统计、详情状态和底部说明同步使用上述五态文案。
- 暂时注释主列表“平台同步”列;同步相关字段、方法和重试入口保留,后续可直接恢复。
- 详情附件改为三列图片九宫格,点击缩略图使用 Element UI 图片查看器预览同组大图;非图片附件保留文件块和打开入口。
### 2. 接口与字段
- 不新增或修改接口,继续使用 `GET /business/hazard/getListByPage`、`GET /business/hazard/info/{id}` 和 `GET /business/hazard/attachment/{reportId}`。
- 附件地址优先读取 `fileUrl`,其次 `filePath`;完整 HTTP(S) 地址直接使用,相对路径拼接 `MyConfig.BASE_API`。
- 图片判断兼容 `attachmentType=IMAGE`、`fileType=image/*` 和常见图片扩展名;无法识别为图片的附件不进入大图预览列表。
### 3. 验收
- [x] 五个状态筛选、Tag、统计和详情文案一致,只有审核中显示“去审核”。
- [x] 平台同步列不显示,相关代码仍可恢复。
- [x] 图片附件按三列展示,点击可从当前图片开始预览并切换同组图片;非图片附件仍可打开。
- [x] 单文件 ESLint、开发热编译、生产构建和 `git diff --check` 通过。
### 4. 完成结果
- 已将状态统一为待提交、审核中、整改中、已通过、已驳回;兼容识别历史数字状态和旧名称,但页面展示及审核按钮均按新状态执行。
- 已注释主表平台同步列,保留同步字段、方法和重试逻辑;详情流程字段暂不受影响。
- 详情附件已按图片三列九宫格展示,使用 Element UI `el-image` 大图预览并支持同组切换;非图片附件保留可打开文件块。
- 单文件 ESLint、Vue 模板编译、生产构建和 `git diff --check` 通过;构建仅有项目既有资源体积 warning。
## 隐患台账新版 Table UI 改造(2026-09-15)
### 1. 目标与范围
- 将 `src/views/hazard/ledger/index.vue` 的主列表由独立筛选栏和 `el-card` 改为统一的 `<data-list-panel modern-table>` 结构。
- 筛选条件放入 filters,当前筛选/本页状态统计放入 actions;表格、分页和状态说明分别进入主内容及 footer。
- 主表增加 Element UI 原生 `border` 以支持列宽拖拽,由 `modern-table` 模式隐藏外框和竖向分隔线;移除旧式斑马纹。
- 保留列表字段、状态 Tag、详情、审核入口、同步重试、分页、空态、接口和所有业务判断。
### 2. 接口与风险
- 本次不新增或修改接口,继续使用隐患台账列表、详情、附件、同步重试及部门树接口。
- 仅调整主列表模板结构和局部样式;详情弹窗不纳入新版 Table 改造。
- 统计摘要仍基于当前页 `ledgerList` 计算,“当前筛选”继续显示后端分页总数。
### 3. 验收
- [x] 筛选区、统计区、无竖线 Card Table、分页与已改造列表视觉一致。
- [x] 主表支持拖拽表头列宽,固定操作列、溢出提示和空态正常。
- [x] 查询、重置、分页、详情、审核和同步重试行为不变。
- [x] 定向静态检查、开发热编译、生产构建及 `git diff --check` 完成。
### 4. 完成结果
- 隐患台账主列表已接入 `<data-list-panel modern-table>`,筛选、当前页统计、表格、分页和状态说明按新版列表结构归位。
- 主表已增加 `border` 并移除 `stripe`:保留新版无竖线视觉,同时恢复 Element UI 表头列宽拖拽;操作按钮也已统一为新版按钮样式。
- 列表、详情、附件、审核、同步重试、部门树和分页接口均未修改;单文件 ESLint、开发热编译、生产构建和 `git diff --check` 通过,构建仅有项目既有资源体积 warning。
## Token 过期回跳、角色更多操作与 Table 列拖拽修复(2026-09-15)
### 0. Table 模式参数补充(用户追加,2026-09-15)
- 为 `DataListPanel` 增加显式布尔参数 `modern-table`,默认值为 `false`。
- 只有传入 `modern-table` 时,组件才应用当前新版 Table 的无外框、无竖向分隔线样式;未传参数时不覆盖 Element UI 原有竖线样式。
- 16 个已完成新版 UI 改造的列表显式传入 `modern-table`,并保留各自 `el-table` 的 `border` 属性以启用列宽拖拽。
- 本次只收紧样式作用范围,不修改接口、字段、权限或列表交互。
- 验收:新版列表外观不变且可以拖拽;旧页面和未传参数的 `DataListPanel` 表格不会被新版无竖线样式影响;公共组件静态检查和生产构建通过。
- 完成结果:`DataListPanel` 已新增默认关闭的 `modernTable` 布尔属性,只有 `<data-list-panel modern-table>` 才生成新版 Table 修饰类并应用无竖线样式;16 个新版页面均已显式传参且主表保留 `border`。结构扫描、开发热编译、公共组件定向 ESLint、生产构建和 `git diff --check` 均通过。
### 0.1 系统监控旧表格竖线补充(用户追加,2026-09-15)
- 系统监控下仍使用旧 Table 的在线用户、定时任务、调度日志和缓存列表没有传 Element UI 原生 `border`,因此既不显示原竖线,也不能拖拽列宽。
- 为上述 4 个页面的 5 张表显式增加 `border`,恢复旧式表格竖线和列宽拖拽;不传 `modern-table`,不套用新版无竖线样式。
- 操作日志、登录日志继续使用新版模式;数据监控为 iframe,服务监控和缓存监控为非 Element UI 列表,本次不修改。
- 本次不涉及接口、字段和业务事件;验收以定向检查、开发热编译和生产构建为准。
- 完成结果:在线用户、定时任务、调度日志以及缓存列表的缓存名称/缓存键名两张表均已增加 `border`,恢复旧式竖向分隔线和列宽拖拽;开发热编译、生产构建和 `git diff --check` 通过。定向 ESLint 仅报告四个旧页面原有的 223 个错误、68 个警告,本次未批量格式化。
### 1. 目标与范围
- 修复 Token 过期或主动退出后,登录成功恢复到已废弃 `/index` 并进入 404 的问题。
- 恢复角色管理行末清晰可见的“更多操作”省略号下拉入口,保留“数据权限、分配用户”原权限和处理逻辑。
- 为此前改造的 16 个 `DataListPanel` Card 主列表恢复表头拖拽调整列宽能力,保持当前无竖向分隔线的 UI。
- 不修改登录、角色或列表接口,不调整后端权限字符和业务字段。
### 2. 原因与方案
- Token/退出:`src/utils/request.js` 和导航栏退出仍硬跳 `/index`,但该路由已经被移除;无 Token 守卫将其保存为 `redirect=/index`,登录页随后恢复该地址并命中 404。过期场景改用前端登出清理状态后直达 `/login`,主动退出同样直达登录页;登录提交对历史 `/index`、`/404`、`/login` 回跳参数增加兜底。
- 角色更多操作:数据权限和分配用户代码仍存在,但入口采用占宽较大的文本按钮,容易在固定操作列内被裁切或忽略。改为截图所示的省略号图标按钮,并提供“更多操作”Tooltip,点击展开原菜单。
- 列拖拽:Element UI 2.15 的表头拖拽同时要求列 `resizable` 和表格 `border=true`;列默认可调整,但新版 Card Table 未传 `border`,因此拖拽未生效。为 Card 主表格补 `border`,由 `DataListPanel` 既有样式继续隐藏外框和竖线。
### 3. 接口与风险
- 本次无新增或变更接口;Token 过期不再调用已失效 Token 的后端退出接口,主动退出仍调用现有退出接口。
- `FedLogOut` 需同步清空 Token、角色和权限,避免同页残留权限状态。
- 只为 `DataListPanel` 的主列表开启拖拽,不改变弹窗子表、树表及未改造页面。
### 4. 验收
- [x] Token 过期确认重新登录后不再生成 `/index` 回跳参数,登录成功默认进入 `/hazard/ledger`。
- [x] 历史 `/login?redirect=/index` 登录后也不会进入 404;主动退出后同样直达登录页。
- [x] 非超级管理员角色行显示省略号更多按钮,可展开数据权限和分配用户。
- [x] 16 个 Card 主列表具备拖拽表头列边界的条件,视觉仍由现有样式保持无竖向分隔线。
- [x] 定向静态检查、开发编译和生产构建完成,既有 warning 与历史 lint 问题已记录。
### 5. 完成结果
- 过期会话改用 `FedLogOut` 清理前端状态并 `replace('/login')`,避免用失效 Token 再请求退出接口;`FedLogOut` 现同步清空 Token、角色和权限。
- 主动退出和获取用户信息失败也不再跳已废弃的 `/index`;登录页过滤 `/index`、`/404`、`/login` 三类无效回跳地址并回落到 `/hazard/ledger`。
- 角色列表保留原操作权限与 `roleId !== 1` 保护规则,将更多入口改为 32px 省略号图标按钮,增加 Tooltip 并使用点击展开。
- 用户、角色、菜单、部门、岗位、字典、参数、公告、操作日志、登录日志、流程监听、流程定义、表单配置、流程表达式、积分规则、隐患流程配置共 16 个 Card 主列表已添加 `border` 行为属性;`DataListPanel` 现有 CSS 继续移除可见外框和竖线。
- 验证结果:`src/permission.js` 定向 ESLint 通过,开发环境与生产构建成功,`git diff --check` 通过;生产构建仅有既有 Browserslist、Webpack 弃用和资源体积 warning。登录、角色及请求等历史文件整体 ESLint 仍有原有格式问题,本次未批量改写。
- 联调边界:尚未用后端真实过期 Token 和具体角色权限账号完成端到端操作,需要测试环境回归确认。
## 登录框响应式居中修复(2026-09-14)
### 1. 目标与范围
- 修复登录页在拖拽浏览器宽高时登录框偏移、窄窗口左侧被裁切的问题。
- 保留现有登录背景、平台装饰图、表单视觉、验证码、记住密码、登录逻辑和用户已修改的页面文案。
- 仅调整 `src/views/login.vue` 的布局样式,不修改接口、路由和鉴权行为。
### 2. 原因与方案
- 原因:`.loginBox` 固定为 `1920×1080`,同时使用绝对定位和固定负边距;登录框的 `left: 50%` 以固定画布而不是浏览器视口为基准,因此视口变化时持续偏移。
- 方案:外层页面和装饰层使用当前视口尺寸,背景采用 `cover center`;装饰层使用 Flex 水平/垂直居中登录框,移除固定画布、负边距、`top/left/transform`。
- 响应式:登录框宽度保留 550px 上限,窄屏保留 16px 安全边距;低高度窗口允许滚动,避免验证码开启后内容被裁切。
### 3. 验收
- [x] 登录框改为按视口 Flex 水平、垂直居中,浏览器宽高变化时不再依赖固定坐标。
- [x] 窄屏时登录框不超出左右边界,低高度时可以滚动访问完整表单。
- [x] 背景和装饰图使用 `cover` 保持比例,登录功能与用户现有文案不变。
- [x] 开发环境热编译和生产构建通过;定向 ESLint 仅报告该文件原有模板/脚本格式问题。
### 4. 完成结果
- 移除 `.loginBox` 的固定 `1920×1080` 画布、绝对定位和负边距,改为占满视口并使用 Flex 居中 `.loginDiv`。
- 登录框保留 550px 桌面宽度并增加 `max-width: 100%`;页面增加安全边距和低高度滚动,验证码图片随可用宽度伸缩。
- 保留现有背景、平台装饰图、验证码、记住密码、登录接口和“积分管理系统”文案,未修改模板和业务脚本。
- 验证结果:开发服务热编译成功,生产构建成功;构建仅有既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 的 38 个错误、12 个警告均位于本次未修改的模板和脚本区域。
## 隐患流程配置页面(2026-09-14)
### 1. 用户目标与边界
- 开发 `src/views/flowable/hazardConfig/index.vue`,实现厂区与隐患等级对应 Flowable 流程模板的分页配置管理。
- 页面沿用当前最新 `DataListPanel` Card 列表样式,包含厂区、隐患等级、状态筛选,新增、修改、删除和分页;列表状态仅使用 Tag 展示。
- 不开发隐患上报页面;`myFactoryConfigs` 仅保留在接口封装中供后续上报页面使用。
### 2. 当前代码状态
- 页面当前只有空的 `app-container`,同级 `components/` 为空,尚无隐患流程配置 API 封装。
- 超级管理员继续使用角色标识 `admin` 判断;二级管理员由后端按登录用户自动限制为所属厂区。
- 工作区已有用户文档及其他页面改动,本次只增量修改当前页面、对应 API 和交接文档。
### 3. 接口计划
| 页面动作 | 方法 | 前端请求路径 | 请求字段 | 确认状态 |
| --- | --- | --- | --- | --- |
| 分页查询 | GET | `/flowable/hazardFlowConfig/list` | `pageNum`、`pageSize`、`deptId`、`hazardLevel`、`status` | 已确认;响应为 `data.list` 和字符串 `data.total` |
| 详情回填 | GET | `/flowable/hazardFlowConfig/{id}` | path:`id` | 已确认 |
| 新增 | POST | `/flowable/hazardFlowConfig` | `deptId/deptName`(仅超管)、`hazardLevel/hazardLevelName`、`flowKey`、`flowName`、`status` | 已确认 |
| 修改/启停 | PUT | `/flowable/hazardFlowConfig` | 完整配置对象;编辑时厂区和隐患等级不可修改 | 用户确认启停暂走修改接口 |
| 删除 | DELETE | `/flowable/hazardFlowConfig/{id}` | path:`id` | 用户确认按现接口执行 |
| 全部厂区 | GET | `/system/dept/factoryList` | 无 | 超级管理员使用 |
| 当前厂区 | GET | `/system/dept/myFactory` | 无 | 二级管理员回填展示 |
### 4. 字段与权限规则
- 隐患等级:`general`=一般隐患、`major`=较大隐患、`critical`=重大隐患;状态:`1`=正常、`0`=停用。
- 超级管理员厂区筛选和新增厂区可选;二级管理员展示当前厂区但控件禁用。
- 二级管理员的列表、新增请求不主动传 `deptId/deptName`,由后端按所属厂区过滤或自动填充;编辑请求保留详情中的不可变厂区字段。
- 列表真实数据已确认返回 `status`,状态筛选按用户确认继续发送 `status`。
### 5. 风险与验收
- 分页响应已确认使用 `data.list` 和 `data.total`;`total` 为字符串,前端转换为数字后传给分页组件。
- `PUT` 是否完整支持重新启用由联调确认;当前按用户决定使用修改接口切换 `status`。
- 验收:最新 Card Table 样式、筛选/重置、分页、空态和错误态完整;新增/编辑校验正确;二级管理员厂区可见但不可改;危险删除有二次确认;静态检查和生产构建通过。
### 6. 完成结果
- 实际完成:页面已使用 `DataListPanel` 实现厂区/等级/状态筛选、批量选择、Card Table、分页、新增、详情回填修改和删除确认;状态以绿色“正常”和灰色“停用”Tag 展示,编辑弹窗可修改状态。
- 角色处理:超级管理员加载全部厂区并可选择;二级管理员调用 `myFactory` 回填禁用厂区控件,列表和新增请求不主动传厂区字段,由后端按登录用户处理。
- 实际接口:新增 `@/api/flowable/hazardConfig`,接入配置列表、详情、新增、修改、删除、当前厂区模板、全部厂区和当前用户厂区接口;当前页面直接使用其中列表、详情、新增、修改、删除及两个厂区接口。
- 实际约定:状态筛选发送 `status`;启停通过编辑弹窗调用 `PUT` 修改 `status`;删除逐条调用现有 `DELETE`;分页固定解析 `data.list` 和 `data.total`。
- 验证结果:新增 API 和页面定向 ESLint 通过,生产构建成功;仅有项目既有 dotenv、Browserslist、Webpack 弃用和资源体积 warning。
- 遗留事项:继续联调确认修改状态和删除行为。
## 流程管理四个列表页 Card UI 统一(2026-09-12)
### 1. 用户目标与边界
- 将流程管理菜单下“流程监听、流程定义、表单配置、流程表达式”的主列表统一为用户/角色管理已采用的 `DataListPanel` Card 风格。
- 只调整主列表的筛选区、批量操作区、表格容器、行内按钮和分页视觉;不改变接口、查询参数、字段、权限指令、事件、弹窗和业务逻辑。
- 不增加左侧树、统计区或其他模块;流程定义页的流程设计说明、流程图、主表单配置及弹窗内部表格保持原样。
### 2. 页面与现有能力
| 页面 | 文件 | 必须保留的主列表能力 |
| --- | --- | --- |
| 流程监听 | `src/views/system/listener/index.vue` | 名称/监听类型筛选、多选、分页、增删改、导出、字典展示 |
| 流程定义 | `src/views/flowable/definition/index.vue` | 名称/部署时间筛选、多选、分页、新增、删除、设计、配置主表单、挂起/激活 |
| 表单配置 | `src/views/flowable/task/form/index.vue` | 表单名称筛选、多选、分页、增删改、导出、详情 |
| 流程表达式 | `src/views/system/expression/index.vue` | 名称/状态筛选、多选、分页、增删改、导出 |
### 3. 接口与字段
- 本次不新增或修改 API 封装,四页继续调用现有 `@/api/system/listener`、`@/api/flowable/definition`、`@/api/flowable/form`、`@/api/system/expression`。
- 保留现有列表字段、响应解析、字典和所有权限字符;`DataListPanel` 只负责 UI 容器和通用样式。
### 4. 风险与验收
- 只包装主列表,不能误改流程定义页“挂载表单”弹窗中的子表格及分页。
- 原 `right-toolbar` 的搜索显隐和刷新事件必须保留;多选禁用状态、固定操作列和分页双向绑定保持不变。
- 验收:四页主列表使用统一 Card、紧凑筛选、主次按钮、无竖向单元格线和 Card 内分页;原功能与弹窗无变化;`git diff --check` 和生产构建通过。
### 5. 完成结果
- 实际完成:流程监听、流程定义、表单配置、流程表达式四页主列表均已复用共享 `DataListPanel`,统一为紧凑筛选、批量操作、白色 Card、无竖向单元格线表格和 Card 内分页。
- 按钮视觉:新增/修改使用蓝色主按钮,删除使用红色危险按钮,导出及普通行内操作使用白色次按钮;原权限指令、禁用条件和点击事件均保留。
- 特殊页面边界:流程定义的“流程设计说明”保留在主列表 Card 头部;流程图、上传、主表单配置等弹窗及挂载表单弹窗内部表格/分页未修改。
- 实际接口:继续使用原 `@/api/system/listener`、`@/api/flowable/definition`、`@/api/flowable/form`、`@/api/system/expression`,无请求、参数或字段变化。
- 验证结果:开发服务四页热编译成功,`git diff --check` 通过,生产构建成功;仅有既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 显示四个历史页面已有大量脚本/模板格式问题,本次按 UI 边界未做整文件自动重写。
## 积分管理列表 UI 统一(2026-09-12)
### 1. 用户目标与边界
- 将“积分管理 → 积分规则”列表继续调整为当前系统管理页统一采用的 Card 列表风格。
- “同一隐患等级支持 A/B/C…”放在“积分规则配置 · 多档位”标题下;底部版本说明放在两个暂未接接口按钮下方。
- 按确认稿展示“保存为新版本 V4”蓝色主按钮和“历史月份试算”白色次按钮。
- 用户已确认部门管理完成,本次不再调整部门页面。
- 仅调整积分规则列表模板与局部样式,不改变接口、参数、字段、权限、弹窗及业务事件。
### 2. 当前代码状态
- 积分页已接入规则分页、厂区筛选、新增、详情、启停和删除接口,当前列表已开始复用 `DataListPanel`;仍需完成标题说明、底部按钮与说明的最终布局和按钮配色。
- 部门页已复用 `DataListPanel` 并完成列宽修正,用户已验收为 OK。
- 工作区存在大量用户已有改动,本次只在上述页面和交接文档上增量修改,不覆盖或回退其他改动。
### 3. 接口与字段映射
- 积分管理继续使用 `/business/points/rule/list`、`/system/dept/factoryList`、`/business/points/rule/toggleEnabled`、`/business/points/rule/deleteById`、`/business/points/rule/info`、`/business/points/rule/add`。
- 积分表格继续展示 `hazardLevel`、`hazardCategory`、`points`、`enabled`;详情和新增字段保持原映射。
### 4. 风险与验收
- 积分页底部两个未接接口按钮必须保留现有提示,不伪造成功结果。
- 验收:积分列表与系统列表视觉一致;两段说明文字位置正确;底部按钮文案、主次配色与确认稿一致;定向 ESLint、`git diff --check` 和生产构建通过。
### 5. 完成结果
- 实际完成:积分规则页继续复用共享 `DataListPanel`,筛选、操作、无竖向单元格线表格和分页保持与用户/角色管理列表一致。
- 文案布局:“同一隐患等级支持 A/B/C…”已移动到“积分规则配置 · 多档位”标题下;档位标准说明已放到版本按钮下方。
- 按钮样式:底部展示“保存为新版本 V4”蓝色主按钮和“历史月份试算”白色次按钮,仍沿用原 `showPendingAction` 提示,不调用接口。
- 功能边界:页面的 API、请求参数、排序、权限、新增、详情、启停、删除和分页逻辑均未改动;部门管理按用户确认不再调整。
- 验证结果:`git diff --check` 通过,生产构建成功;仅有项目既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 仍报告积分页面此前已有的整文件格式问题,本次未扩大范围自动重写脚本。
## 系统管理八个列表页 Card UI 批量替换(2026-09-10)
### 1. 用户目标与边界
- 将菜单管理、部门管理、岗位管理、字典管理、参数管理、通知公告、操作日志、登录日志的列表 UI,统一为用户/角色管理已采用的 Card 列表风格。
- 只调整筛选、工具栏、表格、行内按钮与分页的视觉结构,不改变接口、查询参数、字段、权限指令、事件、弹窗或业务逻辑。
- 严格维持各页面当前结构:菜单/部门继续为树形表格且无分页;日志页面继续保留排序、清空、解锁、详情等原有能力;不新增左侧树或其他模块。
### 2. 页面与现有能力
| 页面 | 文件 | 必须保留的列表能力 |
| --- | --- | --- |
| 菜单管理 | `src/views/system/menu/index.vue` | 树形列表、展开/折叠、行内新增/修改/删除 |
| 部门管理 | `src/views/system/dept/index.vue` | 树形列表、展开/折叠、行内新增/修改/删除 |
| 岗位管理 | `src/views/system/post/index.vue` | 多选、分页、增删改、导出 |
| 字典管理 | `src/views/system/dict/index.vue` | 多选、分页、字典数据入口、增删改、导出、刷新缓存 |
| 参数管理 | `src/views/system/config/index.vue` | 多选、分页、增删改、导出、刷新缓存 |
| 通知公告 | `src/views/system/notice/index.vue` | 多选、分页、增删改 |
| 操作日志 | `src/views/monitor/operlog/index.vue` | 多选、排序、分页、删除、清空、导出、详情 |
| 登录日志 | `src/views/monitor/logininfor/index.vue` | 多选、排序、分页、删除、清空、解锁、导出 |
### 3. 接口计划与映射
- 本次不新增或修改任何接口封装,各页面继续调用当前 API 文件和请求参数。
- `DataListPanel` 只承载 `filters`、`actions`、默认表格和 `footer` 插槽,不介入数据加载、状态或交互逻辑。
- 公共样式新增通用类:`data-list-filter-form`、`data-list-actions`、`data-list-table`、`data-list-operation-column`,供本批及后续列表页面复用。
### 4. 风险与验收
- 树形表格的 `row-key`、`tree-props`、`refreshTable` 和展开状态不可改动。
- 日志表格的 `ref`、默认排序和 `sort-change` 不可改动。
- 验收:8 页使用统一 Card、紧凑筛选、按钮配色、无竖向单元格线及 Card 分页;所有原字段、按钮、权限和事件保持;生产构建通过。
### 5. 完成结果
- 实际完成:8 个列表页面均已使用共享 `DataListPanel`;菜单/部门保留树形无分页结构,其余页面分页进入 Card footer,表格及按钮视觉与用户/角色管理统一。
- 实际使用接口:完全沿用 `@/api/system/menu`、`dept`、`post`、`dict/type`、`config`、`notice` 和 `@/api/monitor/operlog`、`logininfor` 的现有封装,无请求或字段变化。
- 功能边界核对:8 个页面的 `script`、API 导入、权限指令、字段和业务方法未改;只修改模板展示与公共组件样式。
- 验证结果:公共组件定向 ESLint 通过,`git diff --check` 通过,`npm run build:prod` 成功;仅有既有 Browserslist、Webpack 弃用和资源体积 warning。
- 遗留事项:需用户在浏览器结合真实权限和数据逐页确认视觉,功能联调状态仍以原页面现状为准。
- 部门管理补充修正:实际验收发现所有表格列都使用固定 `width`,列宽合计小于 Card 可用宽度,导致右侧留白;保留“部门名称”固定 260px,改由“创建时间”使用 `min-width` 弹性列吸收剩余空间,避免部门列被拉伸。
## 角色管理 Card 列表 UI 替换(2026-09-10)
### 1. 用户目标与边界
- 将“系统管理 → 角色管理”的列表视觉调整为与用户管理列表一致的 Card 列表风格。
- 仅调整列表筛选区、批量操作区、表格容器、行内按钮、状态控件和分页的展示样式。
- 保留角色管理现有列表字段、筛选、分页、状态切换、增删改、导出、数据权限和分配用户等功能及弹窗;不增删模块,不增加用户管理的左侧部门树布局。
### 2. 当前代码状态
- 页面:`src/views/system/role/index.vue`,当前为若依默认整页表格布局。
- 公共组件:`src/components/DataListPanel/index.vue` 已用于用户管理,可通过筛选、操作、列表、分页插槽复用。
- 接口与权限:沿用现有 `src/api/system/role.js`、`listRole`、`getRole`、`addRole`、`updateRole`、`delRole`、`changeRoleStatus`、`dataScope`、`deptTreeSelect` 及原权限字符,不新增请求。
### 3. 页面字段映射
| 列表区域 | 现有字段/行为 | UI 调整 |
| --- | --- | --- |
| 筛选 | `roleName`、`roleKey`、`status`、`dateRange` | 无标签紧凑输入框、选择框、日期范围,复用搜索/重置事件 |
| 批量操作 | 新增、修改、删除、导出、`right-toolbar` | 蓝/红/白按钮配色和间距统一,权限指令不变 |
| 列表 | `roleId`、`roleName`、`roleKey`、`roleSort`、`status`、`createTime` | 白色 Card、仅横向分隔线、紧凑字号与行高 |
| 行内操作 | 修改、删除、更多(数据权限/分配用户) | 白底/红色/蓝色按钮,command 保持不变 |
| 分页 | `total`、`queryParams.pageNum/pageSize` | Card 底部分页,事件和参数不变 |
### 4. 风险与验收方式
- 角色状态继续使用原 `el-switch` 双向绑定,确保 `handleStatusChange` 的确认、请求和回滚逻辑不变。
- 不修改角色弹窗及其树形权限配置,避免扩大本次 UI 范围。
- 验收:列表视觉与用户管理统一;原有筛选、分页、状态、增删改、导出、更多操作仍可用;`git diff --check` 和生产构建通过。
### 5. 完成结果
- 实际完成:角色管理列表使用共享 `DataListPanel`,完成筛选、批量操作、Card 表格、状态开关、行内按钮和分页的统一视觉;保持全宽列表,不增加左侧树或其他模块。
- 实际使用接口:沿用 `listRole`、`getRole`、`addRole`、`updateRole`、`delRole`、`changeRoleStatus`、`dataScope`、`deptTreeSelect` 和原导出请求,无接口变更。
- 验证结果:`git diff --check` 通过;生产构建成功,仅有项目既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 检出角色页面历史脚本格式问题,未在本次 UI 范围内批量格式化。
- 后续:其他菜单列表可继续复用 `DataListPanel`,按页面实际功能逐一替换列表 UI。
## 用户管理 Card 列表试点(2026-09-09)
### 1. 用户目标
- 先将“系统管理 → 用户管理”改造成截图所示的紧凑型后台列表。
- 查询条件与批量按钮位于列表 Card 上方,表格由白色 Card 包裹。
- 表格取消竖向单元格线,只保留浅色横向分隔线;按钮改为蓝色主操作、红色危险操作、白底次要操作。
- 抽取通用列表面板组件,后续角色、菜单、字典等列表页面可以复用并逐步替换。
### 2. 当前代码状态
- 用户管理当前使用左侧部门树 + 右侧查询表单/工具栏/表格的 RuoYi 默认布局。
- 用户列表仍使用现有 `listUser/getUser/addUser/updateUser/delUser/changeUserStatus` 等接口和权限字符。
- 工作区存在前序 UI、积分管理、API 文档等改动;本次不覆盖或回退。
### 3. 接口计划
本次不新增、不修改接口。用户列表、增删改、状态、导入导出和部门树接口全部沿用现有封装。
### 4. 页面映射
| 截图区域 | 用户管理实现 |
| --- | --- |
| 左侧筛选 | 部门名称搜索、部门树节点筛选 |
| 顶部筛选 | 用户账号、手机号、状态、创建时间、岗位 |
| 左侧按钮 | 搜索、重置 |
| 右侧按钮 | 新增、修改、删除、导入、导出、刷新、显隐列 |
| Card 列表 | 用户编号、账号、昵称、部门、岗位、手机号、状态、创建时间、操作 |
| 行内操作 | 修改(白底)、删除(红色)、更多(蓝色) |
### 5. 实施步骤
1. 新增跨业务 `DataListPanel`,用筛选区、操作区、列表区、分页区插槽承载不同页面内容。
2. 用户管理保留左侧部门树布局,右侧使用通用列表面板;部门树节点继续使用 `deptId` 筛选。
3. 统一用户管理表格、状态标签/开关和按钮风格,保持原业务事件和权限控制。
4. 进行静态检查和生产构建,更新交接文档。
### 6. 风险与边界
- 本次只以用户管理为试点,不立即批量改动所有历史列表页。
- 公共组件不封装具体表格列和接口,避免不同模块被固定字段限制。
- 左侧部门树属于用户管理必要功能,需要保留搜索、节点点击筛选和重置联动。
### 7. 验收方式
- [x] 用户管理布局与截图方向一致,列表使用 Card 且无竖向单元格线。
- [x] 搜索、重置、部门筛选、岗位筛选、分页、增删改、导入导出、状态切换及更多操作保持原事件和接口逻辑。
- [x] `DataListPanel` 可被其他列表页直接复用。
- [x] 生产构建通过并更新任务、状态、日志。
### 8. 完成结果
- 实际完成:新增通用 `DataListPanel` 插槽组件;用户管理保留左侧部门树,右侧改为顶部筛选/操作区和 Card 表格;表格只保留横向分隔;批量和行内按钮按蓝/红/白三类统一。
- 实际使用接口:沿用 `/system/user/list`、用户增删改/状态/导入导出以及 `/system/user/deptTree`,没有新增或修改请求封装。
- 验证结果:公共组件定向 ESLint 通过;`git diff --check` 通过;`npm run build:prod` 成功,仅有既有 Browserslist、Webpack 弃用及资源体积 warning。
- 补充调整:根据用户反馈恢复左侧部门树,顶部不再重复展示部门下拉;点击节点和重置仍沿用原筛选行为。
- 遗留事项:需要用户浏览器确认本试点视觉;确认后可以按同一组件批量迁移其他系统管理列表页。
## 管理后台原型视觉统一(2026-09-09)
### 1. 用户目标
- 以 `最终交付/原型_管理后台_高保真_V0.10_浅色.html` 为视觉基准,改造现有 `zhongyou_web`,不新建项目。
- 第一阶段统一管理后台基础壳层和 Element UI 组件密度,包括侧栏、Logo、Header、内容背景、Card、表格、表单、按钮、标签、弹窗和分页。
- 保留现有登录、动态菜单、路由、权限、接口封装和业务功能。
### 2. 当前代码状态
- 当前为 Vue 2 + Element UI + RuoYi 左侧菜单布局,侧栏宽 200px、Header 高 50px。
- `App.vue` 使用固定 1920×1080 的 `ScaleBox` 包裹整个后台;原型采用正常流式后台布局。
- `.app-container` 当前使用 15px 白色边框模拟页面间距,Element UI 表格和菜单密度明显大于原型。
- 工作区已有接口文档、积分管理、默认首页等用户改动;本次只在共享布局、样式和开发文档上增量修改,不覆盖或回退已有工作。
### 3. 接口计划
本次为纯 UI 改造,不新增、不修改接口,不调整 Token、权限和动态菜单逻辑。
### 4. 原型视觉映射
| UI 模块 | 原型标准 | 当前项目 | 第一阶段处理 |
| --- | --- | --- | --- |
| 页面背景 | `#F0F2F5` | `.app-container` 外框 `#edf2f8` | 统一为 `#F0F2F5` |
| 侧栏 | 212px、白底、浅分割线 | 200px、明显阴影 | 改为 212px,移除重阴影 |
| Header | 52px | 50px | 改为 52px并同步主内容偏移 |
| 一级/二级菜单 | 约 40px/34px,13px/12px | Element UI 默认约 56px、14px | 降低行高、字号和缩进 |
| 内容留白 | 16px 20px 40px | 15px padding + 15px border | 改为流式内容间距 |
| Card | 8px 圆角、浅边框 | Element UI 默认样式 | 统一 Header、Body、圆角和边框 |
| 表格 | 12px、表头/行约 36px | 13/14px、表头 40px、行约 48px | 统一为紧凑密度 |
| 表单/按钮/标签 | 12px、6px 圆角 | Element UI 中等尺寸 | 统一视觉,不改组件行为 |
### 5. 实施步骤
1. 建立原型主题色、字号、圆角和间距变量,调整基础页面背景与字体。
2. 改造侧栏、Logo、Header 和主内容偏移,去除固定 1920×1080 的全局缩放容器。
3. 在独立共享样式文件中覆盖 Element UI 的 Card、Table、Form、Button、Tag、Dialog、Pagination 等视觉规范。
4. 检查积分管理和隐患台账等已开发页面,修复与新全局样式冲突的局部规则。
5. 执行 ESLint/生产构建,并更新状态和开发日志。
### 6. 风险与边界
- 全局组件密度调整会影响历史页面;优先使用稳定的 Element UI 类名,不改 DOM 和业务交互。
- 原型没有 TagsView;项目默认已关闭,保留已有可选功能并提供兼容高度。
- 深色侧栏作为历史可选配置保留基本可用性,验收以默认浅色主题为准。
- 第一阶段完成整体统一,不承诺所有历史业务页面一次达到像素级一致;局部复杂页面将在第二阶段逐页校准。
### 7. 验收方式
- [x] 默认浅色布局的侧栏、Header、背景、字号、间距与原型基准一致。
- [x] 表格、表单、按钮、Card、标签、弹窗和分页形成统一样式。
- [x] 登录、动态菜单、折叠、移动端、路由和业务接口行为不变。
- [x] 积分管理、隐患台账页面已适配新的全局高度和配色。
- [x] `git diff --check` 和生产构建通过;定向 ESLint 仍报告相关历史文件原有格式问题。
- [x] 更新 `CURRENT_STATUS.md`、`DEVELOPMENT_LOG.md` 和本任务完成结果。
### 8. 完成结果
- 实际完成:后台由固定画布缩放改为流式布局;侧栏、Header、内容容器及常用 Element UI 组件已按原型建立统一视觉基准;旧本地布局配置通过版本标识迁移到新默认值。
- 实际使用接口:无,本次未修改接口、鉴权、权限和动态菜单逻辑。
- 验证结果:`git diff --check` 通过;`npm run build:prod` 成功,仅有既有 Browserslist、Webpack 弃用和资源体积 warning。
- 静态检查说明:定向 ESLint 检出相关历史文件已有的双引号、分号、未使用组件、`MyConfig` 全局变量等问题;未在本次 UI 任务中扩大范围批量格式化。
- 遗留事项:需在浏览器结合客户常用分辨率进行视觉验收;复杂历史页面按实际截图进入第二阶段逐页校准。
## 默认登录首页(2026-09-09)
### 1. 用户目标
- 用户正常登录且没有指定回跳地址时,默认进入隐患台账 `/hazard/ledger`。
- 直接访问根路径 `/`,或已登录用户再次访问登录页时,同样进入隐患台账。
- 保留登录链接中的 `redirect` 参数,避免用户访问具体受保护页面后登录却丢失原目标。
### 2. 当前状态与实施范围
- `src/views/login.vue` 当前登录成功后硬编码跳转 `/questionModule/index`。
- `src/router/index.js` 存在两个根路由重定向,分别指向 `/system/user` 和 `/index`。
- 本次统一上述默认入口为 `/hazard/ledger`。
- 实测首次登录进入 404:`/hazard/ledger` 当前完全依赖后端菜单动态注册,默认跳转发生时该路径可能尚未存在,或当前账号菜单响应未包含该路径。
- 将 `/hazard/ledger` 增加为隐藏的基础路由,保证默认首页在动态菜单加载前即可解析;后端菜单仍负责侧栏展示,接口仍由后端鉴权和数据权限控制。
- 不涉及接口和字段调整。
### 3. 验收方式
- [x] 无 `redirect` 参数登录后进入 `/hazard/ledger`。
- [x] 有合法 `redirect` 参数时返回原目标页面。
- [x] 访问 `/` 时重定向到 `/hazard/ledger`。
- [x] 本次修改行符合 ESLint 规则,生产构建通过;涉及文件存在与本次无关的历史 ESLint 问题。
完成结果:登录成功默认跳转、根路由和已登录后访问登录页的回退入口均统一为 `/hazard/ledger`;实测 404 后补充隐藏基础路由,消除首次进入时对动态菜单注册时序和菜单返回内容的依赖。
## 积分管理页面(2026-09-08,开发前梳理)
### 1. 用户目标
- 页面位置:`src/views/points/management/index.vue`。
- 进入后展示积分管理 Tab:积分规则、申诉处理、手动调整、流水冲正;默认展示“积分规则”,其余 Tab 暂不可切换。
- 积分规则 Tab 展示规则配置卡片、厂区筛选(仅超级管理员)、分页列表、详情弹窗、启用/停用和删除操作;新增规则弹窗仅超级管理员可见。
- 卡片底部展示“保存为新版本”和“V4历史月份试算”按钮,暂不接接口,仅展示指定说明文本。
- UI 以现有 Element UI 组件和实际需求为准,不照搬原型稿。
- 本次暂不实现申诉处理、手动调整、流水冲正的可用交互,仅保留不可切换 Tab。
### 2. 接口计划(待编码)
| 页面动作 | 接口名称 | 方法 | 前端请求路径 | 请求字段 | 响应字段 | 确认状态 |
| --- | --- | --- | --- | --- | --- | --- |
| 规则分页 | 分页查询积分规则列表 | GET | `/business/points/rule/list` | `pageNum`、`pageSize`;超级管理员可传 `deptId` | `data` 分页对象,列表字段待真实响应核对 | API 已确认,响应结构待联调 |
| 厂区筛选项 | 获取所有厂区级部门列表 | GET | `/system/dept/factoryList` | 无 | `data` 全部厂区部门数组,字段至少 `deptId/deptName` | API 已确认,仅超级管理员调用,选择项全部展开 |
| 当前厂区 | 获取当前用户所属厂区部门 | GET | `/system/dept/myFactory` | 无 | `data` 厂区部门对象 | API 已确认,非超级管理员是否需要前端调用待定 |
| 启用/停用 | 启用/禁用积分规则 | POST | `/business/points/rule/toggleEnabled` | query:`id`、`enabled`(0/1) | 通用对象响应 | API 已确认 |
| 删除 | 删除积分规则 | GET | `/business/points/rule/deleteById` | query:`id` | 通用对象响应 | API 已确认,需二次确认 |
| 详情 | 获取积分规则详情 | GET | `/business/points/rule/info` | query:`id` | `data` 规则对象 | API 已确认 |
| 新增 | 新增积分规则 | POST | `/business/points/rule/add` | JSON 规则对象;必须选择厂区并传 `deptId`;不传 `createTime/updateTime/id`;`priority` 可输入或由前端自增 | 通用对象响应 | API 已确认 |
### 3. 页面字段映射(已确认)
| UI 文案 | 候选接口字段 | 当前处理 |
| --- | --- | --- |
| 隐患等级 | `hazardLevel` | 固定编码:`general`=一般隐患、`major`=较大隐患、`critical`=重大隐患;新增使用下拉选择 |
| 档位 | `hazardCategory` | 使用字母档位 A、B、C…;前端可按当前等级已有档位生成下一个字母,用户可修改 |
| 积分 | `points` | 必填整数 |
| 启用 | `enabled` | 0/1 映射 Switch;新增默认 1 |
| 优先级 | `priority` | 新增时前端按当前规则列表计算最大值 + 1;用户可修改 |
| 厂区 | `deptId`、`deptName` | 新建规则必须选择;超级管理员可选择全部 `factoryList` 数据;页面暂不提供新建全局规则入口 |
### 4. 风险与待确认
- “档位”映射为 `hazardCategory`,不新增独立字段;同一隐患等级下按档位字母排序。
- 新增规则必填:`hazardLevel`、`hazardCategory`(档位)、`points`;`enabled` 默认 1;`ruleCode`、`ruleName` 非必填。
- 超级管理员角色标识确定使用 `admin`;登录用户信息中的 `admin: true` 和角色 `roleKey=admin` 均可作为判断依据,页面统一复用项目权限工具。
- 超级管理员新建时必须选择厂区并传对应 `deptId`。厂区列表使用 `factoryList` 返回的全部数据并展开,不截断为当前部门;页面暂不提供新建全局规则入口。
- 接口路径封装注意:运行时 `BASE_API` 已包含一层 `/gd_dataserver`,`src/api` 只写 `/business/...`、`/system/...`,禁止写成重复的 `/gd_dataserver/gd_dataserver/...`。
- `/list` 的分页响应虽说明为 `data` 中的 PageInfo,但总数字段(如 `total`)和列表字段名称需用真实响应核对。
- 详情弹窗展示规则对象中的主要业务字段和审计字段(厂区、等级、档位、积分、启用、优先级、规则编码、规则名称、备注、创建/更新时间)。
### 5. 排序与档位生成规则
- 列表展示顺序:隐患等级顺序固定为 `general`(一般隐患)→ `major`(较大隐患)→ `critical`(重大隐患);每个等级内按 `hazardCategory` 的字母自然升序(A、B、C…),同档位再按 `priority` 降序,最后按 `id` 稳定排序。
- 由于 `/list` 是分页接口,优先将排序参数交给后端(若接口不支持,则前端对当前页排序,并在文档中保留分页排序限制);实现时会避免把三种等级混成按返回顺序展示。
- 新增弹窗选择隐患等级后,读取当前已加载规则中该等级的档位,计算最大字母后生成下一档;首次默认为 A。用户可以直接修改档位。
- 字母生成支持 A-Z;超过 Z 时按 AA、AB…继续递增,输入统一转为大写并校验格式。
### 6. 验收方式(开发后)
- [x] 默认仅积分规则 Tab 可用,其余 Tab 不可切换。
- [x] 超级管理员显示厂区筛选和新增按钮;其他管理员隐藏两者且列表仅显示本厂区数据。
- [x] 规则列表完成加载、筛选、分页、空态、错误态、Switch 切换、删除确认、详情弹窗。
- [x] 新增请求不发送 `createTime/updateTime/id`,`ruleCode/ruleName` 可为空。
- [x] 静态检查通过,生产构建通过,并更新状态、日志和页面接口映射。
状态:积分管理积分规则页面已完成,生产构建已验证(2026-09-08);申诉处理、手动调整、流水冲正暂禁用
## 隐患台账页面任务(2026-09-04) ## 隐患台账页面任务(2026-09-04)

196
docs/development/DEVELOPMENT_LOG.md

@ -1,5 +1,166 @@
# 开发日志 # 开发日志
## 2026-10-08:隐患审核积分档位按厂区查询
- 问题:审核页“积分档位”下拉为空且显示裸规则ID;根因是 `rulesByLevel` 未按隐患所属厂区查询——超管无厂区上下文返回空 `children`,而 `trialCalculate` 带了 `deptId` 故能命中。
- `src/api/points/rule.js`:`getRulesByLevel(params)` 改为接收参数对象,支持 `deptId`。
- `src/views/hazard/audit/components/AuditActionForm.vue`:调用时补传 `deptId = report.factoryDeptId`;新增 `applyTierFallback()`,档位列表为空但详情已有 `finalFlowLevelId` 时用详情档位兜底展示,避免裸 ID。
- 依赖后端已为 `rulesByLevel` 增加 `deptId`(线上已更新)。验证:无诊断错误,`npm run build:prod` 通过,仅既有资源体积 warning。
## 2026-10-08:左侧菜单隐藏“隐患审核”
- 左侧菜单由后端菜单接口下发。在 `src/store/modules/permission.js` 的 `GenerateRoutes` 中,对仅用于侧栏展示的路由副本调用新增的 `filterHiddenSidebarRoutes()`,按组件路径 `hazard/audit/index`(或标题“隐患审核”)剔除该菜单项。
- 仅过滤侧栏/顶栏展示数据,`rewriteRoutes` 路由注册保持不变,`/hazard/audit` 与基础路由 `/hazard/audit/detail` 仍可跳转,台账“去审核”入口不受影响。
- 验证:无诊断错误,`npm run build:prod` 通过,仅有既有资源体积 warning。
## 2026-10-08:隐患流程配置新增“流程类型”字段并列表展示
- 新增/修改弹窗增加“流程类型”下拉,字段 `bizType`,选项来自字典 `flow_biz_type`(组件注册 `dicts: ['flow_biz_type']`),提交时取字典项键值;`createEmptyForm`、`normalizeForm`、`formRules`、`buildPayload` 同步纳入该字段。
- 列表在“厂区名称”后新增“流程类型”列,用 `el-tag` 展示;新增 `bizTypeLabel(row)` 按字典 `flow_biz_type` 反查 label,字段为空时模板显示 `-`。
- 字段名以 `api.json` 为准使用 `bizType`(非下划线 `biz_type`)。验证:无诊断错误,`npm run build:prod` 通过,仅有既有资源体积 warning。
## 2026-10-08:隐患台账非管理员单位筛选改用 myFactory 并归位 /system/dept 封装
- 修复非管理员进入隐患台账右上角弹出“当前操作没有权限”:根因是 `getUnits()` 调用了 `GET /system/user/deptTree`(用户管理权限,非管理员无权,且不在最新 `api.json`)。
- 台账页 `getUnits()` 按角色分流:超级管理员调用 `listFactoryDepartments()`(`/system/dept/factoryList`),非管理员调用 `getMyFactoryDepartment()`(`/system/dept/myFactory`);非管理员隐藏“单位”筛选项,仅静默按本厂区过滤。
- `created` 调整为 `getUnits().finally(() => getList())`,保证非管理员首屏列表请求已带 `unitId`;移除不再使用的 `deptTreeSelect` 引用和 `flattenTree`。
- 将 `listFactoryDepartments()`、`getMyFactoryDepartment()` 从 `src/api/flowable/hazardConfig.js` 和 `src/api/points/rule.js` 归位到 `src/api/system/dept.js` 并删除重复定义;同步更新隐患流程配置页和积分管理页的 import。
- 验证:相关文件无诊断错误,`npm run build:prod` 通过,仅有项目既有资源体积/Browserslist warning。后端 `todoList` 是否按 `unitId` 过滤仍需联调确认。
## 2026-09-19:隐患台账切换待办接口并自动补齐审批 taskId
- 隐患台账列表请求由 `GET /business/hazard/getListByPage` 切换为 `GET /flowable/hazard/todoList`,保留原分页、筛选、详情弹窗和审核入口逻辑。
- 台账“去审核”只携带隐患 `id`,不再依赖列表行中的 `taskId/taskID/todoTaskId`。
- 审核页新增 `getHazardProcessDetail` 封装,调用 `GET /flowable/busiInfo/getProcessDetail?id={flowInstanceId}`;详情加载后若 `canApprove=true` 且有 `flowInstanceId`,自动获取当前任务并补齐 `taskId`。
- 兼容 `getProcessDetail` 返回数组或 `list/rows/records/tasks/taskList/flowList/data` 等结构,并优先选择未结束任务;路由仍允许显式传入 `taskId` 作为兜底。
- 台账跳转补充携带 `canApprove` 和 `flowInstanceId`,避免审核详情缺少这两个流程字段时无法补齐任务;流程详情解析改为递归查找含 `taskId` 的对象。
- Web 审核页上传附件由错误的 `/flowable/hazard/uploadAttachment` 改为 `/business/hazard/uploadAttachment`;后端实测要求 `multipart/form-data`,请求字段名确认为 `files`。
- App 端 `uploadHazardAttachment` 同步改为 `/business/hazard/uploadAttachment` 的 `multipart/form-data` 请求,字段名使用 `files`。
- 审核动作卡片中新上传的附件由纯文本 Tag 改为可点击卡片:图片使用 `el-image` 大图预览,文档点击后新窗口打开,并保留移除按钮。
- 定向 ESLint 和生产构建通过;构建仅有既有资源体积、Browserslist 和 Webpack 弃用 warning。`getProcessDetail` 的真实响应结构和“当前任务”选择规则仍需联调确认。
## 2026-09-19:SelectTree 机构/人员回显修复
- 修复 `SelectTree` 回显时可能直接展示原始 `id` 的问题:树节点 ID 与 `echoBack` 改为字符串归一化比较,避免接口返回字符串 `"108"` 而详情返回数字 `108` 导致匹配失败。
- 在 `orgdata_bm` 树数据异步加载完成后重新执行回显,避免初始化时树数据尚未就绪导致首次回显停留在原始 ID。
- 生产构建通过;`git diff --check` 通过。`SelectTree` 全文件 ESLint 仍存在项目既有格式问题,本次未做无关的全文件格式化。
## 2026-09-19:隐患审核页字典、分类标准与 Tag 展示调整
- 对齐 App 端 `ReportFormScreen.tsx` 字典:审核动作卡片“管理级别”由前端硬编码 `general/major/critical` 改为读取 `hazard_management_level` 字典,并补入组件 `dicts` 列表;切换等级弹窗的当前等级改读 `currentFlowLevel/hazardCategory`,避免把管理级别字典值当作流程等级。
- 左侧“上报内容”卡片在“隐患信息”模块的整改负责人、专业下方新增“分类标准”独占一行的展示,优先展示 `hazardClassificationStandard`,兼容 `criteriaNames`、`hazardClassificationStandardLabel`;隐患分类为 `general/一般` 时固定显示 `-`。
- 左侧卡片的“隐患状态”“隐患分类”使用 `el-tag` 展示;隐患分类按值映射颜色:一般 `primary`、较大 `warning`、重大 `danger`,并修复 tag 在 `info-item` 网格内被拉伸为整行宽的问题。
- 未新增或修改接口。两个组件定向 ESLint、`git diff --check` 和生产构建通过,构建仅有既有资源体积、Browserslist 和构建工具 warning。
## 2026-09-19:隐患审核页缺 taskId 时仍可查看详情
- 台账“去审核”不再因列表行缺少 `taskId` 而拦截跳转,统一携带 `id`,仅在行数据存在 `taskId/taskID/todoTaskId` 时附加 `taskId`。
- 审核页路由校验改为仅要求 `id`;缺 `taskId` 时仍加载并展示隐患详情和附件,页面顶部提示仅可查看、无法审批。
- `AuditActionForm` 的 `taskId` 改为可选属性,缺少时禁用通过/驳回/重新评估等级,并显示“从待办任务办理入口进入”的提示。
- 未新增或修改接口;审批仍需后端返回或入口传入 `taskId`。定向 ESLint、生产构建和 `git diff --check` 通过,构建仅有既有资源体积和 Browserslist warning。
## 2026-09-18:积分规则支持厂区管理员管理并增加厂区列
- 积分规则“新建”入口向可进入页面的管理员开放;超级管理员继续调用 `factoryList` 选择厂区,厂区管理员改为调用 `myFactory` 展示并锁定所属厂区。
- 厂区管理员列表查询显式移除 `deptId`,新增请求不发送 `deptId/deptName`,由后端按登录用户过滤或自动填充;所属厂区加载失败时禁用提交。启停和删除继续使用原接口,由后端校验规则归属。
- 规则列表增加“厂区”列,优先显示 `deptName`,其次显示 `deptId`,均无时显示“全局规则”;详情同步使用相同兜底。
- 新建表单将“规则名称”设为必填,校验通过后继续使用现有 `ruleName` 字段提交;未增加编辑按钮或更新接口,其余 Tab、分页和当前页排序逻辑保持不变。
- `src/api/points/rule.js` 定向 ESLint 通过,积分页面可成功生产编译;页面整文件 ESLint 仍有既有压缩模板及脚本格式问题,未做无关的全文件格式化。生产构建成功,仅有项目既有 warning;未使用真实厂区管理员账号联调。
## 2026-09-15:隐患台账状态与附件展示调整
- 列表状态按后端字典统一为 `draft` 待提交、`reviewing` 审核中、`rectifying` 整改中、`approved` 已通过、`rejected` 已驳回;历史数字值和旧状态名称仅作兼容识别。
- “去审核”按钮仅在审核中显示,筛选项、统计、Tag、详情状态和底部状态说明同步更新为五态文案。
- 主列表“平台同步”列暂时注释,保留同步字段、失败判断、重试方法和详情流程字段,后续可直接恢复。
- 详情附件改为三列图片九宫格:图片按 `fileUrl/filePath` 生成访问地址,点击 `el-image` 打开同组大图预览;非图片附件显示文件块并支持新窗口打开。
- 未新增或修改接口;继续使用台账列表、详情和附件接口。单文件 ESLint、Vue 模板编译、生产构建和 `git diff --check` 通过,构建仅有既有资源体积 warning。
## 2026-09-15:隐患台账新版 Table UI 改造
- 隐患台账主列表由独立筛选栏和 `el-card` 切换为统一的 `<data-list-panel modern-table>`,筛选、当前筛选/本页状态统计、表格、分页和状态说明按新版列表结构布局。
- 主表增加 Element UI 原生 `border` 并移除 `stripe`,由 `modern-table` 隐藏外框和竖向分隔线,在保持新版视觉的同时支持拖拽表头列宽。
- 详情、去审核和同步重试按钮采用新版紧凑按钮样式;列表字段、状态 Tag、固定操作列、溢出提示和空态保持完整。
- 未修改台账列表、详情、附件、同步重试或部门树接口,也未调整查询、分页、详情、审核及同步重试业务逻辑。
- 单文件 ESLint、开发服务热编译、生产构建和 `git diff --check` 通过;构建仅有项目既有 dotenv、Browserslist、webpack 弃用及资源体积 warning。
## 2026-09-15:Token 过期回跳、角色更多操作与 Table 列拖拽修复
- 定位 404 根因:过期 Token 和主动退出仍跳转已废弃 `/index`,无 Token 路由守卫将其写入 `redirect`,登录成功恢复该地址后命中 404。
- 过期会话改为前端登出,清空 Token、角色和权限后替换到 `/login`,不再使用失效 Token 请求后端退出;主动退出及获取用户信息失败也统一避开 `/index`。
- 登录页增加历史回跳兜底,`/index`、`/404`、`/login` 均回落至 `/hazard/ledger`,避免已打开的旧登录链接继续触发 404。
- 角色列表将原“更多”文本入口改为带 Tooltip 的省略号图标按钮,点击展开既有“数据权限、分配用户”,权限字符和事件逻辑不变。
- 为 16 个 `DataListPanel` Card 主列表补回 Element UI 的 `border` 行为属性,从而恢复表头列宽拖拽;既有 Card CSS 继续隐藏外框和竖向单元格线。
- 按追加要求为 `DataListPanel` 增加默认关闭的 `modern-table` 参数,无竖线 Table 样式只在显式开启时生效;16 个已改造页面全部传入该参数,未改造页面继续使用 Element UI 原竖线样式。
- 补齐系统监控旧表格的原生 `border`:在线用户、定时任务、调度日志和缓存列表共 5 张表恢复竖向分隔线与列宽拖拽;操作日志、登录日志保持新版无竖线样式。
- `src/permission.js` 定向 ESLint、开发编译、生产构建和 `git diff --check` 通过;其他相关历史文件仍有既有 ESLint 格式问题,构建仅有项目既有 warning。真实过期 Token 和角色权限账号仍需在测试环境端到端回归。
## 2026-09-14:登录框响应式居中修复
- 修复登录页拖拽浏览器宽高时登录框偏移:移除装饰层固定 `1920×1080` 尺寸、绝对定位和固定负边距,改为视口尺寸与 Flex 水平/垂直居中。
- 背景图和平台装饰图改用 `cover` 保持比例;登录框保留 550px 桌面宽度并增加窄屏安全边距,低高度窗口支持滚动,验证码区域可随宽度收缩。
- 未修改验证码、记住密码、登录接口、路由跳转及用户现有“积分管理系统”文案。
- 开发服务热编译和生产构建成功,仅有项目既有构建 warning;定向 ESLint 仍报告该文件未修改模板/脚本中的历史格式问题。
## 2026-09-14:隐患流程配置页面
- 新增 `src/api/flowable/hazardConfig.js`,封装流程模板配置列表、详情、新增、修改、删除、当前厂区已配置模板、全部厂区和当前用户厂区请求。
- 将空白隐患流程配置页实现为最新 `DataListPanel` Card 列表:厂区/隐患等级/状态筛选、批量选择、分页、新增、修改、状态 Tag、删除确认和行内操作。
- 列表状态按用户要求只展示 Tag:正常为绿色、停用为灰色;启用/停用通过编辑弹窗和 `PUT /flowable/hazardFlowConfig` 修改完整配置,删除继续使用现有 `DELETE /flowable/hazardFlowConfig/{id}`。
- 超级管理员通过 `admin` 角色标识加载并选择全部厂区;二级管理员调用 `myFactory` 显示禁用的所属厂区控件,列表和新增请求不主动传 `deptId/deptName`,由后端按用户权限过滤和填充。
- 真实列表响应已确认使用 `data.list` 和字符串 `data.total`,页面固定解析并将总数转为数字;状态字段和状态筛选保留。定向 ESLint 和生产构建通过,仅有项目既有构建 warning。
## 2026-09-12:流程管理四个主列表 Card UI 统一
- 流程监听、流程定义、表单配置、流程表达式四个页面的主列表统一复用共享 `DataListPanel`,采用紧凑筛选、批量操作、白色 Card、无竖向单元格线和 Card 内分页结构。
- 新增/修改、删除、导出及行内操作按钮按现有用户/角色管理样式统一主次配色,同时保留原权限指令、选中禁用条件和事件。
- 流程定义页保留原“流程设计说明”,并将其放在主列表 Card 头部;流程图、XML 上传、主表单配置等弹窗及挂载表单弹窗内部表格未修改。
- 四页继续使用现有 `listener`、`definition`、`form`、`expression` API 封装,接口、查询参数、字段、响应解析和业务脚本均未改变。
- 开发服务热编译、`git diff --check` 和生产构建通过;构建仅有既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 仍有四页历史格式问题,本次未越界批量格式化。
## 2026-09-12:积分规则列表 Card UI 统一
- 积分管理的积分规则页复用共享 `DataListPanel`,筛选、新建、表格和分页沿用用户/角色管理列表的 Card 结构及无竖向单元格线样式。
- 将“同一隐患等级支持 A/B/C…”说明移动到“积分规则配置 · 多档位”标题下方;将档位标准说明移动到两个底部按钮下方。
- 底部按钮按确认稿调整为“保存为新版本 V4”蓝色主按钮和“历史月份试算”白色次按钮;点击仍使用原未接接口提示,不新增请求。
- 未修改积分规则的接口、字段、权限、排序、筛选、新增、详情、启停、删除或分页逻辑;部门管理已由用户确认完成,本次未继续调整。
- `git diff --check` 和生产构建通过;构建仅有既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 显示积分页面已有整文件格式问题,本次按 UI 范围未做全文件自动格式化。
## 2026-09-10:系统管理八个列表页 Card UI 批量替换
- 菜单管理、部门管理、岗位管理、字典管理、参数管理、通知公告、操作日志和登录日志统一使用共享 `DataListPanel` 的筛选、操作、Card 表格和分页插槽。
- 扩展 `DataListPanel` 通用样式类,统一紧凑筛选控件、按钮布局、无竖向单元格线、行内操作和移动端换行,供后续列表页继续复用。
- 菜单和部门继续使用原树形表格并保持展开/折叠;其余分页页面只将原分页移入 Card footer;操作日志和登录日志的默认排序及 `sort-change` 原样保留。
- 页面现有列表字段、权限指令、API 导入、查询参数、业务方法、缓存刷新、清空、解锁、详情和编辑弹窗均未修改,也未新增任何模块。
- 公共 `DataListPanel` 定向 ESLint 通过,`git diff --check` 通过,生产构建成功;仅有项目既有 Browserslist、Webpack 弃用和资源体积 warning。
## 2026-09-10:角色管理 Card 列表 UI 替换
- 角色管理 `src/views/system/role/index.vue` 的列表区域改用共享 `DataListPanel`,采用筛选区、批量操作区、白色 Card 表格和底部分页结构。
- 保留角色编号、角色名称、权限字符、显示顺序、状态、创建时间和操作列;表格沿用全局紧凑字号与无竖向单元格线样式。
- 新增/修改/删除/导出按钮、状态开关、行内修改/删除/更多(数据权限、分配用户)及权限指令均保持原事件和权限字符,仅调整视觉呈现。
- 未增加左侧部门树或其他模块,角色新增/编辑、数据权限弹窗和分配用户入口代码未改动;未新增或修改接口。
- `git diff --check` 通过;定向 ESLint 仍报告角色页面原有脚本格式问题(本次新增模板仅有少量既有规则 warning),公共 `DataListPanel` 无新增错误;生产构建成功,仅有既有 Browserslist、Webpack 弃用和资源体积 warning。
## 2026-09-09:用户管理 Card 列表试点
- 新增全局注册的 `src/components/DataListPanel/index.vue`,提供筛选、操作、标题、表格和分页插槽,并统一白色 Card、圆角、浅边框和无竖向单元格线的表格外观。
- 用户管理保留“左侧部门树 + 右侧列表”,右侧调整为顶部用户账号、手机号、状态、日期和岗位筛选,加批量操作及 Card 列表。
- 左侧部门树数据仍使用原接口和 `deptId` 参数,保留部门名称搜索、节点点击查询及重置联动;此前改为顶部 `Treeselect` 的方案已按用户反馈撤回。
- 按截图统一按钮:搜索/新增/修改/更多为蓝色,删除为红色,重置/导入/导出为白底;状态使用绿色/灰色标签并保留点击二次确认切换。
- 用户列表、增删改、状态、导入导出、权限字符和分页逻辑全部沿用现有实现,没有修改接口协议。
- 新公共组件定向 ESLint 通过,`git diff --check` 通过,生产构建成功;只有项目既有 Browserslist、Webpack 弃用和资源体积 warning。
## 2026-09-09:管理后台原型视觉统一第一阶段
- 以交付原型的浅色管理后台规范为基准,保留现有 Vue 2、Element UI、登录、动态菜单、权限和接口逻辑,在 `zhongyou_web` 内进行整体 UI 改造。
- 移除 `App.vue` 中固定 1920×1080 的 `ScaleBox` 全局缩放,恢复正常流式后台布局,避免字体和间距随屏幕失真。
- 侧栏由 200px 改为 212px,Header 由 50px 改为 52px;统一菜单行高、字号、选中态、浅色分割线、Logo 和主内容偏移。
- 新增 `src/assets/styles/prototype-theme.scss`,统一页面色板以及 Element UI 的 Card、Tabs、Table、Form、Input、Button、Tag、Dialog、Switch、Pagination 和 Descriptions。
- 默认主题色切换为 `#1890ff`、表格字号切换为 12px;为本地布局配置增加 `prototype-v1` 版本标识,避免旧缓存覆盖新视觉默认值。
- 调整 Header 消息、APK、用户名、面包屑以及公共分页组件;积分管理、隐患台账、隐患审核同步适配新背景和 52px 顶部高度。
- 本次没有新增或修改接口,也没有调整鉴权、权限或动态菜单行为。
- `git diff --check` 通过;生产构建成功,仅有既有 Browserslist、Webpack 弃用和资源体积 warning。定向 ESLint 仍报告相关历史文件已有格式问题,未在本次任务中批量改写。
## 2026-09-05:隐患台账构建验证 ## 2026-09-05:隐患台账构建验证
- 执行 `npm run build:prod`,构建成功;仅保留 dotenv 配置行、Browserslist 数据过期和资源体积 warning。 - 执行 `npm run build:prod`,构建成功;仅保留 dotenv 配置行、Browserslist 数据过期和资源体积 warning。
@ -48,3 +209,38 @@
- 修复 Header、用户名、箭头、APK 等元素在浅色背景下的文字颜色。 - 修复 Header、用户名、箭头、APK 等元素在浅色背景下的文字颜色。
- 修改生产构建脚本以兼容 Node 22/OpenSSL 3。 - 修改生产构建脚本以兼容 Node 22/OpenSSL 3。
- 生产构建通过;只有旧 Browserslist 数据和资源体积警告。 - 生产构建通过;只有旧 Browserslist 数据和资源体积警告。
# 2026-09-09
## 默认登录首页调整
- 登录成功且没有 `redirect` 参数时,默认跳转到隐患台账 `/hazard/ledger`。
- 两处根路由重定向统一为 `/hazard/ledger`,已登录用户访问登录页时也通过根路由进入隐患台账。
- 保留已有 `redirect` 参数优先级,用户被登录拦截后仍返回原目标页面。
- 首次实测进入 404 后,在已有隐藏 `/hazard` 基础路由下增加 `ledger` 子路由,避免默认首页依赖动态菜单注册时序或菜单响应是否包含该路径;侧栏菜单仍由后端控制,接口仍执行后端鉴权和数据权限。
- 生产构建通过,仅有既有 Browserslist、构建工具弃用和资源体积 warning;相关历史文件仍存在与本次无关的 ESLint 格式问题。
# 2026-09-08
## 重新生成 API 文档
- 使用上级目录最新 `api.json` 重新生成 `docs/api/`。
- 当前文档包含 28 个模块、278 个接口和 32 个模型。
- 新增/更新积分规则接口及厂区接口资料,供积分管理页面开发使用。
- 同步更新积分管理页面的接口映射和开发前任务梳理;尚未修改业务 Vue 代码。
## 积分管理需求确认
- 确认档位使用 `hazardCategory`,以 A、B、C…表示,用户可修改;新增时前端按当前隐患等级已有最大档位生成下一字母。
- 确认隐患等级下拉:`general`=一般隐患、`major`=较大隐患、`critical`=重大隐患。
- 确认规则列表按一般→较大→重大分组,各组内按档位字母升序排列;`enabled` 新增默认 1。
- 确认 `hazardLevel`、档位、`points` 为必填;`priority` 可由前端按当前等级最大值+1生成,用户可修改。
- 确认超级管理员使用 `admin` 角色判断;详情字段由页面按主要业务和审计字段定义。
- 补充确认:新建规则必须指定 `deptId`,页面暂不提供新建全局规则入口。超级管理员厂区选择使用 `factoryList` 返回的全部数据并展开。前端 API 封装只保留一层 `/gd_dataserver` 前缀之后的业务路径。
## 积分规则页面开发完成
- 新增 `src/api/points/rule.js`,封装规则分页、厂区列表、新增、详情、启停和删除接口。
- 完成积分管理页面:四个 Tab(后三个暂禁用)、积分规则卡片、超级管理员厂区筛选和新建入口、等级分组/档位排序、分页、详情弹窗、Switch 启停、删除二次确认。
- 新增规则校验 `deptId/hazardLevel/hazardCategory/points` 必填,默认 `enabled=1`,档位按当前等级已有最大字母自动生成,`priority` 可修改;页面暂不提供新建全局规则入口。
- “保存为新版本”“V4历史月份试算”暂以提示按钮展示,不调用接口。
- ESLint 检查通过;生产构建通过,仅有既有资源体积和 Browserslist warning。

Loading…
Cancel
Save