Box Signテンプレート
Box Signテンプレートオブジェクト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
type | enum<string> | いいえ | 値は常にsign-templateになります。 使用可能なオプション: sign-template. |
id | string | いいえ | テンプレートの識別子。 |
name | string | いいえ | テンプレートの名前。 null を指定できます。 |
email_subject | string | いいえ | 署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。 null を指定できます。 |
email_message | string | いいえ | 署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグa、abbr、acronym、b、blockquote、code、em、i、ul、li、ol、strongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。 null を指定できます。 |
days_valid | integer | いいえ | 作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。 null を指定できます。 |
parent_folder | フォルダ (Mini) | いいえ | 最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必要です。ルートフォルダ (フォルダID 0) は使用できません。 |
source_files | array of ファイル (Mini) | いいえ | 署名するドキュメントの作成元ファイルのリスト。ファイルごとにIDフィールドとtypeフィールドのみが必要です。 |
are_fields_locked | boolean | いいえ | テンプレートの入力フィールドが編集可能かどうかを示します。 |
are_options_locked | boolean | いいえ | テンプレートドキュメントのオプション (ドキュメントの名前変更など) が編集可能かどうかを示します。 |
are_recipients_locked | boolean | いいえ | テンプレートの署名者が編集可能かどうかを示します。 |
are_email_settings_locked | boolean | いいえ | テンプレートのメール設定が編集可能かどうかを示します。 |
are_files_locked | boolean | いいえ | テンプレートファイルが編集可能かどうかを示します。これには、テンプレートファイルの削除または名前変更が含まれます。 |
signers | array of テンプレートの署名者フィールド | いいえ | テンプレートの署名者の配列。 注: テンプレートで指定された一部の署名者が競合するセグメント (ユーザーグループ) に属している可能性もあります。これは、セキュリティポリシーにより、倫理的な競合につながる可能性のあるやり取りやコミュニケーションを防ぐためにユーザーがセグメントに割り当てられていることを意味します。このような場合、競合するセグメントに存在する署名者を含むテンプレートに基づいて署名リクエストを送信しようとすると、エラーが発生します。 セグメントと情報バリアの詳細については、こちらを参照してください。 |
additional_info | object | いいえ | 必須フィールドと編集不可フィールドに関する追加情報。 |
ready_sign_link | object | いいえ | Boxの署名リンク機能により、テンプレートから作成した署名リクエストへのリンクを作成できます。このリンクは、署名者が誰になるか不明な状態で公開フォーム (メール、ソーシャルメディアの投稿、ウェブページなど) に署名リクエストを投稿する場合に使用します。注: 署名リンク機能は、Enterprise Plusをご利用のお客様に限定されており、Box Verified Enterpriseでは利用できません。 null を指定できます。 |
custom_branding | object | いいえ | 通知および署名リクエストに適用されているカスタムブランド設定。 null を指定できます。 |
request_flow | string | いいえ | テンプレートから作成された署名リクエストの署名フロー。値にはstandardまたはcfr11を指定できます。 null を指定できます。 |
例
{
"type": "sign-template",
"id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
"name": "Official contract",
"email_subject": "Sign Request from Acme",
"email_message": "Hello! Please sign the document below",
"days_valid": 2,
"parent_folder": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"source_files": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
],
"are_fields_locked": false,
"are_options_locked": true,
"are_recipients_locked": false,
"are_email_settings_locked": true,
"are_files_locked": true,
"signers": [
{
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "text",
"is_required": true,
"page_index": 4,
"document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
"dropdown_choices": [
"Yes",
"No",
"Maybe"
],
"group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
"coordinates": {
"x": 0.672258592471358,
"y": 0.18654283173599448
},
"dimensions": {
"width": 0.2618657937806874,
"height": 0.05311728090109673
},
"label": "Legal name",
"read_only": true,
"validation": {
"validation_type": "email"
}
}
],
"email": "example@mail.com",
"role": "signer",
"is_in_person": true,
"order": 2,
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"label": "Jane Doe",
"public_id": "RJZYYVPR",
"is_password_required": true,
"is_phone_number_required": true,
"login_required": true
}
],
"additional_info": {
"non_editable": [
"email_subject",
"name"
],
"required": {
"signers": [
[
"email"
],
[
"email"
]
]
}
},
"ready_sign_link": {
"url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
"name": "Official contract",
"instructions": "Hello! Please sign the document below",
"folder_id": "12345",
"is_notification_disabled": true,
"is_active": false
},
"custom_branding": {
"company_name": "Corporation inc.",
"logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
"branding_color": "9E5E6F",
"email_footer_text": "Contact email email@mail.com"
},
"request_flow": "standard"
}
Box Signテンプレート
任意のBox Sign APIエンドポイントからデフォルトで返されるテンプレートのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of Box Signテンプレート | いいえ | テンプレートのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"type": "sign-template",
"id": "4206996024-14944f75-c34b-478a-95a1-264b1ff80d35",
"name": "Official contract",
"email_subject": "Sign Request from Acme",
"email_message": "Hello! Please sign the document below",
"days_valid": 2,
"parent_folder": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"source_files": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
],
"are_fields_locked": false,
"are_options_locked": true,
"are_recipients_locked": false,
"are_email_settings_locked": true,
"are_files_locked": true,
"signers": [
{
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26",
"type": "text",
"content_type": "text",
"is_required": true,
"page_index": 4,
"document_id": "123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7",
"dropdown_choices": [
"Yes",
"No",
"Maybe"
],
"group_id": "da317330-225a-4c72-89ad-0d6dcaaf4df6",
"coordinates": {
"x": 0.672258592471358,
"y": 0.18654283173599448
},
"dimensions": {
"width": 0.2618657937806874,
"height": 0.05311728090109673
},
"label": "Legal name",
"read_only": true,
"validation": {
"validation_type": "email"
}
}
],
"email": "example@mail.com",
"role": "signer",
"is_in_person": true,
"order": 2,
"signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"label": "Jane Doe",
"public_id": "RJZYYVPR",
"is_password_required": true,
"is_phone_number_required": true,
"login_required": true
}
],
"additional_info": {
"non_editable": [
"email_subject",
"name"
],
"required": {
"signers": [
[
"email"
],
[
"email"
]
]
}
},
"ready_sign_link": {
"url": "\"https://app.box.com/sign/\nready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178\"",
"name": "Official contract",
"instructions": "Hello! Please sign the document below",
"folder_id": "12345",
"is_notification_disabled": true,
"is_active": false
},
"custom_branding": {
"company_name": "Corporation inc.",
"logo_uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=",
"branding_color": "9E5E6F",
"email_footer_text": "Contact email email@mail.com"
},
"request_flow": "standard"
}
]
}