获取审批表单字段
接口说明: 通过审批设置id查询对应审批表单的字段。
请求方式:POST(HTTPS)
请求地址:https://api.xinrenxinshi.com/v5/workflow/setting/detail
请求Header:
key | value |
---|---|
access_token | 获取的access_token的实际值 |
Query参数:
key | value |
---|---|
sign | 签名值 |
Body参数:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
settingId | Integer | Y | 审批设置id,通过接口获取 |
timestamp | Long | Y | 请求时间戳(精确到毫秒) |
返回结果:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
errcode | Integer | Y | 0成功,其他失败 |
errmsg | String | Y | 结果描述 |
data | FlowSettingDetailResult | N | 处理成功时返回 |
FlowSettingDetailResult
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
fieldData | List<FlowSettingGroup> | Y | 审批全部的字段组 |
relationMap | List<RelationResult> | Y | 关联字段信息 |
RelationResult
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
fieldId | String | Y | 关联字段id |
relation | String | Y | 关联字段的选项id与被关联字段的字段id的映射json字符串 |
FlowSettingGroup
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
groupId | String | Y | 字段分组id |
groupName | String | Y | 字段分组名 |
groupNameEng | String | Y | 字段分组英文名 |
groupType | Integer | Y | 分组类型,0-普通分组,1-明细分组 |
position | Integer | Y | 顺序 |
isHide | Integer | Y | 是否隐藏,0-否,1是 |
isFixed | Integer | Y | 是否是固定字段组,0-否,1是 |
isStart | Integer | N | 是否是第一个明细分组,0否1是 |
isEnd | Integer | N | 是否是最后一个明细分组,0否1是 |
index | Integer | N | 明细分组的下标 |
fields | List<FlowFieldResult> | Y | 分组里的表单字段信息 |
FlowFieldResult
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
fieldId | String | Y | 字段id |
groupId | String | Y | 字段分组id,修改了审批表单设置后,groupid会重新生成 |
type | Integer | Y | 字段类型,字段类型,1:单行文本 2:多行文本 3:数值 4:日期区间 5:日期 6:单选框 7:多选框 8:图片 9:说明文字 11 文件 19:计算公式 20:关联审批单 22:大写金额 23:手写签名 |
labelName | String | Y | 字段名 |
require | Integer | Y | 是否必填,0-否,1是 |
groupType | Integer | Y | 分组类型,0-普通分组,1-明细分组 |
labelNameEng | String | N | 字段名英文 |
dateType | Integer | Y | 日期区间单位,0-按天,1-按小时,2-按小时或天 |
isCondition | Integer | Y | 是否可以作为分支条件,0否1是 |
isNewAndOldValue | Integer | Y | 是否区分新旧值,0否1是 |
isHide | Integer | Y | 是否隐藏字段,0否1是 |
componentType | Integer | Y | 自选组件类型,0-无类型,1-员工,2-部门,9-城市级别,15-大写金额,16-手写签 |
ruleLevel | Integer | Y | 读写级别,1-隐藏,2-只读,3-可编辑 |
startLabelName | String | N | 开始时间的名字 |
endLabelName | String | N | 结束时间的名字 |
longLabelName | String | N | 日期区间类型,开始时间到结束时间的天数的名字 |
startLabelNameEng | String | N | 日期区间类型,开始时间的名字英文 |
endLabelNameEng | String | N | 日期区间类型,结束时间的名字英文 |
longLabelNameEng | String | N | 日期区间类型,开始时间到结束时间的天数的名字英文 |
fieldName | String | N | 字段本身的属性名 |
fieldList | List<Object> | N | 单选/多选里的选项内容列表 |
unit | String | N | 数字字段类型的单位 |
relaxStartLabelName | String | N | 休息开始时间-加班审批特有 |
relaxEndLabelName | String | N | 休息结束时间-加班审批特有 |
relaxStartLabelNameEng | String | N | 休息开始时间-加班审批特有 英文 |
relaxEndLabelNameEng | String | N | 休息结束时间-加班审批特有 英文 |
请求示例(HTTPS):
https://api.xinrenxinshi.com/v5/workflow/setting/detail?sign=7omyqoNIY5QPWKCyQM3Q7Hk8mNQ=
请求Body示例:
{
"settingId":8758671,
"timestamp":1629862969555
}
SDK请求示例(java):
FlowSettingDetailRequest request = new FlowSettingDetailRequest(access_token());
request.setSettingId(8758671);
OpenapiResponse<FlowSettingDetailResult> response = XrxsApprovalService.getFlowSettingDetail(request);
响应示例:
{
"errcode":0,
"errmsg":"成功",
"data":{
"fieldData":[
{
"groupId":"7e8abc552bf84d8b961653d78493752d",
"groupName":"申请详情",
"groupNameEng":null,
"groupType":0,
"position":1,
"isHide":0,
"isFixed":1,
"fields":[
{
"fieldId":"4bc294982d0e470ba930eb1db5d39456",
"groupId":null,
"type":1,
"labelName":"申请类型",
"labelNameEng":"Apply",
"require":0,
"groupType":0,
"dateType":0,
"fieldName":"applicationType",
"fieldList":[
],
"unit":null,
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":null,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
},
{
"fieldId":"11ecdcb614af4a64aeaf5d72340fedc2",
"groupId":null,
"type":6,
"labelName":"请假类型",
"labelNameEng":"Type",
"require":1,
"groupType":0,
"dateType":0,
"fieldName":"holiday_type",
"fieldList":[
],
"unit":null,
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":null,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
},
{
"fieldId":"a5b019e58fb5456fa2022699d3d549c6",
"groupId":null,
"type":6,
"labelName":"申请单位",
"labelNameEng":"Unit",
"require":1,
"groupType":0,
"dateType":0,
"fieldName":"time_unit",
"fieldList":[
],
"unit":null,
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":null,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
},
{
"fieldId":"47b1e915beeb4984a0ab8cae00e4ab11",
"groupId":null,
"type":4,
"labelName":"开始时间,结束时间,请假时长",
"labelNameEng":"开始时间,结束时间,请假时长",
"require":1,
"groupType":0,
"dateType":1,
"fieldName":"startTime,endTime,leave_days",
"fieldList":[
],
"unit":null,
"startLabelName":"开始时间",
"endLabelName":"结束时间",
"longLabelName":"请假时长",
"startLabelNameEng":"Start date",
"endLabelNameEng":"End date",
"longLabelNameEng":"Length",
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":null,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
}
]
},
{
"groupId":"d0872608b9c0462b8cb72cc9a5f28f3b",
"groupName":"申请原由",
"groupNameEng":"New Group 1",
"groupType":0,
"position":1001,
"isHide":0,
"isFixed":0,
"fields":[
{
"fieldId":"eb23e1d104384c7f99ba49d8f8f2f8ef",
"groupId":"d0872608b9c0462b8cb72cc9a5f28f3b",
"type":6,
"labelName":"原因",
"labelNameEng":"New Single Option",
"require":1,
"groupType":0,
"dateType":1,
"fieldName":"",
"fieldList":[
{
"id":"4298e7e28c4b462fa21dfc174ea832db",
"name":"身体健康问题"
},
{
"id":"e34e76d88e7f47b69fd7bfe3ff747f1a",
"name":"家庭问题"
},
{
"id":"ada1dfa5b04e4116829bade91aa803e3",
"name":"人际关系"
}
],
"unit":"",
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":0,
"isNewAndOldValue":0,
"isHide":0,
"isJson":1,
"ruleLevel":3,
"componentType":0
},
{
"fieldId":"1e91b075ca88416c858be181aa5040f8",
"groupId":"d0872608b9c0462b8cb72cc9a5f28f3b",
"type":8,
"labelName":"图片证明",
"labelNameEng":"New Image",
"require":0,
"groupType":0,
"dateType":1,
"fieldName":"",
"fieldList":[
],
"unit":"",
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":0,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
},
{
"fieldId":"0356d3d12105476c9be21a1614d26e4a",
"groupId":"d0872608b9c0462b8cb72cc9a5f28f3b",
"type":4,
"labelName":null,
"labelNameEng":null,
"require":0,
"groupType":0,
"dateType":2,
"fieldName":"",
"fieldList":[
],
"unit":"",
"startLabelName":"开始日期",
"endLabelName":"结束日期",
"longLabelName":"天数",
"startLabelNameEng":"Start Date",
"endLabelNameEng":"End Date",
"longLabelNameEng":"Number of Days",
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":0,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
},
{
"fieldId":"0fab522c2088430da0157e1551cf485b",
"groupId":"d0872608b9c0462b8cb72cc9a5f28f3b",
"type":11,
"labelName":"附件",
"labelNameEng":"New Attachment",
"require":0,
"groupType":0,
"dateType":1,
"fieldName":"",
"fieldList":[
],
"unit":"",
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":0,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
}
]
},
{
"groupId":"8a943db632e34b8aa6711fe91af015e0",
"groupName":"新增分组2",
"groupNameEng":"New Group 2",
"groupType":1,
"position":1002,
"isHide":0,
"isFixed":0,
"fields":[
{
"fieldId":"4abd5ef9ff72452291dfbfbfa89bf49d",
"groupId":"8a943db632e34b8aa6711fe91af015e0",
"type":1,
"labelName":"新增单行文本",
"labelNameEng":"Single Line Text",
"require":0,
"groupType":1,
"dateType":1,
"fieldName":"",
"fieldList":[
],
"unit":"",
"startLabelName":null,
"endLabelName":null,
"longLabelName":null,
"startLabelNameEng":null,
"endLabelNameEng":null,
"longLabelNameEng":null,
"relaxStartLabelName":null,
"relaxEndLabelName":null,
"relaxStartLabelNameEng":null,
"relaxEndLabelNameEng":null,
"isCondition":0,
"isNewAndOldValue":0,
"isHide":0,
"isJson":0,
"ruleLevel":3,
"componentType":0
}
]
}
],
"relationMap":[
{
"fieldId":"11ecdcb614af4a64aeaf5d72340fedc2",
"relation":"[{\"chooseOptionId\":\"2\",\"relationFields\":[\"eb23e1d104384c7f99ba49d8f8f2f8ef\"]},{\"chooseOptionId\":\"3\",\"relationFields\":[\"1e91b075ca88416c858be181aa5040f8\"]}]"
}
]
}
}