获取签署人模板控件详情

GET/esignglobal/v1/templates/signerFieldsDetail

接口描述

查询模板中的签署人控件信息。

通过合同模板编号templateId来获取模板中设置的签署人控件信息，后续可通过快速发起信封接口来发起信封。

请求参数

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

请求示例

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

响应参数

参数名称				类型	说明
templateId				string	合同模板ID
templateName				string	合同模板名称
documentFields				array	文件控件列表
	fieldType			string	文件维度控件列表。用于在指定文件上添加不绑定签署人的文件维度控件。
	pageNo			string	控件类型。传 eMeterai 表示印尼印花税控件。
	posX			float	控件所在页码。印尼印花税控件仅支持指定单页，需传入单个页码，不支持 1-3、1,3 等连续或非连续多页格式。
	posY			float	x 轴偏移量，页面左下角为坐标原点。坐标范围与其他控件坐标范围一致。
signerFields				array	模板中的签署人控件列表信息
	signConfigs			array	签署控件信息
		fieldId		string	控件ID（设置合同模板时由eSignGlobal系统自动生成）
		fieldKey		string	控件Key（设置合同模板时由用户自定义）
		fieldType		string	控件类型： signature-签名区 stamp-图章区 approval-审批控件
		required		boolean	是否必填，默认必填 true-必填 false-非必填
		sizeRule		string	签署区尺寸展示方式 originalSize-根据签名/图章实际尺寸落章 targetSize-自定义签名/图章区宽高
		height		int	签署控件高度
		width		int	签署控件宽度
		movable		boolean	签署时允许移动位置 false-不允许签署人调整自己的签署控件位置 true-允许签署人调整自己的签署控件位置
		allowedOptions		array	允许签署人审批的选项，适用于fieldType为approval。默认为["approve", "decline"] approve-同意 decline-拒绝
		posX		float	控件位置X横坐标
		posY		float	控件位置Y纵坐标
		pageNo		string	控件所在页码
	fillConfigs			array	签署控件信息
		fieldId		string	控件ID（设置合同模板时由eSignGlobal系统自动生成）
		fieldKey		string	控件Key（设置合同模板时由用户自定义）
		fieldName		string	控件名称
		required		boolean	是否必填 true-必填 false-非必填
		fieldsType		string	控件类型： 1-单行文本 15-勾选框
		textField		object	文本控件属性
			overflowType	int	只对text生效 1-自动缩小字号 2-限制输入
			minFontSize	float	只对text生效，只对overflowType=1生效。 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			width	float	控件宽度
			fontSize	float	只对text生效，字体大小 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			textColor	string	只对text生效，十六进制颜色
			bold	boolean	只对text生效，字体是否加粗 true-加粗 false-不加粗
			italic	boolean	只对text生效，是否斜体 true-斜体 false-非斜体
			underline	boolean	只对text生效，字体是否添加下划线 true-添加下划线 false-不添加下划线
			lineThrough	boolean	只对text生效，是否添加删除线 true-添加删除线 false-不添加删除线
			horizontalAlignment	string	只对text生效，水平居中格式 LEFT-靠左 CENTER-居中 RIGHT-靠右
		tickBoxField		object	勾选框属性
			tickOptions	array	只对Check生效 1-勾 2-叉
		posX		float	控件位置X横坐标
		posY		float	控件位置Y纵坐标
		pageNo		string	控件所在页码
	signDateConfigs			array	签署日期信息
		fieldId		string	控件ID（设置合同模板时由eSignGlobal系统自动生成）
		fieldKey		string	控件Key（设置合同模板时由用户自定义）
		movable		boolean	签署时允许移动位置 false-不允许签署人调整自己的签署控件位置 true-允许签署人调整自己的签署控件位置
		posX		float	控件位置X横坐标
		posY		float	控件位置Y纵坐标
		pageNo		string	控件所在页码
		signDateFormat		string	签署日期格式

响应示例

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"
}