获取模板详情

GET /esignglobal/v1/templates/templateDetail

接口描述

查询模板中的控件信息。

通过合同模板编号templateId来获取模板中设置的所有控件信息，后续可通过接口 填写模板生成文件 来填充模板。

请求参数

参数名称	类型	是否必填	说明
templateId	string	true	合同模板ID，可在eSignGlobal的模板列表中查询

请求示例

GET  https:// … …/esignglobal/v1/templates/templateDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

响应参数

参数名称				类型	说明
templateId				string	合同模板ID
templateName				string	合同模板名称
templateType				int	合同模板类型：0-PDF，1-WORD
createTime				string	合同模板创建时间（Unix 时间戳格式，单位：毫秒）
updateTime				string	合同模板更新时间（Unix 时间戳格式，单位：毫秒）
templateStatus				int	合同模板状态：0-未启用、1-启用
fields				array	模板中的控件列表信息
	fieldId			string	控件ID（设置合同模板时由eSignGlobal 系统自动生成）
	fieldKey			string	控件Key（设置合同模板时由用户自定义）
	fieldName			string	控件名称
	required			boolean	控件是否必填： True-必填，false-非必填
	fieldType			int	1-单行文本，2-数字，3-日期，8-多行文本，9-复选，10- 单选，11- 图片，14-下拉框，15-勾选框
	fieldPosition			object	控件位置信息（仅PDF模板返回）
		posX		float	控件位置X横坐标
		posY		float	控件位置Y纵坐标
		posNo		int	控件所在页码
		movable		boolean	签署时允许移动位置，默认false false-不允许签署人调整自己的签署控件位置 true-允许签署人调整自己的签署控件位置
	fieldSpecialAttribute			object	控件特有属性
		dateFormat		string	日期格式（日期控件特有）
		imageType		string	图片类型（图片控件特有）
		options		array	选项（下拉框控件、单选控件、多选控件特有）
			optionContent	string	选项内容
			optionOrder	int	选项顺序
			selected	boolean	选项是否默认选中
		numberFormat		string	数字格式（数字控件特有），格式如下：0-整数，0.0-保留一位小数，0.00-保留两位小数
		tableContent		array	表格行列内容（动态表格控件特有），格式：[row{"column1":"value1","column2":"value2"}] 补充说明： row表示动态表格对应的行，row的个数依据模板动态表格控件中所添加的所添加的行数。 column1表示当前行中单元格的Key值value1表示当前行中单元格的Value值，单元格未设置固定值时为""空字符串，否则为所设置的固定值。详见tableContent解释说明。
		fieldMaxLength		string	可填充的长度上限，单位：中文字符【注】1个中文字符=2个英文字符；
	fieldSize			object	控件尺寸
		fieldWidth		float	控件宽度（矩形的左右距离，单位为px）
		fieldHeight		float	控件高度（矩形的上下距离，单位为px）

响应示例

{
    "code": "0",
    "data ": {
        "createTime": 1693910774808,
        "fields": [
            {
                "fieldId": "7e4bbdb838f64a31b0a4bdea18d1613c",
                "fieldKey": "",
                "fieldName": "身份证号 ",
                "fieldPosition": null,
                "fieldSize": {
                    "fieldHeight": "",
                    "fieldWidth": ""
                },
                "fieldSpecialAttribute": {
                    "dateFormat": "yyyy/MM/dd ",
                    "fieldMaxLength": "",
                    "imageType": "",
                    "numberFormat": "",
                    "options": [

                    ],
                    "tableContent": [

                    ]
                },
                "fieldType": 3,
                "required": false
            }
        ],
        "templateId": "d288b477-ed3c-4fe6-801c-80d8ec5fe9cf",
        "templateName": "test123456 ",
        "templateStatus": 0,
        "updateTime": 1693911131351
    },
    "message": "成功 "
}