dujiabo
/
zhongyouweb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: c325354e5d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c325354e5d'
${ noResults }
zhongyouweb/docs/api/modules/16-audit-log.md

15 KiB
Raw Blame History

操作审计日志

本模块共 13 个接口。源文件：api.json。

快速索引

接口名称 方法 路径 用途
新增 POST /gd_dataserver/business/audit/log/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/business/audit/log/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/business/audit/log/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
按业务单号查询审计日志 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/business/audit/log/delete 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
主键删除 GET /gd_dataserver/business/audit/log/deleteById 根据主键ID删除单条记录，成功返回 data 为 null。
批量删除 GET /gd_dataserver/business/audit/log/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
查询所有 GET /gd_dataserver/business/audit/log/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
分页查询 GET /gd_dataserver/business/audit/log/getListByPage 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
详情 GET /gd_dataserver/business/audit/log/info 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
条件查询 GET /gd_dataserver/business/audit/log/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
逻辑删除 GET /gd_dataserver/business/audit/log/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
修改 POST /gd_dataserver/business/audit/log/updateById 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。

接口详情

新增

  • 用途： 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/audit/log/add
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addOneUsingPOST_2

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：操作审计日志
  • 必填：文档未标记
字段 必填 类型 说明 示例
afterData 否 string 操作后数据（JSON） -
beforeData 否 string 操作前数据（JSON） -
bizId 否 string 业务单号 -
createTime 否 string / date-time 操作时间 -
id 否 integer / int64 主键ID -
operationType 否 string 操作类型：AUDIT_PASS-审核通过 POINTS_ADJUST-积分调整 EXCHANGE_REFUND-兑换退款 -
operator 否 string 操作人 -
operatorIp 否 string 操作人IP地址 -
remark 否 string 操作备注 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

批量新增

  • 用途： 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/audit/log/addBatch
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addBatchUsingPOST_2

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：array<操作审计日志>
  • 必填：文档未标记

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

新增并返回保存的数据

  • 用途： 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
  • 请求： POST /gd_dataserver/business/audit/log/addReturn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addReturnUsingPOST_2

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：操作审计日志
  • 必填：文档未标记
字段 必填 类型 说明 示例
afterData 否 string 操作后数据（JSON） -
beforeData 否 string 操作前数据（JSON） -
bizId 否 string 业务单号 -
createTime 否 string / date-time 操作时间 -
id 否 integer / int64 主键ID -
operationType 否 string 操作类型：AUDIT_PASS-审核通过 POINTS_ADJUST-积分调整 EXCHANGE_REFUND-兑换退款 -
operator 否 string 操作人 -
operatorIp 否 string 操作人IP地址 -
remark 否 string 操作备注 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

按业务单号查询审计日志

  • 用途： 根据业务单号（如隐患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}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： listByBizIdUsingGET

参数：

字段 位置 必填 类型 说明 示例
bizId path 是 string 业务单号 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

根据属性删除

  • 用途： 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/audit/log/delete
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteUsingGET_2

参数：

字段 位置 必填 类型 说明 示例
afterData query 否 string 操作后数据（JSON） -
beforeData query 否 string 操作前数据（JSON） -
bizId query 否 string 业务单号 -
createTime query 否 string / date-time 操作时间 -
id query 否 integer / int64 主键ID -
operationType query 否 string 操作类型：AUDIT_PASS-审核通过 POINTS_ADJUST-积分调整 EXCHANGE_REFUND-兑换退款 -
operator query 否 string 操作人 -
operatorIp query 否 string 操作人IP地址 -
remark query 否 string 操作备注 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

主键删除

  • 用途： 根据主键ID删除单条记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/audit/log/deleteById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteOneUsingGET_2

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

批量删除

  • 用途： 根据ID列表批量删除记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/audit/log/deleteByIds
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_5

参数：

字段 位置 必填 类型 说明 示例
ids query 是 string ID列表(逗号分隔) -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

查询所有

  • 用途： 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
  • 请求： GET /gd_dataserver/business/audit/log/getAll
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getAllUsingGET_2

参数：

无

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

分页查询

  • 用途： 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
  • 请求： GET /gd_dataserver/business/audit/log/getListByPage
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getListByPageUsingGET_2

参数：

字段 位置 必填 类型 说明 示例
afterData query 否 string 操作后数据（JSON） -
beforeData query 否 string 操作前数据（JSON） -
bizId query 否 string 业务单号 -
createTime query 否 string / date-time 操作时间 -
id query 否 integer / int64 主键ID -
operationType query 否 string 操作类型：AUDIT_PASS-审核通过 POINTS_ADJUST-积分调整 EXCHANGE_REFUND-兑换退款 -
operator query 否 string 操作人 -
operatorIp query 否 string 操作人IP地址 -
pageNum query 是 integer / int32 页码 -
remark query 否 string 操作备注 -
pageSize query 是 integer / int32 每页条数 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

详情

  • 用途： 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
  • 请求： GET /gd_dataserver/business/audit/log/info
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： infoUsingGET_2

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

条件查询

  • 用途： 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
  • 请求： GET /gd_dataserver/business/audit/log/list
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getListUsingGET_2

参数：

字段 位置 必填 类型 说明 示例
afterData query 否 string 操作后数据（JSON） -
beforeData query 否 string 操作前数据（JSON） -
bizId query 否 string 业务单号 -
createTime query 否 string / date-time 操作时间 -
id query 否 integer / int64 主键ID -
operationType query 否 string 操作类型：AUDIT_PASS-审核通过 POINTS_ADJUST-积分调整 EXCHANGE_REFUND-兑换退款 -
operator query 否 string 操作人 -
operatorIp query 否 string 操作人IP地址 -
remark query 否 string 操作备注 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

逻辑删除

  • 用途： 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/audit/log/removeById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_4

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

修改

  • 用途： 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/audit/log/updateById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： updateByIdUsingPOST_2

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：操作审计日志
  • 必填：文档未标记
字段 必填 类型 说明 示例
afterData 否 string 操作后数据（JSON） -
beforeData 否 string 操作前数据（JSON） -
bizId 否 string 业务单号 -
createTime 否 string / date-time 操作时间 -
id 否 integer / int64 主键ID -
operationType 否 string 操作类型：AUDIT_PASS-审核通过 POINTS_ADJUST-积分调整 EXCHANGE_REFUND-兑换退款 -
operator 否 string 操作人 -
operatorIp 否 string 操作人IP地址 -
remark 否 string 操作备注 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -