> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Box Signリクエストを作成
> 署名リクエストを作成します。これには、署名用ドキュメントの準備と署名者への署名リクエストの送信が含まれます。
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 [**Box APIのバージョン管理**](/ja/guides/api-calls/api-versioning-strategy/)を参照してください。
「[Box SDKのバージョニング戦略](/ja/guides/tooling/sdks/sdk-versioning/)について詳しく学ぶ。」
## OpenAPI
````yaml box-openapi-jp.json POST /sign_requests
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box
Platform](https://developer.box.com)では、[Box](https://box.com)内に保存されているコンテンツへのアクセス権限を付与する機能が提供されています。また、ファイルとフォルダの基本操作、会社内のユーザーの管理、リーガルホールドやリテンションポリシーなどの複雑なトピックのためのエンドポイントも提供されています。
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 92c221bf9d
servers:
- url: https://api.box.com/2.0
description: Box Platform APIサーバー。
security:
- OAuth2Security: []
tags:
- name: AI
description: サポート対象のLLMの操作に使用される、一連のエンドポイント。
x-box-tag: ai
- name: AI Studio
description: AI Studioの操作に使用される、一連のエンドポイント。
x-box-tag: ai_studio
- name: アプリ項目の関連付け
x-box-tag: app_item_associations
- name: 承認
description: ユーザー承認プロセスを管理するために使用される、一連のエンドポイント。
x-box-tag: authorization
x-box-priority: true
- name: Box Signリクエスト
description: Box Signリクエストは、署名用ファイルを送信するために使用されます。
x-box-tag: sign_requests
- name: Classifications
description: 分類ラベルは、機密性の高いコンテンツやセキュリティ上の制限が適用されるコンテンツに使用されます。
x-box-tag: classifications
- name: ファイルの分類
description: 分類ラベルは、機密性の高いファイルやセキュリティ上の制限が適用されるファイルに使用されます。
x-box-tag: file_classifications
- name: フォルダの分類
description: 分類ラベルは、機密性の高いフォルダやセキュリティ上の制限が適用されるフォルダに使用されます。
x-box-tag: folder_classifications
- name: Collaborations
description: コラボレーションは、アクセス制限リストと同様に、ユーザーやグループがファイルやフォルダにアクセスする際の権限を定義します。
x-box-tag: user_collaborations
- name: コラボレーション (リスト)
description: ファイル、フォルダ、保留、グループコラボレーションを取得するために使用される、一連のエンドポイント。
x-box-tag: list_collaborations
- name: Collections
description: コレクションを利用して、ファイル、フォルダ、ウェブリンクを1つのフォルダにまとめることなくグループ化できます。
x-box-tag: collections
- name: Comments
description: >-
コメントは、ユーザーがファイルに対して生成するメッセージです。コメントを使用すると、複数のユーザーがファイル上でコラボレーションし、コンテンツに対するフィードバックについて話し合うことができます。
x-box-tag: comments
- name: Device Pinners
description: Device Pinnerを使用すると、どのデバイスでネイティブBoxアプリケーションの使用を許可するかを企業レベルで制御できます。
x-box-tag: device_pinners
- name: ドメインの制限 (ユーザーの除外)
description: 特定の企業に許可されたコラボレーションドメインのリストによって課せられた制限からユーザーを除外できる、一連のエンドポイント。
x-box-tag: collaboration_allowlist_exempt_targets
- name: コラボレーションに対するドメインを制限
description: ユーザーが企業のファイルやフォルダでコラボレーションできるドメインを管理する、一連のエンドポイント。
x-box-tag: collaboration_allowlist_entries
- name: ダウンロード
description: ダウンロードを利用して、ファイルをアプリケーションのサーバーに保存することも、エンドユーザーがブラウザで直接保存することもできます。
x-box-tag: downloads
- name: メールエイリアス
description: メールエイリアスを使用することで、ユーザーのログイン用プライマリメールアドレスに加えて複数のメールアドレスを指定できます。
x-box-tag: email_aliases
- name: Events
description: イベントを利用して、企業内の任意のユーザー (複数可) またはサービスによって実行される操作をアプリケーションが登録できます。
x-box-tag: events
- name: ファイルリクエスト
description: >-
ファイルリクエストを利用すると、任意のユーザーに対してファイルとそれに関連付けられたメタデータを迅速かつ安全にリクエストできます。ユーザーは、既存のファイルリクエストを基にして新しいファイルリクエストを作成できるほか、ファイルリクエストの設定を更新したり、プログラムによってファイルリクエストの有効化、無効化、削除を実行したりできます。
x-box-tag: file_requests
- name: ファイルバージョンリーガルホールド
description: >-
リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。ファイルバージョンリーガルホールドは、特定のファイルバージョンに割り当てられているすべてのポリシーを表します。
x-box-tag: file_version_legal_holds
- name: ファイルバージョンリテンション
description: >-
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。
x-box-tag: file_version_retentions
- name: ファイルバージョン
description: ファイルの特定のバージョンを管理するために使用される、一連のエンドポイント。
x-box-tag: file_versions
- name: Files
description: >-
ファイルは、フォルダとともに、Box
APIの中核を成します。ファイルはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
x-box-tag: files
- name: フォルダロック
description: フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。
x-box-tag: folder_locks
- name: Folders
description: >-
フォルダは、ファイルとともに、Box
APIの中核を成します。フォルダはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。
x-box-tag: folders
- name: 統合マッピング
description: 統合マッピングを使用すると、ユーザーはパートナーアプリからのコンテンツがBoxのどこに保存されるかを管理できます。
x-box-tag: integration_mappings
- name: グループメンバーシップ
description: グループメンバーシップは、ユーザーがグループに属していることを示します。
x-box-tag: memberships
- name: Groups
description: 企業内に作成されたグループ。
x-box-tag: groups
- name: Invites
description: 招待は、ユーザーを企業に招待するために使用されます。
x-box-tag: invites
- name: リーガルホールドポリシー
description: >-
リーガルホールドとは、係争中の訴訟や当然予期される訴訟で、関連する可能性のあるさまざまな形式の情報を企業が保全するために利用できるプロセスのことです。
x-box-tag: legal_hold_policies
- name: リーガルホールドポリシー割り当て
description: >-
リーガルホールドポリシー割り当ては、ポリシーとカストディアンの関係です。この場合、カストディアンにはユーザー、フォルダ、ファイル、またはファイルバージョンを指定できます。
x-box-tag: legal_hold_policy_assignments
- name: メタデータカスケードポリシー
description: メタデータカスケードポリシーには、フォルダに適用されているメタデータインスタンスを、そのフォルダ内の項目にどのように適用するかが記載されています。
x-box-tag: metadata_cascade_policies
- name: メタデータインスタンス (ファイル)
description: メタデータインスタンスには、テンプレートとファイル間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
x-box-tag: file_metadata
- name: メタデータインスタンス (フォルダ)
description: メタデータインスタンスには、テンプレートとフォルダ間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。
x-box-tag: folder_metadata
- name: メタデータ階層
description: メタデータ階層とは、企業内のメタデータを整理して管理するために役立つ、階層型分類システムです。
x-box-tag: metadata_taxonomies
- name: メタデータテンプレート
description: メタデータテンプレートには、ファイルに割り当てることができる、一連の再利用可能なキー/値ペアが記載されています。
x-box-tag: metadata_templates
- name: 最近使用した項目
description: 最近使用した項目は、ユーザーが最近アクセスしたファイルやフォルダなどの項目を表します。
x-box-tag: recent_items
- name: リテンションポリシー
description: >-
リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダや企業全体に割り当てることができます。
x-box-tag: retention_policies
- name: リテンションポリシー割り当て
description: >-
リテンションポリシー割り当ては、ポリシーとフォルダや企業の関係です。割り当てを作成すると、そのフォルダや企業に属するすべてのファイルバージョンにリテンションが適用されます。
x-box-tag: retention_policy_assignments
- name: 検索
description: Box APIを使用すると、ファイルコンテンツ検索クエリを使用してBox内のコンテンツを探すことができます。
x-box-tag: search
- name: セッション終了
description: セッション終了APIを使用すると、グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成できます。
x-box-tag: session_termination
- name: 共有リンク (ファイル)
description: >-
ファイル共有リンクは、Boxに保存されているファイルを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_files
- name: 共有リンク (フォルダ)
description: >-
フォルダ共有リンクは、Boxに保存されているフォルダを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_folders
- name: 共有リンク (ウェブリンク)
description: >-
ファイル用ウェブリンクは、Box内のウェブリンクを対象として生成されるURLです。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_web_links
- name: 共有リンク (アプリ項目)
description: Boxに保存されているアプリ項目に対して生成されるURL。これにより、リソースへの直接的な読み取り専用アクセスが可能になります。
x-box-tag: shared_links_app_items
- name: Shield情報バリア
description: >-
BoxのShield情報バリアは、倫理的境界を定義します。倫理的境界とは、利益相反につながり、結果として倫理的または法的に問題のあるビジネス活動につながる可能性があるやり取りまたは通信を防ぐメカニズムです。
x-box-tag: shield_information_barriers
- name: Shield情報バリアのセグメント
description: >-
Shield情報バリアのセグメントは、ユーザーの定義済みグループを表します。セグメントがグループと異なる点は、ユーザーが所属できるセグメントが1つのみであることです。
x-box-tag: shield_information_barrier_segments
- name: Shield情報バリアのセグメントメンバー
description: Shield情報バリアのセグメントメンバーは、特定のセグメントに割り当てられたユーザーを表します。
x-box-tag: shield_information_barrier_segment_members
- name: Shield情報バリアレポート
description: Shield情報バリアレポートには、情報バリアが有効化されるときに完全に削除される既存のコラボレーションに関する情報が含まれます。
x-box-tag: shield_information_barrier_reports
- name: Shield情報バリアのセグメント制限
description: Shield情報バリアのセグメント制限とは、コンテンツ (ファイルまたはフォルダ) の所有者に基づいて適用されるアクセス制限です。
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Signテンプレート
description: >-
署名テンプレートを使用すると、署名リクエストの作成時に、あらかじめ定義されたBox
Signテンプレートを使用できます。このテンプレートに含まれるプレースホルダには、リクエストの作成時にデータが自動的に入力されます。
x-box-tag: sign_templates
- name: Skills
description: >-
Box
Skillsは、ファイルの基盤となるメタデータを強化することを目的として、Boxにアップロードされたファイルにカスタム処理を実行するための機能です。
x-box-tag: skills
- name: 標準およびZonesのストレージポリシー
description: ストレージポリシー割り当ては、特定の企業内の項目に対するストレージゾーンを表します。
x-box-tag: storage_policies
- name: 標準およびZonesのストレージポリシー割り当て
description: ストレージポリシー割り当ては、ストレージゾーンと割り当てられた項目 (特定のゾーンに保存されているファイルなど) の間の関係を表します。
x-box-tag: storage_policy_assignments
- name: タスク割り当て
description: タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。
x-box-tag: task_assignments
- name: Tasks
description: >-
ユーザーはタスクを使用することで、ファイルのコラボレータに対して、ファイルのレビューや作業の一部の完了をリクエストできます。タスクは、開発者がファイル中心のワークフローを作成するために使用できます。
x-box-tag: tasks
- name: サービス利用規約
description: サービス利用規約を管理するために使用される、一連のエンドポイント。
x-box-tag: terms_of_services
- name: サービス利用規約のユーザーステータス
description: 特定ユーザーのサービス利用規約のステータスを管理するために使用される、一連のエンドポイント。
x-box-tag: terms_of_service_user_statuses
- name: フォルダの移動
description: ユーザーが所有するすべての項目 (ファイル、フォルダ、およびワークフロー) を別のユーザーのアカウントに移動するためのAPI。
x-box-tag: transfer
- name: ごみ箱内のファイル
description: 削除されて現在ごみ箱にあるファイル。
x-box-tag: trashed_files
- name: ごみ箱内のフォルダ
description: 削除されて現在ごみ箱にあるフォルダ。
x-box-tag: trashed_folders
- name: ごみ箱内の項目
description: 削除されて現在ごみ箱にある項目。
x-box-tag: trashed_items
- name: ごみ箱内のウェブリンク
description: 削除されて現在ごみ箱にあるウェブリンク。
x-box-tag: trashed_web_links
- name: アップロード
description: >-
直接ファイルアップロードAPIは最大50 MBのファイルをサポートしており、1回のAPIリクエストですべてのバイナリデータをBox
APIに送信します。
x-box-tag: uploads
- name: アップロード (分割)
description: >-
分割アップロードエンドポイントは20
MB以上のファイルをサポートしており、アプリケーションでファイルを複数のパーツに分割してアップロードすることで、エラーのキャッチと個別のパーツの再送信を詳細に制御できます。
x-box-tag: chunked_uploads
- name: ユーザーのアバター
description: >-
ユーザーのアバターとは、ユーザー画像を表すためにBoxにアップロードされたJPGファイルまたはPNGファイルです。これはユーザーアカウントで表示されます。
x-box-tag: avatars
- name: Users
description: >-
Box APIは、管理対象ユーザーアカウントでログインする実際の従業員や、App
Userを使用して強力な自動化ワークフローを推進するアプリケーションなど、さまざまなユーザーをサポートしています。
x-box-tag: users
- name: 電子すかし (ファイル)
description: >-
電子すかしとは、埋め込みファイルのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、ファイルのアクセス日時が表示されます。
x-box-tag: file_watermarks
- name: 電子すかし (フォルダ)
description: >-
電子すかしとは、埋め込みフォルダのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、フォルダコンテンツのアクセス日時が表示されます。
x-box-tag: folder_watermarks
- name: ウェブリンク
description: ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
x-box-tag: web_links
- name: Webhooks
description: >-
Webhookを使用すると、Boxコンテンツのイベントを監視し、イベントの発生時に任意のURLへの通知を受け取ることができます。たとえば、ファイルがダウンロードされるのを待ち、ダウンロード後に共有リンクを削除するワークフローを作成できます。
x-box-tag: webhooks
- name: ワークフロー (リスト)
description: Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
x-box-tag: workflows
- name: zipダウンロード
description: zipダウンロードは、ファイルやフォルダを含むZIPアーカイブを作成するリクエストが成功したことを表します。
x-box-tag: zip_downloads
externalDocs:
description: Box Developerドキュメント。
url: https://developer.box.com
paths:
/sign_requests:
post:
tags:
- Box Signリクエスト
summary: Box Signリクエストを作成
description: 署名リクエストを作成します。これには、署名用ドキュメントの準備と署名者への署名リクエストの送信が含まれます。
operationId: post_sign_requests
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignRequestCreateRequest'
responses:
'201':
description: Box Signリクエストオブジェクトを返します。
content:
application/json:
schema:
$ref: '#/components/schemas/SignRequest'
default:
description: 予期しないクライアントエラー。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Box Signリクエストを作成
source: |-
curl -i -X POST "https://api.box.com/2.0/sign_requests" \
-H "authorization: Bearer " \
-d '{
"signers": [
{
"role": "signer",
"email": "example_email@box.com"
}
],
"source_files": [
{
"type": "file",
"id": "123456789"
}
],
"parent_folder":
{
"type": "folder",
"id": "0987654321"
}
}'
- lang: dotnet
label: Box Signリクエストを作成
source: >-
await client.SignRequests.CreateSignRequestAsync(requestBody: new
SignRequestCreateRequest(signers: Array.AsReadOnly(new [] {new
SignRequestCreateSigner() { Email = signerEmail,
SuppressNotifications = true, DeclinedRedirectUrl =
"https://www.box.com", EmbedUrlExternalUserId = "123", IsInPerson =
false, LoginRequired = false, Password = "password", Role =
SignRequestCreateSignerRoleField.Signer }}), areRemindersEnabled:
true, areTextSignaturesEnabled: true, daysValid: 30L,
declinedRedirectUrl: "https://www.box.com", emailMessage: "Please
sign this document", emailSubject: "Sign this document", externalId:
"123", externalSystemName: "BoxSignIntegration",
isDocumentPreparationNeeded: false, name: "Sign Request",
parentFolder: new FolderMini(id: destinationFolder.Id), redirectUrl:
"https://www.box.com", prefillTags: Array.AsReadOnly(new [] {new
SignRequestPrefillTag() { DateValue = Utils.DateFromString(date:
"2035-01-01"), DocumentTagId = "0" }}), sourceFiles:
Array.AsReadOnly(new [] {new FileBase(id: fileToSign.Id)})));
- lang: swift
label: Box Signリクエストを作成
source: >-
try await client.signRequests.createSignRequest(requestBody:
SignRequestCreateRequest(signers: [SignRequestCreateSigner(email:
signerEmail, suppressNotifications: true, declinedRedirectUrl:
"https://www.box.com", embedUrlExternalUserId: "123", isInPerson:
false, loginRequired: false, password: "password", role:
SignRequestCreateSignerRoleField.signer)], areRemindersEnabled:
true, areTextSignaturesEnabled: true, daysValid: Int64(30),
declinedRedirectUrl: "https://www.box.com", emailMessage: "Please
sign this document", emailSubject: "Sign this document", externalId:
"123", externalSystemName: "BoxSignIntegration",
isDocumentPreparationNeeded: false, name: "Sign Request",
parentFolder: FolderMini(id: destinationFolder.id), redirectUrl:
"https://www.box.com", prefillTags:
[SignRequestPrefillTag(dateValue: try
Utils.Dates.dateFromString(date: "2035-01-01"), documentTagId:
"0")], sourceFiles: [FileBase(id: fileToSign.id)]))
- lang: java
label: Box Signリクエストを作成
source: >-
client.getSignRequests().createSignRequest(new
SignRequestCreateRequest.Builder(Arrays.asList(new
SignRequestCreateSigner.Builder().email(signerEmail).role(SignRequestCreateSignerRoleField.SIGNER).isInPerson(false).embedUrlExternalUserId("123").declinedRedirectUrl("https://www.box.com").loginRequired(false).password("password").suppressNotifications(true).build())).sourceFiles(Arrays.asList(new
FileBase(fileToSign.getId()))).parentFolder(new
FolderMini(destinationFolder.getId())).isDocumentPreparationNeeded(false).redirectUrl("https://www.box.com").declinedRedirectUrl("https://www.box.com").areTextSignaturesEnabled(true).emailSubject("Sign
this document").emailMessage("Please sign this
document").areRemindersEnabled(true).name("Sign
Request").prefillTags(Arrays.asList(new
SignRequestPrefillTag.Builder().documentTagId("0").dateValue(dateFromString("2035-01-01")).build())).daysValid(30L).externalId("123").externalSystemName("BoxSignIntegration").build())
- lang: node
label: Box Signリクエストを作成
source: |-
await client.signRequests.createSignRequest({
signers: [
{
email: signerEmail,
suppressNotifications: true,
declinedRedirectUrl: 'https://www.box.com',
embedUrlExternalUserId: '123',
isInPerson: false,
loginRequired: false,
password: 'password',
role: 'signer' as SignRequestCreateSignerRoleField,
} satisfies SignRequestCreateSigner,
],
areRemindersEnabled: true,
areTextSignaturesEnabled: true,
daysValid: 30,
declinedRedirectUrl: 'https://www.box.com',
emailMessage: 'Please sign this document',
emailSubject: 'Sign this document',
externalId: '123',
externalSystemName: 'BoxSignIntegration',
isDocumentPreparationNeeded: false,
name: 'Sign Request',
parentFolder: new FolderMini({ id: destinationFolder.id }),
redirectUrl: 'https://www.box.com',
prefillTags: [
{
dateValue: dateFromString('2035-01-01'),
documentTagId: '0',
} satisfies SignRequestPrefillTag,
],
sourceFiles: [new FileBase({ id: fileToSign.id })],
} satisfies SignRequestCreateRequest);
- lang: python
label: Box Signリクエストを作成
source: |-
client.sign_requests.create_sign_request(
[
SignRequestCreateSigner(
email=signer_email,
suppress_notifications=True,
declined_redirect_url="https://www.box.com",
embed_url_external_user_id="123",
is_in_person=False,
login_required=False,
password="password",
role=SignRequestCreateSignerRoleField.SIGNER,
)
],
source_files=[FileBase(id=file_to_sign.id)],
parent_folder=FolderMini(id=destination_folder.id),
is_document_preparation_needed=False,
redirect_url="https://www.box.com",
declined_redirect_url="https://www.box.com",
are_text_signatures_enabled=True,
email_subject="Sign this document",
email_message="Please sign this document",
are_reminders_enabled=True,
name="Sign Request",
prefill_tags=[
SignRequestPrefillTag(
date_value=date_from_string("2035-01-01"), document_tag_id="0"
)
],
days_valid=30,
external_id="123",
external_system_name="BoxSignIntegration",
)
components:
schemas:
SignRequestCreateRequest:
description: Box Signリクエストオブジェクトを作成します。
type: object
allOf:
- $ref: '#/components/schemas/SignRequest--Base'
- properties:
source_files:
description: >-
署名するドキュメントの作成元ファイルのリスト。現在は、10ファイルに制限されています。ファイルごとにIDフィールドとtypeフィールドのみが必要です。
type: array
items:
$ref: '#/components/schemas/File--Base'
maxItems: 10
nullable: true
signature_color:
description: 署名に特定の色 (青、黒、または赤) を強制します。
type: string
example: blue
enum:
- blue
- black
- red
nullable: true
signers:
description: >-
署名リクエストの署名者の配列。許可されている署名者の最大数は35です。
**注**:
一部の署名者が競合する[セグメント](/reference/resources/shield-information-barrier-segment-member)
(ユーザーグループ)
に属している可能性もあります。これは、セキュリティポリシーにより、倫理的な競合につながる可能性のあるやり取りやコミュニケーションを防ぐためにユーザーがセグメントに割り当てられていることを意味します。このような場合、署名リクエストを送信しようとすると、エラーが発生します。
セグメントと情報バリアの詳細については、[こちら](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ)を参照してください。
type: array
items:
$ref: '#/components/schemas/SignRequestCreateSigner'
parent_folder:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: >-
最終的な署名済みドキュメントと署名ログの保存先フォルダ。`ID`フィールドと`type`フィールドのみが必須です。ルートフォルダ
(フォルダID `0`) は使用できず、nullにすることもできません。
署名リクエストの作成時にこの値が渡されない場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ
(そのフォルダへのアップロード権限がある場合) または「My Sign
Requests」という名前のフォルダになります。
required:
- signers
title: Box Signリクエストを作成する
x-box-resource-id: sign_request_create_request
SignRequest:
description: Box Signリクエストオブジェクト。
type: object
allOf:
- $ref: '#/components/schemas/SignRequest--Base'
- properties:
type:
description: 値は常に`sign-request`になります。
type: string
example: sign-request
enum:
- sign-request
source_files:
description: >-
署名するドキュメントの作成元ファイルのリスト。現在は、10ファイルに制限されています。ファイルごとにIDフィールドとtypeフィールドのみが必要です。
type: array
items:
$ref: '#/components/schemas/File--Base'
signers:
description: 署名リクエストの署名者の配列。
type: array
items:
$ref: '#/components/schemas/SignRequestSigner'
signature_color:
description: 署名に特定の色 (青、黒、または赤) を強制します。
type: string
example: blue
nullable: true
id:
description: Box SignリクエストID。
type: string
example: '12345'
prepare_url:
description: >-
このURLは、リクエストで`is_document_preparation_needed`が`true`に設定されている場合に返されます。このパラメータは、UIを使用して署名リクエストを準備する際に使用されます。署名リクエストは、準備段階が完了するまで送信されません。
type: string
example: https://prepareurl.com
nullable: true
signing_log:
allOf:
- $ref: '#/components/schemas/File--Mini'
- description: リクエストに対する署名者のアクティビティがすべて記録されているファイルへの参照。
status:
description: 署名リクエストのステータスを説明します。
type: string
example: converting
enum:
- converting
- created
- sent
- viewed
- signed
- cancelled
- declined
- error
- error_converting
- error_sending
- expired
- finalizing
- error_finalizing
sign_files:
description: >-
署名されるファイル (元のソースファイルのコピー)
のリスト。署名者が署名すると、これらのファイルの新しいバージョンが作成され、署名プロセスのどの時点でもダウンロードできます。
type: object
properties:
files:
type: array
items:
$ref: '#/components/schemas/File--Mini'
is_ready_for_download:
description: >-
`sign_files`のドキュメントが処理中で、PDFが古くなっている可能性があるかどうかを示します。任意のドキュメントを変更するには、すべての`sign_files`で処理が必要になります。処理が終了するまで
(およびこの値がtrueになるまで) 待ってからPDFをダウンロードすることをお勧めします。
type: boolean
example: true
auto_expire_at:
description: '`days_valid`を使用すると、未署名の場合に署名リクエストの有効期限となる日時 (GMT) が計算されます。'
type: string
format: date-time
example: '2021-04-26T08:12:13.982Z'
nullable: true
parent_folder:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: >-
最終的な署名済みドキュメントと署名ログの保存先フォルダ。
署名リクエストの作成時にこの値が渡されなかった場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ
(そのフォルダへのアップロード権限がある場合) または「My Sign
Requests」という名前のフォルダになります。
nullable: false
collaborator_level:
description: 署名リクエストに対するユーザーのコラボレータレベル。値には「owner」、「editor」、「viewer」を指定できます。
type: string
example: owner
nullable: true
short_id:
description: 署名リクエストの短い識別子。
type: string
example: SR-12345
nullable: false
created_at:
description: 署名リクエストが作成された日時をマークするタイムスタンプ。
type: string
format: date-time
example: '2025-02-01T12:00:00Z'
nullable: false
finished_at:
description: すべての署名操作が完了した日時を示すタイムスタンプ。
type: string
format: date-time
example: '2025-02-02T12:00:00Z'
nullable: true
error_code:
description: 署名リクエストがエラー状態の場合、具体的な理由を特定します。エラーコードが適用されない場合はnullです。
type: string
example: cfr11_validation_failed
nullable: true
readOnly: true
sender_email:
description: 署名リクエストの送信者のメールアドレス。
type: string
example: sender@box.com
nullable: true
sender_id:
description: 署名リクエストの送信者のユーザーID。
type: integer
example: 12345
nullable: true
title: Box Signリクエスト
x-box-resource-id: sign_request
x-box-tag: sign_requests
ClientError:
description: 一般的なエラー。
type: object
properties:
type:
description: 値は常に`error`になります。
type: string
example: error
enum:
- error
nullable: false
status:
description: レスポンスのHTTPステータス。
type: integer
format: int32
example: 400
nullable: false
code:
description: Box固有のエラーコード。
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: エラーについての短い説明メッセージ。
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
このエラーに関する追加コンテキストを含む自由形式のオブジェクト。使用できるフィールドは、エンドポイントごとに定義されています。`message`は唯一の例です。
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: このエラーの原因に関する詳細情報にリンクされたURL。
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。
type: string
example: abcdef123456
nullable: false
title: クライアントエラー
x-box-resource-id: client_error
SignRequest--Base:
description: 署名リクエストオブジェクトのStandard版の表示。
type: object
properties:
is_document_preparation_needed:
description: UIを使用してドキュメントの準備を完了するために送信者がレスポンスで`prepare_url`を受け取る必要があるかどうかを示します。
type: boolean
example: true
redirect_url:
description: 指定した場合、ドキュメントに署名された時点で、署名リクエストがこのURLにリダイレクトされます。
type: string
example: https://www.example.com
nullable: true
declined_redirect_url:
description: 署名者がドキュメントへの署名を拒否した後にリダイレクトされるURI。
type: string
example: https://declined-redirect.com
nullable: true
are_text_signatures_enabled:
description: (テキストの) 入力で生成された署名の使用を無効にします。
type: boolean
example: true
default: true
email_subject:
description: 署名リクエストメールの件名。これは、署名リクエストによって消去されます。このフィールドを渡さない場合は、デフォルトの件名が使用されます。
type: string
example: Sign Request from Acme
nullable: true
email_message:
description: >-
署名リクエストメールに含めるメッセージ。このフィールドは、特定の文字のサニタイズによって消去されます。ただし、一部のHTMLタグは使用できます。また、このメッセージに含まれているリンクはメールではハイパーリンクに変換されます。このメッセージには、HTMLタグ`a`、`abbr`、`acronym`、`b`、`blockquote`、`code`、`em`、`i`、`ul`、`li`、`ol`、`strong`を含めることができます。HTMLに対するテキストの比率が大きすぎると、メールがスパムフィルタに入る可能性があることに注意してください。これらのタグにカスタムスタイルを適用することはできません。このフィールドを渡さない場合は、デフォルトのメッセージが使用されます。
type: string
example: Hello! Please sign the document below
nullable: true
are_reminders_enabled:
description: 3、8、13、18日目にドキュメントに署名するよう署名者に促します。リマインダは未署名の署名者にのみ送信されます。
type: boolean
example: true
name:
description: 署名リクエストの名前。
type: string
example: name
prefill_tags:
description: >-
署名に関連するタグがドキュメントのコンテンツに含まれている場合、この`prefill_tags`を使用してタグを事前入力できます。その際、タグの「id」を事前入力タグの`external_id`フィールドとして参照します。
type: array
items:
$ref: '#/components/schemas/SignRequestPrefillTag'
days_valid:
description: >-
作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。
type: integer
example: 2
maximum: 730
minimum: 0
nullable: true
external_id:
description: これは、署名リクエストが関連する外部システムのIDを参照する際に使用できます。
type: string
example: '123'
nullable: true
template_id:
description: 署名リクエストがテンプレートから作成された場合、このフィールドはそのテンプレートのIDを示します。
type: string
example: 123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb
nullable: true
external_system_name:
description: >-
署名ログで、`embed_url_external_id`が割り当てられている署名者の横に表示するシステム名 (省略可)
として使用されます。
type: string
example: Box
nullable: true
request_flow:
description: >-
署名リクエストのフロータイプ。値には`standard`または`cfr11`を指定できます。作成時に指定されていない場合、管理者設定に基づいてデフォルトが選択されます。
type: string
example: standard
nullable: true
title: Box Signリクエスト (Base)
x-box-tag: sign_requests
File--Base:
description: 最も基本的なファイルのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。
type: object
properties:
id:
description: >-
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。
type: string
example: '12345'
nullable: false
etag:
description: >-
このファイルのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合)
にファイルに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。
type: string
example: '1'
nullable: true
type:
description: 値は常に`file`になります。
type: string
example: file
enum:
- file
nullable: false
nullable: true
required:
- id
- type
title: ファイル (Base)
x-box-resource-id: file--base
x-box-tag: files
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
SignRequestCreateSigner:
description: Box Signリクエストオブジェクトを作成するために使用される署名者オブジェクトのスキーマ。
type: object
properties:
email:
description: >-
署名者のメールアドレス。メールアドレスが含まれるように構成されているテンプレートを使用する場合を除き、署名リクエストを作成する際は署名者のメールアドレスが必須です。
type: string
example: example@gmail.com
nullable: true
role:
description: >-
署名リクエストに含まれる署名者のロールを定義します。`signer`はドキュメントに署名し、`approver`はドキュメントを承認する必要があります。最終的な署名済みドキュメントと署名ログを受け取るのは、`final_copy_reader`のみです。
type: string
example: signer
default: signer
enum:
- signer
- approver
- final_copy_reader
is_in_person:
description: 送信者の埋め込みURLと組み合わせて使用されます。送信者が署名すると、その次の`in_person`署名者にリダイレクトされます。
type: boolean
example: true
order:
description: 署名者の順序。
type: integer
example: 2
minimum: 0
embed_url_external_user_id:
description: 埋め込みURLへのアクセス時に認証を担当する、外部アプリケーションの署名者のユーザーID。
type: string
example: '1234'
nullable: true
redirect_url:
description: >-
署名者がドキュメントに署名した後にリダイレクトされるURL。このURLを定義すると、特定の署名者で、デフォルトまたはグローバルのリダイレクトURL設定より優先されます。拒否した場合のリダイレクトURLが指定されていない場合は、このURLが拒否の操作にも使用されます。
type: string
example: https://example.com
nullable: true
declined_redirect_url:
description: >-
署名者がドキュメントへの署名を拒否した後にリダイレクトされるURL。このURLを定義すると、特定の署名者で、デフォルトまたはグローバルのリダイレクトURL設定より優先されます。
type: string
example: https://declined-example.com
nullable: true
login_required:
description: >-
trueに設定した場合、署名者はリクエストに署名する前にBoxアカウントにログインする必要があります。署名者に既存のアカウントがない場合は、無料のBoxアカウントを作成できます。
type: boolean
example: true
nullable: true
verification_phone_number:
description: >-
設定した場合、2要素認証での署名者の認証にこの電話番号が使用されます。認証されると、署名者はドキュメントに署名できるようになります。`login_required`と組み合わせて選択することはできません。
type: string
example: '6314578901'
nullable: true
password:
description: 設定した場合、署名者は、このパスワードを入力しないと、ドキュメントに署名できません。このフィールドは書き込み専用です。
type: string
example: SecretPassword123
nullable: true
writeOnly: true
signer_group_id:
description: >-
設定した場合、同じ値が設定されている署名者は、同じ入力および同じ署名者グループに割り当てられます。署名者グループはBoxグループではありません。これは、署名リクエストに属しているエンティティであり、この署名リクエスト内でのみ使用/アクセスできます。署名者グループには複数の署名者が含まれることが想定されています。指定された値が1人の署名者に対してのみ使用されている場合、この値は無視され、リクエストは、個別の署名者を対象としたものとして処理されます。指定できる値は任意の文字列で、同じグループに属している署名者を判別するためだけに使用できます。成功したレスポンスでは、同じ署名者グループ内の署名者ではなく、生成されたUUID値が示されます。
type: string
example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
nullable: true
suppress_notifications:
description: trueの場合、署名リクエストに関するメールは送信されません。
type: boolean
example: false
nullable: true
language:
description: 修正版の[ISO 639-1](/guides/api-calls/language-codes)形式で表されるユーザーの言語。
type: string
example: en
nullable: true
title: Box Signリクエストオブジェクトを作成するための署名者フィールド。
Folder--Mini:
description: 他のリソースの下にネストされたときに使用されるファイルバージョンのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/Folder--Base'
- properties:
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
この項目に適用された最新のUser Eventを表す数値の識別子。
これを`GET
/events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser
Eventを除外できます。
たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser
Eventの発生を監視する場合などがこれに該当します。User
Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser
Eventをすべて無視します。
- nullable: false
name:
description: フォルダの名前。
type: string
example: Contracts
nullable: false
title: フォルダ (Mini)
x-box-resource-id: folder--mini
x-box-tag: folders
x-box-variant: mini
SignRequestSigner:
description: Box Signリクエストオブジェクトの本文で使用される署名者オブジェクトのスキーマ。
type: object
allOf:
- $ref: '#/components/schemas/SignRequestCreateSigner'
- properties:
has_viewed_document:
description: 署名者がドキュメントを表示する場合は`true`に設定します。
type: boolean
example: true
readOnly: true
signer_decision:
description: 署名者による最終的な決定。
type: object
nullable: true
properties:
type:
description: 署名者による決定の種類。
type: string
example: signed
enum:
- signed
- declined
finalized_at:
description: 決定が行われた日時。
type: string
format: date-time
example: '2021-04-26T08:12:13.982Z'
additional_info:
description: 署名者の拒否理由など、決定に関する追加情報。
type: string
example: Requesting changes before signing.
nullable: true
inputs:
type: array
items:
$ref: '#/components/schemas/SignRequestSignerInput'
readOnly: true
embed_url:
description: 署名のために署名者に案内するURL。
type: string
example: https://example.com
nullable: true
readOnly: true
iframeable_embed_url:
description: >-
このURLは、HTMLの`iframe`タグ内のドキュメントに署名するために設計されています。これがレスポンスで返されるのは、`embed_url_external_user_id`パラメータが`create
Box Sign request`コールで渡された場合のみです。
type: string
example: >-
https://app.box.com/embed/sign/document/gfhr4222-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4
nullable: true
attachments:
description: 署名者がアップロードした添付ファイル。
type: array
items:
$ref: '#/components/schemas/SignRequestSignerAttachment'
nullable: true
required:
- email
title: Box Signリクエストのレスポンスの署名者フィールド
File--Mini:
description: 他のリソースの下にネストされたときに使用されるファイルのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/File--Base'
- properties:
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
この項目に適用された最新のUser Eventを表す数値の識別子。
これを`GET
/events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser
Eventを除外できます。
たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser
Eventの発生を監視する場合などがこれに該当します。User
Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser
Eventをすべて無視します。
- nullable: false
name:
description: ファイルの名前。
type: string
example: Contract.pdf
sha1:
description: ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。
type: string
format: digest
example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37
nullable: false
file_version:
allOf:
- $ref: '#/components/schemas/FileVersion--Mini'
- description: ファイルの現在のバージョンに関する情報。
nullable: true
title: ファイル (Mini)
x-box-resource-id: file--mini
x-box-tag: files
x-box-variant: mini
SignRequestPrefillTag:
description: 事前入力タグは、署名者の入力データをプレースホルダに事前入力するために使用されます。含めることができる値フィールドは1つだけです。
type: object
properties:
document_tag_id:
description: これは、署名リクエストのファイルに含まれている特定のタグのIDを参照します。
type: string
example: '1234'
nullable: true
text_value:
description: テキストの事前入力値。
type: string
example: text
nullable: true
checkbox_value:
description: チェックボックスの事前入力値。
type: boolean
example: true
nullable: true
date_value:
description: 日付の事前入力値。
type: string
format: date
example: '2021-04-26'
nullable: true
title: 署名リクエスト事前入力タグ
Folder--Base:
description: 最も基本的なフォルダのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。
type: object
properties:
id:
description: >-
フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。
type: string
example: '12345'
nullable: false
etag:
description: >-
このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合)
にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。
type: string
example: '1'
nullable: true
type:
description: 値は常に`folder`になります。
type: string
example: folder
enum:
- folder
nullable: false
required:
- id
- type
title: フォルダ (Base)
x-box-resource-id: folder--base
x-box-tag: folders
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
SignRequestSignerInput:
description: 署名リクエストに署名者が作成した入力。
type: object
allOf:
- $ref: '#/components/schemas/SignRequestPrefillTag'
- properties:
type:
description: 入力の種類。
type: string
example: text
enum:
- signature
- date
- text
- checkbox
- radio
- dropdown
content_type:
description: 入力のコンテンツタイプ。
type: string
example: signature
enum:
- signature
- initial
- stamp
- date
- checkbox
- text
- full_name
- first_name
- last_name
- company
- title
- email
- attachment
- radio
- dropdown
page_index:
description: 入力が配置されるページのインデックス。
type: integer
example: 4
read_only:
description: この入力が読み取り専用 (署名者による変更不可) かどうかを示します。
type: boolean
example: true
validation:
description: 署名者がテキストフィールドに入力する際に従う必要のある書式設定ルールを指定します。設定した場合、この検証は必須となります。
example:
validation_type: email
anyOf:
- $ref: '#/components/schemas/SignRequestSignerInputValidation'
- title: OpenAPI 3.0 null schema type
description: The definition for a null schema type in OpenAPI `3.0`.
type: object
nullable: true
additionalProperties: false
reason:
description: >-
署名者の入力の理由。`cfr11`リクエストフローの署名または最初のコンテンツタイプに適用できます。適用不可の場合、値は`null`です。
type: string
example: I read and approve this document
nullable: true
is_validated:
description: >-
署名者の入力が再認証で検証されたかどうかを示します。`cfr11`リクエストフローの署名または最初のコンテンツタイプにのみ適用できます。標準リクエストフローまたは適用不可の入力タイプの場合、値は`null`です。
type: boolean
example: true
nullable: true
required:
- page_index
title: 署名リクエストの署名者の入力
SignRequestSignerAttachment:
description: 署名者が添付ファイルとしてアップロードしたファイルであることを示すメタデータ。
type: object
properties:
id:
description: 添付ファイルの識別子。
type: string
example: '12345'
nullable: true
name:
description: 添付ファイルの表示名。
type: string
example: proof_of_identity.pdf
nullable: true
title: 署名者向けの添付機能
FileVersion--Mini:
description: 他のリソース内にネストされたときに使用されるファイルバージョンのMini版の表示。
type: object
allOf:
- $ref: '#/components/schemas/FileVersion--Base'
- properties:
sha1:
description: ファイルの現在のバージョンのSHA1ハッシュ。
type: string
example: 134b65991ed521fcfe4724b7d814ab8ded5185dc
title: ファイルバージョン (Mini)
x-box-resource-id: file_version--mini
x-box-variant: mini
SignRequestSignerInputValidation:
description: >-
署名者がテキストフィールドの入力で従う必要のある書式設定ルールを指定します。設定した場合、この検証は必須となります。形式は、あらかじめ定義されているオプションのリスト
(例: メール、電話番号、日付) から選択するか、カスタム正規表現を使用して定義することができます。
oneOf:
- $ref: '#/components/schemas/SignRequestSignerInputEmailValidation'
- $ref: '#/components/schemas/SignRequestSignerInputCustomValidation'
- $ref: '#/components/schemas/SignRequestSignerInputZIPValidation'
- $ref: '#/components/schemas/SignRequestSignerInputZIP4Validation'
- $ref: '#/components/schemas/SignRequestSignerInputSSNValidation'
- $ref: >-
#/components/schemas/SignRequestSignerInputNumberWithPeriodValidation
- $ref: '#/components/schemas/SignRequestSignerInputNumberWithCommaValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateISOValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateUSValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateEUValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateAsiaValidation'
title: 署名リクエストの署名者入力の検証
FileVersion--Base:
description: 最も基本的なファイルバージョンのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。
type: object
properties:
id:
description: ファイルバージョンを表す一意の識別子。
type: string
example: '12345'
nullable: false
type:
description: 値は常に`file_version`になります。
type: string
example: file_version
enum:
- file_version
nullable: false
required:
- id
- type
title: ファイルバージョン (Base)
x-box-resource-id: file_version--base
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
SignRequestSignerInputEmailValidation:
description: 署名者がテキストフィールドに入力する際に従う必要のある書式設定ルールを指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: テキスト入力がメールアドレスであることを検証します。
type: string
example: email
enum:
- email
required:
- validation_type
title: 署名リクエストの署名者入力のメール検証
SignRequestSignerInputCustomValidation:
description: 署名者によるテキストフィールドの入力にカスタム検証ルールを指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: テキスト入力の検証形式をカスタムとして定義します。検証にはカスタム正規表現が使用されます。
type: string
example: custom
enum:
- custom
custom_regex:
description: 検証に使用される正規表現。
type: string
example: (^[a-zA-Z0-9._%+-]+)
nullable: true
custom_error_message:
description: 入力時にカスタム正規表現の検証に失敗した場合に表示されるエラーメッセージ。
type: string
example: Please enter a valid value.
nullable: true
required:
- validation_type
- custom_regex
- custom_error_message
title: 署名リクエストの署名者入力のカスタム検証
SignRequestSignerInputZIPValidation:
description: 署名者によるテキストフィールドの入力に検証ルールを指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: テキスト入力が郵便番号であることを検証します。
type: string
example: zip
enum:
- zip
required:
- validation_type
title: 署名リクエストの署名者入力の郵便番号検証
SignRequestSignerInputZIP4Validation:
description: 署名者によるテキストフィールドの入力に検証ルールを指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: テキスト入力が郵便番号 (ZIP+4) であることを検証します。
type: string
example: zip_4
enum:
- zip_4
required:
- validation_type
title: 署名リクエストの署名者入力の郵便番号 (ZIP+4) 検証
SignRequestSignerInputSSNValidation:
description: 署名者によるテキストフィールドの入力に検証ルールを指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: テキスト入力が社会保障番号 (SSN) であることを検証します。
type: string
example: ssn
enum:
- ssn
required:
- validation_type
title: 署名リクエストの署名者入力のSSN検証
SignRequestSignerInputNumberWithPeriodValidation:
description: 署名者によるテキストフィールドの入力に対して、ピリオドの書式設定ルールを適用した数字を指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: 'テキスト入力で、ピリオドを小数点区切り記号として使用する数字形式が使用されていることを検証します (例: 1,23)。'
type: string
example: number_with_period
enum:
- number_with_period
title: 署名リクエストの署名者入力のピリオドを使用した数字の検証
SignRequestSignerInputNumberWithCommaValidation:
description: 署名者によるテキストフィールドの入力に対して、コンマの書式設定ルールを適用した数字を指定します。設定した場合、この検証は必須となります。
type: object
properties:
validation_type:
description: 'テキスト入力で、コンマを小数点区切り記号として使用する数字形式が使用されていることを検証します (例: 1,23)。'
type: string
example: number_with_comma
enum:
- number_with_comma
title: 署名リクエストの署名者入力のコンマを使用した数字の検証
SignRequestSignerInputDateISOValidation:
description: >-
署名者によるテキストフィールドの入力に対して、ISO日付の書式設定ルールを指定します。設定した場合、この検証は必須となります。日付形式は`YYYY-MM-DD`パターンに従います。
type: object
properties:
validation_type:
description: テキスト入力でISOの日付形式`YYYY-MM-DD`が使用されていることを検証します。
type: string
example: date_iso
enum:
- date_iso
title: 署名リクエストの署名者入力の日付 (ISO) 検証
SignRequestSignerInputDateUSValidation:
description: >-
署名者によるテキストフィールドの入力に対して、米国の日付の書式設定ルールを指定します。設定した場合、この検証は必須となります。日付形式は`MM/DD/YYYY`パターンに従います。
type: object
properties:
validation_type:
description: テキスト入力で米国の日付形式`MM/DD/YYYY`が使用されていることを検証します。
type: string
example: date_us
enum:
- date_us
title: 署名リクエストの署名者入力の日付 (米国) 検証
SignRequestSignerInputDateEUValidation:
description: >-
署名者によるテキストフィールドの入力に対して、欧州で使用されている日付の書式設定ルールを指定します。設定した場合、この検証は必須となります。日付形式は`DD/MM/YYYY`パターンに従います。
type: object
properties:
validation_type:
description: テキスト入力で欧州の日付形式`DD/MM/YYYY`が使用されていることを検証します。
type: string
example: date_eu
enum:
- date_eu
title: 署名リクエストの署名者入力の日付 (欧州) 検証
SignRequestSignerInputDateAsiaValidation:
description: >-
署名者によるテキストフィールドの入力に対して、アジアで使用されている日付の書式設定ルールを指定します。設定した場合、この検証は必須となります。日付形式は`YYYY/MM/DD`パターンに従います。
type: object
properties:
validation_type:
description: テキスト入力でアジアの日付形式`YYYY/MM/DD`が使用されていることを検証します。
type: string
example: date_asia
enum:
- date_asia
title: 署名リクエストの署名者入力の日付 (アジア) 検証
securitySchemes:
OAuth2Security:
type: oauth2
description: >-
The access token received from the authorization server in the OAuth 2.0
flow.
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Boxに格納されているすべてのファイルとフォルダの読み取り
root_readwrite: Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み
manage_app_users: App Userのプロビジョニングと管理
manage_managed_users: 管理対象ユーザーのプロビジョニングと管理
manage_groups: 企業のグループの管理
manage_webhook: APIを使用したプログラムによるWebhookの作成
manage_enterprise_properties: Enterpriseのプロパティを管理
manage_data_retention: データリテンションポリシーの管理
manage_legal_hold: リーガルホールドの管理
````