创建实例
POST
/v1.0/workflow/processCentres/instances
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。
接口功能介绍
权限
| 应用类型 | 是否支持 | 权限 | API Explorer调试 |
|---|---|---|---|
| 企业内部应用 | 支持 | 工作流实例写权限 | API Explorer |
| 第三方企业应用 | 支持 | 工作流实例写权限 | API Explorer |
| 第三方个人应用 | 暂不支持 | 工作流实例写权限 | 暂不支持 |
FormComponent参数补充说明
控件通用属性
{
"componentId": "TextField-12345677", // 控件id，表单内唯一，与bizAlias二选一
"required":true, // 控件是否必填
"label": "单行文本", // 控件标题
"placeholder": "请输入", // 输入提示
"bizAlias": "staffId", // 控件的业务标识，表单内唯一，与componentId二选一
"print": "0", // 是否参与打印(0标识字段不参与打印、1标识字段可打印)，默认可打印
"disabled": false, // 是否可编辑
}单行输入控件
{
"componentType": "TextField",
"props": {
"label": "单行输入框", // 控件标题
"placeholder": "请输入", // 输入提示
"componentId": "TextField_17EZKEGSOCTC0", // 控件id，表单内唯一，无业务语义
"required": false, // 是否必填，默认非必填
"bizAlias": "staffId" // 控件的业务标识，表单内唯一，与componentId二选一
}
}多行输入控件
{
"componentType": "TextareaField",
"props": {
"label": "多行输入框",
"placeholder": "请输入多行文本内容，需要换行时请输入\r\n", // 输入提示
"componentId": "TextareaField_17EZKEGSOCTC0",
"required": false
}
}数字输入控件
{
"componentType": "NumberField",
"props": {
"label": "数字输入框",
"placeholder": "请输入数字",
"componentId": "NumberField_108PIFZM21F40",
"required": false,
"unit":"元", // 数字单位
"defaultValue":"10", // 默认值
}
}单选控件
{
"componentType": "DDSelectField",
"props": {
"options": [ // 可选选项列表
{
"value": "选项1", // 选项显示名称
"key": "option_0" // 控件内唯一key，非必填，系统会默认生成
},
{
"value": "选项2",
"key": "option_1"
},
{
"value": "选项3",
"key": "option_2"
},
{
"key": "other", // 其他项特殊key
"value": "其它"
}
],
"label": "单选框",
"placeholder": "请选择",
"componentId": "DDSelectField_14T8M4EKXAV40",
"required": false
}
}多选控件
{
"componentType": "DDMultiSelectField",
"props": {
"options": [
{
"value": "选项1",
"key": "option_0"
},
{
"value": "选项2",
"key": "option_1"
},
{
"value": "选项3",
"key": "option_2"
},
{
"key": "other", // 其他项特殊key
"value": "其它"
}
],
"label": "多选框",
"placeholder": "请选择",
"componentId": "DDMultiSelectField_1XJ7NG1GSD6O0",
"required": false
}
}日期控件
{
"componentType": "DDDateField",
"props": {
"unit": "小时", // 日期格式，枚举值（小时、天）
"format": "yyyy-MM-dd HH:mm", // 日期格式，非必填，小时对应yyyy-MM-dd HH:mm，天对应yyyy-MM-dd HH:mm
"bizAlias": "",
"label": "日期",
"placeholder": "请选择",
"componentId": "DDDateField_SQL0DF3MS9C0",
"required": false,
"defaultValue": "2021-12-21 17:46" // 默认值
}
}时间区间控件
{
"componentType": "DDDateRangeField",
"props": {
"unit": "小时", // 日期格式，枚举值（小时、天）
"format": "yyyy-MM-dd HH:mm", // 日期格式，非必填，小时对应yyyy-MM-dd HH:mm，天对应yyyy-MM-dd HH:mm
"bizAlias": "",
"label": "[\"开始时间\",\"结束时间\"]",
"placeholder": "请选择",
"componentId": "DDDateRangeField_7MPG14N3OOO0",
"duration": true, // 是否自动计算时长
"durationLabel": "时长", // 时长计算显示文本
"required": false
}
}文字说明控件
{
"componentType": "TextNote",
"props": {
"link": "https://www.dingtalk.com/", // 超链接
"notPrint": "0",
"bizAlias": "",
"componentId": "TextNote_13RP7230RAF40",
"content": "说明文字" // 说明文字
}
}图片控件
{
"componentType": "DDPhotoField",
"props": {
"label": "图片",
"componentId": "DDPhotoField_P50A0HMHB280",
"required": false
}
}金额控件
{
"componentType": "MoneyField",
"props": {
"upper": "0", // 金额需要大写(0不大写，1需要大写)，默认需要大写
"label": "金额（元）",
"placeholder": "请输入金额",
"componentId": "MoneyField_L1PP26ZDV400",
"required": false
}
}附件
{
"componentType": "DDAttachment",
"props": {
"label": "附件",
"componentId": "DDAttachment_18U4QTOWLMPS0",
"required": false
}
}联系人控件
{
"componentType": "InnerContactField",
"props": {
"label": "联系人",
"placeholder": "请选择",
"componentId": "InnerContactField_162USP4V1BC00",
"choice": "1", //枚举值：1标识支持多选，0标识单选，默认为0
"required": false,
"bizAlias": ""
}
}部门控件
{
"componentType": "DepartmentField",
"props": {
"multiple": false, // 是否支持多选，true多选，false单选
"label": "部门",
"placeholder": "请选择",
"componentId": "DepartmentField_1GY5JSPOCY000",
"required": false
}
}关联审批单
{
"componentType": "RelateField",
"props": {
"label": "关联审批单",
"placeholder": "请选择",
"componentId": "RelateField_5X1DL4KMKUW0",
"required": false,
"bizAlias": "",
"availableTemplates": [ // 可被关联的审批模板列表，为空时表示可关联所有审批模板的实例数据
{
"name": "产品演示", // 可关联的审批表单名称
"processCode": "PROC-1B8FC788-D2B4-4DA2-BEAE-E56F5EC17C5B" // 可关联的审批表单formCode
},
{
"name": "调岗套件演示",
"processCode": "PROC-6C383FEC-3ED6-4B90-8019-401629CB8275"
}
]
}
}省市区控件
{
"componentType": "AddressField",
"props": {
"addressModel": "district", // 枚举值,city省市,district省市区,street省市区-街道
"bizAlias": "",
"label": "省市区",
"componentId": "AddressField_1P9H21H8R2LC0",
"required": false
}
}评分控件
{
"componentType": "StarRatingField",
"props": {
"limit": 5, // 枚举值：5分制、10分制
"label": "评分",
"placeholder": "请输入",
"componentId": "StarRatingField_10E5NHTA2W0G0",
"required": false,
"bizAlias": ""
}
}错误码
| HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | aflowProcessFormContentInvalid | 审批流的表单格式错误 | 审批流的表单格式错误 |
| 400 | process.error | 审批流不存在 | 审批流不存在 |
| 400 | permission.error | 没有访问权限 | 没有访问权限 |
| 400 | permission.error | 没有审批流操作权限 | 没有审批流操作权限 |
| 400 | instance.error | 发起审批实例失败 | 发起审批实例失败 |
| 400 | needAuth | 没有发起审批的权限 | 没有发起审批的权限 |
| 400 | invalidAgentId | 无效的微应用ID | 无效的微应用ID |
| 400 | invalidSuiteKey | 无效的suiteKey | 无效的suiteKey |
| 400 | required.error | %s | 必填项校验错误 |
| 400 | internalError | %s | 系统内部错误 |
| 400 | userNotExist | 用户不存在 | 用户不存在 |
| 400 | formConverterError | 表单数据反向转换出错 | 表单数据反向转换出错 |
| 400 | parameter.invalid | 参数错误 | 参数错误 |
| 500 | system.error | 系统错误 | 系统错误 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.dingtalk.com/v1.0/workflow/processCentres/instances' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
"processCode" : "String",
"originatorUserId" : "String",
"formComponentValueList" : [ {
"name" : "String",
"value" : "String",
"extValue" : "String",
"id" : "String",
"bizAlias" : "String",
"componentType" : "String"
} ],
"title" : "String",
"url" : "String",
"notifiers" : [ {
"userid" : "String",
"position" : "String"
} ],
"bizData" : "String"
}'响应示例响应示例
{
"result": {
"processInstanceId": "string"
}
}请求参数
Header 参数
x-acs-dingtalk-access-token
string
必需
Body 参数application/json
返回响应
扫码加入交流群修改于 2024-01-11 10:20:51