開発者センター

テンプレートに入力してファイルを生成

POST /esignglobal/v1/templates/createFileByTemplate

インターフェースの説明

契約テンプレート番号に基づいてtemplateIdテンプレート内のコントロールを使用してカスタムコンテンツを入力し、最終的に非同期でPDFファイルを生成します。

呼び出す前に、テンプレートの状態が有効になっていることを確認してください

リクエストパラメータ

パラメータ名

タイプ

必須項目

説明

templateId

string

true

契約テンプレートID

fileName

string

false

生成後のファイル名

注:ファイル名には、次の9つの特殊文字を含めることはできません:/ \ : * " < > | ?およびすべての絵文字

fields

array

false

テンプレート内のコントロールリスト情報(コントロールIDとコントロールキーのいずれかを選択して値を渡します)

 

fieldId

string

false

コントロールID(契約テンプレートの設定時にeSignGlobalシステムによって自動的に生成されます)

 

fieldKey

string

false

コントロールキー(契約書テンプレート設定時にユーザーがカスタム設定)

 

fieldValue

string

false

コントロールの入力値
(1)コントロールの種類に応じて入力できます。
(2)動的テーブルコントロールに入力する際、新しい行のデータを追加する必要がある場合は、insertRowパラメータにtrueを渡す必要があります。

callBackUrl

string

false

コールバックアドレス(最大長500)。有効なhttpsアドレスである必要があります。

リクエスト例

{
    "templateId": "1866fd459647435b98f7d40b2a9bc33e",
    "fields": [
        {
        	"fieldKey": "Number",
        	"fieldValue": "120000100101.001"
        },
        {
        	"fieldKey": "Date",
        	"fieldValue": "2025-07-07"
        },
        {
        	"fieldKey": "Checkbox",
        	"fieldValue": "[0,1,2]"
        },
        {
        	"fieldKey": "Radio",
        	"fieldValue": "1"
        },
        {
        	"fieldKey": "Select",
        	"fieldValue": "0"
        },
        {
        	"fieldKey": "Email",
        	"fieldValue": "test@gmail.com"
        },
        {
        	"fieldKey": "mergeFilling",
        	"fieldValue": "eSignGlobal"
        },
        {
        	"fieldKey": "tabkey",
        	"fieldId": "537c875667f24b9782a7bb42f1dc98b2",
        	"fieldValue": "[{\"row\":{\"column1\":\"Name\"}},{\"row\":{\"column1\":\"Jack\"}},{\"insertRow\":\"true\",\"row\":{\"column1\":\"Mike\"}}]"
        },
        {
        	"fieldId": "4d25013762f042758cdd727a9d4f8029",
        	"fieldKey": "",
        	"fieldValue": "123"
        }
    ]
}

レスポンスパラメータ

パラメータ名

タイプ

説明

taskId

string

ファイル合成タスクID

レスポンス例

{
    "code": "0",
    "data": {
        "taskId": "7e6d1125dc164fa4b2c268f8bb809dea"
    },
    "message": "success"
}

コントロール入力例の説明

コントロールタイプ

コントロールの入力例

具体的な説明

一行テキスト

「具体的な文字XXXXX」

入力する具体的な文字

複数行テキスト

「複数行の文字\n複数行の文字」

入力する具体的な文字、\n 改行する

数字

"12345"

整数と小数をサポート

日付

"2025-01-01"

デフォルトの形式はyyyy-MM-dd

指定された形式をサポート:

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd,yyyy

dd MM yyyy

単一選択

"1"

0からソートを開始し、0オプション1を表し、1オプション2を表します....

複数選択

"[0,1,2]"

0からソートを開始し、0オプション1を表し、1オプション2を表します....

チェック

"0" 、"1"、"2"

0 - 未選択

1 - 選択済み ✓

2 - バツ印 ✗(テンプレート設定で「バツ印を許可」オプションを有効にする必要があります)

ドロップダウン選択

"0"

0からソートを開始、0オプション1を表し、1オプション2を表します....

画像

"URL"

画像リンクをアップロードする必要があります

動的テーブル

[{\"row\":{\"column1\":\"具体的内容\"}},{\"row\":{\"column1\":\"具体的内容\"}},{\"insertRow\":\"true\",\"row\":{\"column1\":\"Mike\"}}]

rowは動的テーブルの行データであり、rowの数が動的テーブル作成時に追加されたテーブル行数です。rowのcolumn1は現在の行の列column1上のセルKey値であり、column2は列column2のセルKey値です。

メールアドレス

"123456@XX.com"

メールアドレス

インターフェースの説明
リクエストパラメータ
リクエスト例
レスポンスパラメータ
レスポンス例
コントロール入力例の説明