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.
10 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: 3129d82d04
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3129d82d04'
${ noResults }
zhongyouweb/docs/api/modules/06-points-rule.md

16 KiB
Raw Blame History

积分规则配置

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

快速索引

接口名称 方法 路径 用途
新增 POST /gd_dataserver/gd_dataserver/business/points/rule/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/gd_dataserver/business/points/rule/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/gd_dataserver/business/points/rule/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
计算积分 GET /gd_dataserver/gd_dataserver/business/points/rule/calculatePoints 根据隐患等级和类别查询对应奖励积分。返回 data 为 Integer 类型的积分数值，如 50。
根据属性删除 GET /gd_dataserver/gd_dataserver/business/points/rule/delete 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
主键删除 GET /gd_dataserver/gd_dataserver/business/points/rule/deleteById 根据主键ID删除单条记录，成功返回 data 为 null。
批量删除 GET /gd_dataserver/gd_dataserver/business/points/rule/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
查询所有 GET /gd_dataserver/gd_dataserver/business/points/rule/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
分页查询 GET /gd_dataserver/gd_dataserver/business/points/rule/getListByPage 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
详情 GET /gd_dataserver/gd_dataserver/business/points/rule/info 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
条件查询 GET /gd_dataserver/gd_dataserver/business/points/rule/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
逻辑删除 GET /gd_dataserver/gd_dataserver/business/points/rule/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
积分规则试算 GET /gd_dataserver/gd_dataserver/business/points/rule/trialCalculate 模拟积分计算过程，返回匹配的规则详情和计算结果。返回 data 为对象，包含：hazardLevel-输入的隐患等级、hazardCategory-输入的隐患类别、matchedRule-匹配到的规则对象{id,ruleName,points,priority}或null、calculatedPoints-计算得到的积分数值(无匹配时为0)。
修改 POST /gd_dataserver/gd_dataserver/business/points/rule/updateById 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。

接口详情

新增

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：积分规则配置
  • 必填：文档未标记
字段 必填 类型 说明 示例
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>
201 Created -
401 Unauthorized -
403 Forbidden -
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 为保存的实体对象。
  • 请求： POST /gd_dataserver/gd_dataserver/business/points/rule/addReturn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addReturnUsingPOST_10

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：积分规则配置
  • 必填：文档未标记
字段 必填 类型 说明 示例
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>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

计算积分

  • 用途： 根据隐患等级和类别查询对应奖励积分。返回 data 为 Integer 类型的积分数值，如 50。
  • 请求： GET /gd_dataserver/gd_dataserver/business/points/rule/calculatePoints
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： calculatePointsUsingGET

参数：

字段 位置 必填 类型 说明 示例
hazardLevel query 是 string 隐患等级编码 -
hazardCategory query 是 string 隐患类别编码 -

响应：

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

根据属性删除

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
enabled query 否 integer / int32 是否启用：0-禁用 1-启用 -
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 更新时间 -

响应：

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

主键删除

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

参数：

字段 位置 必填 类型 说明 示例
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/rule/deleteByIds
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_21

参数：

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

响应：

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

查询所有

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

参数：

无

响应：

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

分页查询

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

参数：

字段 位置 必填 类型 说明 示例
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 每页条数 -

响应：

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

详情

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

参数：

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

响应：

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

条件查询

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

参数：

字段 位置 必填 类型 说明 示例
createTime query 否 string / date-time 创建时间 -
enabled query 否 integer / int32 是否启用：0-禁用 1-启用 -
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 更新时间 -

响应：

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

逻辑删除

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

参数：

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

响应：

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

积分规则试算

  • 用途： 模拟积分计算过程，返回匹配的规则详情和计算结果。返回 data 为对象，包含：hazardLevel-输入的隐患等级、hazardCategory-输入的隐患类别、matchedRule-匹配到的规则对象{id,ruleName,points,priority}或null、calculatedPoints-计算得到的积分数值(无匹配时为0)。
  • 请求： GET /gd_dataserver/gd_dataserver/business/points/rule/trialCalculate
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： trialCalculateUsingGET

参数：

字段 位置 必填 类型 说明 示例
hazardLevel query 是 string 隐患等级编码 -
hazardCategory query 是 string 隐患类别编码 -

响应：

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

修改

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

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：积分规则配置
  • 必填：文档未标记
字段 必填 类型 说明 示例
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>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -