创建审批实例

POST

https://open.feishu.cn/open-apis/approval/v4/instances

自建应用商店应用

创建一个审批实例，调用方需对审批定义的表单有详细了解，将按照定义的表单结构，将表单 Value 通过接口传入。

控件值说明

单行文本

{                                     
    "id": "widget1",
    "type": "input",
    "value": "data"
}

多行文本

{                                     
    "id": "widget1",
    "type": "textarea",
    "value": "data"
}

日期

value 满足 RFC3339 格式，
{                                     
    "id": "widget1",
    "type": "date",
    "value": "2019-10-01T08:12:01+08:00"
}

单选

value 为定义中 option 中的 value 字段，查看审批定义获取

{                                     
    "id": "widget1",
    "type": "radio",
    "value": "optionA"
}
{                                     
    "id": "widget1",
    "type": "radioV2",
    "value": "k2b8mkx0-h71x5gljn3i-1"
}

数字

{
    "id": "widget1",
    "type": "number",
    "value": 1234.5678
}

金额

{
    "id": "widget1",
    "type": "amount",
    "value": 1234.5678,
    "currency":"USD"
}

计算公式

由定义创建时的公式计算出的值，若不匹配则返回错误

{
    "id": "widget1",
    "type": "formula",
    "value": 1234.5678
}

联系人

value 为 user id 数组「*此接口不支持创建表单联系人」

{
    "id":"widget1",
    "type":"contact",
    "value": ["f8ca557e"],
    "open_ids": ["ou_12345"]
}

关联审批

value 为关联审批的 instance code 数组

{
    "id":"widget1",
    "type":"connect",
    "value": ["19EAC829-F1CB-527F-BE2A-1330422E60C0"]
}

附件

value 为上传文件返回的 code

{
    "id":"widget1",
    "type":"attachment",
    "value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]
}
{
    "id":"widget1",
    "type":"attachmentV2",
    "value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]
}

图片

value 为上传文件返回的 code

{
    "id":"widget1",
    "type":"image",
    "value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]
}

多选

value 为定义中 option 中的 value 字段，查看审批定义获取

{
    "id":"widget1",
    "type":"checkbox",
    "value": ["optionA"]
}
{
    "id":"widget1",
    "type":"checkboxV2",
    "value": ["k2b8mkx0-h71x5gljn3i-1"]
}

日期区间

start 和 end 满足 RFC3339 格式

{
    "id": "widget1",
    "type": "dateInterval",
    "value": {
         "start":"2019-10-01T08:12:01+08:00",
         "end":"2019-10-02T08:12:01+08:00",
         "interval": 2.0
     }
}

明细

value 是二维数组

{
    "id": "widget1",
    "type": "fieldList",
    "value": [
         [   
            {
                "id": "widget1",
                "type": "checkbox",
                "value": ["jxpsebqp-0"]
            }
         ]
     ]
}

部门

{
    "id":"widget1",
    "type":"department",
    "value":[
        {
            "open_id":"od-xxx"
        }
    ]
}

电话

{
    "id":"widget1",
    "type":"telephone",
    "value": {
        "countryCode":"+86",
        "nationalNumber":"13122222222"
    }
}

换班控件组

shiftTime 和 returnTIme 满足 RFC3339 格式

{
    "id": "widget1",
    "type": "shiftGroup",
    "value": {
         "shiftTime": "2019-10-01T08:12:01+08:00",
         "returnTime": "2019-10-02T08:12:01+08:00",
         "reason": "ask for leave"
     }
}

不支持开放平台创建的类型

控件	类型
地址	address
出差控件组	tripGroup
请假控件组	leaveGroup
加班控件组	workGroup
补卡控件组	remedyGroup
外出控件组	outGroup
电子签章	signGroup

错误码

