zhongyouweb/docs/api/schemas.md

数据模型与字段字典

共 32 个模型。

FlowCommentDto

字段	必填	类型	说明	示例/枚举
comment	否	string	-	-
type	否	string	-	-

FlowSaveXmlVo

字段	必填	类型	说明	示例/枚举
category	否	string	-	-
name	否	string	-	-
xml	否	string	-	-

R«List«UserEntity»»

字段	必填	类型	说明	示例/枚举
code	否	integer / int32	-	-
data	否	array	-	-
msg	否	string	-	-

R«UserEntity»

字段	必填	类型	说明	示例/枚举
code	否	integer / int32	-	-
data	否	UserEntity	-	-
msg	否	string	-	-

R«string»

字段	必填	类型	说明	示例/枚举
code	否	integer / int32	-	-
data	否	string	-	-
msg	否	string	-	-

UserEntity

用户实体

字段	必填	类型	说明	示例/枚举
mobile	否	string	用户手机	-
password	否	string	用户密码	-
userId	否	integer / int32	用户ID	-
username	否	string	用户名称	-

兑换安全配置

字段	必填	类型	说明	示例/枚举
antiFarmEnabled	否	integer / int32	隐患上报防刷检测是否启用：1-启用 0-禁用	-
configName	否	string	配置名称	-
createTime	否	string / date-time	创建时间	-
dailyLimitPerUser	否	integer / int32	每人每日兑换上限（积分）	-
dailyOrderCountLimit	否	integer / int32	每人每日兑换次数上限	-
enabled	否	integer / int32	是否启用：1-启用 0-禁用	-
id	否	integer / int64	主键ID	-
largeAmountNeedApproval	否	integer / int32	大额兑换是否需审批：1-是 0-否	-
largeAmountThreshold	否	integer / int32	大额兑换预警阈值（积分）	-
monthlyLimitPerUser	否	integer / int32	每人每月上限（积分）	-
pointsRatio	否	integer / int32	积分比例（N积分=1元）	-
rapidExchangeThreshold	否	integer / int32	短时间内兑换次数阈值（触发预警）	-
rapidExchangeWindowMinutes	否	integer / int32	快速兑换检测时间窗口（分钟）	-
remark	否	string	备注	-
singleMaxPoints	否	integer / int32	单笔最大积分	-
singleMinPoints	否	integer / int32	单笔最小积分	-
updateTime	否	string / date-time	更新时间	-
yearlyLimitPerUser	否	integer / int32	每人每年上限（积分）	-

兑换操作日志

字段	必填	类型	说明	示例/枚举
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	-

兑换物品

字段	必填	类型	说明	示例/枚举
createTime	否	string / date-time	创建时间	-
dailyLimitPerUser	否	integer / int32	每人每日兑换上限（0表示无限制）	-
description	否	string	物品描述	-
externalLink	否	string	第三方兑换链接	-
id	否	integer / int64	主键ID	-
itemCode	否	string	物品编码	-
itemName	否	string	物品名称	-
pointsRequired	否	integer / int32	所需积分	-
sortOrder	否	integer / int32	排序权重	-
status	否	integer / int32	状态：0-下架 1-上架	-
stock	否	integer / int32	库存数量（0表示无限）	-
thirdPartyCode	否	string	第三方平台物品编码	-
updateTime	否	string / date-time	更新时间	-

兑换订单追踪

字段	必填	类型	说明	示例/枚举
createTime	否	string / date-time	创建时间	-
fromStatus	否	integer / int32	变更前状态	-
id	否	integer / int64	主键ID	-
ipAddress	否	string	操作IP	-
operateType	否	string	操作类型：CREATE/FREEZE/UNFREEZE/DEDUCT/SUBMIT/CANCEL/REFUND/RETRY	-
operator	否	string	操作人	-
orderId	否	integer / int64	订单ID	-
orderNo	否	string	订单号	-
remark	否	string	操作备注	-
statusName	否	string	状态名称	-
toStatus	否	integer / int32	变更后状态	-

商城端-用户信息

商城端获取用户基本信息时的响应数据结构

字段	必填	类型	说明	示例/枚举
email	否	string	用户邮箱	zhangsan@example.com
id	否	string	用户唯一标识ID	1001
phone	否	string	用户手机号	13800138000
sap	否	string	用户SAP编号（商城端用户唯一标识）	SAP001
sex	否	integer / int32	性别 1:男 2:女	1
userName	否	string	用户姓名	张三

商城端-用户积分信息

商城端获取用户积分余额时的响应数据结构

字段	必填	类型	说明	示例/枚举
id	否	string	用户唯一标识ID	1001
integral	否	number / bigdecimal	用户可用积分额度	5000
phone	否	string	用户手机号	13800138000
sap	否	string	用户SAP编号（商城端用户唯一标识）	SAP001
userName	否	string	用户姓名	张三

商城端-积分操作请求

商城端扣减或退还积分时的请求数据结构

字段	必填	类型	说明	示例/枚举
integralValue	是	number / bigdecimal	积分数值（正整数）	1000
orderNum	是	string	订单号（商城订单号，用于幂等校验）	ORDER202608210001
sap	是	string	用户SAP编号（从获取用户信息接口获得）	SAP001

商城端接口统一响应«Void»

商城端对接接口的统一响应格式，包含success/errorCode/message/data四个字段

字段	必填	类型	说明	示例/枚举
errorCode	否	string	错误码（成功时为null）	1001, 1002, 2001, 2002
message	否	string	提示信息	操作成功
success	否	boolean	请求是否成功	true

商城端接口统一响应«商城端-用户信息»

商城端对接接口的统一响应格式，包含success/errorCode/message/data四个字段

字段	必填	类型	说明	示例/枚举
data	否	商城端-用户信息	业务数据体（无数据时为null）	-
errorCode	否	string	错误码（成功时为null）	1001, 1002, 2001, 2002
message	否	string	提示信息	操作成功
success	否	boolean	请求是否成功	true

商城端接口统一响应«商城端-用户积分信息»

商城端对接接口的统一响应格式，包含success/errorCode/message/data四个字段

字段	必填	类型	说明	示例/枚举
data	否	商城端-用户积分信息	业务数据体（无数据时为null）	-
errorCode	否	string	错误码（成功时为null）	1001, 1002, 2001, 2002
message	否	string	提示信息	操作成功
success	否	boolean	请求是否成功	true

工作流任务相关--请求参数

字段	必填	类型	说明	示例/枚举
assignee	否	string	审批人	-
candidateGroups	否	array	审批组	-
candidateUsers	否	array	候选人	-
comment	否	string	任务意见	-
currentChildExecutionId	否	string	子执行流ID	-
defId	否	string	流程环节定义ID	-
deploymentId	否	string	-	-
flag	否	boolean	子执行流是否已执行	false
instanceId	否	string	流程实例Id	-
result	否	string	任务审批结果 1-同意 2-退回	-
targetKey	否	string	节点	-
taskId	否	string	任务Id	-
userId	否	string	用户Id	-
variables	否	object	流程变量信息	-

工作流任务相关-返回参数

字段	必填	类型	说明	示例/枚举
assigneeDeptName	否	string	任务执行人部门	-
assigneeId	否	string	任务执行人Id	-
assigneeName	否	string	任务执行人名称	-
businessKey	否	string	流程业务ID	-
candidate	否	string	候选执行人	-
candidateGroup	否	string	候选执行组	-
category	否	string	流程类型	-
comment	否	FlowCommentDto	任务意见	-
createTime	否	string / date-time	任务创建时间	-
deployId	否	string	流程部署编号	-
deptName	否	string	部门名称	-
duration	否	string	任务耗时	-
endTime	否	string / date-time	流程完成时间	-
executionId	否	string	任务执行编号	-
finishTime	否	string / date-time	任务完成时间	-
hisProcInsId	否	string	历史流程实例ID	-
ishq	否	boolean	是否会签	false
procDefId	否	string	流程ID	-
procDefKey	否	string	流程key	-
procDefName	否	string	流程定义名称	-
procDefVersion	否	integer / int32	流程定义内置使用版本	-
procInsId	否	string	流程实例ID	-
procVars	否	object	流程变量信息	-
startDeptName	否	string	流程发起人部门名称	-
startUserId	否	string	流程发起人Id	-
startUserName	否	string	流程发起人名称	-
taskDefKey	否	string	任务Key	-
taskId	否	string	任务编号	-
taskLocalVars	否	object	局部变量信息	-
taskName	否	string	任务名称	-
taskNum	否	string	开始节点/结束节点 start--开始节点 end--结束节点	-

工作流签字任务相关--请求参数

字段	必填	类型	说明	示例/枚举
assignee	否	string	审批人	-
candidateGroups	否	array	审批组	-
candidateUsers	否	array	候选人	-
comment	否	string	任务意见	-
currentChildExecutionId	否	string	子执行流ID	-
defId	否	string	流程环节定义ID	-
deploymentId	否	string	部署ID	-
file	否	string	拍照	-
flag	否	boolean	子执行流是否已执行	false
instanceId	否	string	流程实例Id	-
qz	否	string	任务签字	-
result	否	string	任务审批结果 1-同意 2-退回	-
targetKey	否	string	节点	-
taskId	否	string	任务Id	-
taskName	否	string	任务名称	-
type	否	string	业务类型	-
userId	否	string	用户Id	-
userName	否	string	用户名称	-
variables	否	object	流程变量信息	-
zyxkid	否	string	作业许可Id	-

操作审计日志

字段	必填	类型	说明	示例/枚举
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	操作备注	-

流程定义

字段	必填	类型	说明	示例/枚举
category	否	string	流程分类	-
deploymentId	否	string	部署ID	-
deploymentTime	否	string / date-time	部署时间	-
deptId	否	string	所属机构ID	-
deptName	否	string	所属机构名称	-
flowKey	否	string	流程key	-
formId	否	integer / int64	配置表单id	-
formName	否	string	配置表单名称	-
id	否	string	流程id	-
name	否	string	流程名称	-
suspensionState	否	integer / int32	流程定义状态: 1:激活 , 2:中止	-
version	否	integer / int32	版本	-

用户积分账户

字段	必填	类型	说明	示例/枚举
availableBalance	否	integer / int32	可用积分余额	-
createTime	否	string / date-time	创建时间	-
frozenBalance	否	integer / int32	冻结积分余额	-
id	否	integer / int64	主键ID	-
totalIncome	否	integer / int32	历史总入账积分	-
totalOutcome	否	integer / int32	历史总出账积分	-
updateTime	否	string / date-time	更新时间	-
userId	否	integer / int64	用户ID	-
version	否	integer / int32	乐观锁版本号	-

积分兑换订单

字段	必填	类型	说明	示例/枚举
createTime	否	string / date-time	-	-
finishTime	否	string / date-time	完成时间	-
id	否	integer / int64	主键ID	-
itemId	否	integer / int64	兑换物品ID	-
itemName	否	string	物品名称	-
itemPrice	否	integer / int32	兑换所需积分	-
orderNo	否	string	订单号	-
quantity	否	integer / int32	兑换数量	-
status	否	integer / int32	订单状态：0-待处理 1-处理中 2-兑换成功 3-兑换失败 4-已退款 5-已关闭	-
thirdPartyOrderId	否	string	第三方平台订单号	-
thirdPartyResponse	否	string	第三方回调原始数据	-
totalPoints	否	integer / int32	总消耗积分	-
updateTime	否	string / date-time	更新时间	-
userId	否	integer / int64	用户ID	-

积分流水明细

字段	必填	类型	说明	示例/枚举
afterBalance	否	integer / int32	变动后可用余额	-
afterFrozen	否	integer / int32	变动后冻结余额	-
amount	否	integer / int32	变动积分（正数=入账，负数=出账）	-
beforeBalance	否	integer / int32	变动前可用余额	-
beforeFrozen	否	integer / int32	变动前冻结余额	-
bizId	否	string	业务单号	-
bizType	否	string	业务类型：REPORT-隐患上报奖励 EXCHANGE-兑换扣减 REFUND-退款回滚 FREEZE-冻结 UNFREEZE-解冻	-
createTime	否	string / date-time	创建时间	-
id	否	integer / int64	主键ID	-
operator	否	string	操作人	-
remark	否	string	备注	-
status	否	integer / int32	状态：1-有效 2-已冲正	-
txnNo	否	string	流水号	-
userId	否	integer / int64	用户ID	-

积分申诉

