查看审批定义

Error: 为了更好地提升接口文档的的易理解性，我们对文档进行了升级，请尽快迁移至新版本>>

根据 Approval Code 获取某个审批定义的详情，用于构造创建审批实例的请求。

请求

项目	值
HTTP URL	https://www.feishu.cn/approval/openapi/v2/approval/get
HTTP Method	POST
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	approval:approval:readonly 访问审批应用

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

参数	类型	必须	说明
approval_code	String	是	审批定义 Code
locale	String	否	zh-CN - 中文 en-US - 英文 ja-JP - 日文

请求体示例

{
    "approval_code": "7C468A54-8745-2245-9675-08B7C63E7A85",
    "locale": "en-US"
}

响应

响应体

参数	类型	必须	说明
code	int	是	错误码，非 0 表示失败
msg	String	是	返回码的描述
data	map	是	返回业务信息
∟approval_name	String	是	审批名称
∟status	String	是	审批定义状态 ACTIVE -已启用 INACTIVE -已停用 DELETED -已删除 UNKNOWN -未知
∟form	String	是	json 数组，控件信息
∟id	String	是	控件 ID
∟custom_id	String	否	控件自定义 ID
∟name	String	是	控件名称
∟type	String	是	控件类型
∟enable_default_value	bool	是	此控件是否启用了默认值
∟widget_default_value	String	是	控件的默认值
∟default_value_type	String	是	控件的默认值类型
∟display_condition	String	否	控件显隐条件
∟conditional	String	否
∟conditions	list	否
∟conditional	String	否	多个条件同时满足
∟expressions	list	否
∟source_widget	String	否
∟compare_type	String	否	判断规则
∟standard_value	String	否	条件值
∟node_list	list	是	节点信息
∟name	String	是	节点名称
∟need_approver	bool	是	是否发起人自选节点 true - 发起审批时需要提交审批人
∟node_id	String	是	节点 ID
∟custom_node_id	String	否	节点自定义 ID，如果没有设置则不返回
∟node_type	String	是	审批方式 AND -会签 OR - 或签 SEQUENTIAL -依次审批 CC_NODE -抄送节点
∟viewers	list	是	可见人列表
∟type	String	是	可见人类型，分别有： TENANT：租户内可见 DEPARTMENT：指定部门 USER：指定用户 ROLE：指定角色 USER_GROUP：指定用户组 NONE：任何人都不可见
∟open_id	String	否	在可见人类型为DEPARTMENT时，open_id为部门的open_id 在可见人类型为USER时，open_id为用户的open_id 在可见人类型为ROLE时，open_id为角色的open_id 在可见人类型为USER_GROUP时，open_id为用户组的open_id
∟user_id	String	否	在可见人类型为USER时，表示可见人用户id
控件信息:
名称	类型
-	-
单行文本	input
多行文本	textarea
数字	number
金额	amount
日期	date
日期区间	dateInterval
计算公式	formula
附件	attachment/attachmentV2
图片	image/imageV2
联系人	contact
关联审批	connect
地址	address
电话	telephone
请假控件组	leaveGroup
加班控件组	workGroup
换班控件组	shiftGroup
补卡控件组	remedyGroup
出差控件组	tripGroup
外出控件组	outGroup

{
    "id": "widget1",
    "custom_id": "user_name",
    "name": "Item application",
    "type": "input",
    "printable": true,
    "required":true
}

名称	类型
单选	radio/radioV2
多选	checkbox/checkboxV2

{
    "id": "widget1",
    "name": "Item application",
    "type": "radio",
    "printable": true,
    "required":true,
    "option": [
        {
            "text": "1",
            "value": "jxpsebqp-0"
        }
    ]
}

名称	类型
明细	fieldList

{
 "id": "widget1",
 "name": "Item application",
 "type": "fieldList",
 "printable": true,
 "required": true,
 "option":{
 	"input_type": "LIST",
 	"print_type": "LIST"
 },
 "children":[
 	{
 	"id": "widget2",
 	"name": "Item name",
 	"type": "input"
 }
 ]
}

名称	类型
电话	telephone

{
    "id":"widget1",
    "name":"Item application",
    "type":"telephone",
    "printable": true,
    "required":true,
    "option":{
        "available_type": "FIXED_LINE_OR_MOBILE"
      }
}

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "approval_name": "Payment",
        "status": "ACTIVE",
        "form": "[{\"id\": \"widget1\", \"custom_id\": \"user_name\",\"name\": \"Item application\",\"type\": \"textarea\",\"printable\": true,\"required\": true}\"]",
        "node_list": [
            {
                "name": "Approval",
                "need_approver": true,
                "node_id": "46e6d96cfa756980907209209ec03b64",
                "node_type": "AND"
            }
        ],
        "viewers": [
            {
                "open_id": "",
                "type": "TENANT",
                "user_id": ""
            }
        ]
    }
}