获取审批表单详情

请求参数

请求头 (Headers)

参数名	类型	必填	说明
Content-Type	String	是	application/json
Authorization	String	是	访问令牌

请求体 (Body)

参数名	类型	必填	说明
corpId	String	是	企业ID，用于多租户隔离
operationEmpId	String	是	操作人员工ID
formKey	String	是	表单唯一标识（formKey），用于定位具体的审批表单。注：接口会自动获取最新版本

响应参数

字段名	类型	说明
code	Integer	响应状态码，200表示成功
message	String	响应消息
data	UserFormDetail	表单详情视图对象，包含表单的完整信息

UserFormDetail

字段名	类型	说明
form	UserForm	表单基础信息对象
formItems	UserFormItemEntity[]	表单字段列表
formLogic	UserFormLogicEntity	表单逻辑配置对象
scheme	JSON	流程设计内容（BPMN流程图的JSON表示）
hasNotFormPermissions	boolean	是否无表单权限（true=无权限，false=有权限）
formSettings	FormSettings	表单设置对象

UserForm

表单基础信息对象（UserFormDetail的内部类）

字段名	类型	说明
formKey	String	表单唯一标识，全局唯一的表单Key
name	String	表单名称，如"请假申请"、"报销审批"
description	String	表单描述，对表单用途的说明
type	FormTypeEnum	表单类型枚举（ORDINARY=普通表单，APPROVAL=审批表单）
version	Integer	表单版本号，每次修改表单会递增
sourceId	String	来源ID，标识表单来源或模板类型
formVenusTemplateType	String	人事模板类型，与人事系统集成时使用

UserFormItemEntity

表单字段实体，描述表单中的每个输入项

字段名	类型	说明
id	String	字段唯一ID
formKey	String	所属表单的Key
label	String	字段标签名称，显示给用户看的字段名
type	String	字段类型，见下方字段类型说明
scheme	Object	字段配置方案，包含字段的详细配置信息
required	Boolean	是否必填（true=必填，false=选填）
version	Integer	字段版本号
displayOrder	Integer	显示排序，数字越小越靠前
expand	Object	扩展配置，字段的额外配置项

字段类型 (type) 说明

类型值	说明
INPUT	单行文本输入框
NUMBER	数字输入框
TEXTAREA	多行文本输入框
SELECT	单选下拉框
RADIO	单选按钮组
CHECKBOX	多选框组
DATE	日期选择器
TIME	时间选择器
UPLOAD	文件上传
USER_SELECT	人员选择器
DEPT_SELECT	部门选择器
PROVINCE_CITY	省市区级联选择
SUB_FORM	子表单（明细表）
DESCRIPTION	说明文字
IMAGE_SELECT	图片选择

UserFormLogicEntity

表单逻辑配置实体，用于控制字段的显示隐藏、联动等逻辑

字段名	类型	说明
id	String	逻辑配置ID
formKey	String	所属表单的Key
logicConfig	Object	逻辑配置内容，包含条件表达式和执行动作

FormSettings

表单设置对象，包含流程配置和基础配置

字段名	类型	说明
flowSettings	FlowSettingsVO	流程相关设置
baseSettings	BaseSettingsVO	基础设置

FlowSettingsVO

流程设置对象（FormSettingsVO的内部类）

字段名	类型	说明
handSignatureConfig	HandSignatureConfigVO	手写签名配置
addApprovalConfig	AddApprovalConfigVO	加签配置
autoDuplicateRemovalApprovalConfig	AutoDuplicateRemovalApprovalConfigVO	自动去重配置
titleConfig	TitleConfigVO	标题配置
transferApprovalConfigVO	TransferApprovalConfigVO	转交配置
memberAuthConfigVO	MemberAuthConfigVO	权限组配置
autoHandoverApprovalConfig	AutoHandoverApprovalConfigVO	自动发起离职交接配置
approvalPassAutoConfirmOffBoardingConfig	ApprovalPassAutoConfirmOffBoardingConfigVO	审批通过后自动确认离职配置
approvalSyncDingTalkOaConfig	ApprovalSyncDingTalkOaConfigVO	同步钉钉OA配置

HandSignatureConfigVO

手写签名配置对象

