Box Signリクエスト

Box Signリクエストオブジェクト。

is_document_preparation_needed

boolean

UIを使用してドキュメントの準備を完了するために送信者がレスポンスでprepare_urlを受け取る必要があるかどうかを示します。

例:

true

redirect_url

string | null

指定した場合、ドキュメントに署名された時点で、署名リクエストがこのURLにリダイレクトされます。

例:

"https://www.example.com"

declined_redirect_url

string | null

署名者がドキュメントへの署名を拒否した後にリダイレクトされるURI。

例:

"https://declined-redirect.com"

are_text_signatures_enabled

boolean

デフォルト:true

(テキストの) 入力で生成された署名の使用を無効にします。

例:

true

email_subject

string | null

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

例:

"Sign Request from Acme"

email_message

string | null

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

例:

"Hello! Please sign the document below"

are_reminders_enabled

boolean

3、8、13、18日目にドキュメントに署名するよう署名者に促します。リマインダは未署名の署名者にのみ送信されます。

例:

true

name

string

署名リクエストの名前。

例:

"name"

prefill_tags

署名リクエスト事前入力タグ · object[]

署名に関連するタグがドキュメントのコンテンツに含まれている場合、このprefill_tagsを使用してタグを事前入力できます。その際、タグの「id」を事前入力タグのexternal_idフィールドとして参照します。

表示子属性

days_valid

integer | null

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

必須範囲: 0 <= x <= 730

例:

2

external_id

string | null

これは、署名リクエストが関連する外部システムのIDを参照する際に使用できます。

例:

"123"

template_id

string | null

署名リクエストがテンプレートから作成された場合、このフィールドはそのテンプレートのIDを示します。

例:

"123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb"

external_system_name

string | null

署名ログで、embed_url_external_idが割り当てられている署名者の横に表示するシステム名 (省略可) として使用されます。

例:

"Box"

type

enum<string>

値は常にsign-requestになります。

利用可能なオプション:

sign-request

例:

"sign-request"

source_files

(ファイル (Base) · object | null)[]

署名するドキュメントの作成元ファイルのリスト。現在は、10ファイルに制限されています。ファイルごとにIDフィールドとtypeフィールドのみが必要です。

最も基本的なファイルのBase版の表示。fieldsクエリパラメータを使用すると、最小限の数のフィールドが返されます。

表示子属性

signers

Box Signリクエストのレスポンスの署名者フィールド · object[]

署名リクエストの署名者の配列。

表示子属性

signature_color

string | null

署名に特定の色 (青、黒、または赤) を強制します。

例:

"blue"

string

Box SignリクエストID。

例:

"12345"

prepare_url

string | null

このURLは、リクエストでis_document_preparation_neededがtrueに設定されている場合に返されます。このパラメータは、UIを使用して署名リクエストを準備する際に使用されます。署名リクエストは、準備段階が完了するまで送信されません。

例:

"https://prepareurl.com"

signing_log

ファイル (Mini) · object

リクエストに対する署名者のアクティビティがすべて記録されているファイルへの参照。

表示子属性

status

enum<string>

署名リクエストのステータスを説明します。

利用可能なオプション:

converting,

created,

sent,

viewed,

signed,

cancelled,

declined,

error_converting,

error_sending,

expired,

finalizing,

error_finalizing

例:

"converting"

sign_files

object

署名されるファイル (元のソースファイルのコピー) のリスト。署名者が署名すると、これらのファイルの新しいバージョンが作成され、署名プロセスのどの時点でもダウンロードできます。

表示子属性

auto_expire_at

string<date-time> | null

days_validを使用すると、未署名の場合に署名リクエストの有効期限となる日時 (GMT) が計算されます。

例:

"2021-04-26T08:12:13.982Z"

parent_folder

フォルダ (Mini) · object

最終的な署名済みドキュメントと署名ログの保存先フォルダ。

署名リクエストの作成時にこの値が渡されなかった場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ (そのフォルダへのアップロード権限がある場合) または「My Sign Requests」という名前のフォルダになります。

表示子属性

collaborator_level

string | null

署名リクエストに対するユーザーのコラボレータレベル。値には「owner」、「editor」、「viewer」を指定できます。

例:

"owner"

short_id

string

署名リクエストの短い識別子。

例:

"SR-12345"

created_at

string<date-time>

署名リクエストが作成された日時をマークするタイムスタンプ。

例:

"2025-02-01T12:00:00Z"

finished_at

string<date-time> | null

すべての署名操作が完了した日時を示すタイムスタンプ。

例:

"2025-02-02T12:00:00Z"

sender_email

string | null

署名リクエストの送信者のメールアドレス。

例:

"[email protected]"

sender_id

integer | null

署名リクエストの送信者のユーザーID。

例:

12345