查询模板文件详情

文档变更说明

原接口的中文名称由“查询模板详情/下载模板”变更为“查询模板文件详情”，其接口功能未做调整。

接口描述

查看模板文件的模板ID、模板名称、文件大小、模板内填写控件信息和下载链接，本接口不支持轮询。

说明：

此接口所查询的下载链接属于原始模板文件，如果需要下载内容填充后的PDF文件请调用【查询PDF文件详情】接口。

接口地址

/v1/docTemplates/{templateId}

请求方法

GET

请求头

提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。

方式一：请求签名鉴权（优先推荐）

请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	应用ID
Content-Type	string	是	application/json;charset=UTF-8
X-Tsign-Open-Ca-Timestamp	string	是	API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击
Accept	string	是	建议统一填写 /
X-Tsign-Open-Ca-Signature	string	是	签名字符串
Content-MD5	string	是	当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。
X-Tsign-Open-Auth-Mode	string	是	选择请求方式进行鉴权，固定值，Signature

方式二：OAuth2.0鉴权（不推荐使用）

当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：

参数名称	类型	必选	参数说明
X-Tsign-Open-App-Id	string	是	应用ID
X-Tsign-Open-Token	string	是	通过获取鉴权Token接口返回
Content-Type	string	是	application/json; charset=UTF-8

请求参数

参数名称	类型	必选	参数类型	参数说明
templateId	string	是	path	模板id，该参数需放在请求地址里面，可以参考【请求示例】

响应参数

展开全部参数参数名称					类型	必选	参数说明
code					int	是	业务码，0表示成功
message					string	否	信息
data					object	否	业务信息
	templateId				string	否	模板ID
	templateName				string	否	模板名称
	templateType				int	否	固定值 3
	downloadUrl				string	否	模板文件下载链接，有效期60分钟。
	fileSize				long	否	模板文件大小
	createTime				int64	否	创建时间，Unix时间戳（毫秒级）
	updateTime				int64	否	更新时间，Unix时间戳（毫秒级）
	structComponents				array	否	文件模板中的填写控件列表
	id			string	否	填写控件id，使用时可用id填充，为空时表示添加，不为空时表示修改
	key			string	否	模板下填写控件唯一标识，使用模板时也可用根据key值填充
	type			int	否	填写控件类型， 1-单行文本，2-数字，3-日期，6-签约区， 8-多行文本，11-图片
	context			object	否	填写控件上下文信息，包含了名称，填充格式，样式以及坐标
		label		string	否	填写控件显示名称
		required		boolean	否	是否必填，默认true
limit		string	否	填写控件type=2,type=3时填充格式校验规则：数字格式如：#,#00.0# 日期格式如： yyyy-MM-dd
style		object	否	填写控件样式
		width	float	否	填写控件宽度
		height	float	否	填写控件高度
		font	int	否	填充字体,默认1， 1-宋体，2-新宋体,4-黑体，5-楷体
		fontSize	float	否	填充字体大小,默认12
		textColor	string	否	字体颜色，默认#000000黑色
pos		object	否	填写控件坐标
		page	int	否	页码
	x	float	否	x轴坐标，左下角为原点
	y	float	否	y轴坐标，左下角为原点
options		array	否	控件结构中的子元素，用于选择控件，如：单选，多选，下拉选项
	index	int	否	选项下标，从0开始
	label	string	否	选项名称
	other	boolean	否	是否是其他
	x	float	否	选项在父边框中的x轴坐标
	y	float	否	选项在父边框中的y轴坐标
	width	float	否	选项宽度
	height	float	否	选项高度
	selected	boolean	否	是否默认选中
version		int	否	控件版本，开发者可忽略此字段
ext		string	否	扩展字段，用于支持一些扩展功能支持以下字段： imgType：图片类型； page：骑缝章的跨度页码，例如当骑缝章盖1-5页时，返回：1-5【注】单页盖章不会返回page字段； signRequirements：签署要求，逗号分隔 1-企业章 2-经办人 3-法定代表人章； qiFeng：是否骑缝章签署，true - 骑缝章，false - 非骑缝章； units：暂无用途； signDatePos：签署区日期，当签署区设置了签署时间时，用于时间的坐标位置，如{\"x\":30.8,\"y\":724.01,\"page\":1}； fillLengthLimit：控件填充的限制长度（限制填充的字数），用于单行/多行文本。
refId			string	否	关联签署方的ID，开发者可忽略此字段
allowEdit			boolean	否	是否允许编辑，用于管控页面是否能对该控件进行修改；线下制作的模板（带表单域）此值为false,其余为true

请求示例

GET https://openapi.esign.cn/v1/docTemplates/【模板id】

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "templateId":"e2175bd0445149abb0a9650xxx",
        "fileKey":"$d81790ee-xxxx",
        "downloadUrl":"https://esignoss.esign.cn/1111564182/62b5abc0-b17e-4e09-a599-40705ff6fcdf/test.pdf?Expires=xxx&amp;OSSAccessKeyId=xx&amp;Signature=xxx",
        "fileSize":0,
        "templateName":"劳动合同模板.pdf",
        "templateType":3,
        "createTime":1639721566000,
        "updateTime":1639721567000,
        "structComponents":[
            {
                "id":"d37abe49d6f3482xxx",
                "key":"",
                "groupKey":null,
                "aiKey":null,
                "type":1,
                "context":{
                    "label":"姓名",
                    "limit":null,
                    "subType":null,
                    "required":true,
                    "style":{
                        "font":1,
                        "fontSize":12,
                        "textColor":"#000000",
                        "width":160,
                        "height":15,
                        "bold":false,
                        "italic":false,
                        "underLine":false,
                        "horizontalAlignment":"LEFT",
                        "verticalAlignment":"TOP"
                    },
                    "pos":{
                        "x":323.15,
                        "y":702.82,
                        "page":1
                    },
                    "options":null,
                    "version":2,
                    "ext":"{\"units\":\"px\",\"qiFeng\":false,\"signDatePos\":null,\"signRequirements\":\"\",\"imgType\":1,\"fillLengthLimit\":13}"
                },
                "refId":null,
                "allowEdit":true
            },
            
            {
                "id":"dea04bf0944a429cb3a909c25fxxx",
                "key":"",
                "groupKey":null,
                "aiKey":null,
                "type":6,
                "context":{
                    "label":"签署区",
                    "limit":"yyyy/MM/dd",
                    "subType":null,
                    "required":true,
                    "style":{
                        "font":1,
                        "fontSize":12,
                        "textColor":"#000000",
                        "width":100,
                        "height":100,
                        "bold":false,
                        "italic":false,
                        "underLine":false,
                        "horizontalAlignment":"LEFT",
                        "verticalAlignment":"TOP"
                    },
                    "pos":{
                        "x":181.65,
                        "y":550.34,
                        "page":1
                    },
                    "options":null,
                    "version":2,
                    "ext":"{\"units\":\"px\",\"qiFeng\":false,\"signDatePos\":{\"x\":131.65,\"y\":500.34,\"page\":1},\"signRequirements\":\"\",\"imgType\":1,\"fillLengthLimit\":0}"
                },
                "refId":"850a75cb96a34f75b1181ed462e57bd2",
                "allowEdit":true
            }
        ]
    }
}