署名者テンプレートコントロールの詳細を取得

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	コントロールキー（契約テンプレート設定時にユーザーがカスタム設定）
		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	コントロール位置YY座標
		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にのみ適用、16進数カラーコード
			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	コントロール位置YY座標
		pageNo		string	コントロールが存在するページ番号
	signDateConfigs			array	署名日情報
		fieldId		string	コントロールID（契約テンプレート設定時にシステムが自動生成）eSignGlobal
		fieldKey		string	コントロールキー（契約テンプレート設定時にユーザーがカスタム設定）
		movable		boolean	署名時の位置移動許可 false-署名者が自分の署名コントロールの位置を調整不可 true-署名者が自分の署名コントロールの位置を調整可能
		posX		float	コントロールのX座標
		posY		float	コントロール位置YY座標
		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"
}