创建表单业务数据

POST

/v1.0/h3yun/forms/instances

调用本接口创建单条表单、流程表单的业务数据对象。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	氚云数据管理权限	API Explorer
第三方企业应用	支持	氚云数据管理权限	API Explorer
第三方个人应用	暂不支持	氚云数据管理权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParameter.input.invalid	%s	入参校验失败
400	dataNotExist.user.userNotExist	操作用户不存在	操作用户不存在
400	invalidParameter.json.invalidJsonStringParamter	%s	bizObjectJson参数解析失败
400	dataNotExist.form.schemaNotExist	表单结构不存在	无效的schemaCode参数
400	convertFail.jsonToBizStructureFail	%s	bizObjectJson转换为表单结构失败
400	dataModified.form.createBizObjectFail	%s	创建业务对象失败
400	systemError	%s	系统错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.dingtalk.com/v1.0/h3yun/forms/instances' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "schemaCode" : "String",
  "opUserId" : "String",
  "bizObjectJson" : "String",
  "isDraft" : Boolean
}'

响应示例

{
    "code": "string",
    "message": "string",
    "data": {
        "schemaCode": "string",
        "formUsageType": "string",
        "bizObjectId": "string",
        "processInstanceId": "string"
    }
}

请求参数

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

schemaCode

string

表单编码。

必需

opUserId

string

操作用户ID。

必需

bizObjectJson

string

必需

json格式的业务数据。JSON数组的key只可以调用获取表单对象结构接口获取。

例如：
{
"F0000010": "0000004",
"F0000011": "王五1",
"F0000012": "D1级客户",
"F0000013": 7000,
"D000183Fcd15f3a51e624bbc9945392d190b6aa8": [
{
"F0000014": "里斯",
"F0000015": 156666365656,
"F0000016": "技术部",
"F0000017": "经理1",
"F0000018": "男",
"F0000019": "lgbxunmi@dd.com",
"F0000020": true,
"F0000021": "测试数据"
}
]
}

示例

返回响应

🟢200成功

application/json

Body

code

string

状态码。

必需

message

string

状态码描述。

必需

data

object

返回结果。

必需

schemaCode

string

表单编码。

必需

formUsageType

string

必需

数据模型，取值： DataList：本地存储的列表库 Workflow：工作流应用

bizObjectId

string

表单业务数据ID。

必需

processInstanceId

string

流程实例ID。

必需

修改于 2024-01-23 09:47:25

获取表单对象结构

查询表单业务数据列表

创建表单业务数据

权限#

错误码#

请求参数

返回响应

权限

错误码