字段名	类型	说明
handSignatureEnable	Boolean	是否开启手写签名（true=开启，false=关闭）
signatureSelection	String	签名选择方式（REQUIRED=必须签名，OPTIONAL=可选签名，DISABLED=禁用签名）

AddApprovalConfigVO

加签配置对象

字段名	类型	说明
addApprovalEnable	Boolean	是否开启加签功能（true=开启，false=关闭）

AutoDuplicateRemovalApprovalConfigVO

自动去重配置对象

字段名	类型	说明
autoApprovalEnable	Boolean	是否开启自动去重（true=开启，false=关闭）
sameApproverEnable	Boolean	是否启用同一审批人去重（true=开启，false=关闭）
sameApproverConfig	String	同一审批人去重策略（AUTO_PASS=自动通过，SKIP=跳过）
starterSameApproverEnable	Boolean	发起人和审批人相同时自动通过（true=开启，false=关闭）

TitleConfigVO

标题配置对象

字段名	类型	说明
useDefaultTitle	Boolean	是否使用默认标题（true=使用默认，false=自定义）
titleSetting	ReminderVariableContent	标题设置内容，自定义标题的模板

TransferApprovalConfigVO

转交配置对象

字段名	类型	说明
transferApprovalEnable	Boolean	是否开启转交功能（true=开启，false=关闭）

MemberAuthConfigVO

权限组配置对象

字段名	类型	说明
authConfigList	ListAuthConfigVO	权限组列表
otherMemberConfig	OtherMemberConfigVO	权限组外成员配置

AuthConfigVO

权限组配置对象

字段名	类型	说明
name	String	权限组名称
allUser	Boolean	是否包含全部员工（true=全员，false=指定范围）
nodeUserList	ListEmpIdNameModel	指定用户列表
nodeDeptList	ListOrgIdNameModel	指定部门列表
nodeRoleList	ListRoleIdNameModel	指定角色列表
scopes	ListScopeIdNameModel	自定义范围
formProperties	ListFormNodeProperties	表单字段权限配置

OtherMemberConfigVO

权限组外成员配置对象

字段名	类型	说明
otherMemberViewAuthEnable	Boolean	权限组外成员是否可查看（true=可查看，false=不可查看）
formProperties	ListFormNodeProperties	表单字段权限配置

BaseSettingsVO

基础设置对象（FormSettingsVO的内部类）

字段名	类型	说明
approvalAdminConfig	ApprovalAdminConfigVO	审批管理员配置
applicableDepartmentConfigVO	ApplicableDepartmentConfigVO	适用部门配置

ApprovalAdminConfigVO

审批管理员配置对象

字段名	类型	说明
allApprovalAdmin	Boolean	是否全员为审批管理员（true=全员，false=指定人员）
approvalAdminUserList	ListEmpIdNameModel	指定的审批管理员列表

ApplicableDepartmentConfigVO

适用部门配置对象

字段名	类型	说明
orgList	ListOrgIdNameModel	适用部门列表

错误码说明

错误码	说明
400	请求参数错误（缺少必填字段）
401	未授权（Token无效或过期）
403	无权限访问
404	表单不存在
500	服务器内部错误

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200getFormPublishedDetails-Example

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "form": { //表单基础信息
            "formKey": "",
            "name": "", //表单名称
            "description": "", //表单描述
            /**
             * ORDINARY :普通表单
             * WORKFLOW :流程表单
             * FOLDER :文件夹
             * EXAM :考试
             */
            "type": "",
            "version": 0,
            "sourceId": "",
            "formVenusTemplateType": ""
        },
        "formItems": [ //表单项
            {
                "id": 0, //主键 避免超出长度 前端丢失精度
                "createTime": "", //创建时间
                "updateTime": "", //更新时间
                "formKey": "", //表单Id
                "version": 0, //版本
                /**
                 * 表单项Id 类型  + 时间戳
                 * 如果是人事业务字段，存fieldId
                 */
                "formItemId": "",
                /**
                 * 表单项来源
                 * SYSTEM :SYSTEM
                 * VENUS :VENUS
                 */
                "source": "",
                /**
                 * 表单项类型
                 * INPUT :INPUT
                 * NUMBER :NUMBER
                 * TEXTAREA :TEXTAREA
                 * SELECT :SELECT
                 * CASCADER :CASCADER
                 * SORT :SORT
                 * SLIDER :SLIDER
                 * RADIO :RADIO
                 * CHECKBOX :CHECKBOX
                 * DATE :DATE
                 * DATE_RANGE :DATE_RANGE
                 * RATE :RATE
                 * IMAGE_UPLOAD :IMAGE_UPLOAD
                 * UPLOAD :UPLOAD
                 * IMAGE :IMAGE
                 * IMAGE_SELECT :IMAGE_SELECT
                 * IMAGE_CAROUSEL :IMAGE_CAROUSEL
                 * DESC_TEXT :DESC_TEXT
                 * SIGN_PAD :SIGN_PAD
                 * PAGINATION :PAGINATION
                 * DIVIDER :DIVIDER
                 * PROVINCE_CITY :PROVINCE_CITY
                 * PHONE_VERIFICATION :PHONE_VERIFICATION
                 * SUB_FORM :SUB_FORM
                 * INPUT_MAP :INPUT_MAP
                 * MATRIX_INPUT :MATRIX_INPUT
                 * MATRIX_SCALE :MATRIX_SCALE
                 * HORIZONTAL_INPUT :HORIZONTAL_INPUT
                 * MATRIX_SELECT :MATRIX_SELECT
                 * USER_SELECT :USER_SELECT
                 * DEPT_SELECT :DEPT_SELECT
                 * OCR :OCR
                 * RANDOM_NUMBER :RANDOM_NUMBER
                 * FUNCTION_CALC :FUNCTION_CALC
                 * GOODS_SELECT :GOODS_SELECT
                 * RESERVE_DAY :RESERVE_DAY
                 * RESERVE_TIME_RANGE :RESERVE_TIME_RANGE
                 * ASSOCIATE_APPROVAL :ASSOCIATE_APPROVAL
                 * EXPLANATORY_TEXT :EXPLANATORY_TEXT
                 */
                "type": "",
                "label": "", //表单项标题
                "displayType": false, //展示类型组件 只在表单填写页查询到
                "hideType": false, //隐藏类型组件 在表单填写页面无法查看到
                "specialType": false, //需要在入库前特殊处理的组件 比如随机编码等 验重
                "showLabel": false, //是否显示标签
                "defaultValue": "", //表单项默认值
                "required": false, //是否必填
                /**
                 * 是否必填(补充)
                 * REQUIRED :必填
                 * OPTIONAL :选填
                 * BY_RULE :按规则
                 */
                "requiredSupplement": "",
                "placeholder": "", //输入型提示文字
                "sort": 0, //排序
                "span": 0, //栅格宽度
                "scheme": { //扩展字段 表单项独有字段
                    "key": {}
                },
                "regList": [ //正则表达式
                    {
                        "key": {}
                    }
                ]
            }
        ],
        "formLogic": { //逻辑
            "id": 0, //主键 避免超出长度 前端丢失精度
            "createTime": "", //创建时间
            "updateTime": "", //更新时间
            "formKey": "", //表单key
            "scheme": [
                {
                    "triggerList": [ //触发内容
                        {
                            "formItemId": "", //表单项Id
                            "type": "" //类型
                        }
                    ],
                    "conditionList": [ //条件
                        {
                            "formItemId": "", //表单项Id
                            "expression": "", //表达式
                            "optionValue": {}, //选项
                            "relation": "" //AND OR
                        }
                    ]
                }
            ]
        },
        "scheme": { //流程设计内容
            "key": {}
        },
        /**
         * 是否有表单权限
         * true 无权限 false 有权限
         */
        "hasNotFormPermissions": false,
        "formSettings": { //表单设置
            "flowSettings": {
                "handSignatureConfig": {
                    "handSignatureEnable": false, //手写签名是否开启 true 开启 false没有开启
                    "signatureSelection": "" //签名选择  SignatureSelectionEnum
                },
                "addApprovalConfig": {
                    "addApprovalEnable": false //加签是否开启 true 开启 false没有开启
                },
                "autoDuplicateRemovalApprovalConfig": {
                    "autoApprovalEnable": false, //是否开启自动去重
                    "sameApproverEnable": false, //同一审批人去重
                    /**
                     * 同一审批人去重配置
                     * <AutoCompletePolicyEnum.value>
                     */
                    "sameApproverConfig": "",
                    "starterSameApproverEnable": false //发起人和审批人相同时的，审批自动通过
                },
                "titleConfig": {
                    "useDefaultTitle": false, //是否为默认标题
                    "titleSetting": { //内容
                        "formatContent": "", //前端markDown格式字符串
                        "originalContent": "", //原始内容
                        "businessContent": "" //业务内容 #@{变量}#
                    }
                },
                "transferApprovalConfigVO": { //是否开启转交，因为需要兼容线上的审批单，所以没有加签配置的，转交按钮也不展示
                    "transferApprovalEnable": false
                },
                "memberAuthConfigVO": { //权限组配置
                    "authConfigList": [
                        {
                            "name": "", //权限组名称
                            "allUser": false, //是否全部员工
                            "nodeUserList": [
                                {
                                    "empId": "",
                                    "empName": ""
                                }
                            ],
                            "nodeDeptList": [
                                {
                                    "orgId": "",
                                    "orgName": ""
                                }
                            ],
                            "nodeRoleList": [
                                {
                                    "roleId": "",
                                    "roleName": ""
                                }
                            ],
                            "scopes": [ //自定义范围
                                {
                                    "conditions": [ //范围条件
                                        {
                                            "model": null, //条件模块  emp=花名册字段
                                            "fieldId": null, //字段id
                                            "fieldName": null, //字段名称
                                            "fieldType": null, //自定义字段类型：
                                            "values": [ //条件值
                                                ""
                                            ],
                                            "values_sources": null, //条件值
                                            "selection": null //下拉框选项
                                        }
                                    ]
                                }
                            ],
                            "formProperties": [ //表单字段权限
                                {
                                    "id": "", //字段id
                                    "name": "", //字段名称
                                    "required": false, //是否必填
                                    "requiredSupplement": "", //是否必填（补充）
                                    /**
                                     * 字段权限
                                     * FieldPermissionsEnum
                                     */
                                    "fieldPermissions": "",
                                    "scheme": { //前端用到
                                        "key": {}
                                    }
                                }
                            ]
                        }
                    ],
                    "otherMemberConfig": {
                        "otherMemberViewAuthEnable": false,
                        "formProperties": [
                            {
                                "id": "", //字段id
                                "name": "", //字段名称
                                "required": false, //是否必填
                                "requiredSupplement": "", //是否必填（补充）
                                /**
                                 * 字段权限
                                 * FieldPermissionsEnum
                                 */
                                "fieldPermissions": "",
                                "scheme": { //前端用到
                                    "key": {}
                                }
                            }
                        ]
                    }
                },
                "autoHandoverApprovalConfig": { //自动发起离职交接配置
                    "offBoardingApprovalPassAutoStartHanoverApproval": false, //离职审批通过自动发起离职交接审批
                    "formKey": [ //离职交接模板信息
                        {
                            "label": "", //选项中文描述
                            "value": "", //选项编码
                            "order": 0, //选项排序
                            "status": "", //选项状态
                            /**
                             * 所绑定其他选项值
                             * 如：离职类型对应不同的离职原因
                             */
                            "markValue": "",
                            /**
                             * 使用场景
                             * label展示的部门链信息，但是还需要部门的信息
                             */
                            "orgLabel": ""
                        }
                    ],
                    "offBoardingPassImmediatelyStart": false, //离职审批通过立即发起离职交接审批
                    "triggeringConditions": [ //触发条件
                        {
                            "fieldId": "", //关联字段
                            "triggerSuffix": "", //前缀
                            "days": 0, //天数 （前缀为'当天'时 该值为空）
                            "sendTime": "" //发送时间
                        }
                    ]
                },
                "approvalPassAutoConfirmOffBoardingConfig": { //离职申请通过后自动发起离职交接配置
                    "approvalPassAutoConfirmOffBoarding": false //审批通过自动确定离职（可能是离职申请或者离职交接）
                },
                "approvalSyncDingTalkOaConfig": { //离职申请通过后自动发起离职交接配置
                    "approvalSyncDingTalkOa": false //同步到钉钉 OA 审批中心
                }
            },
            "baseSettings": {
                "approvalAdminConfig": {
                    "allApprovalAdmin": false, //是否全选 审批角色管理员
                    "approvalAdminUserList": [ //单独设置的审批角色 管理员id
                        {
                            "empId": "",
                            "empName": ""
                        }
                    ]
                },
                "applicableDepartmentConfigVO": {
                    "orgList": [ //适用部门id列表
                        {
                            "orgId": "",
                            "orgName": ""
                        }
                    ]
                }
            }
        },
        "fieldsRuleMapping": {
            "key": [
                {
                    "id": 0, //主键 避免超出长度 前端丢失精度
                    "createTime": "", //创建时间
                    "updateTime": "", //更新时间
                    "formKey": "", //表单Id
                    "version": 0, //版本
                    /**
                     * 表单项Id 类型  + 时间戳
                     * 如果是人事业务字段，存fieldId
                     */
                    "formItemId": "",
                    /**
                     * 表单项来源
                     * SYSTEM :SYSTEM
                     * VENUS :VENUS
                     */
                    "source": "",
                    /**
                     * 表单项类型
                     * INPUT :INPUT
                     * NUMBER :NUMBER
                     * TEXTAREA :TEXTAREA
                     * SELECT :SELECT
                     * CASCADER :CASCADER
                     * SORT :SORT
                     * SLIDER :SLIDER
                     * RADIO :RADIO
                     * CHECKBOX :CHECKBOX
                     * DATE :DATE
                     * DATE_RANGE :DATE_RANGE
                     * RATE :RATE
                     * IMAGE_UPLOAD :IMAGE_UPLOAD
                     * UPLOAD :UPLOAD
                     * IMAGE :IMAGE
                     * IMAGE_SELECT :IMAGE_SELECT
                     * IMAGE_CAROUSEL :IMAGE_CAROUSEL
                     * DESC_TEXT :DESC_TEXT
                     * SIGN_PAD :SIGN_PAD
                     * PAGINATION :PAGINATION
                     * DIVIDER :DIVIDER
                     * PROVINCE_CITY :PROVINCE_CITY
                     * PHONE_VERIFICATION :PHONE_VERIFICATION
                     * SUB_FORM :SUB_FORM
                     * INPUT_MAP :INPUT_MAP
                     * MATRIX_INPUT :MATRIX_INPUT
                     * MATRIX_SCALE :MATRIX_SCALE
                     * HORIZONTAL_INPUT :HORIZONTAL_INPUT
                     * MATRIX_SELECT :MATRIX_SELECT
                     * USER_SELECT :USER_SELECT
                     * DEPT_SELECT :DEPT_SELECT
                     * OCR :OCR
                     * RANDOM_NUMBER :RANDOM_NUMBER
                     * FUNCTION_CALC :FUNCTION_CALC
                     * GOODS_SELECT :GOODS_SELECT
                     * RESERVE_DAY :RESERVE_DAY
                     * RESERVE_TIME_RANGE :RESERVE_TIME_RANGE
                     * ASSOCIATE_APPROVAL :ASSOCIATE_APPROVAL
                     * EXPLANATORY_TEXT :EXPLANATORY_TEXT
                     */
                    "type": "",
                    "label": "", //表单项标题
                    "displayType": false, //展示类型组件 只在表单填写页查询到
                    "hideType": false, //隐藏类型组件 在表单填写页面无法查看到
                    "specialType": false, //需要在入库前特殊处理的组件 比如随机编码等 验重
                    "showLabel": false, //是否显示标签
                    "defaultValue": "", //表单项默认值
                    "required": false, //是否必填
                    /**
                     * 是否必填(补充)
                     * REQUIRED :必填
                     * OPTIONAL :选填
                     * BY_RULE :按规则
                     */
                    "requiredSupplement": "",
                    "placeholder": "", //输入型提示文字
                    "sort": 0, //排序
                    "span": 0, //栅格宽度
                    "scheme": { //扩展字段 表单项独有字段
                        "key": {}
                    },
                    "regList": [ //正则表达式
                        {
                            "key": {}
                        }
                    ]
                }
            ]
        }
    }
}

请求参数#

请求参数

请求示例代码

返回响应

请求参数