獲取模板詳情

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": "成功 "
}