テンプレート詳細を取得

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			string	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-小数点以下1桁、0.00-小数点以下2桁
		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": "成功 "
}