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

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	契約テンプレート名
signerFields				array	テンプレート内の署名者コントロールリスト情報
	signConfigs			array	署名コントロール情報
		fieldId		string	コントロールID（契約テンプレート設定時にeSignGlobalシステムが自動生成）
		fieldKey		string	コントロールキー（契約テンプレート設定時にユーザーがカスタム）
		fieldType		string	コントロールタイプ： signature-署名エリア stamp-捺印エリア approval-承認コントロール
		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	コントロールキー（契約テンプレート設定時にユーザーがカスタム）
		fieldName		string	コントロール名
		required		boolean	必須項目ですか true - 必須 false - 必須ではありません
		fieldsType		string	コントロールタイプ： 1 - 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	コントロール位置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"
}