HTTP状态码	错误码	描述	排查建议
400	1390001	param is invalid	参数错误
400	1390015	approval is not active	审批定义已停用，检查审批定义是否启用
400	1390013	unsupported approval for free process	不支持自由流程
400	1395001	There have been some errors. Please try again later	服务出现错误，请稍候再试

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/approval/v4/instances' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "approval_code":"4202AD96-9EC1-4284-9C48-B923CDC4F30B",
    "user_id":"59a92c4a",
    "open_id":"ou_806a18fb5bdf525e38ba219733bdbd73",
    "form":"[{\"id\":\"111\",\"type\":\"input\",\"value\":\"11111\"},{\"id\":\"222\",\"required\":true,\"type\":\"dateInterval\",\"value\":{\"start\":\"2019-10-01T08:12:01+08:00\",\"end\":\"2019-10-02T08:12:01+08:00\",\"interval\": 2.0}},{\"id\":\"333\",\"type\":\"radioV2\",\"value\":\"1\"},{\"id\":\"444\",\"type\":\"number\", \"value\":\"4\"},{\"id\":\"555\",\"type\":\"textarea\",\"value\":\"fsafs\"}]",
    "node_approver_user_id_list":[
        {"key": "46e6d96cfa756980907209209ec03b64","value":["59a92c4a"]},
        {"key": "manager_node_id","value":["59a92c4a"]}
    ],
    "node_approver_open_id_list":[
        {"key": "46e6d96cfa756980907209209ec03b64","value":["ou_806a18fb5bdf525e38ba219733bdbd73"]},
        {"key": "manager_node_id","value":["ou_806a18fb5bdf525e38ba219733bdbd73"]}
    ],
    "node_cc_user_id_list":[
        {"key": "46e6d96cfa756980907209209ec03b64","value":["59a92c4a"]},
        {"key": "manager_node_id","value":["59a92c4a"]}
    ],
    "node_cc_open_id_list":[
        {"key": "46e6d96cfa756980907209209ec03b64","value":["ou_806a18fb5bdf525e38ba219733bdbd73"]},
        {"key": "manager_node_id","value":["ou_806a18fb5bdf525e38ba219733bdbd73"]}
    ]
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "instance_code": "81D31358-93AF-92D6-7425-01A5D67C4E71"
  }
}

请求参数

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

approval_code

string

审批定义 code

必需

user_id

string

发起审批用户

可选

open_id

string

可选

发起审批用户 open id, 如果传了 user_id 则优先使用 user_id

tenant_id

string

平台租户ID

可选

uuid

string

可选

审批实例 uuid，用于幂等操作, 每个租户下面的唯一key，同一个 uuid 只能用于创建一个审批实例，如果冲突，返回错误码 60012 ，格式建议为 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX，不区分大小写

department_id

string

可选

发起审批用户部门id，如果用户只属于一个部门，可以不填。如果属于多个部门，默认会选择部门列表第一个部门

form

string

必需

json 数组，控件值

node_approver_user_id_list

array [object {2}]

可选

如果有发起人自选节点，则需要填写对应节点的审批人

key

string

可选

node id 或 custom node id，通过查看审批定义获取示例值："46e6d96cfa756980907209209ec03b64"

value

array[string]

可选

value: 审批人列表示例值：["f7cb567e"]

node_approver_open_id_list

array [object {2}]

可选

审批人发起人自选 open id，与上述node_approver_user_id_list字段取并集

key

string

可选

node id 或 custom node id，通过查看审批定义获取示例值："46e6d96cfa756980907209209ec03b64"

value

array[string]

可选

value: 审批人列表示例值：["f7cb567e"]

node_cc_user_id_list

array [object {2}]

可选

如果有发起人自选节点，则可填写对应节点的抄送人，单个节点最多选择20位抄送人数据校验规则：最大长度：20

key

string

可选

node id ，通过查看审批定义获取示例值："46e6d96cfa756980907209209ec03b75"

value

array[string]

可选

value: 审批人列表示例值：["f7cb567e"]

node_cc_open_id_list

array [object {2}]

可选

抄送人发起人自选 open id 单个节点最多选择20位抄送人数据校验规则：最大长度：20

key

string

可选

node id ，通过查看审批定义获取示例值："46e6d96cfa756980907209209ec03b75"

value

array[string]

可选

value: 审批人列表示例值：["f7cb567e"]

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非0表示失败

msg

string

返回码的描述

必需

data

object

返回业务信息

必需

instance_code

string

审批实例 Code

必需

修改于 2023-01-28 10:20:31

资源介绍

撤回审批实例

创建审批实例

控件值说明#

#

错误码#

请求参数

返回响应

控件值说明

错误码