创建数据表单实例新版SDK
更新于 2025-01-16
特别提醒
当前接口为OA高级版专享接口，升级OA高级版可用，可满足更高级的开发需求，响应个性化的业务场景。查看全部专享OpenAPI
接口功能介绍
例如，调用本接口创建一个数据表单实例，效果类似于钉钉工作台 > OA审批 > 全部审批单 > 搜索对应审批单名称 > 发起提交，接口调用效果如下图所示。
调用本接口创建数据表单实例，接口返回的实例ID请务必注意保存，方便后续调用其他接口使用。
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | OA审批工作流读写权限（OA高级版专享） | API Explorer |
| 第三方企业应用 | 暂不支持 | 暂不支持 | 暂不支持 |
| 第三方个人应用 | 暂不支持 | 暂不支持 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Body参数
名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
originatorUserId | String | 是 | 发起人的userId。 |
processCode | String | 是 | 数据表单模板code。可在数据表单模板编辑页-基础设置-页面底部查看。 |
formComponentValueList | Array | 是 | 表单控件列表。 说明
具体请参照请求示例规范填写。 |
id | String | 否 | 控件id |
bizAlias | String | 否 | 控件别名 |
name | String | 是 | 控件名称 |
value | String | 是 | 控件值 |
extValue | String | 否 | 控件扩展值 |
componentType | String | 否 | 控件类型。详情请参考本文FormComponent参数补充说明。
说明
选项值应当被配置在选项列表中
说明
选项值均应当被配置在选项列表中
说明
联系人控件中的userID应当是当前组织下在职成员的userID
说明
关联审批单传入的审批实例ID应当是当前组织下存在的审批实例ID
说明
部门控件中应当传入当前组织下存在的部门ID |
details | Array | 否 | 子控件列表，最大列表长度：150。 |
id | String | 否 | 控件id。 |
bizAlias | String | 否 | 控件别名。 |
name | String | 否 | 控件名称。 |
value | String | 否 | 控件值。 |
extValue | String | 否 | 控件扩展值。 |
details | Array | 否 | 子控件列表，最大列表长度：150。 |
id | String | 否 | 控件id。 |
bizAlias | String | 否 | 控件别名。 |
name | String | 否 | 控件名称。 |
value | String | 否 | 控件值。 |
extValue | String | 否 | 控件扩展值。 |
componentType | String | 否 | 控件类型。 |
返回参数
名称 | 类型 | 描述 |
|---|---|---|
instanceId | String | 数据表单实例ID。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | permission.error | 没有访问权限 | 没有访问权限 |
400 | processcode.error | processCode对应的表单不存在 | processCode对应的表单不存在 |
400 | formschema.error | %s | 表单schema不合法 |
400 | formName.error | 已有相同名称表单 | 表单名称错误 |
400 | processes.error | 获取模板列表失败 | 获取模板列表失败 |
400 | needAuth | 没有发起审批的权限 | 没有发起审批的权限 |
400 | invalidAgentId | 无效的微应用ID | 无效的微应用ID |
400 | invalidSuiteKey | 无效的suiteKey | 无效的suiteKey |
400 | system.error | 表单扩展信息添加错误 | 添加process扩展属性错误 |
400 | user.not.exist | 用户不存在 | 用户不存在 |
500 | system.error | 系统错误 | 系统错误 |
500 | param.error | %s | 参数错误 |
500 | form.error | 参数错误，不是存表单 | 参数错误 |
500 | form.code.error | 表单详情查询失败 | 参数错误 |
500 | form.invalid | 模版被停用，联系管理员启用 | 模版被停用 |
500 | type.error | 表单类型错误 | 表单类型错误 |
500 | instance.error | 创建表单实例失败 | 创建表单实例失败 |
500 | benefit.status.invalid | 权益校验失败，未开通或过期 | 权益校验失败，未开通或过期 |
500 | oaplus.query.limit | 请求过于频繁，稍后重试 | 请求过于频繁，稍后重试 |
