Box Signテンプレート
Box Signテンプレートオブジェクト。
4206996024-14944f75-c34b-478a-95a1-264b1ff80d35テンプレートの識別子。
sign-template値は常にsign-templateになります。
次の値に固定: sign-template
必須フィール ドと編集不可フィールドに関する追加情報。
["email_subject","name"]編集不可フィールド。
必須フィールド。
[["email"],["email"]]必須の署名者 フィールド。
["email"]trueテンプレートのメール設定が編集可能かどうかを示します。
falseテンプレートの入力フィールドが編集可能かどうかを示します。
trueテンプレートファイルが編集可能かどうかを示します。これには、テンプレートファイルの削除または名前変更が含まれます。
trueテンプレートドキュメントのオプション (ドキュメントの名前変更など) が編集可能かどうかを示します。
falseテンプレートの署名者が編集可能かどうかを示します。
通知および署名リクエストに適用されているカスタムブランド設定。
9E5E6Fカスタムブランド設定の色 (16進数)。
Corporation inc.会社の名前。
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA
AAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A
8AAQUBAScY42YAAAAASUVORK5CYII=カスタムブランド設定のロゴURI (base64画像形式)。
20730作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。
Hello! Please sign the document below署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグa、abbr、acronym、b、blockquote、code、em、i、ul、li、ol、strongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。
Sign Request from Acme署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィール ドを渡さない場合は、デフォルトの件名が使用されます。
Official contractテンプレートの名前。
最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必要です。ルートフォルダ (フォルダID 0) は使用できません。
Boxの署名リンク機能により、テンプレートから作成した署名リクエストへのリンクを作成できます。このリンクは、署名者が誰になるか不明な状態で公開フォ ーム (メール、ソーシャルメディアの投稿、ウェブページなど) に署名リクエストを投稿する場合に使用します。注: 署名リンク機能は、Enterprise Plusをご利用のお客様に限定されており、Box Verified Enterpriseでは利用できません。
12345最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必要です。ルートフォルダ (フォルダID 0) は使用できません。
Hello! Please sign the document below署名者全員に対する追加の指示。
false署名リンクが有効になっているかどうか。
true署名者が署名したときの通知を無効にするかどうか。
Official contractリクエスト名。
"https://app.box.com/sign/
ready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178"署名者に送信できるURL。
example@mail.com署名者のメールアドレス。
text入力の種類。
次の値のいずれか1つ: signature,date,text,checkbox,attachment,radio,dropdown
trueチェックボックスの事前入力値。
text入力のコンテンツタイプ。
次の値のいずれか1つ: signature,initial,stamp,date,checkbox,text,full_name,first_name,last_name,company,title,email,attachment,radio,dropdown
ページ上で入力が配 置される場所。
0.672258592471358入力が配置されるページに対する相対的なx座標 (範囲は0～1)。
0.18654283173599448入力が配置されるページに対する相対的なy座標 (範囲は0～1)。
2021-04-26日付の事前入力値。
入力のサイズ。
0.05311728090109673入力が配置されるページに対する相対的な高さ (範囲は0～1)。
0.2618657937806874入力が配置されるページに対する相対的な幅 (範囲は0～1)。
123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7ドキュメントの識別子。
1234これは、署名リクエストのファイルに含まれている特定のタグのIDを参照します。
["Yes","No","Maybe"]入力のタイプがdropdownの場合、この値には、ドロップダウンのすべてのオプションが設定されます。
da317330-225a-4c72-89ad-0d6dcaaf4df6入力のタイプがradioの場合、この識別子で収集するようにグループ化できます。
true入力が必要かどうか。
Legal nameラベルフィールドは、テキスト、添付、ラジオボタン、チェックボックスのタイプの入力に特に使用されます。
4入力が配置されるページのインデックス。
trueこの入力が読み取り専用 (署名者による変更不可) かどうかを示します。
textテキストの事前入力値。
{"validation_type":"email"}署名者がテキストフィールドに入力する際に従う必要のある書式設定ルールを指定します。設定した場合、この検証は必須となります。
true署名者の埋め込みURLと組み合わせて使用されます。送信者が署名すると、その次のin_person署名者にリダイレクトされます。
trueメールアドレスが定義されている署名者に対してtrueの場合、テンプレートの作成時に指定されたパスワードがデフォルトで使用されます。メールアドレスが指定/定義されていない署名者に対してtrueの場合、作成者 は、テンプレートの使用時にパスワードを指定する必要があります。
trueメールアドレスが定義されている署名者に対してtrueの場合、テンプレートの作成時に指定された電話番号がデフォルトで使用されます。メールアドレスが指定/定義されていない署名者に対してtrueの場合、テンプレート作成者は、リクエストの作成時に電話番号を指定する必要があります。
Jane Doeテンプレート作成者が署名者を区別するために設定した、署名者のプレースホルダラベル。
truetrueの場合、署名者は、ドキュメントにアクセスするためにログインする必要があります。
20署名者の順序。
RJZYYVPR署名者の識別子。これは、テンプレート内で署名者を識別するために使用できます。
signer"signer"署名リクエストに含まれる署名者の役割を定義します。役割がsignerの場合はドキュメントの署名する必要があり、approverの場合はドキュメントを承認します。また、最終的な署名済みドキュメントと署名ログを受け取るのは、final_copy_reader役割のみです。
次の値のいずれか1つ: signer,approver,final_copy_reader
cd4ff89-8fc1-42cf-8b29-1890dedd26d7指定した場合、この値は、同じ入力が割り当てられ、同じ署名者グループに属している署名者を指します。署名者グループはBoxグループではありません。これは、テンプレート自体に属しているエンティティであり、そのテンプレートから作成されたBox Signリクエスト内でのみ使用できます。
署名するドキュメントの作成元ファイルのリスト。ファイルごとにIDフィールドとtypeフィールドのみが必要です。
レスポンスの例
{
"id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
"type": "sign-template",
"additional_info": {
"non_editable": [
"email_subject",
"name"
],
"required": {
"signers": [
[
"email"
],
[
"email"
]
]
}
},
"are_email_settings_locked": true,
"are_fields_locked": false,
"are_files_locked": true,
"are_options_locked": true,
"are_recipients_locked": false,
"custom_branding": {
"branding_color": "9E5E6F",
"company_name": "Corporation inc.",
"email_footer_text": "Contact email email@mail.com",
"logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII="
},
"days_valid": 2,
"email_message": "Hello! Please sign the document below",
"email_subject": "Sign Request from Acme",
"name": "Official contract",
"parent_folder": {
"id": "12345",
"type": "folder",
"etag": "1",
"name": "Contracts",
"sequence_id": "3"
},
"ready_sign_link": {
"folder_id": "12345",
"instructions": "Hello! Please sign the document below",
"is_active": false,
"is_notification_disabled": true,
"name": "Official contract",
"url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\""
},
"signers": [
{
"email": "example@mail.com",
"inputs": [
{
"checkbox_value": true,
"date_value": "2021-04-26",
"document_tag_id": "1234",
"text_value": "text",
"content_type": "text",
"coordinates": {
"x": 0.672258592471358,
"y": 0.18654283173599448
},
"dimensions": {
"height": 0.05311728090109673,
"width": 0.2618657937806874
},
"document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
"dropdown_choices": [
"Yes",
"No",
"Maybe"
],
"group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
"is_required": true,
"label": "Legal name",
"page_index": 4,
"read_only": true,
"type": "text",
"validation": {
"validation_type": "email"
}
}
],
"is_in_person": true,
"is_password_required": true,
"is_phone_number_required": true,
"label": "Jane Doe",
"login_required": true,
"order": 2,
"public_id": "RJZYYVPR",
"role": "signer",
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7"
}
],
"source_files": [
{
"etag": "1",
"id": "12345",
"type": "file",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"name": "Contract.pdf",
"sequence_id": "3",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
}
]
}