创建审批定义
POST
https://open.feishu.cn/open-apis/approval/v4/approvals
接口谨慎调用，创建后的审批定义无法停用/删除
字段说明
form_content 字段说明
1.
{
"id":"",
"name":"",
"type":"input",
"required":true
}1.
{
"id":"",
"name":"",
"type":"amount",
"required":true,
"value":"CNY",
"option":{ "currencyRange": ["CNY","USD"]
}
}value 为金额控件的枚举值，包括： CNY - 人民币 USD - 美元 EUR - 欧元 JPY - 日元 CAD - 加拿大元 CHF - 瑞士法郎 SGD - 新加坡元 AUD - 澳大利亚元 KBW - 韩元 INR - 印度卢比 TWD - 新台币 HKD - 港元 MOP - 澳门元 THB - 泰铢 IDR - 印尼盾 PHP - 菲律宾比索 MYR - 马来西亚令吉
1.
{
"id":"",
"name":"",
"type":"text",
"required":true,
"value":"@i18n@text"
}value 为说明内容的国际化文案 Key，以 @i18n@ 开头，长度不得少于 9 个字符
1.
{
"id":"",
"name":"",
"type":"radioV2",
"required":true,
"value":[{"key":"1","text":"@i18n@choice1"},{"key":"2","text":"@i18n@choice2"}]
}{
"id":"",
"name":"",
"type":"radioV2",
"required":true,
"value":[],
"externalData":{
"externalUrl":"https://www.xxx_bytedance.net/",
"token":"t",
"key":"k",
"linkageConfigs":[
{
"linkageWidgetID":"widget1",
"key":"linkageWidget1",
"value":"example"
}
],
"externalDataLinkage":true
}
}value为每个选项 Key 和 Text，其中 Key 不能重复，Text 以 @i18n@开头，长度不得少于9个字符
1.
{
"id":"",
"name":"",
"type":"date",
"required":true,
"value": "YYYY-MM-DD"
}value 为日期格式： YYYY-MM-DD：年-月-日 YYYY-MM-DD a：年-月-日 上午/下午 YYYY-MM-DD hh:mm：年-月-日 时:分
1.
{
"id":"",
"name":"",
"type":"connect",
"required":true,
"value":["code1","code2"]
}value 为关联审批定义的 code
1.
{
"id":"",
"name":"",
"type":"contact",
"required":true,
"value":{
"ignore": true,
"multi": false
}
}value 为联系人控件的配置项： ignore：是否可选自己，默认 false，可选自己 multi：是否可选多人，默认 false，不可选
1.
{
"id":"",
"name":"",
"type":"address",
"required":true,
"value":{
"enableDetailAddress": false,
"requiredDetailAddress": false,
"preLocating": false
}
}value 为地址控件的配置项： enableDetailAddress：是否开启详细地址，默认 false，不开启 requiredDetailAddress：详细地址是否必填，默认 false，不必填 preLocating：是否自动定位，默认 false，不自动定位
1.
{
"id":"",
"name":"",
"type":"dateInterval",
"required":true,
"value":{
"format": "YYYY-MM-DD",
"intervalAllowModify": false,
}
}value 为日期区间控件的配置项： format：日期格式，同 date 控件 intervalAllowModify：时长是否可以修改，默认 false，不可以修改
1.
{
"id":"",
"name":"",
"type":"telephone",
"required":true,
"option":{
"availableType": "FIXED_LINE_OR_MOBILE"
}
}option 为电话控件的配置项： availableType：电话可选类型，可选值为 MOBILE、FIXED_LINE、FIXED_LINE_OR_MOBILE
1.
{
"id": "",
"name": "",
"type": "fieldList",
"required": true,
"value":
[
{
"id": "",
"name": "",
"type": "input",
"required": true
}
],
"option":
{
"inputType": "LIST",
"printType": "LIST"
}
}option 为明细控件的配置项： inputType：明细控件的填写格式，可选 LIST(纵向填写)、FORM(横向填写) printType: 明细控件的打印格式，可选 LIST(纵向打印)、FORM(横向打印)
图标枚举
错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1390001 | param is invalid | 参数错误 |
| 400 | 1390002 | approval code not found | 检查审批定义code是否正确 |
| 400 | 1390003 | instance code not found | 检查审批实例code是否正确 |
| 400 | 1390004 | user_id or open_id not found | 检查user_id,open_id是否正确 |
| 403 | 1390009 | no operation permission | 检查操作权限是否正确 |
| 400 | 1390013 | unsupported approval for free process | 不支持自由流程 |
| 400 | 1390015 | approval is not active | 审批定义已停用，检查审批定义是否启用 |
| 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/approvals' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
"approval_name": "@i18n@approval_name",
"approval_code": "813718CE-F38D-45CA-A5C1-ACF4F564B526",
"viewers":[
{
"viewer_type":"TENANT",
"viewer_user_id":""
}
],
"form": {
"form_content": "[{\"id\":\"111\",\"name\":\"@i18n@event_name\",\"required\":true,\"type\":\"input\"},{\"id\":\"222\",\"name\":\"@i18n@time_interval\",\"required\":true,\"type\":\"dateInterval\",\"value\":{\"format\":\"YYYY-MM-DD hh:mm\",\"intervalAllowModify\":false}},{\"id\":\"333\",\"name\":\"@i18n@event_type\",\"type\":\"radioV2\",\"value\":[{\"key\":\"1\",\"text\":\"@i18n@recurrence_event\"},{\"key\":\"2\",\"text\":\"@i18n@single_event\"}]},{\"id\":\"444\",\"name\":\"@i18n@attende_count\",\"required\":true,\"type\":\"number\"},{\"id\":\"555\",\"name\":\"@i18n@apply_reason\",\"required\":true,\"type\":\"textarea\"}]"
},
"node_list": [{
"id": "START",
"privilege_field":{
"writable": ["111","222"],
"readable": ["111","222"]
}
},{
"id": "7106864726566",
"privilege_field":{
"writable": ["111","222"],
"readable": ["111","222"]
},
"name": "@i18n@node_name",
"node_type": "AND",
"approver": [
{
"type": "Personal",
"user_id": "59a92c4a"
}
],
"ccer": [
{
"type": "Supervisor",
"level": "2"
}
]
},{
"id": "END"
}],
"settings" : {
"revert_interval":0
},
"config" : {
"can_update_viewer": false,
"can_update_form": true,
"can_update_process": true,
"can_update_revert": true,
"help_url":"https://www.baidu.com"
},
"icon": 1,
"i18n_resources" : [{
"locale": "zh-CN",
"texts" : [
{"key":"@i18n@approval_name","value":"审批名称"},
{"key":"@i18n@event_name","value":"日程名称"},
{"key":"@i18n@node_name","value":"审批"},
{"key":"@i18n@time_interval","value":"日程名称"},
{"key":"@i18n@event_type","value":"日程类型"},
{"key":"@i18n@recurrence_event","value":"重复性日程"},
{"key":"@i18n@single_event","value":"单次日程"},
{"key":"@i18n@attende_count","value":"参与人数量"},
{"key":"@i18n@apply_reason","value":"申请原因"}
],
"is_default": true
}],
"process_manager_ids": ["1c5ea995"]
}'响应示例响应示例
{
"code": 0,
"msg": "success",
"data": {
"approval_code": "81D31358-93AF-92D6-7425-01A5D67C4E71",
"approval_id": "7090754740375519252"
}
}请求参数
Query 参数
department_id_type
string
可选
示例值:
open_department_id
user_id_type
string
用户 ID 类型
示例值:
open_id
Header 参数
Authorization
string
必需
默认值:
Bearer {{access_token}}
Content-Type
string
必需
默认值:
application/json; charset=utf-8
Body 参数application/json
返回响应
扫码加入交流群修改于 2023-01-28 10:08:16