字段	必填	类型	说明	示例/枚举
adjustPoints	否	integer / int32	调整积分（正数补发，负数扣减）	-
appealNo	否	string	申诉编号	-
appealReason	否	string	申诉理由	-
appealType	否	string	申诉类型：REJECT-审核驳回申诉 POINTS-积分异议 OTHER-其他	-
attachmentUrls	否	string	附件URL（JSON数组）	-
canApprove	否	boolean	当前用户是否可审批此流程	false
createTime	否	string / date-time	创建时间	-
flowInstanceId	否	string	流程实例ID（预留）	-
flowStatus	否	integer / int32	流程状态：0-无流程 1-进行中 2-已完成	-
handleRemark	否	string	处理意见/结果说明	-
handleTime	否	string / date-time	处理时间	-
handleUserId	否	integer / int64	处理人用户ID	-
handleUserName	否	string	处理人姓名	-
id	否	integer / int64	主键ID	-
isInitiator	否	boolean	当前用户是否为此流程发起人	false
reportId	否	integer / int64	关联隐患上报ID	-
reportNo	否	string	关联隐患编号	-
status	否	string	申诉状态：0-待受理 1-处理中 2-已通过 3-已驳回 4-已撤回	-
statusName	否	string	申诉状态名称	-
updateTime	否	string / date-time	更新时间	-
userId	否	integer / int64	申诉人用户ID	-
userName	否	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	更新时间	-

防刷分管控配置

字段	必填	类型	说明	示例/枚举
configName	否	string	配置名称	-
createTime	否	string / date-time	创建时间	-
dailyPointsEarnLimit	否	integer / int32	每人每日积分获取上限	-
dailyReportLimit	否	integer / int32	每人每日上报次数上限	-
enabled	否	integer / int32	是否启用：1-启用 0-禁用	-
id	否	integer / int64	主键ID	-
ipExchangeDailyLimit	否	integer / int32	同一IP每日兑换上限	-
remark	否	string	备注	-
reportIntervalMinutes	否	integer / int32	两次上报最小间隔（分钟）	-
sameItemDailyLimit	否	integer / int32	同一商品每人每日兑换上限	-
sameLocationReportLimit	否	integer / int32	同一地点上报次数上限（每日）	-
sameReporterAuditLimit	否	integer / int32	同一上报人每日通过审核次数上限	-
selfReportCheckEnabled	否	integer / int32	是否启用自报自审检测：1-是 0-否	-
updateTime	否	string / date-time	更新时间	-

隐患上报流程提交请求

字段	必填	类型	说明	示例/枚举
attachments	否	array<隐患附件>	附件列表（先调用uploadAttachment接口获取）	-
report	是	隐患信息	隐患信息	-

隐患上报请求

字段	必填	类型	说明	示例/枚举
attachments	否	array<隐患附件>	附件列表	-
report	否	隐患信息	隐患信息	-

隐患信息

