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.
2 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: 5d91e750f7
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5d91e750f7'
${ noResults }
zhongyouweb/docs/api/modules/12-exchange-operation-log.md

18 KiB
Raw Blame History

兑换操作日志

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

快速索引

接口名称 方法 路径 用途
新增 POST /gd_dataserver/gd_dataserver/business/points/operation/log/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/gd_dataserver/business/points/operation/log/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/gd_dataserver/business/points/operation/log/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
根据属性删除 GET /gd_dataserver/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/gd_dataserver/business/points/operation/log/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
查询所有 GET /gd_dataserver/gd_dataserver/business/points/operation/log/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
分页查询 GET /gd_dataserver/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/gd_dataserver/business/points/operation/log/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
查询订单操作日志 GET /gd_dataserver/gd_dataserver/business/points/operation/log/order/{orderId} 返回 data 为 ExchangeOperationLog 数组，字段同上。
逻辑删除 GET /gd_dataserver/gd_dataserver/business/points/operation/log/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
修改 POST /gd_dataserver/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。

接口详情

新增

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：兑换操作日志
  • 必填：文档未标记
字段 必填 类型 说明 示例
createTime 否 string / date-time 创建时间 -
durationMs 否 integer / int32 耗时（毫秒） -
errorMsg 否 string 错误信息 -
id 否 integer / int64 主键ID -
ipAddress 否 string 操作IP -
operationDesc 否 string 操作描述 -
operationType 否 string 操作类型：VIEW/VALIDATE/CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
orderId 否 integer / int64 关联订单ID -
orderNo 否 string 关联订单号 -
requestParams 否 string 请求参数（JSON） -
responseResult 否 string 响应结果（JSON） -
status 否 string 操作结果：SUCCESS/FAIL -
userAgent 否 string 客户端UA -
userId 否 integer / int64 操作用户ID -

响应：

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

批量新增

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

参数：

无

请求体：

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

响应：

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

新增并返回保存的数据

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：兑换操作日志
  • 必填：文档未标记
字段 必填 类型 说明 示例
createTime 否 string / date-time 创建时间 -
durationMs 否 integer / int32 耗时（毫秒） -
errorMsg 否 string 错误信息 -
id 否 integer / int64 主键ID -
ipAddress 否 string 操作IP -
operationDesc 否 string 操作描述 -
operationType 否 string 操作类型：VIEW/VALIDATE/CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
orderId 否 integer / int64 关联订单ID -
orderNo 否 string 关联订单号 -
requestParams 否 string 请求参数（JSON） -
responseResult 否 string 响应结果（JSON） -
status 否 string 操作结果：SUCCESS/FAIL -
userAgent 否 string 客户端UA -
userId 否 integer / int64 操作用户ID -

响应：

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

根据属性删除

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
durationMs query 否 integer / int32 耗时（毫秒） -
errorMsg query 否 string 错误信息 -
id query 否 integer / int64 主键ID -
ipAddress query 否 string 操作IP -
operationDesc query 否 string 操作描述 -
operationType query 否 string 操作类型：VIEW/VALIDATE/CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
orderId query 否 integer / int64 关联订单ID -
orderNo query 否 string 关联订单号 -
requestParams query 否 string 请求参数（JSON） -
responseResult query 否 string 响应结果（JSON） -
status query 否 string 操作结果：SUCCESS/FAIL -
userAgent query 否 string 客户端UA -
userId query 否 integer / int64 操作用户ID -

响应：

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

主键删除

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

参数：

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

响应：

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

批量删除

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

参数：

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

响应：

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

查询所有

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

参数：

无

响应：

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

分页查询

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
durationMs query 否 integer / int32 耗时（毫秒） -
errorMsg query 否 string 错误信息 -
id query 否 integer / int64 主键ID -
ipAddress query 否 string 操作IP -
operationDesc query 否 string 操作描述 -
operationType query 否 string 操作类型：VIEW/VALIDATE/CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
orderId query 否 integer / int64 关联订单ID -
orderNo query 否 string 关联订单号 -
pageNum query 是 integer / int32 页码 -
requestParams query 否 string 请求参数（JSON） -
responseResult query 否 string 响应结果（JSON） -
status query 否 string 操作结果：SUCCESS/FAIL -
userAgent query 否 string 客户端UA -
userId query 否 integer / int64 操作用户ID -
pageSize query 是 integer / int32 每页条数 -

响应：

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

详情

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

参数：

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

响应：

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

条件查询

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
durationMs query 否 integer / int32 耗时（毫秒） -
errorMsg query 否 string 错误信息 -
id query 否 integer / int64 主键ID -
ipAddress query 否 string 操作IP -
operationDesc query 否 string 操作描述 -
operationType query 否 string 操作类型：VIEW/VALIDATE/CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
orderId query 否 integer / int64 关联订单ID -
orderNo query 否 string 关联订单号 -
requestParams query 否 string 请求参数（JSON） -
responseResult query 否 string 响应结果（JSON） -
status query 否 string 操作结果：SUCCESS/FAIL -
userAgent query 否 string 客户端UA -
userId query 否 integer / int64 操作用户ID -

响应：

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

查询订单操作日志

  • 用途： 返回 data 为 ExchangeOperationLog 数组，字段同上。
  • 请求： GET /gd_dataserver/gd_dataserver/business/points/operation/log/order/{orderId}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getLogsByOrderIdUsingGET

参数：

字段 位置 必填 类型 说明 示例
orderId path 是 integer / int64 订单ID -

响应：

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

逻辑删除

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

参数：

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

响应：

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

修改

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：兑换操作日志
  • 必填：文档未标记
字段 必填 类型 说明 示例
createTime 否 string / date-time 创建时间 -
durationMs 否 integer / int32 耗时（毫秒） -
errorMsg 否 string 错误信息 -
id 否 integer / int64 主键ID -
ipAddress 否 string 操作IP -
operationDesc 否 string 操作描述 -
operationType 否 string 操作类型：VIEW/VALIDATE/CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY -
orderId 否 integer / int64 关联订单ID -
orderNo 否 string 关联订单号 -
requestParams 否 string 请求参数（JSON） -
responseResult 否 string 响应结果（JSON） -
status 否 string 操作结果：SUCCESS/FAIL -
userAgent 否 string 客户端UA -
userId 否 integer / int64 操作用户ID -

响应：

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

查询用户操作日志

  • 用途： 返回 data 为 ExchangeOperationLog 数组，每个元素包含：id、userId-用户ID、orderId-订单ID、orderNo-订单号、operationType-操作类型、operationDetail-操作详情、result-结果、createTime。
  • 请求： GET /gd_dataserver/gd_dataserver/business/points/operation/log/user/{userId}
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getLogsByUserIdUsingGET

参数：

字段 位置 必填 类型 说明 示例
userId path 是 integer / int64 用户ID -

响应：

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