企业内部开发 服务端API OA 审批 获取审批模板详情
获取审批模板详情

企业可通过审批应用或自建应用Secret调用本接口,获取企业微信“审批应用”内指定审批模板的详情。

 

请求方式:POST(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/oa/gettemplatedetail?access_token=ACCESS_TOKEN

请求示例:

{
   "template_id" : "ZLqk8pcsAoXZ1eYa6vpAgfX28MPdYU3ayMaSPHaaa"
}
较早时间创建的模板,id为类似“1910324946027731_1688852032423522_1808577376_15111111111”的数字串。

参数说明:

参数必须说明
access_token调用接口凭证。必须使用审批应用或企业内自建应用的secret获取,获取方式参考:文档-获取access_token
template_id模板的唯一标识id。可在“获取审批单据详情”、“审批状态变化回调通知”中获得,也可在审批模板的模板编辑页面浏览器Url链接中获得。
1.审批应用的Secret可获取企业自建模板及第三方服务商添加的模板详情;自建应用的Secret可获取企业自建模板的模板详情。
2.接口调用频率限制为600次/分钟。

返回结果 :

{
    "errcode": 0,
    "errmsg": "ok",
    "template_names": [
        {
            "text": "全字段",
            "lang": "zh_CN"
        }
    ],
    "template_content": {
        "controls": [
            {
                "property": {
                    "control": "Selector",
                    "id": "Selector-15111111111",
                    "title": [
                        {
                            "text": "单选控件",
                            "lang": "zh_CN"
                        }
                    ],
                    "placeholder": [
                        {
                            "text": "这是单选控件的说明",
                            "lang": "zh_CN"
                        }
                    ],
                    "require": 0,
                    "un_print": 0
                },
                "config": {
                    "selector": {
                        "type": "single",
                        "exp_type": 0,
                        "options": [
                            {
                                "key": "option-15111111111",
                                "value": [
                                    {
                                        "text": "选项1",
                                        "lang": "zh_CN"
                                    }
                                ]
                            },
                            {
                                "key": "option-15222222222",
                                "value": [
                                    {
                                        "text": "选项2",
                                        "lang": "zh_CN"
                                    }
                                ]
                            }
                        ]
                    }
                }
            }
        ]
    }
}

参数说明:

参数说明
template_names模板名称,若配置了多语言则会包含中英文的模板名称,默认为zh_CN中文
template_content模板控件信息
└ controls模板控件数组。模板详情由多个不同类型的控件组成,控件类型详细说明见附录。
└ └ property模板控件属性,包含了模板内控件的各种属性信息
└ └ └ control控件类型:Text-文本;Textarea-多行文本;Number-数字;Money-金额;Date-日期/日期+时间;Selector-单选/多选;Contact-成员/部门;Tips-说明文字;File-附件;Table-明细;Attendance-假勤控件;Vacation-请假控件;Location-位置;RelatedApproval-关联审批单;Formula-公式;DateRange-时长
└ └ └ id控件id
└ └ └ title控件名称,若配置了多语言则会包含中英文的控件名称,默认为zh_CN中文
└ └ └ placeholder控件说明,向申请者展示的控件填写说明,若配置了多语言则会包含中英文的控件说明,默认为zh_CN中文
└ └ └ require是否必填:1-必填;0-非必填
└ └ └ un_print是否参与打印:1-不参与打印;0-参与打印
└ └ config模板控件配置,包含了部分控件类型的附加类型、属性,详见附录说明。目前有配置信息的控件类型有:Date-日期/日期+时间;Selector-单选/多选;Contact-成员/部门;Table-明细;Attendance-假勤组件(请假、外出、出差、加班)

附录

 

附1:Date控件(日期/日期+时间控件)config说明:

{
    "date": {
        "type": "day"
    }
}
参数说明
date类型标志,日期/日期+时间控件的config中会包含此参数
└ type时间展示类型:day-日期;hour-日期+时间

附2:Selector控件(单选/多选控件)config说明:

{
    "selector": {
        "type": "single",
        "options": [
            {
                "key": "option-15111111111",
                "value": [
                    {
                        "text": "选项1",
                        "lang": "zh_CN"
                    }
                ]
            },
            {
                "key": "option-15222222222",
                "value": [
                    {
                        "text": "选项2",
                        "lang": "zh_CN"
                    }
                ]
            }
        ]
    }
}
参数说明
selector类型标志,单选/多选控件的config中会包含此参数
└ type选择类型:single-单选;multi-多选
└ options选项,包含单选/多选控件中的所有选项,可能有多个
└ └ key选项key,选项的唯一id,可用于发起审批申请,为单选/多选控件赋值
└ └ value选项值,若配置了多语言则会包含中英文的选项值,默认为zh_CN中文

附3:Contact控件(成员/部门控件)config说明:

{
    "contact": {
        "type": "multi",
        "mode": "department"
    }
}
参数说明
contact类型标志,单选/多选控件的config中会包含此参数
└ type选择方式:single-单选;multi-多选
└ mode选择对象:user-成员;department-部门

附4:Table(明细控件)config说明:

{
    "table": {
        "children": [
            {
                "property": {
                    "control": "Text",
                    "id": "Text-15111111111",
                    "title": [
                        {
                            "text": "明细内文本控件",
                            "lang": "zh_CN"
                        }
                    ],
                    "placeholder": [
                        {
                            "text": "这是明细内文本控件的说明",
                            "lang": "zh_CN"
                        }
                    ],
                    "require": 0,
                    "un_print": 0
                }
            }
        ],
        "stat_field": []
    }
}
参数说明
table类型标志,明细控件的config中会包含此参数
└ children明细内的子控件,内部结构同controls

附5:Attendance控件(假勤控件)config说明:
说明:【出差】【加班】【外出】模板特有的控件

{
	"attendance": {
		"date_range": {
			"type": "hour"
		},
		"type": 3
	}
}
参数说明
attendance类型标志,假勤控件的config中会包含此参数
└ date_range假期控件属性
└└ type时间刻度:hour-精确到分钟, halfday—上午/下午
└ type假勤控件类型:1-请假,3-出差,4-外出,5-加班

附6:Vacation控件(假勤控件)说明:
说明:【请假】模板特有控件, 请假类型强关联审批应用中的假期管理。

{
	"vacation_list": {
		"item": [{
			"id": 1,
			"name": [{
				"text": "年假",
				"lang": "zh_CN"
			}]
		}, {
			"id": 2,
			"name": [{
				"text": "事假",
				"lang": "zh_CN"
			}]
		}
		...//省略 
		]
	}
}
参数说明
vacation_list假期类型数组
└ item单个假期类型属性
└└ id假期类型标识id

| └└ name | 假期类型名称,默认zh_CN中文名称|

错误说明

错误码说明
301025参数错误,请求template_id非法
301026通用错误码,拉取审批模板内部接口失败
上一篇
概述
下一篇
提交审批申请