> ## 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テンプレートのリストを取得
> ユーザーによって作成された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 GET /sign_templates
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_templates:
get:
tags:
- Box Signテンプレート
summary: Box Signテンプレートのリストを取得
description: ユーザーによって作成されたBox Signテンプレートを取得します。
operationId: get_sign_templates
parameters:
- name: marker
in: query
description: |-
結果が返される開始位置のマーカー。マーカーベースのページネーションを使用している場合に使用されます。
これを使用するには、`usemarker`を`true`に設定する必要があります。
required: false
schema:
type: string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
- name: limit
in: query
description: 返す項目の1ページあたりの最大数。
required: false
schema:
type: integer
format: int64
maximum: 1000
example: 1000
responses:
'200':
description: テンプレートのコレクションを返します。
content:
application/json:
schema:
$ref: '#/components/schemas/SignTemplates'
'401':
description: '`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。'
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: 予期しないクライアントエラー。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Box Signテンプレートのリストを取得
source: >-
curl -L -X GET
"https://api.box.com/2.0/sign_templates?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000"
\
-H "authorization: Bearer "
- lang: dotnet
label: Box Signテンプレートのリストを取得
source: >-
await client.SignTemplates.GetSignTemplatesAsync(queryParams: new
GetSignTemplatesQueryParams() { Limit = 2L });
- lang: swift
label: Box Signテンプレートのリストを取得
source: >-
try await client.signTemplates.getSignTemplates(queryParams:
GetSignTemplatesQueryParams(limit: Int64(2)))
- lang: java
label: Box Signテンプレートのリストを取得
source: >-
client.getSignTemplates().getSignTemplates(new
GetSignTemplatesQueryParams.Builder().limit(2L).build())
- lang: node
label: Box Signテンプレートのリストを取得
source: |-
await client.signTemplates.getSignTemplates({
limit: 2,
} satisfies GetSignTemplatesQueryParams);
- lang: python
label: Box Signテンプレートのリストを取得
source: client.sign_templates.get_sign_templates(limit=2)
components:
schemas:
SignTemplates:
description: 任意のBox Sign APIエンドポイントからデフォルトで返されるテンプレートのリスト。
type: object
allOf:
- type: object
description: マーカーベースのページネーションについて説明しているAPIレスポンスの部分。
properties:
limit:
description: >-
これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
type: integer
format: int64
example: 1000
next_marker:
description: 次の検索結果ページの開始場所のマーカー。
type: string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
nullable: true
prev_marker:
description: 前の検索結果ページの開始場所のマーカー。
type: string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
nullable: true
- properties:
entries:
description: テンプレートのリスト。
type: array
items:
$ref: '#/components/schemas/SignTemplate'
title: Box Signテンプレート
x-box-resource-id: sign_templates
x-box-tag: sign_templates
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
SignTemplate:
description: Box Signテンプレートオブジェクト。
type: object
allOf:
- properties:
type:
description: 値は常に`sign-template`になります。
type: string
example: sign-template
enum:
- sign-template
id:
description: テンプレートの識別子。
type: string
example: 4206996024-14944f75-c34b-478a-95a1-264b1ff80d35
name:
description: テンプレートの名前。
type: string
example: Official contract
nullable: 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
days_valid:
description: >-
作成した署名リクエストが完了しなかった場合に自動的に期限切れになるまでの日数を設定します。デフォルトでは、署名リクエストに有効期限を適用しないため、署名リクエストは期限切れになりません。
type: integer
example: 2
maximum: 730
minimum: 0
nullable: true
parent_folder:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: >-
最終的な署名済みドキュメントと署名ログの保存先フォルダ。`ID`フィールドと`type`フィールドのみが必要です。ルートフォルダ
(フォルダID `0`) は使用できません。
source_files:
description: 署名するドキュメントの作成元ファイルのリスト。ファイルごとにIDフィールドとtypeフィールドのみが必要です。
type: array
items:
$ref: '#/components/schemas/File--Mini'
are_fields_locked:
description: テンプレートの入力フィールドが編集可能かどうかを示します。
type: boolean
example: false
are_options_locked:
description: テンプレートドキュメントのオプション (ドキュメントの名前変更など) が編集可能かどうかを示します。
type: boolean
example: true
are_recipients_locked:
description: テンプレートの署名者が編集可能かどうかを示します。
type: boolean
example: false
are_email_settings_locked:
description: テンプレートのメール設定が編集可能かどうかを示します。
type: boolean
example: true
are_files_locked:
description: テンプレートファイルが編集可能かどうかを示します。これには、テンプレートファイルの削除または名前変更が含まれます。
type: boolean
example: true
signers:
description: >-
テンプレートの署名者の配列。
**注**:
テンプレートで指定された一部の署名者が競合する[セグメント](/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/TemplateSigner'
additional_info:
description: 必須フィールドと編集不可フィールドに関する追加情報。
type: object
properties:
non_editable:
description: 編集不可フィールド。
type: array
items:
type: string
enum:
- email_subject
- email_message
- name
- days_valid
- signers
- source_files
example:
- email_subject
- name
required:
description: 必須フィールド。
type: object
properties:
signers:
description: 必須の署名者フィールド。
type: array
items:
type: array
items:
type: string
enum:
- email
example:
- email
example:
- - email
- - email
ready_sign_link:
description: >-
Boxの署名リンク機能により、テンプレートから作成した署名リクエストへのリンクを作成できます。このリンクは、署名者が誰になるか不明な状態で公開フォーム
(メール、ソーシャルメディアの投稿、ウェブページなど) に署名リクエストを投稿する場合に使用します。注:
署名リンク機能は、Enterprise Plusをご利用のお客様に限定されており、Box Verified
Enterpriseでは利用できません。
type: object
nullable: true
properties:
url:
description: 署名者に送信できるURL。
type: string
example: |-
"https://app.box.com/sign/
ready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178"
name:
description: リクエスト名。
type: string
example: Official contract
nullable: true
instructions:
description: 署名者全員に対する追加の指示。
type: string
example: Hello! Please sign the document below
nullable: true
folder_id:
description: >-
最終的な署名済みドキュメントと署名ログの保存先フォルダ。`ID`フィールドと`type`フィールドのみが必要です。ルートフォルダ
(フォルダID `0`) は使用できません。
type: string
example: '12345'
nullable: true
is_notification_disabled:
description: 署名者が署名したときの通知を無効にするかどうか。
type: boolean
example: true
is_active:
description: 署名リンクが有効になっているかどうか。
type: boolean
example: false
custom_branding:
description: 通知および署名リクエストに適用されているカスタムブランド設定。
type: object
nullable: true
properties:
company_name:
description: 会社の名前。
type: string
example: Corporation inc.
nullable: true
logo_uri:
description: カスタムブランド設定のロゴURI (base64画像形式)。
type: string
example: |-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA
AAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A
8AAQUBAScY42YAAAAASUVORK5CYII=
nullable: true
branding_color:
description: カスタムブランド設定の色 (16進数)。
type: string
example: 9E5E6F
nullable: true
email_footer_text:
description: メールフッターのコンテンツ。
type: string
example: Contact email email@mail.com
nullable: true
request_flow:
description: テンプレートから作成された署名リクエストの署名フロー。値には`standard`または`cfr11`を指定できます。
type: string
example: standard
nullable: true
title: Box Signテンプレート
x-box-resource-id: sign_template
x-box-tag: sign_templates
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
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
TemplateSigner:
description: テンプレートの署名者のスキーマ。
type: object
properties:
inputs:
type: array
items:
$ref: '#/components/schemas/TemplateSignerInput'
readOnly: true
email:
description: 署名者のメールアドレス。
type: string
example: example@mail.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
signer_group_id:
description: >-
指定した場合、この値は、同じ入力が割り当てられ、同じ署名者グループに属している署名者を指します。署名者グループはBoxグループではありません。これは、テンプレート自体に属しているエンティティであり、そのテンプレートから作成されたBox
Signリクエスト内でのみ使用できます。
type: string
example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
nullable: true
label:
description: テンプレート作成者が署名者を区別するために設定した、署名者のプレースホルダラベル。
type: string
example: Jane Doe
nullable: true
public_id:
description: 署名者の識別子。これは、テンプレート内で署名者を識別するために使用できます。
type: string
example: RJZYYVPR
is_password_required:
description: >-
メールアドレスが定義されている署名者に対してtrueの場合、テンプレートの作成時に指定されたパスワードがデフォルトで使用されます。メールアドレスが指定/定義されていない署名者に対してtrueの場合、作成者は、テンプレートの使用時にパスワードを指定する必要があります。
type: boolean
example: true
nullable: true
is_phone_number_required:
description: >-
メールアドレスが定義されている署名者に対してtrueの場合、テンプレートの作成時に指定された電話番号がデフォルトで使用されます。メールアドレスが指定/定義されていない署名者に対してtrueの場合、テンプレート作成者は、リクエストの作成時に電話番号を指定する必要があります。
type: boolean
example: true
nullable: true
login_required:
description: trueの場合、署名者は、ドキュメントにアクセスするためにログインする必要があります。
type: boolean
example: true
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
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
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
TemplateSignerInput:
description: テンプレートに署名者が作成した入力。
type: object
allOf:
- $ref: '#/components/schemas/SignRequestPrefillTag'
- properties:
type:
description: 入力の種類。
type: string
example: text
enum:
- signature
- date
- text
- checkbox
- attachment
- radio
- dropdown
content_type:
description: 入力のコンテンツタイプ。
type: string
example: text
enum:
- signature
- initial
- stamp
- date
- checkbox
- text
- full_name
- first_name
- last_name
- company
- title
- email
- attachment
- radio
- dropdown
is_required:
description: 入力が必要かどうか。
type: boolean
example: true
page_index:
description: 入力が配置されるページのインデックス。
type: integer
example: 4
document_id:
description: ドキュメントの識別子。
type: string
example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7
nullable: true
dropdown_choices:
description: 入力のタイプが`dropdown`の場合、この値には、ドロップダウンのすべてのオプションが設定されます。
type: array
items:
type: string
example:
- 'Yes'
- 'No'
- Maybe
nullable: true
group_id:
description: 入力のタイプが`radio`の場合、この識別子で収集するようにグループ化できます。
type: string
example: da317330-225a-4c72-89ad-0d6dcaaf4df6
nullable: true
coordinates:
description: ページ上で入力が配置される場所。
type: object
properties:
x:
description: 入力が配置されるページに対する相対的なx座標 (範囲は0～1)。
type: number
example: 0.672258592471358
'y':
description: 入力が配置されるページに対する相対的なy座標 (範囲は0～1)。
type: number
example: 0.18654283173599448
dimensions:
description: 入力のサイズ。
type: object
properties:
width:
description: 入力が配置されるページに対する相対的な幅 (範囲は0～1)。
type: number
example: 0.2618657937806874
height:
description: 入力が配置されるページに対する相対的な高さ (範囲は0～1)。
type: number
example: 0.05311728090109673
label:
description: ラベルフィールドは、テキスト、添付、ラジオボタン、チェックボックスのタイプの入力に特に使用されます。
type: string
example: Legal name
nullable: true
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
required:
- page_index
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
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: 署名リクエスト事前入力タグ
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: 署名リクエストの署名者入力の検証
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: リーガルホールドの管理
````