字段	必填	类型	说明	示例/枚举
actualCompleteTime	否	string / date-time	实际完成时间	-
auditRemark	否	string	审核备注	-
auditTime	否	string / date-time	审核时间	-
auditUserId	否	integer / int64	审核人用户ID	-
auditUserNameName	否	string	审核人姓名	-
auditUserUsername	否	string	审核人账号	-
canApprove	否	boolean	当前用户是否可审批此流程	false
causeAnalysis	否	string	原因分析	-
chargePersonId	否	integer / int64	整改负责人用户ID	-
chargePersonName	否	string	整改负责人姓名	-
chargePersonUsername	否	string	整改负责人账号	-
createBy	否	string	创建者	-
createTime	否	string / date-time	创建时间	-
currentFlowLevel	否	string	当前流程等级编码（general/major/critical）	-
departmentId	否	integer / int64	部门ID	-
departmentName	否	string	部门名称	-
deployId	否	string	流程模板id	-
description	否	string	隐患描述	-
discoverTime	否	string / date-time	发现时间	-
factoryDeptId	否	string	所属厂区部门ID	-
factoryDeptName	否	string	所属厂区部门名称	-
flowInstanceId	否	string	流程实例id	-
flowStatus	否	integer / int32	流程状态（0-未开始 1-进行中 2-已完成）	-
fundsSource	否	string	资金来源编码	-
fundsSourceId	否	integer / int64	资金来源字典ID	-
fundsSourceName	否	string	资金来源名称	-
governanceType	否	string	治理类型编码	-
governanceTypeId	否	integer / int64	治理类型字典ID	-
governanceTypeName	否	string	治理类型名称	-
hazardCategory	否	string	隐患分类编码	-
hazardCategoryId	否	integer / int64	隐患分类字典ID	-
hazardCategoryName	否	string	隐患分类名称	-
hazardLevel	否	string	管理级别编码	-
hazardLevelId	否	integer / int64	管理级别字典ID	-
hazardLevelName	否	string	管理级别名称	-
hazardName	否	string	隐患名称	-
hazardSourceDetail	否	string	来源具体描述	-
hazardType	否	string	隐患类型编码	-
hazardTypeId	否	integer / int64	隐患类型字典ID	-
hazardTypeName	否	string	隐患类型名称	-
id	否	integer / int64	主键ID	-
isInitiator	否	boolean	当前用户是否为此流程发起人	false
limitedCompleteTime	否	string / date-time	限定完成时间	-
major	否	string	专业编码	-
majorId	否	integer / int64	专业字典ID	-
majorName	否	string	专业名称	-
pointsAwarded	否	integer / int32	奖励积分	-
pointsStatus	否	string	积分发放状态编码	-
pointsStatusId	否	integer / int64	积分发放状态字典ID	-
pointsStatusName	否	string	积分发放状态名称	-
preventiveMeasures	否	string	防范措施	-
pushResponse	否	string	第三方返回结果	-
pushStatus	否	string	推送状态编码	-
pushStatusId	否	integer / int64	推送状态字典ID	-
pushStatusName	否	string	推送状态名称	-
pushTime	否	string / date-time	推送时间	-
rectificationPlan	否	string	整改方案	-
remark	否	string	备注	-
reportNo	否	string	隐患编号	-
reporterId	否	integer / int64	上报人用户ID	-
reporterName	否	string	上报人姓名	-
reporterUsername	否	string	上报人账号	-
riskTarget	否	string	风险分析对象	-
riskUnit	否	string	风险分析单元	-
sourceType	否	string	隐患来源编码	-
sourceTypeId	否	integer / int64	隐患来源字典ID	-
sourceTypeName	否	string	隐患来源名称	-
status	否	string	隐患状态编码	-
statusId	否	integer / int64	隐患状态字典ID	-
statusName	否	string	隐患状态名称	-
supervisorId	否	integer / int64	监察人用户ID	-
supervisorName	否	string	监察人姓名	-
supervisorUsername	否	string	监察人账号	-
thirdPartyId	否	string	第三方系统记录ID	-
unitId	否	integer / int64	单位ID	-
unitName	否	string	单位名称	-
updateBy	否	string	更新者	-
updateTime	否	string / date-time	更新时间	-

隐患流程模板配置

字段	必填	类型	说明	示例/枚举
createBy	否	string	-	-
createByName	否	string	-	-
createTime	否	string / date-time	-	-
deptId	是	string	部门ID（厂区）	100
deptName	否	string	部门名称	一厂
flowKey	是	string	Flowable流程定义Key	hazard_general_flow
flowName	否	string	流程名称	一般隐患奖励审批流程
hazardLevel	是	string	隐患等级编码（general-一般/major-较大/critical-重大）	general
hazardLevelName	否	string	隐患等级名称	一般隐患
id	否	integer / int64	主键ID	-
params	否	object	-	-
status	否	string	状态（0停用 1正常）	1
updateBy	否	string	-	-
updateByName	否	string	-	-
updateTime	否	string / date-time	-	-

隐患附件

字段	必填	类型	说明	示例/枚举
attachmentType	否	string	附件类型：IMAGE-图片 VIDEO-视频 DOCUMENT-文档 OTHER-其他	-
createBy	否	string	创建者	-
createTime	否	string / date-time	创建时间	-
fileName	否	string	文件原始名称	-
filePath	否	string	文件存储路径	-
fileSize	否	integer / int64	文件大小（字节）	-
fileType	否	string	文件MIME类型	-
id	否	integer / int64	主键ID	-
remark	否	string	备注	-
reportId	否	integer / int64	关联隐患ID	-
sortOrder	否	integer / int32	排序	-
suffix	否	string	文件后缀	-
updateBy	否	string	更新者	-
updateTime	否	string / date-time	更新时间	-
uploadUserId	否	integer / int64	上传人用户ID	-