日本時間5月16日のContent Cloud Summitで、カスタムアプリにBox AI APIを活用する方法を紹介します。

詳細を表示

Box Signテンプレート

Box Signテンプレートオブジェクト

string
4206996024-14944f75-c34b-478a-95a1-264b1ff80d35

テンプレートの識別子。

string
sign-template

オブジェクトタイプ

次の値に固定: sign-template

必須フィールドと編集不可フィールドに関する追加情報。

["email_subject","name"]

編集不可フィールド。

必須フィールド。

array array
[["email"],["email"]]

必須の署名者フィールド。

string array
["email"]
true

テンプレートのメール設定が編集可能かどうかを示します。

false

テンプレートの入力フィールドが編集可能かどうかを示します。

true

テンプレートファイルが編集可能かどうかを示します。これには、テンプレートファイルの削除または名前変更が含まれます。

true

テンプレートドキュメントのオプション (ドキュメントの名前変更など) が編集可能かどうかを示します。

false

テンプレートの署名者が編集可能かどうかを示します。

通知および署名リクエストに適用されているカスタムブランド設定。

9E5E6F

カスタムブランド設定の色 (16進数)。

Corporation inc.

会社の名前

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA AAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A 8AAQUBAScY42YAAAAASUVORK5CYII=

カスタムブランド設定のロゴURI (base64画像形式)。

integer
20730

作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。

Hello! Please sign the document below

署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。 このメッセージには、HTMLタグaabbracronymbblockquotecodeemiulliolstrongを含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。

Sign Request from Acme

署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。

string
Official contract

テンプレートの名前。

最終的な署名済みドキュメントと署名ログの保存先フォルダ。IDフィールドとtypeフィールドのみが必要です。ルートフォルダ (フォルダID 0) は使用できません。

object array

テンプレートの署名者の配列。

example@mail.com

署名者のメールアドレス

object array
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)。

string / date
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

テキストの事前入力値

true

署名者の埋め込みURLと組み合わせて使用されます。送信者が署名すると、その次のin_person署名者にリダイレクトされます。

20

署名者の順序

signer"signer"

署名リクエストに含まれる署名者の役割を定義します。役割がsignerの場合はドキュメントの署名する必要があり、approverの場合はドキュメントを承認します。また、最終的な署名済みドキュメントと署名ログを受け取るのは、final_copy_reader役割のみです。

次の値のいずれか1つ: signer,approver,final_copy_reader

cd4ff89-8fc1-42cf-8b29-1890dedd26d7

指定した場合、この値は、同じ入力が割り当てられ、同じ署名者グループに属している署名者を指します。署名者グループはBoxグループではありません。これは、テンプレート自体に属しているエンティティであり、そのテンプレートから作成された署名リクエスト内でのみ使用できます。

署名するドキュメントの作成元ファイルのリスト。ファイルごとに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": [
    {
      "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
        }
      ],
      "email": "example@mail.com",
      "role": "signer",
      "is_in_person": true,
      "order": 2,
      "signer_group_id": "cd4ff89-8fc1-42cf-8b29-1890dedd26d7"
    }
  ],
  "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"
      }
    }
  ]
}