{ "openapi": "3.0.2", "info": { "title": "Box Platform API", "description": "[Box Platform](https://box.dev)では、[Box](https://box.com)内に保存されているコンテンツへのアクセス権限を付与する機能が提供されています。また、ファイルとフォルダの基本操作、会社内のユーザーの管理、リーガルホールドやリテンションポリシーなどの複雑なトピックのためのエンドポイントも提供されています。", "termsOfService": "https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9", "contact": { "name": "Box, Inc", "url": "https://box.dev", "email": "devrel@box.com" }, "license": { "name": "Apache-2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", "x-box-commit-hash": "3e46126eb3" }, "servers": [ { "url": "https://api.box.com/2.0", "description": "Box Platform APIサーバー。" } ], "paths": { "/authorize": { "get": { "operationId": "get_authorize", "summary": "ユーザーを承認", "description": "ユーザーを[Box](https://box.com)ウェブサイトにリダイレクトして承認し、ユーザーに代わって操作を実行する権限をリクエストします。\n\nこれは、OAuth 2.0を使用してユーザーを承認する際の最初の手順です。Box APIをユーザーに代わって使用することについて、ユーザーに承認してもらうようリクエストするには、この形式を使用してユーザーを所定のURLにリダイレクトする必要があります。", "parameters": [ { "name": "response_type", "in": "query", "description": "受信するレスポンスのタイプ。", "required": true, "schema": { "type": "string", "format": "token", "enum": [ "code" ] }, "example": "code" }, { "name": "client_id", "in": "query", "description": "ユーザーの認証をリクエストしているアプリケーションのクライアントID。アプリケーションのクライアントIDを取得するには、Box開発者コンソールにログインして、該当するアプリケーションの \\[**アプリケーションの編集**] リンクをクリックします。\\[構成] ページの \\[OAuth2パラメータ] セクションで、`client_id`というラベルの付いた項目を探します。その項目のテキストが、アプリケーションのクライアントIDです。", "required": true, "schema": { "type": "string" }, "example": "ly1nj6n11vionaie65emwzk575hnnmrk" }, { "name": "redirect_uri", "in": "query", "description": "ユーザーがアプリケーションの権限を許可または拒否した後にブラウザがリダイレクトされるURI。このURIは、アプリケーションの構成に含まれるリダイレクトURIのいずれかと一致します。このURIは有効なHTTPS URIでなければならず、OAuth 2.0フローの次の手順を完了するには、リダイレクトを処理できる状態になっている必要があります。このパラメータは省略可能ですが、開発者コンソールでアプリケーション用にリダイレクトURIを複数設定した場合は、承認URLに含める必要があります。パラメータが指定されていないと、ユーザーがアプリケーションにアクセス権限を付与した後に`redirect_uri_missing`エラーが発生します。", "required": false, "schema": { "type": "string", "format": "url" }, "example": "http://example.com/auth/callback" }, { "name": "state", "in": "query", "description": "任意のカスタム文字列。認証が完了すると、同じ文字列がBoxからリダイレクトURLに渡されます。このパラメータを使用するとリダイレクト時にユーザーを識別できるだけでなく、ハイジャックされたセッションやその他の悪用を防止できます。", "required": false, "schema": { "type": "string" }, "example": "my_state" }, { "name": "scope", "in": "query", "description": "ユーザーを認証するアプリケーションスコープのスペース区切りのリスト。デフォルトでは、\\[構成] ページでアプリケーションに対して構成されているすべてのスコープになります。", "required": false, "schema": { "type": "string" }, "example": "admin_readwrite" } ], "responses": { "200": { "description": "何もデータを返しませんが、ブラウザで使用するようにしてください。", "content": { "text/html": { "schema": { "type": "string", "format": "html" } } } }, "default": { "description": "何もデータを返しませんが、ブラウザで使用するようにしてください。", "content": { "text/html": { "schema": { "type": "string", "format": "html" } } } } }, "x-box-tag": "authorization", "security": [], "servers": [ { "url": "https://account.box.com/api/oauth2", "description": "クライアント側認証に使用するサーバー。" } ], "tags": [ "承認" ] } }, "/oauth2/token": { "post": { "operationId": "post_oauth2_token", "summary": "アクセストークンをリクエスト", "description": "クライアント側で取得したOAuth 2.0認証コードまたはサーバー側のJWTアサーションを使用してアクセストークンをリクエストします。\n\nアクセストークンとは、リクエストが認証済みセッションに属していることをBoxで検証するための文字列です。通常の手順では、最初にユーザーが[承認](#get-authorize)エンドポイントに対して認証をリクエストした後で、Boxが認証コードを送信します。\n\nユーザーはこのエンドポイントに認証コードを送信してアクセストークンと交換します。返されたアクセストークンは、Box APIコールを行うときに使用できます。", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PostOAuth2Token" } } } }, "responses": { "200": { "description": "`Authorization: Bearer `のように承認ヘッダー内でトークンを渡すことによって認証済みのAPIコールを行うために使用できる新しいアクセストークンを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessToken" } } } }, "400": { "description": "認証エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2Error" } } } }, "default": { "description": "認証エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2Error" } } } } }, "x-box-tag": "authorization", "security": [], "servers": [ { "url": "https://api.box.com", "description": "サーバー側認証に使用するサーバー。" } ], "tags": [ "承認" ] } }, "/oauth2/token#refresh": { "post": { "operationId": "post_oauth2_token#refresh", "summary": "アクセストークンを更新", "description": "クライアントID、シークレット、更新トークンを使用してアクセストークンを更新します。", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PostOAuth2Token--RefreshAccessToken" } } } }, "responses": { "200": { "description": "`Authorization: Bearer `のように承認ヘッダー内でトークンを渡すことによって認証済みのAPIコールを行うために使用できる新しいアクセストークンを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessToken" } } } }, "400": { "description": "認証エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2Error" } } } }, "default": { "description": "認証エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2Error" } } } } }, "x-box-tag": "authorization", "security": [], "servers": [ { "url": "https://api.box.com", "description": "サーバー側認証に使用するサーバー。" } ], "tags": [ "承認" ], "x-box-is-variation": true } }, "/oauth2/revoke": { "post": { "operationId": "post_oauth2_revoke", "summary": "アクセストークンを取り消し", "description": "アクティブなアクセストークンを無効にします。これにより、認証されていたユーザーはログアウトされます。", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PostOAuth2Revoke" } } } }, "responses": { "200": { "description": "トークンが正常に無効化された場合は、空のレスポンスを返します。" }, "400": { "description": "認証エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2Error" } } } }, "default": { "description": "認証エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2Error" } } } } }, "x-box-tag": "authorization", "security": [], "servers": [ { "url": "https://api.box.com", "description": "サーバー側認証に使用するサーバー。" } ], "tags": [ "承認" ] } }, "/files/{file_id}": { "get": { "operationId": "get_files_id", "summary": "ファイル情報を取得", "description": "ファイルに関する詳細を取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。\n\nまた、このフィールドを使用すると、ファイルに適用されている任意のメタデータに対してクエリを実行できます。その際、`metadata`フィールドのほか、取得するテンプレートのスコープとキー (例: `?fields=metadata.enterprise_12345.contractTemplate`) も指定します。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "if-none-match", "in": "header", "description": "項目が変更されている場合にのみ、その項目を返します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは`304 Not Modified`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "boxapi", "in": "header", "description": "この項目の共有リンクのURLと省略可能なパスワード。\n\nこのヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。\n\n`shared_link=[link]`形式を使用するか、パスワードが必要な場合は`shared_link=[link]&shared_link_password=[password]`を使用します。\n\nこのヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。", "required": false, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" }, { "name": "x-rep-hints", "in": "header", "description": "ファイルの特定の`representations`をリクエストするために必要なヘッダー。特定のファイルレプリゼンテーションをリクエストするには、このヘッダーを`fields`クエリパラメータと組み合わせて使用します。\n\nこれらのレプリゼンテーションの一般的な形式は`X-Rep-Hints: [...]`で、`[...]`の部分では`[fileType?query]`という形式で1つまたは複数のヒントを指定します。\n\nたとえば、ピクセルサイズ`32x32`および`64x64`の`png`レプリゼンテーションをリクエストするには、以下のヒントを指定します。\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nまた、`[extracted_text]`レプリゼンテーションを使用すると、Box内のすべてのドキュメントファイルタイプに`text`レプリゼンテーションを使用できます。\n\n`x-rep-hints: [extracted_text]`.", "required": false, "schema": { "type": "string", "nullable": true }, "example": "[pdf]" } ], "responses": { "200": { "description": "ファイルオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" } } } }, "304": { "description": "`If-None-Match`ヘッダーがフォルダの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。" }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "415": { "description": "誤ったメディアタイプのファイルに対してアクションが実行されると、エラーが返されます。\n\n* Box Embedでサポートされないファイルの`expiring_embed_link`をリクエストすると、`unsupported_media_type`が返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "files", "tags": [ "Files" ] }, "post": { "operationId": "post_files_id", "summary": "ファイルを復元", "description": "ごみ箱に移動されたファイルを復元します。\n\n元のフォルダが削除されている場合にフォルダの復元先となる新しい親ID (省略可) を指定することができます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "ファイルの新しい名前 (省略可)。", "type": "string", "example": "Restored.docx" }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" } } }, { "description": "元のフォルダがすでに存在しない場合にファイルの復元先となるフォルダのID (省略可) を指定します。\n\nこのIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にファイルの復元先となるフォールバックの場所を指定します。" } ] } } } } } }, "responses": { "201": { "description": "ファイルが復元されたときにファイルオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashFileRestored" } } } }, "403": { "description": "ファイルの復元先フォルダに対してユーザーがアクセス権限を持っていない場合、またはごみ箱からファイルを復元する権限を持っていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "ファイルの復元先フォルダに同じ名前のファイルが存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_files", "tags": [ "ごみ箱内のファイル" ] }, "put": { "operationId": "put_files_id", "summary": "ファイルを更新", "description": "ファイルを更新します。ファイルの名前変更や移動、共有リンクの作成、ファイルのロックといった目的に使用できます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "ファイルの別の名前 (省略可)。これを使用してファイルの名前を変更できます。\n\nファイル名はその親フォルダ内で一意である必要があります。名前のチェックでは大文字と小文字が区別されないため、`New File`という名前のファイルは、`new file`というフォルダがすでに含まれている親フォルダ内に作成できません。", "type": "string", "example": "NewFile.txt" }, "description": { "description": "ファイルの説明。Boxウェブアプリでファイルを表示すると、右側のサイドバーパネルに表示されます。さらに、このインデックスはファイルの検索インデックスで使用されるため、ユーザーは説明の内容でファイルを見つけることができます。", "type": "string", "example": "The latest reports. Automatically updated", "maxLength": 256 }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" }, "user_id": { "description": "`user_id`の入力は省略可能です。`user_id`が存在する場合、ルート以外のフォルダへの移動は許可されません。`user_id`が指定されている場合、親フォルダIDはゼロにする必要があります。", "type": "string", "example": "12346930" } } }, { "description": "ファイルの新しい親フォルダ (省略可)。これを使用して、ファイルを新しいフォルダに移動できます。" } ] }, "shared_link": { "allOf": [ { "description": "項目の共有リンクを定義します。これを`null`に設定すると、共有リンクが削除されます。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link" }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true } } } } }, { "description": "ファイルの共有リンクを定義します。これを`null`に設定すると、共有リンクが削除されます。" } ], "nullable": true }, "lock": { "description": "項目のロックを定義します。これにより、ロックを作成したユーザー以外は、この項目を移動、名前変更、および変更できなくなります。\n\nこれを`null`に設定すると、ロックが削除されます。", "type": "object", "nullable": true, "properties": { "access": { "description": "このオブジェクトのタイプ。", "type": "string", "example": "lock", "enum": [ "lock" ] }, "expires_at": { "description": "ロックが期限切れになる日時を定義します。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "is_download_prevented": { "description": "ロック中でもファイルのダウンロードを許可するかどうかを定義します。", "type": "boolean", "example": true } }, "required": [ "type" ] }, "disposition_at": { "description": "特定のファイルのリテンションの有効期限のタイムスタンプ。この日付は、一度ファイルに設定すると短縮できません。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "description": "ファイルをダウンロードできるユーザーを定義します。", "type": "object", "properties": { "can_download": { "description": "このファイルのダウンロードが許可されるユーザーを定義します。使用可能な値は、`open` (すべてのユーザー) または`company` (ユーザーの会社のその他のメンバー) です。\n\nこの設定は、通常コラボレーションの`role`に含まれるダウンロード権限より優先されます。`company`に設定すると、基本的に、ロールが`viewer`または`editor`である外部ユーザーのダウンロードオプションが削除されます。", "type": "string", "example": "open", "enum": [ "open", "company" ] } } }, "collections": { "description": "このファイルをメンバーとして追加するコレクションの配列。現時点では、`favorites`コレクションのみがサポートされています。\n\nコレクションのIDを取得するには、[すべてのコレクションのリストを取得][1]エンドポイントを使用します。\n\n空の配列`[]`または`null`を渡すと、すべてのコレクションからこのファイルが削除されます。\n\n[1]: e://get-collections", "type": "array", "items": { "title": "Reference", "description": "オブジェクトの最も基本的な参照。", "type": "object", "properties": { "id": { "description": "このオブジェクトの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "このオブジェクトのタイプ。", "type": "string", "example": "file" } } }, "nullable": true }, "tags": { "description": "この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。\n\nタグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。\n\nタグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。", "type": "array", "items": { "type": "string" }, "example": [ "approved" ], "maxItems": 100, "minItems": 1 } } } } } }, "responses": { "200": { "description": "ファイルオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" } } } }, "400": { "description": "新しいリテンション期間が最大リテンション期間を超える場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。\n\n* 認証済みユーザーにファイルの移動先フォルダへのアクセス権限がない場合に`access_denied_insufficient_permissions`が返されます。\n* リテンション期間が現在のリテンションのタイムスタンプと等しいか、それより短い場合に返されます。\n* リテンションの対象でない`file_id`が入力された場合に返されます。\n* ファイルが保持されているものの、廃棄アクションが`remove_retention`に設定されている場合に返されます。\n* 情報バリアの制限によりフォルダのコピーが禁止されている場合に`forbidden_by_policy`が返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "files", "tags": [ "Files" ] }, "delete": { "operationId": "delete_files_id", "summary": "ファイルを削除", "description": "ファイルを削除します (完全に削除するか、ごみ箱に移動します)。\n\n項目がBoxから完全に削除されるか、ごみ箱に移動されるかは、会社の設定により決定されます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" } ], "responses": { "204": { "description": "ファイルが正常に削除された場合は、空のレスポンスを返します。" }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからないかすでに削除されている場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "files", "tags": [ "Files" ] } }, "/files/{file_id}/app_item_associations": { "get": { "operationId": "get_files_id_app_item_associations", "summary": "ファイルのアプリ項目の関連付けのリストを取得", "description": "**これはベータ機能のため、利用が制限される可能性があります。**ファイルが関連付けられているアプリ項目をすべて返します。これには、ファイルの先祖に関連付けられているアプリ項目が含まれます。コンテキストユーザーがファイルにアクセスできることを前提に、コンテキストユーザーにアプリ項目の**表示**権限がなくても、種類/IDが示されます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "application_type", "in": "query", "description": "指定した場合、このアプリケーションの種類のアプリ項目だけが返されます。", "required": false, "schema": { "type": "string", "nullable": false }, "example": "hubs" } ], "responses": { "200": { "description": "アプリ項目オブジェクトのコレクションを返します。このファイルにアプリ項目がない場合は、空のコレクションが返されます。このリストには、このファイルの先祖にあるアプリ項目が含まれます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppItemAssociations" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "app_item_associations", "tags": [ "アプリ項目の関連付け" ] } }, "/files/{file_id}/content": { "get": { "operationId": "get_files_id_content", "summary": "ファイルをダウンロード", "description": "ファイルのコンテンツをバイナリ形式で返します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "range", "in": "header", "description": "ダウンロードするコンテンツのバイト範囲。\n\n`bytes={start_byte}-{end_byte}`の形式を使用して、ダウンロードするファイルのセクションを指定できます。", "required": false, "schema": { "type": "string" }, "example": "bytes=0-1024" }, { "name": "boxapi", "in": "header", "description": "この項目の共有リンクのURLと省略可能なパスワード。\n\nこのヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。\n\n`shared_link=[link]`形式を使用するか、パスワードが必要な場合は`shared_link=[link]&shared_link_password=[password]`を使用します。\n\nこのヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。", "required": false, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" }, { "name": "version", "in": "query", "description": "ダウンロードするファイルバージョン。", "required": false, "schema": { "type": "string" }, "example": "4" }, { "name": "access_token", "in": "query", "description": "このリクエストの事前認証に使用できるアクセストークン (省略可)。つまり、ダウンロードリンクは、認証の処理方法を知らなくても、ブラウザまたはサードパーティのサービスと共有できます。このパラメータを使用する際は、そのファイルへの読み取りアクセスだけを許可するよう、アクセストークンが十分にダウンスコープされていることを確認してください。", "required": false, "schema": { "type": "string" }, "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" } ], "responses": { "200": { "description": "クライアントが自動的にリダイレクトとしてHTTP `3xx`レスポンスに従うように**リダイレクトに従う**設定を有効にしている場合は、リクエストされたファイルを返します。有効にしていない場合は、代わりに`302`が返されます。詳細については、[ファイルのダウンロードに関するガイド](g://downloads/file#download-url)を参照してください。", "content": { "application/octet-stream": { "schema": { "description": "ファイルのバイナリコンテンツ。", "type": "string", "format": "binary" } } } }, "202": { "description": "ファイルをダウンロードする準備ができていない場合は、クライアントがファイルをダウンロードできるようになるまでの秒数を示す`Retry-After`ヘッダーが返されます。\n\nこのレスポンスは、ダウンロードリクエストの直前にファイルがアップロードされた場合に発生することがあります。", "headers": { "Retry-After": { "description": "ダウンロードを再試行するまでの秒数。", "schema": { "type": "integer" } } } }, "302": { "description": "ファイルがダウンロード可能な場合、レスポンスには`dl.boxcloud.com`上のファイルの`Location`ヘッダーが含まれます。\n\n`dl.boxcloud.com`というURLは永続的ではないため、クライアントで実際にファイルをダウンロードするには、リダイレクト指示に従う必要があります。", "headers": { "Location": { "description": "ダウンロードURLへのポインタ。", "schema": { "type": "string", "format": "url" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "downloads", "tags": [ "ダウンロード" ] }, "post": { "operationId": "post_files_id_content", "summary": "ファイルバージョンをアップロード", "description": "ファイルのコンテンツを更新します。ファイルサイズが50 MBを超える場合は、分割アップロードAPIを使用することをお勧めします。\n\n本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "content-md5", "in": "header", "description": "ファイルが転送中に破損していないことを確認するための、ファイルのSHA1ハッシュを含むヘッダー (省略可)。", "required": false, "schema": { "type": "string" }, "example": "134b65991ed521fcfe4724b7d814ab8ded5185dc" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attributes": { "description": "アップロードされるファイルの追加の属性。主に名前と親フォルダ。これらの属性はマルチパートリクエスト本文に含まれており、JSON形式です。\n\n\n\n 本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。\n\n", "type": "object", "properties": { "name": { "description": "ファイルの新しい名前 (省略可)。指定した場合は、新しいバージョンがアップロードされると、ファイル名が変更されます。", "type": "string", "example": "Photo 2.0.png" }, "content_modified_at": { "description": "ファイルが最後に変更された日時を示します。\n\n設定されていない場合は、アップロード日時が使用されます。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "required": [ "name" ] }, "file": { "description": "Boxにアップロードするファイルのコンテンツ。\n\n\n\n 本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。\n\n", "type": "string", "format": "binary" } }, "required": [ "attributes", "file" ] } } } }, "responses": { "200": { "description": "リスト内の新しいファイルオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "uploads", "servers": [ { "url": "https://upload.box.com/api/2.0", "description": "ファイルアップロードに使用するサーバー。" } ], "tags": [ "アップロード" ] } }, "/files/content": { "options": { "operationId": "options_files_content", "summary": "アップロード前の事前チェック", "tags": [ "Files" ], "x-box-tag": "uploads", "description": "ファイル全体をアップロードする前に、ファイルがBoxで受け入れられるかどうかをチェックします。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "ファイルの名前。", "type": "string", "example": "File.mp4" }, "size": { "description": "ファイルのサイズ (バイト単位)。", "type": "integer", "format": "int32", "example": 1024 }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" } } }, { "description": "ファイルのアップロード先の親フォルダ。" } ] } } } } } }, "responses": { "200": { "description": "チェックに合格した場合、レスポンスにはファイルのアップロード先として使用できるセッションURLが含まれます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadUrl" } } } }, "409": { "description": "チェックに合格しなかった場合、レスポンスにはその理由に関する詳細が含まれます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } } }, "post": { "operationId": "post_files_content", "summary": "ファイルをアップロード", "description": "小さいファイルをBoxにアップロードします。ファイルサイズが50 MBを超える場合は、分割アップロードAPIを使用することをお勧めします。\n\n本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "content-md5", "in": "header", "description": "ファイルが転送中に破損していないことを確認するための、ファイルのSHA1ハッシュを含むヘッダー (省略可)。", "required": false, "schema": { "type": "string" }, "example": "134b65991ed521fcfe4724b7d814ab8ded5185dc" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "attributes": { "description": "アップロードされるファイルの追加の属性。主に名前と親フォルダ。これらの属性はマルチパートリクエスト本文に含まれており、JSON形式です。\n\n\n\n 本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。\n\n", "type": "object", "properties": { "name": { "description": "ファイルの名前。\n\nファイル名はその親フォルダ内で一意である必要があります。名前のチェックでは大文字と小文字が区別されないため、`New File`という名前のファイルは、`new file`というフォルダがすでに含まれている親フォルダ内に作成できません。", "type": "string", "example": "Photo.png" }, "parent": { "description": "ファイルのアップロード先の親フォルダ。", "type": "object", "properties": { "id": { "description": "親フォルダのID。ユーザーのルートフォルダを指定するには、`0`を使用します。", "type": "string", "example": "124132" } }, "required": [ "id" ] }, "content_created_at": { "description": "ファイルが最初に作成された日時を定義します。\n\n設定されていない場合は、アップロード日時が使用されます。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "content_modified_at": { "description": "ファイルが最後に変更された日時を示します。\n\n設定されていない場合は、アップロード日時が使用されます。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "required": [ "name", "parent" ] }, "file": { "description": "Boxにアップロードするファイルのコンテンツ。\n\n\n\n 本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。\n\n", "type": "string", "format": "binary" } }, "required": [ "attributes", "file" ] } } } }, "responses": { "201": { "description": "リスト内の新しいファイルオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files" } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `bad_request` - パラメータが指定されていないか誤っている場合に返されます。\n* `item_name_too_long` - フォルダ名が長すぎる場合に返されます。\n* `item_name_invalid` - フォルダ名に無効な文字が含まれている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "親フォルダが存在しない場合、またはユーザーが親フォルダへのアクセスを承認されていない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "ファイルがすでに存在する場合、またはアカウントのディスク容量が不足している場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "uploads", "servers": [ { "url": "https://upload.box.com/api/2.0", "description": "ファイルアップロードに使用するサーバー。" } ], "tags": [ "アップロード" ] } }, "/files/upload_sessions": { "post": { "operationId": "post_files_upload_sessions", "summary": "アップロードセッションを作成", "description": "新しいファイルのアップロードセッションを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "folder_id": { "description": "新しいファイルのアップロード先フォルダのID。", "type": "string", "example": "0" }, "file_size": { "description": "アップロードされるファイルの合計バイト数。", "type": "integer", "format": "int64", "example": 104857600 }, "file_name": { "description": "新規ファイルの名前。", "type": "string", "example": "Project.mov" } }, "required": [ "folder_id", "file_size", "file_name" ] } } } }, "responses": { "201": { "description": "新しいアップロードセッションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSession" } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `missing_destination`: `folder_id`が指定されていません。\n* `invalid_folder_id`: `folder_id`が無効です。\n* `item_name_invalid`: `file_name`が無効です。\n* `missing_file_size`: `file_size`が指定されていません。\n* `invalid_file_size`: `file_size`が有効な数値ではありません。\n* `file_size_too_small`: `file_size`が、このAPIによるアップロードの最小ファイルサイズを下回っています。\n* `missing_file_name`: `file_name`が指定されていません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "何らかの理由で操作が許可されていない場合にエラーを返します。\n\n* `storage_limit_exceeded`: アカウントのストレージサイズの上限に達しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "親フォルダが見つからないか、認証済みユーザーが親フォルダにアクセスできない場合はエラーを返します。\n\n* `invalid_parameter`: `folder_id`値は、ユーザーがアクセスできないフォルダまたは存在しないフォルダを表します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "ファイルがすでに存在する場合、またはアカウントのディスク容量が不足している場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://upload.box.com/api/2.0", "description": "ファイルアップロードに使用するサーバー。" } ], "tags": [ "アップロード (分割)" ] } }, "/files/{file_id}/upload_sessions": { "post": { "operationId": "post_files_id_upload_sessions", "summary": "既存ファイルのアップロードセッションを作成", "description": "既存ファイルのアップロードセッションを作成します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file_size": { "description": "アップロードされるファイルの合計バイト数。", "type": "integer", "format": "int64", "example": 104857600 }, "file_name": { "description": "新規ファイルの新しい名前 (省略可)。", "type": "string", "example": "Project.mov" } }, "required": [ "file_size" ] } } } }, "responses": { "201": { "description": "新しいアップロードセッションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSession" } } } }, "409": { "description": "ファイルがすでに存在する場合、またはアカウントのディスク容量が不足している場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://upload.box.com/api/2.0", "description": "ファイルアップロードに使用するサーバー。" } ], "tags": [ "アップロード (分割)" ] } }, "/files/upload_sessions/{upload_session_id}": { "get": { "operationId": "get_files_upload_sessions_id", "summary": "アップロードセッションを取得", "description": "アップロードセッションに関する情報を返します。\n\n実際のエンドポイントURLは[`Create upload session`](e://post-files-upload-sessions)エンドポイントが返します。", "parameters": [ { "name": "upload_session_id", "in": "path", "description": "アップロードセッションのID。", "required": true, "schema": { "type": "string" }, "example": "D5E3F7A" } ], "responses": { "200": { "description": "アップロードセッションオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadSession" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://{box-upload-server}/api/2.0", "description": "ファイルアップロードに使用するサーバー。", "variables": { "box-upload-server": { "description": "The server for the upload session.", "default": "upload.box.com" } } } ], "tags": [ "アップロード (分割)" ], "x-box-enable-explorer": false }, "put": { "operationId": "put_files_upload_sessions_id", "summary": "ファイルの一部をアップロード", "description": "アップロードセッションでファイルのチャンクをアップロードします。\n\n実際のエンドポイントURLは[`Create upload session`](e://post-files-upload-sessions)および[`Get upload session`](e://get-files-upload-sessions-id)エンドポイントが返します。", "parameters": [ { "name": "upload_session_id", "in": "path", "description": "アップロードセッションのID。", "required": true, "schema": { "type": "string" }, "example": "D5E3F7A" }, { "name": "digest", "in": "header", "description": "分割アップロードの[RFC3230][1]メッセージのダイジェスト。\n\nサポートされているのはSHA1のみです。SHA1ダイジェストはbase64でエンコードされている必要があります。このヘッダーの形式は、`sha=BASE64_ENCODED_DIGEST`です。\n\n`SHA`ダイジェストの値を取得するには、openSSLコマンドを使用して、ファイルのパーツをエンコードします: `openssl sha1 -binary | base64`。\n\n[1]: https://tools.ietf.org/html/rfc3230", "required": true, "schema": { "type": "string" }, "example": "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" }, { "name": "content-range", "in": "header", "description": "チャンクのバイト範囲。\n\nこのセッションですでにアップロードされたパーツの範囲と重複しないようにしてください。各パーツのサイズは、作成したアップロードセッションで指定されているパーツサイズとまったく同じサイズである必要があります。ただし、ファイルの最後のパーツは小さくなる可能性があるため、例外となります。\n\n`content-range`の値を指定する際は、以下の点に注意してください。\n\n* 各パーツのバイト範囲の下限は、パーツサイズの倍数にする必要があります。\n* 上限は、パーツサイズの倍数から1を引いた値にする必要があります。", "required": true, "schema": { "type": "string" }, "example": "bytes 8388608-16777215/445856194" } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "description": "ファイルのバイナリコンテンツ。", "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "チャンクは正常にアップロードされました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadedPart" } } } }, "409": { "description": "チャンクがこれまでにアップロードされた別のチャンクと競合する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "前提条件を満たしていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "416": { "description": "コンテンツの範囲がセッションの指定範囲と一致しない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://{box-upload-server}/api/2.0", "description": "ファイルアップロードに使用するサーバー。", "variables": { "box-upload-server": { "description": "The server for the upload session.", "default": "upload.box.com" } } } ], "tags": [ "アップロード (分割)" ], "x-box-enable-explorer": false }, "delete": { "operationId": "delete_files_upload_sessions_id", "summary": "アップロードセッションを削除", "description": "アップロードセッションを中断して、アップロードされたすべてのデータを破棄します。\n\nこの操作は元に戻せません。\n\n実際のエンドポイントURLは[`Create upload session`](e://post-files-upload-sessions)および[`Get upload session`](e://get-files-upload-sessions-id)エンドポイントが返します。", "parameters": [ { "name": "upload_session_id", "in": "path", "description": "アップロードセッションのID。", "required": true, "schema": { "type": "string" }, "example": "D5E3F7A" } ], "responses": { "204": { "description": "セッションが正常に中断された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://{box-upload-server}/api/2.0", "description": "ファイルアップロードに使用するサーバー。", "variables": { "box-upload-server": { "description": "The server for the upload session.", "default": "upload.box.com" } } } ], "tags": [ "アップロード (分割)" ], "x-box-enable-explorer": false } }, "/files/upload_sessions/{upload_session_id}/parts": { "get": { "operationId": "get_files_upload_sessions_id_parts", "summary": "パーツのリストを取得", "description": "現在までにアップロードセッションにアップロードされたチャンクのリストを返します。\n\n実際のエンドポイントURLは[`Create upload session`](e://post-files-upload-sessions)および[`Get upload session`](e://get-files-upload-sessions-id)エンドポイントが返します。", "parameters": [ { "name": "upload_session_id", "in": "path", "description": "アップロードセッションのID。", "required": true, "schema": { "type": "string" }, "example": "D5E3F7A" }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "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/UploadParts" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://{box-upload-server}/api/2.0", "description": "ファイルアップロードに使用するサーバー。", "variables": { "box-upload-server": { "description": "The server for the upload session.", "default": "upload.box.com" } } } ], "tags": [ "アップロード (分割)" ], "x-box-enable-explorer": false } }, "/files/upload_sessions/{upload_session_id}/commit": { "post": { "operationId": "post_files_upload_sessions_id_commit", "summary": "アップロードセッションをコミット", "description": "アップロードセッションを閉じて、アップロード済みのチャンクからファイルを作成します。\n\n実際のエンドポイントURLは[`Create upload session`](e://post-files-upload-sessions)および[`Get upload session`](e://get-files-upload-sessions-id)エンドポイントが返します。", "parameters": [ { "name": "upload_session_id", "in": "path", "description": "アップロードセッションのID。", "required": true, "schema": { "type": "string" }, "example": "D5E3F7A" }, { "name": "digest", "in": "header", "description": "ファイル全体の[RFC3230][1]メッセージのダイジェスト。\n\nサポートされているのはSHA1のみです。SHA1ダイジェストはBase64でエンコードされている必要があります。このヘッダーの形式は、`sha=BASE64_ENCODED_DIGEST`です。\n\n[1]: https://tools.ietf.org/html/rfc3230", "required": true, "schema": { "type": "string" }, "example": "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "if-none-match", "in": "header", "description": "項目が変更されている場合にのみ、その項目を返します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは`304 Not Modified`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parts": { "description": "アップロードされたパーツのリストの詳細。", "type": "array", "items": { "$ref": "#/components/schemas/UploadPart" } } }, "required": [ "parts" ] } } } }, "responses": { "201": { "description": "リスト内のファイルオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files" } } } }, "202": { "description": "すべてのチャンクがすでにアップロードされているものの、まだ処理されていない場合に返されます。\n\nアップロードセッションを調べてチャンク処理の進捗状況に関する詳細情報を取得し、すべてのチャンクが処理された後でファイルのコミットを再試行します。", "headers": { "Retry-After": { "description": "コミットリクエストの再試行までクライアントが待機する秒数を示します。", "schema": { "type": "integer" } } } }, "409": { "description": "ターゲットフォルダに同じ名前のファイルがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`または`If-None-Match`条件に一致しなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "chunked_uploads", "servers": [ { "url": "https://{box-upload-server}/api/2.0", "description": "ファイルアップロードに使用するサーバー。", "variables": { "box-upload-server": { "description": "The server for the upload session.", "default": "upload.box.com" } } } ], "tags": [ "アップロード (分割)" ], "x-box-enable-explorer": false } }, "/files/{file_id}/copy": { "post": { "operationId": "post_files_id_copy", "summary": "ファイルをコピー", "description": "ファイルのコピーを作成します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "コピーされたファイルの新しい名前 (省略可)。\n\nファイル名にはいくつかの制約があります。印刷不可能なASCII文字、スラッシュ、およびバックスラッシュ (`/`、`\\`) を含む名前のほか、`.`や`..`のような予約済みの名前は、許可されていない文字を削除することで自動的にサニタイズされます。", "type": "string", "example": "FileCopy.txt", "maxLength": 255 }, "version": { "description": "コピーする特定のファイルバージョンのID (省略可)", "type": "string", "example": "0" }, "parent": { "description": "ファイルのコピー先となるフォルダ。", "type": "object", "properties": { "id": { "description": "ファイルのコピー先となるフォルダのID。", "type": "string", "example": "0" } }, "required": [ "id" ] } }, "nullable": false, "required": [ "parent" ] } } } }, "responses": { "201": { "description": "コピーされたファイルを表す新しいファイルオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" } } } }, "304": { "description": "`If-None-Match`ヘッダーがファイルの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、ファイルが前回リクエストされたときから変更されていないことを示します。" }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `bad_request` - パラメータが指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーにファイルのコピーを作成するための適切な権限がない場合にエラーを返します。\n\n* `forbidden_by_policy`: 情報バリアの制限によりファイルのコピーが禁止されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ソースファイルまたは宛先フォルダのどちらも見つからないか、認証済みユーザーがどちらにもアクセスできない場合はエラーを返します。\n\n* `not_found` - 認証済みユーザーがソースファイルまたは宛先フォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "`operation_blocked_temporary`: 別の移動、コピー、削除、または復元操作が進行中であるために宛先フォルダまたは元のフォルダがロックされている場合に返されます。\n\n操作は後で再試行することができます。\n\n`item_name_in_use` - 同じ名前のフォルダがすでに存在している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "files", "tags": [ "Files" ] } }, "/files/{file_id}/thumbnail.{extension}": { "get": { "operationId": "get_files_id_thumbnail_id", "summary": "ファイルサムネイルを取得", "description": "ファイルのサムネイル (小さい画像レプリゼンテーション) を取得します。\n\nサイズ`32x32`、`64x64`、`128x128`、`256x256`は`.png`形式で返すことができます。また、サイズ`32x32`、`160x160`、`320x320`は`.jpg`形式で返すことができます。\n\nサムネイルを生成できる画像および動画ファイルの形式については、[こちら][1]を参照してください。\n\n[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "extension", "in": "path", "description": "サムネイルのファイル形式。", "required": true, "schema": { "type": "string", "enum": [ "png", "jpg" ] }, "example": "png" }, { "name": "min_height", "in": "query", "description": "サムネイルの高さの最小値。", "schema": { "type": "integer", "maximum": 320, "minimum": 32 }, "example": 32 }, { "name": "min_width", "in": "query", "description": "サムネイルの幅の最小値。", "schema": { "type": "integer", "maximum": 320, "minimum": 32 }, "example": 32 }, { "name": "max_height", "in": "query", "description": "サムネイルの高さの最大値。", "required": false, "schema": { "type": "integer", "maximum": 320, "minimum": 32 }, "example": 320 }, { "name": "max_width", "in": "query", "description": "サムネイルの幅の最大値。", "required": false, "schema": { "type": "integer", "maximum": 320, "minimum": 32 }, "example": 320 } ], "responses": { "200": { "description": "サムネイルを作成できる場合は、レスポンスの本文内でサムネイルデータが返されます。", "content": { "image/jpg": { "schema": { "description": "サムネイル。", "type": "string", "format": "binary" } }, "image/png": { "schema": { "description": "サムネイル。", "type": "string", "format": "binary" } } } }, "202": { "description": "サムネイルの生成には数秒かかることがあります。そのような場合、APIはこのファイルタイプに対して使用できるプレースホルダグラフィックを示す`Location`ヘッダーを返します。\n\nプレースホルダグラフィックはサムネイルの生成が完了するまでユーザーインターフェースで使用できます。`Retry-After`ヘッダーは、サムネイルの準備がいつ完了するかを示します。その時点で、このエンドポイントを再試行するとサムネイルを取得できます。", "headers": { "Retry-After": { "description": "サムネイルが利用可能になるまでの時間(秒)。\n\nアプリケーションはこの時間が経過するまでサムネイルの取得を再試行しません。", "schema": { "type": "integer", "format": "int64" } }, "Location": { "description": "サムネイルが生成されるまでの間使用できるプレースホルダ画像へのポインタ。", "schema": { "type": "string", "format": "url" } } } }, "302": { "description": "このファイルタイプのサムネイルをBoxで生成できない場合は、エラーを返します。\n\n代わりに、このファイルタイプのプレースホルダグラフィックを指す`Location`ヘッダーが返されます。", "headers": { "Location": { "description": "このファイルタイプに使用できるプレースホルダグラフィックへのポインタ。", "schema": { "type": "string", "format": "url" } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `requested_preview_unavailable` - 正しくないサイズがリクエストされました。これは、リクエストされたサイズが、サムネイル形式で使用可能なファイルサイズよりも大きいか小さい場合に、またはサイズの制約どうしが矛盾している場合に発生します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、ユーザーがファイルにアクセスできない場合、またはその他の理由でファイルを使用できない場合に返されます。\n\n* `preview_cannot_be_generated` - Boxはこのファイルタイプのサムネイルをサポートしていません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "files", "tags": [ "Files" ] } }, "/files/{file_id}/collaborations": { "get": { "operationId": "get_files_id_collaborations", "summary": "ファイルのコラボレーションのリストを取得", "description": "ファイルでの保留中のコラボレーションとアクティブなコラボレーションのリストを取得します。そのファイルに対するアクセス権限を持つか、そのファイルに招待されているすべてのユーザーを返します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "コラボレーションオブジェクトのコレクションを返します。このファイルでのコラボレーションが存在しない場合は、空のコレクションが返されます。\n\nこのリストには、`status`が`pending`に設定されている保留中のコラボレーションが含まれます。これは、招待が送信されたもののまだ承認されていないことを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collaborations" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "list_collaborations", "tags": [ "コラボレーション (リスト)" ] } }, "/files/{file_id}/comments": { "get": { "operationId": "get_files_id_comments", "summary": "ファイルのコメントのリストを取得", "description": "ファイルに関するコメントのリストを取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "コメントオブジェクトのコレクションを返します。このファイルに関するコメントが存在しない場合は、空のコレクションが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comments" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "comments", "tags": [ "Comments" ] } }, "/files/{file_id}/tasks": { "get": { "operationId": "get_files_id_tasks", "summary": "ファイルに対するタスクのリストを取得", "description": "そのファイルに関連するすべてのタスクのリストを取得します。このエンドポイントはページ割りをサポートしていません。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "ファイルに関連するタスクのリストを返します。\n\nこのファイルに関連するタスクが存在しない場合は、空のコレクションが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tasks" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が指定されていない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "IDが`0`のファイルのタスクを取得しようとした場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "tasks", "tags": [ "Tasks" ] } }, "/files/{file_id}/trash": { "get": { "operationId": "get_files_id_trash", "summary": "ごみ箱内のファイルを取得", "description": "ごみ箱に移動されたファイルを取得します。\n\nそのファイル自体がごみ箱に移動されている場合のみ、このAPIコールを使用して取得できることに注意してください。そうではなく、その親フォルダのいずれかがごみ箱に移動された場合、[`GET /folders/:id/trash`](e://get_folders_id_trash) APIを使用して調べることができるのは、そのフォルダのみです。\n\nごみ箱に移動されたすべての項目のリストを取得するには、[`GET /folders/trash/items`](e://get-folders-trash-items/) APIを使用します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "ごみ箱に移動された日時の情報を含め、ごみ箱内にあるファイルを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashFile" } } } }, "404": { "description": "ファイルがごみ箱で直接見つからない場合にエラーを返します。\n\nそのファイルの親フォルダのいずれかがごみ箱に移動されている場合も、`HTTP 404`が返されることに注意してください。\n\nその場合、[`GET /folders/:id/trash`](e://get_folders_id_trash) APIを使用して調べることができるのは、その親フォルダのみです。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_files", "tags": [ "ごみ箱内のファイル" ] }, "delete": { "operationId": "delete_files_id_trash", "summary": "ファイルを完全に削除", "description": "ごみ箱内にあるファイルを完全に削除します。このアクションは取り消せません。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "ファイルが完全に削除された場合は、空のレスポンスを返します。" }, "404": { "description": "ファイルがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_files", "tags": [ "ごみ箱内のファイル" ] } }, "/files/{file_id}/versions": { "get": { "operationId": "get_files_id_versions", "summary": "すべてのファイルバージョンのリストを取得", "description": "ファイルの過去のバージョンのリストを取得します。\n\nバージョンを追跡するのは、プレミアム (有償) アカウントを持つBoxユーザーのみです。ファイルの現在のバージョンのIDを取得するには、`GET /file/:id` APIを使用します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "このファイルの過去のバージョンの配列を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersions" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_versions", "tags": [ "ファイルバージョン" ] } }, "/files/{file_id}/versions/{file_version_id}": { "get": { "operationId": "get_files_id_versions_id", "summary": "ファイルバージョンを取得", "description": "特定のファイルバージョンを取得します。\n\nバージョンが追跡されるのは、プレミアムアカウントを持つBoxユーザーのファイルに関してのみです。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "file_version_id", "in": "path", "description": "ファイルバージョンのID。", "required": true, "schema": { "type": "string" }, "example": "1234" } ], "responses": { "200": { "description": "特定のファイルバージョンを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersion--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_versions", "tags": [ "ファイルバージョン" ] }, "delete": { "operationId": "delete_files_id_versions_id", "summary": "ファイルバージョンを削除", "description": "特定のファイルバージョンをごみ箱に移動します。\n\nバージョンが追跡されるのは、プレミアムアカウントを持つBoxユーザーのファイルに関してのみです。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "file_version_id", "in": "path", "description": "ファイルバージョンのID。", "required": true, "schema": { "type": "string" }, "example": "1234" }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" } ], "responses": { "204": { "description": "ファイルが正常に削除された場合は、空のレスポンスを返します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_versions", "tags": [ "ファイルバージョン" ] }, "put": { "operationId": "put_files_id_versions_id", "summary": "ファイルバージョンを復元", "description": "削除された、ファイルの特定のバージョンを復元します。このエンドポイントは、PDF、DOC、PPTXなどのファイル形式で機能するため、Box Notesの復元には使用しないでください。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "file_version_id", "in": "path", "description": "ファイルバージョンのID。", "required": true, "schema": { "type": "string" }, "example": "1234" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "復元するファイルバージョン。", "type": "object", "properties": { "trashed_at": { "description": "これを`null`に設定すると、日付がクリアされ、ファイルが復元されます。", "type": "string", "example": null, "nullable": true } } } } } }, "responses": { "200": { "description": "復元されたファイルバージョンオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersion--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_versions", "tags": [ "ファイルバージョン" ] } }, "/files/{file_id}/versions/current": { "post": { "operationId": "post_files_id_versions_current", "summary": "ファイルバージョンを昇格", "description": "特定のファイルバージョンを昇格させます。\n\n以前のバージョンが存在する場合は、この方法を使用して古いバージョンのいずれかをバージョン履歴の先頭に移動できます。\n\nこれにより、古いバージョンの新しいコピーが作成されて、バージョン履歴の先頭に配置されます。このファイルは古いバージョンとまったく同じ内容になり、ハッシュダイジェスト、`etag`、およびファイル名も同じになります。\n\nコメントなど、他のプロパティが以前の値に更新されることはありません。\n\nこのエンドポイントは、PDF、DOC、PPTXなどのファイル形式で機能するため、Box Notesの復元には使用しないでください。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "description": "昇格させるファイルバージョン。", "type": "object", "properties": { "id": { "description": "ファイルバージョンID。", "type": "string", "example": "11446498" }, "type": { "description": "昇格させるタイプ。", "type": "string", "example": "file_version", "enum": [ "file_version" ] } } } } } }, "responses": { "201": { "description": "新しく作成されたファイルバージョンオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersion--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_versions", "tags": [ "ファイルバージョン" ] } }, "/files/{file_id}/metadata": { "get": { "operationId": "get_files_id_metadata", "summary": "ファイルのメタデータインスタンスのリストを取得", "description": "指定したファイルのすべてのメタデータを取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "ファイルに関連付けられたすべてのメタデータを返します。\n\nこのAPIはページ割りをサポートしていないため、常にファイルに関連付けられたすべてのメタデータを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadatas" } } } }, "403": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ユーザーがファイルにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_metadata", "tags": [ "メタデータインスタンス (ファイル)" ] } }, "/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo": { "get": { "operationId": "get_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "ファイルの分類を取得", "description": "ファイルに適用されている分類メタデータインスタンスを取得します。\n\nこのAPIは、`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "`securityClassification`メタデータテンプレートのインスタンスを返します。これには、この会社が使用できるすべての分類のリストを取得する`Box__Security__Classification__Key`フィールドが含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" } } } }, "403": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定したメタデータテンプレートがこのファイルに適用されていない場合、またはユーザーがこのファイルにアクセスできない場合に返されます。\n\n* `instance_not_found` - メタデータテンプレートがファイルに適用されていなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_classifications", "tags": [ "ファイルの分類" ] }, "post": { "operationId": "post_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "ファイルに分類を追加", "description": "追加する分類のラベルを指定することで、ファイルに分類を追加します。\n\nこのAPIは、`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Box__Security__Classification__Key": { "description": "このファイルに適用する分類の名前。\n\n会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される[分類テンプレート](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)を取得します。", "type": "string", "example": "Sensitive" } } } } } }, "responses": { "201": { "description": "ファイルに適用された分類テンプレートインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。\n\n* `not_found` - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。\n* `instance_tuple_not_found` - メタデータテンプレートが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "このメタデータテンプレートのインスタンスがすでにファイルに存在する場合はエラーを返します。\n\n* `tuple_already_exists` - メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_classifications", "tags": [ "ファイルの分類" ] }, "put": { "operationId": "put_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "ファイルの分類を更新", "description": "ファイルの分類を更新します。\n\n分類を更新できるのは、分類がすでにファイルに適用されている場合のみです。分類を編集する際は、会社に対して定義されている値のみを使用できます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "分類ラベルを更新するために加える1つの変更を含むリスト。", "type": "array", "items": { "type": "object", "description": "分類メタデータテンプレートのインスタンスに対して実行する操作。この場合、`Box__Security__Classification__Key`フィールドに格納された値を新しい値で置き換えるために使用されます。", "required": [ "op", "path", "value" ], "properties": { "op": { "description": "値は常に`replace`になります。", "type": "string", "example": "replace", "enum": [ "replace" ] }, "path": { "description": "企業で使用できる分類を定義します。", "type": "string", "example": "/Box__Security__Classification__Key", "enum": [ "/Box__Security__Classification__Key" ] }, "value": { "description": "このファイルに適用する分類の名前。\n\n会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される[分類テンプレート](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)を取得します。", "type": "string", "example": "Sensitive" } } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "更新された分類メタデータテンプレートインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `bad_request` - リクエスト本文の形式が有効なJSON Patch操作の配列ではありません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "リクエスト本文が有効なJSON Patch項目の配列でない場合、一部のエッジケースでエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_classifications", "tags": [ "ファイルの分類" ] }, "delete": { "operationId": "delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "ファイルから分類を削除", "description": "ファイルからすべての分類を削除します。\n\nこのAPIは、`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "分類が正常に削除された場合は空のレスポンスを返します。" }, "400": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルに分類が適用されていない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - 分類メタデータテンプレートのインスタンスがこのファイルに見つかりませんでした。\n* `not_found` - ファイルが見つからなかったか、ユーザーがファイルにアクセスできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_classifications", "tags": [ "ファイルの分類" ] } }, "/files/{file_id}/metadata/{scope}/{template_key}": { "get": { "operationId": "get_files_id_metadata_id_id", "summary": "ファイルのメタデータインスタンスを取得", "description": "ファイルに適用されたメタデータテンプレートのインスタンスを取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "responses": { "201": { "description": "ユーザーまたはアプリケーションによって定義された追加の「キー/値」ペアを含むメタデータテンプレートのインスタンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata--Full" } } } }, "403": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定したメタデータテンプレートがこのファイルに適用されていない場合、またはユーザーがこのファイルにアクセスできない場合に返されます。\n\n* `instance_not_found` - メタデータテンプレートがファイルに適用されていなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_metadata", "tags": [ "メタデータインスタンス (ファイル)" ] }, "post": { "operationId": "post_files_id_metadata_id_id", "summary": "ファイルにメタデータインスタンスを作成", "description": "メタデータテンプレートのインスタンスをファイルに適用します。\n\nほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できる`global.properties`テンプレートは除きます。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "name": "Aaron Levie" }, "additionalProperties": { "allOf": [ {}, { "example": "Aaron Levie" }, { "description": "メタデータテンプレートに存在する各フィールドの値。`global.properties`テンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。" } ] }, "x-box-example-key": "name" } } } }, "responses": { "201": { "description": "テンプレートに適用されたデータを含む、ファイルに適用されたテンプレートのインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata--Full" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataError" } } } }, "404": { "description": "ファイルテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。\n\n* `not_found` - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。\n* `instance_tuple_not_found` - メタデータテンプレートが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "このメタデータテンプレートのインスタンスがすでにファイルに存在する場合はエラーを返します。\n\n* `tuple_already_exists` - メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_metadata", "tags": [ "メタデータインスタンス (ファイル)" ], "x-box-enable-explorer": false }, "put": { "operationId": "put_files_id_metadata_id_id", "summary": "ファイルのメタデータインスタンスを更新", "description": "ファイルのメタデータを更新します。\n\nメタデータインスタンスを更新できるのは、テンプレートがすでにファイルに適用されている場合のみです。メタデータを編集する際には、メタデータテンプレートのスキーマに一致した値のみを使用できます。\n\n更新はアトミックに適用されます。操作の適用中にエラーが発生した場合、メタデータインスタンスは変更されません。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "メタデータインスタンスに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)の指定。\n\n変更は操作オブジェクトのJSON配列として表されます。", "type": "array", "items": { "title": "メタデータインスタンスの更新操作", "description": "メタデータインスタンスに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)操作。", "type": "object", "properties": { "op": { "description": "テンプレートに対して実行する変更のタイプ。その中には、既存のテンプレートを変更する際に危険を伴うものもあります。", "type": "string", "example": "add", "enum": [ "add", "replace", "remove", "test", "move", "copy" ] }, "path": { "description": "変更を適用するメタデータJSONオブジェクト内の場所を、[JSON-Pointer](https://tools.ietf.org/html/rfc6901)の形式で指定します。\n\nパスの先頭にはテンプレートのルートを表す`/`を必ず付ける必要があります。文字`~`と`/`は予約文字であるため、キー内ではエスケープする必要があります。", "type": "string", "example": "/currentState" }, "value": { "$ref": "#/components/schemas/MetadataInstanceValue" }, "from": { "description": "値の移動元またはコピー元であるメタデータJSONオブジェクト内の場所。`move`または`copy`操作には必須であり、[JSON-Pointer](https://tools.ietf.org/html/rfc6901)の形式である必要があります。", "type": "string", "example": "/nextState" } } } } } } }, "responses": { "200": { "description": "カスタムテンプレートデータを含め、更新されたメタデータテンプレートインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata--Full" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `bad_request` - リクエスト本文の形式が有効なJSON Patchオブジェクトの配列ではありません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "リクエスト本文が有効なJSON Patch項目の配列でない場合、一部のエッジケースでエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_metadata", "tags": [ "メタデータインスタンス (ファイル)" ] }, "delete": { "operationId": "delete_files_id_metadata_id_id", "summary": "ファイルからメタデータインスタンスを削除", "description": "ファイルメタデータを削除します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "responses": { "204": { "description": "メタデータが正常に削除された場合は空のレスポンスを返します。" }, "400": { "description": "リクエストのパラメータが無効な場合に返されます。これは、`scope`が無効な場合に発生する可能性があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルにメタデータテンプレートのインスタンスが適用されていない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - 指定された`scope`および`templateKey`を持つメタデータテンプレートのインスタンスがこのファイルに見つかりませんでした。\n* `not_found` - ファイルが見つからなかったか、ユーザーがファイルにアクセスできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_metadata", "tags": [ "メタデータインスタンス (ファイル)" ] } }, "/files/{file_id}/metadata/global/boxSkillsCards": { "get": { "operationId": "get_files_id_metadata_global_boxSkillsCards", "summary": "ファイルのBox Skillカードのリストを取得", "description": "ファイルに添付されているBox Skillsメタデータカードのリストを取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "ファイルに関連付けられたすべてのメタデータを返します。\n\nこのAPIはページ割りをサポートしていないため、常にファイルに関連付けられたすべてのメタデータを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCardsMetadata" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "skills", "tags": [ "Skills" ] }, "post": { "operationId": "post_files_id_metadata_global_boxSkillsCards", "summary": "ファイルにBox Skillカードを作成", "description": "ファイルに1つ以上のBox Skillsメタデータカードを適用します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cards": { "description": "このファイルに適用するBox Skillカードのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/SkillCard" } } }, "required": [ "cards" ] } } } }, "responses": { "201": { "description": "テンプレートに適用されたデータを含む、ファイルに適用されたテンプレートのインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCardsMetadata" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。\n\n* `not_found` - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。\n* `instance_tuple_not_found` - メタデータテンプレートが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "このメタデータテンプレートのインスタンスがすでにファイルに存在する場合はエラーを返します。\n\n* `tuple_already_exists` - メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "skills", "tags": [ "Skills" ] }, "put": { "operationId": "put_files_id_metadata_global_boxSkillsCards", "summary": "ファイルのBox Skillカードを更新", "description": "ファイルの1つ以上のBox Skillsメタデータカードを更新します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "メタデータテンプレートに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)の指定。\n\n変更は操作オブジェクトのJSON配列として表されます。", "type": "array", "items": { "type": "object", "description": "既存のカードを置き換える操作。", "properties": { "op": { "description": "値は常に`replace`になります。", "type": "string", "example": "replace", "enum": [ "replace" ] }, "path": { "description": "置き換えるカードを表すJSONパス。ほとんどの場合、これは`/cards/{index}`形式になります (`index`は、カードのリストにおいてそのカードの位置を示すゼロから始まるインデックスです)。", "type": "string", "example": "/cards/0" }, "value": { "allOf": [ { "$ref": "#/components/schemas/SkillCard" }, { "description": "カードのリスト内の`path`で定義された位置に挿入されるカード。" } ] } } } } } } }, "responses": { "200": { "description": "カスタムテンプレートデータを含め、更新されたメタデータテンプレートを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCardsMetadata" } } } }, "404": { "description": "リクエストしたファイルが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "skills", "tags": [ "Skills" ] }, "delete": { "operationId": "delete_files_id_metadata_global_boxSkillsCards", "summary": "ファイルからBox Skillカードを削除", "description": "ファイルからBox Skillsカードのメタデータを削除します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "カードが正常に削除された場合は空のレスポンスを返します。" }, "404": { "description": "ファイルにBox Skillカードのインスタンスが適用されていない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - Box Skillカードのメタデータテンプレートのインスタンスがこのファイルに見つかりませんでした。\n* `not_found` - ファイルが見つからなかったか、ユーザーがファイルにアクセスできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "skills", "tags": [ "Skills" ] } }, "/files/{file_id}/watermark": { "get": { "operationId": "get_files_id_watermark", "summary": "ファイルの電子すかしを取得", "description": "ファイルの電子すかしを取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "このファイルに関連付けられている電子すかしに関する情報を含むオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watermark" } } } }, "404": { "description": "ファイルに電子すかしが適用されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_watermarks", "tags": [ "電子すかし (ファイル)" ] }, "put": { "operationId": "put_files_id_watermark", "summary": "ファイルに電子すかしを適用", "description": "ファイルの電子すかしを適用または更新します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "watermark": { "description": "ファイルに適用する電子すかし。", "type": "object", "properties": { "imprint": { "description": "適用する電子すかしのタイプ。\n\n現在サポートされているオプションは1つのみです。", "type": "string", "example": "default", "enum": [ "default" ] } }, "required": [ "imprint" ] } }, "required": [ "watermark" ] } } } }, "responses": { "200": { "description": "このファイルに電子すかしがすでに適用されている場合は、更新された電子すかしを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watermark" } } } }, "201": { "description": "このファイルにまだ電子すかしが適用されていない場合は、新しい電子すかしを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watermark" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_watermarks", "tags": [ "電子すかし (ファイル)" ] }, "delete": { "operationId": "delete_files_id_watermark", "summary": "ファイルから電子すかしを削除", "description": "ファイルから電子すかしを削除します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "電子すかしを削除して空のレスポンスを返します。" }, "404": { "description": "ファイルに電子すかしが適用されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_watermarks", "tags": [ "電子すかし (ファイル)" ] } }, "/file_requests/{file_request_id}": { "get": { "operationId": "get_file_requests_id", "summary": "ファイルリクエストを取得", "description": "ファイルリクエストに関する情報を取得します。", "parameters": [ { "name": "file_request_id", "in": "path", "description": "ファイルリクエストを表す一意の識別子。\n\nファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLが`https://*.app.box.com/filerequest/123`の場合、`file_request_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "123" } ], "responses": { "200": { "description": "ファイルリクエストオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRequest" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルリクエストが見つからない場合、または関連付けられたフォルダへのアクセス権限がユーザーに与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_request_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_requests", "tags": [ "ファイルリクエスト" ] }, "put": { "operationId": "put_file_requests_id", "summary": "ファイルリクエストを更新", "description": "ファイルリクエストを更新します。これは使用すると、ファイルリクエストを有効化または無効化できます。", "parameters": [ { "name": "file_request_id", "in": "path", "description": "ファイルリクエストを表す一意の識別子。\n\nファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLが`https://*.app.box.com/filerequest/123`の場合、`file_request_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "123" }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRequestUpdateRequest" } } } }, "responses": { "200": { "description": "更新されたファイルリクエストオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRequest" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。\n\n* `access_denied_insufficient_permissions` - 認証済みユーザーにファイルリクエストを更新するためのアクセス権限がない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルリクエストが見つからない場合、または関連付けられたフォルダへのアクセス権限がユーザーに与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_request_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルリクエストの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルリクエストが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_requests", "tags": [ "ファイルリクエスト" ] }, "delete": { "operationId": "delete_file_requests_id", "summary": "ファイルリクエストを削除", "description": "ファイルリクエストを完全に削除します。", "parameters": [ { "name": "file_request_id", "in": "path", "description": "ファイルリクエストを表す一意の識別子。\n\nファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLが`https://*.app.box.com/filerequest/123`の場合、`file_request_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "123" } ], "responses": { "204": { "description": "ファイルリクエストが正常に削除された場合は、空のレスポンスを返します。" }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルリクエストが見つからないかすでに削除されている場合、またはユーザーに関連付けられたフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_request_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_requests", "tags": [ "ファイルリクエスト" ] } }, "/file_requests/{file_request_id}/copy": { "post": { "operationId": "post_file_requests_id_copy", "summary": "ファイルリクエストをコピー", "description": "あるフォルダにすでに存在する既存のファイルリクエストをコピーし、別のフォルダに適用します。", "parameters": [ { "name": "file_request_id", "in": "path", "description": "ファイルリクエストを表す一意の識別子。\n\nファイルリクエストのIDを確認するには、ウェブアプリケーションでファイルリクエストの作成画面にアクセスして、そのURLからIDをコピーします。たとえば、URLが`https://*.app.box.com/filerequest/123`の場合、`file_request_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRequestCopyRequest" } } } }, "responses": { "200": { "description": "更新されたファイルリクエストオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileRequest" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。\n\n* `access_denied_insufficient_permissions` - 認証済みユーザーにファイルリクエストを更新するためのアクセス権限がない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルリクエストが見つからない場合、または関連付けられたフォルダへのアクセス権限がユーザーに与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_request_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_requests", "tags": [ "ファイルリクエスト" ] } }, "/folders/{folder_id}": { "get": { "operationId": "get_folders_id", "summary": "フォルダ情報を取得", "description": "フォルダ内の最初の100エントリを含むフォルダの詳細を取得します。\n\nクエリで`sort`、`direction`、`offset`、および`limit`パラメータを渡すと、返される[フォルダ項目](r://folder--full#param-item-collection)のリストを管理できます。\n\nフォルダ内の項目をさらに取得するには、[フォルダ内の項目を取得](e://get-folders-id-items)エンドポイントを使用します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。\n\nまた、このフィールドを使用すると、ファイルに適用されている任意のメタデータに対してクエリを実行できます。その際、`metadata`フィールドのほか、取得するテンプレートのスコープとキー (例: `?fields=metadata.enterprise_12345.contractTemplate`) も指定します。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "if-none-match", "in": "header", "description": "項目が変更されている場合にのみ、その項目を返します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは`304 Not Modified`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "boxapi", "in": "header", "description": "この項目の共有リンクのURLと省略可能なパスワード。\n\nこのヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。\n\n`shared_link=[link]`形式を使用するか、パスワードが必要な場合は`shared_link=[link]&shared_link_password=[password]`を使用します。\n\nこのヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。", "required": false, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" }, { "name": "sort", "in": "query", "description": "項目並べ替えの**2番目**の基準として使用される属性を定義します。\n\nフォルダの種類は、項目の並べ替え方法に影響します。\n\n* **標準フォルダ**: 項目は必ず最初に`type`を基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。\n\n* **ルートフォルダ**: ルートフォルダ \n\n (`id`が`0`のフォルダ) の場合、マーカーベースのページ割りでこのパラメータはサポートされません。\n\n* **関連付けられたフォルダの親パスがコラボレータに表示される共有フォルダ**: 項目は必ず最初に`type`を基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "date", "size" ] }, "example": "id" }, { "name": "direction", "in": "query", "description": "結果を並べ替える方向。アルファベットの昇順 (`ASC`) または降順 (`DESC`) のいずれかを指定できます。", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 } ], "responses": { "200": { "description": "フォルダ内の最初の100エントリを含め、フォルダを返します。`sort`、`direction`、`offset`、`limit`のようなクエリパラメータを使用した場合、_フォルダ項目のリスト_は状況に応じて影響を受けます。\n\nフォルダ内の項目をさらに取得するには、[フォルダ内の項目を取得](e://get-folders-id-items)エンドポイントを使用します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" } } } }, "304": { "description": "`If-None-Match`ヘッダーがフォルダの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。" }, "403": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folders", "tags": [ "Folders" ] }, "post": { "operationId": "post_folders_id", "summary": "フォルダを復元", "description": "ごみ箱に移動されたフォルダを復元します。\n\n元のフォルダが削除されている場合にフォルダの復元先となる新しい親ID (省略可) を指定することができます。\n\nこの操作の進行中は、ファイルツリーの一部がロックされます。ロックされるのは主に元のフォルダとその子孫フォルダ、および宛先フォルダです。\n\n操作の進行中は、ロックされたどのフォルダに対しても、その他の移動、コピー、削除または復元操作を実行できません。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "フォルダの新しい名前 (省略可)。", "type": "string", "example": "Restored Photos" }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" } } }, { "description": "元のフォルダがすでに存在しない場合にフォルダの復元先となるフォルダのID (省略可) を指定します。\n\nこのIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にフォルダの復元先となるフォールバックの場所を指定します。" } ] } } } } } }, "responses": { "201": { "description": "フォルダが復元されたときにフォルダオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashFolderRestored" } } } }, "403": { "description": "フォルダの復元先フォルダに対してユーザーがアクセス権限を持っていない場合、またはごみ箱からフォルダを復元する権限を持っていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "宛先フォルダに同じ名前のフォルダがある場合はエラーを返します。\n\n`operation_blocked_temporary`: 別の移動、コピー、削除、または復元操作が進行中であるために宛先フォルダまたは元のフォルダがロックされている場合に返されます。\n\n操作は後で再試行することができます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_folders", "tags": [ "ごみ箱内のフォルダ" ] }, "put": { "operationId": "put_folders_id", "summary": "フォルダを更新", "description": "フォルダを更新します。フォルダの移動、共有リンクの作成、コラボレーションの更新といった目的にも使用できます。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "このフォルダの新しい名前 (省略可)。\n\nフォルダ名には、印刷不可能なASCII文字、スラッシュ、バックスラッシュ (`/`、`\\`) を含む名前、末尾にスペースを含む名前、`.`および`..`という名前は使用できないという制限が適用されます。\n\nフォルダ名はその親フォルダ内で一意である必要があります。名前のチェックでは大文字と小文字が区別されないため、`New Folder`という名前のフォルダは、`new folder`というフォルダがすでに含まれている親フォルダ内に作成できません。", "type": "string", "example": "New Folder" }, "description": { "description": "このフォルダの説明 (省略可)。", "type": "string", "example": "Legal contracts for the new ACME deal", "maxLength": 256, "nullable": false }, "sync_state": { "description": "フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。これはBox Sync (廃止済み) で使用され、Box Driveでは 使用されません。", "type": "string", "example": "synced", "enum": [ "synced", "not_synced", "partially_synced" ], "nullable": false }, "can_non_owners_invite": { "description": "フォルダの所有者ではないユーザーがそのフォルダに新しいコラボレータを招待できるかどうかを指定します。", "type": "boolean", "example": true }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" }, "user_id": { "description": "`user_id`の入力は省略可能です。`user_id`が存在する場合、ルート以外のフォルダへの移動は許可されません。`user_id`が指定されている場合、親フォルダIDはゼロにする必要があります。", "type": "string", "example": "12346930" } } }, { "description": "このフォルダの親フォルダ。フォルダを移動したり、ごみ箱からフォルダを復元したりするときに使用します。" } ] }, "shared_link": { "allOf": [ { "description": "項目の共有リンクを定義します。これを`null`に設定すると、共有リンクが削除されます。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link" }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true } } } } }, { "description": "フォルダの共有リンクの作成を有効にします。" } ] }, "folder_upload_email": { "allOf": [ { "title": "フォルダアップロードメール", "type": "object", "description": "書き込みフォルダアップロードメールオブジェクト。", "properties": { "access": { "description": "このパラメータが設定されている場合、ユーザーは、このフォルダに対して自動的に作成されたメールアドレスに メールでファイルを送信できます。\n\nメールアドレスを作成するには、フォルダを作成するとき、または更新するときにこのプロパティを設定します。\n\n`collaborators`に設定すると、コラボレータの登録済み メールアドレスからのメールのみが受け入れられます。これには、ユーザーが登録しているすべてのメールエイリアスも含まれます。\n\n`open`に設定すると、どのメールアドレスからのメールでも受け入れられます。", "type": "string", "example": "open", "enum": [ "open", "collaborators" ], "nullable": false } } }, { "description": "このオブジェクトを設定するとアップロードメールアドレスが有効になります。\n\nユーザーはこのメールアドレスを使用することにより、メールを介してフォルダにファイルを直接アップロードできます。\n\n値を`null`に設定するとアップロードメールアドレスは無効になります。" } ], "nullable": true }, "tags": { "description": "この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。\n\nタグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。\n\nタグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。", "type": "array", "items": { "type": "string" }, "example": [ "approved" ], "maxItems": 100, "minItems": 1 }, "is_collaboration_restricted_to_enterprise": { "description": "このフォルダへの招待を社内のユーザーのみに限定するかどうかを指定します。既存のコラボレーションには影響しません。", "type": "boolean", "example": true }, "collections": { "description": "このフォルダをメンバーとして追加するコレクションの配列。現時点では、`favorites`コレクションのみがサポートされています。\n\nコレクションのIDを取得するには、[すべてのコレクションのリストを取得][1]エンドポイントを使用します。\n\n空の配列`[]`または`null`を渡すと、すべてのコレクションからこのフォルダが削除されます。\n\n[1]: e://get-collections", "type": "array", "items": { "title": "Reference", "description": "オブジェクトの最も基本的な参照。", "type": "object", "properties": { "id": { "description": "このオブジェクトの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "このオブジェクトのタイプ。", "type": "string", "example": "file" } } }, "nullable": true }, "can_non_owners_view_collaborators": { "description": "このフォルダの所有者ではないコラボレータがこのフォルダのその他のコラボレータを表示できないように制限します。\n\nこの制限を有効にした場合は、所有者ではないユーザーが新しいコラボレータを招待することも制限されます。\n\nこのフィールドを`false`に設定する場合は、`can_non_owners_invite_collaborators`も`false`に設定する必要があります (まだ設定されていない場合)。", "type": "boolean", "example": true } } } } } }, "responses": { "200": { "description": "更新されたフォルダのフォルダオブジェクトを返します\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。\n\nユーザーが多数の項目を含むフォルダ (そのすべての子孫も含む) を移動する場合、コールは非同期的に実行されます。この操作が10分以内に完了しない場合、ユーザーには200 OKのレスポンスが返され、操作は続行されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" } } } }, "400": { "description": "一部のパラメータが指定されていないか無効な場合、またはフォルダロックにより移動操作ができなくなっている場合はエラーを返します。\n\n* `bad_request` - パラメータが指定されていないか誤っている場合に返されます。このエラーは、アクセスタイプが`open`の共有リンクにパスワードが設定されている場合にも発生します。\n* `item_name_too_long` - フォルダ名が長すぎる場合に返されます。\n* `item_name_invalid` - フォルダ名に無効な文字が含まれている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーにこのアクションを実行するためのアクセス権限がない場合はエラーを返します。\n\n* `access_denied_insufficient_permissions`: ユーザーにフォルダまたは親フォルダへのアクセス権限がない場合か、移動できないようにフォルダロックが適用されているのにフォルダが移動されている場合に返されます。\n\n* `insufficient_scope`: アプリケーションにフォルダを更新するための適切なスコープがない場合に返されます。Boxに格納されているすべてのファイルとフォルダに対して読み取りと書き込みを行えるようにアプリケーションが設定されていることを確認してください。\n\n* `forbidden`: ユーザーが他のユーザーに対してこのアクションを実行することが許可されていない場合に返されます。これには、アクセスレベルが`company`に設定されている共有リンクを無料アカウントで作成するアクションも含まれます。\n\n* `forbidden_by_policy`: 情報バリアの制限によりフォルダのコピーが禁止されている場合に返されます。\n\nリクエスト本文に含まれる操作が多すぎる場合にエラーを返します。\n\n* `operation_limit_exceeded`: ユーザーがリクエスト本文で`parent.id`に加えてパラメータを渡したときに返されます。このエンドポイントに対する呼び出しは分割する必要があります。最初の呼び出しには`parent.id`だけを含める必要があります。次の呼び出しには他のパラメータを含めることができます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダまたは親フォルダが見つからないか、認証済みユーザーがどちらのフォルダにもアクセスできない場合はエラーを返します。\n\n* `not_found` - 認証済みユーザーがフォルダまたは親フォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "`operation_blocked_temporary`: 別の移動、コピー、削除、または復元操作が進行中であるために宛先フォルダまたは元のフォルダがロックされている場合に返されます。\n\n操作は後で再試行することができます。\n\n`item_name_in_use`: この名前のフォルダがすでに親フォルダ内に存在している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがフォルダの現在の`etag`値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "503": { "description": "操作の処理時間が60秒を超えるとエラーを返します。このレスポンスが返された後も操作は続行されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folders", "tags": [ "Folders" ] }, "delete": { "operationId": "delete_folders_id", "summary": "フォルダを削除", "description": "フォルダを完全に削除するか、ごみ箱に移動して削除します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "if-match", "in": "header", "description": "変更を加える前にこの項目が最近変更されていないことを確認します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは`412 Precondition Failed`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "recursive", "in": "query", "description": "フォルダとその中にあるすべてのコンテンツを再帰的に削除することにより、空でないフォルダを削除します。", "required": false, "schema": { "type": "boolean" }, "example": true } ], "responses": { "204": { "description": "フォルダが正常に削除された場合、またはごみ箱に移動された場合は、空のレスポンスを返します。" }, "400": { "description": "ユーザーが不正なリクエストを行った場合にエラーを返します。\n\n* `folder_not_empty`: フォルダが空でない場合に返されます。フォルダとそのコンテンツを再帰的に削除するには、`recursive`クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーにこのアクションを実行するためのアクセス権限がない場合はエラーを返します。\n\n* `access_denied_insufficient_permissions`: ユーザーにフォルダへのアクセス権限がない場合、または削除されないようにフォルダにフォルダロックが適用されている場合に返されます。\n\n* `insufficient_scope`: アプリケーションにフォルダを削除するための適切なスコープがない場合にエラーが返されます。Boxに格納されているすべてのファイルとフォルダに対して読み取りと書き込みを行えるようにアプリケーションが設定されていることを確認してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからないか、認証済みユーザーが親フォルダにアクセスできない場合は、エラーを返します。\n\n* `not_found` - 認証済みユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "`operation_blocked_temporary`: 別の移動、コピー、削除、または復元操作が進行中であることによりフォルダがロックされている場合に返されます。\n\n操作は後で再試行することができます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがフォルダの現在の`etag`値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "503": { "description": "操作の処理時間が60秒を超えるとエラーを返します。このレスポンスが返された後も操作は続行されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folders", "tags": [ "Folders" ] } }, "/folders/{folder_id}/app_item_associations": { "get": { "operationId": "get_folders_id_app_item_associations", "summary": "フォルダのアプリ項目の関連付けのリストを取得", "description": "**これはベータ機能のため、利用が制限される可能性があります。**フォルダが関連付けられているアプリ項目をすべて返します。これには、フォルダの先祖に関連付けられているアプリ項目が含まれます。コンテキストユーザーがフォルダにアクセスできることを前提に、コンテキストユーザーにアプリ項目の**表示**権限がなくても、種類/IDが示されます。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "application_type", "in": "query", "description": "指定した場合、このアプリケーションの種類のアプリ項目だけが返されます。", "required": false, "schema": { "type": "string", "nullable": false }, "example": "hubs" } ], "responses": { "200": { "description": "アプリ項目オブジェクトのコレクションを返します。このフォルダにアプリ項目がない場合は、空のコレクションが返されます。このリストには、このフォルダの先祖にあるアプリ項目が含まれます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppItemAssociations" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "app_item_associations", "tags": [ "アプリ項目の関連付け" ] } }, "/folders/{folder_id}/items": { "get": { "operationId": "get_folders_id_items", "summary": "フォルダ内の項目のリストを取得", "description": "フォルダ内の項目のページを取得します。これらの項目はファイル、 フォルダ、ウェブリンクのいずれかになります。\n\nフォルダ自体の詳細情報 (サイズなど) をリクエストするには、代わりに[フォルダを取得](#get-folders-id)エンドポイントを使用します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。\n\nまた、このフィールドを使用すると、ファイルに適用されている任意のメタデータに対してクエリを実行できます。その際、`metadata`フィールドのほか、取得するテンプレートのスコープとキー (例: `?fields=metadata.enterprise_12345.contractTemplate`) も指定します。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "usemarker", "in": "query", "description": "オフセットベースのページ割り方式ではなくマーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は1つのみです。\n\nこの値をtrueに設定すると、APIは、レスポンスの次のページを取得するために、このエンドポイントにパラメータとして渡すことができる`marker`フィールドを返します。", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "boxapi", "in": "header", "description": "この項目の共有リンクのURLと省略可能なパスワード。\n\nこのヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。\n\n`shared_link=[link]`形式を使用するか、パスワードが必要な場合は`shared_link=[link]&shared_link_password=[password]`を使用します。\n\nこのヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。", "required": false, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" }, { "name": "sort", "in": "query", "description": "項目並べ替えの**2番目**の基準として使用される属性を定義します。\n\nフォルダの種類は、項目の並べ替え方法に影響します。\n\n* **標準フォルダ**: 項目は必ず最初に`type`を基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。\n\n* **ルートフォルダ**: ルートフォルダ \n\n (`id`が`0`のフォルダ) の場合、マーカーベースのページ割りでこのパラメータはサポートされません。\n\n* **関連付けられたフォルダの親パスがコラボレータに表示される共有フォルダ**: 項目は必ず最初に`type`を基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "date", "size" ] }, "example": "id" }, { "name": "direction", "in": "query", "description": "結果を並べ替える方向。アルファベットの昇順 (`ASC`) または降順 (`DESC`) のいずれかを指定できます。", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" } ], "responses": { "200": { "description": "フォルダに含まれるファイル、フォルダ、およびウェブリンクのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "403": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folders", "tags": [ "Folders" ] } }, "/folders": { "post": { "operationId": "post_folders", "summary": "フォルダを作成", "description": "指定した親フォルダ内に空のフォルダを新規に作成します。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "新しいフォルダの名前。\n\nフォルダ名には、印刷不可能なASCII文字、スラッシュ、バックスラッシュ (`/`、`\\`) を含む名前、末尾にスペースを含む名前、`.`および`..`という名前は使用できないという制限が適用されます。\n\nフォルダ名はその親フォルダ内で一意である必要があります。名前のチェックでは大文字と小文字が区別されないため、`New Folder`という名前のフォルダは、`new folder`というフォルダがすでに含まれている親フォルダ内に作成できません。", "type": "string", "example": "New Folder", "maxLength": 255, "minLength": 1 }, "parent": { "description": "新しいフォルダの作成先となる親フォルダ。", "type": "object", "properties": { "id": { "description": "親フォルダのID。", "type": "string", "example": "0" } }, "required": [ "id" ] }, "folder_upload_email": { "allOf": [ { "title": "フォルダアップロードメール", "type": "object", "description": "書き込みフォルダアップロードメールオブジェクト。", "properties": { "access": { "description": "このパラメータが設定されている場合、ユーザーは、このフォルダに対して自動的に作成されたメールアドレスに メールでファイルを送信できます。\n\nメールアドレスを作成するには、フォルダを作成するとき、または更新するときにこのプロパティを設定します。\n\n`collaborators`に設定すると、コラボレータの登録済み メールアドレスからのメールのみが受け入れられます。これには、ユーザーが登録しているすべてのメールエイリアスも含まれます。\n\n`open`に設定すると、どのメールアドレスからのメールでも受け入れられます。", "type": "string", "example": "open", "enum": [ "open", "collaborators" ], "nullable": false } } }, { "description": "このオブジェクトを設定するとアップロードメールアドレスが有効になります。\n\nユーザーはこのメールアドレスを使用することにより、メールを介してフォルダにファイルを直接アップロードできます。" } ] }, "sync_state": { "description": "フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。これはBox Sync (廃止済み) で使用され、Box Driveでは 使用されません。", "type": "string", "example": "synced", "enum": [ "synced", "not_synced", "partially_synced" ], "nullable": false } }, "required": [ "name", "parent" ] } } } }, "responses": { "201": { "description": "フォルダオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `bad_request` - パラメータが指定されていないか誤っている場合に返されます。\n* `item_name_too_long` - フォルダ名が長すぎる場合に返されます。\n* `item_name_invalid` - フォルダ名に無効な文字が含まれている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーにこのアクションを実行するためのアクセス権限がない場合にエラーは返します。これは、ユーザーにフォルダまたは親フォルダへのアクセス権限がないか、アプリケーションにファイルおよびフォルダへの書き込み権限がないことが原因となっている可能性があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "親フォルダが見つからないか、認証済みユーザーが親フォルダにアクセスできない場合はエラーを返します。\n\n* `not_found` - 認証済みユーザーが親フォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "`operation_blocked_temporary`: 別の移動、コピー、削除、または復元操作が進行中であるために宛先フォルダまたは元のフォルダがロックされている場合に返されます。\n\n操作は後で再試行することができます。\n\n`item_name_in_use`: この名前のフォルダがすでに親フォルダ内に存在している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folders", "tags": [ "Folders" ] } }, "/folders/{folder_id}/copy": { "post": { "operationId": "post_folders_id_copy", "summary": "フォルダをコピー", "description": "フォルダのコピーを宛先フォルダ内に作成します。\n\n元のフォルダは変更されません。", "parameters": [ { "name": "folder_id", "in": "path", "description": "コピーするフォルダの一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nIDが`0`のルートフォルダはコピーできません。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "0" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "コピーされたフォルダの新しい名前 (省略可)。\n\nファイル名にはいくつかの制約があります。印刷不可能なASCII文字、スラッシュ、およびバックスラッシュ (`/`、`\\`) を含む名前、または末尾にスペースを含む名前は禁止されています。\n\nまた、`.`および`..`という名前も使用できません。", "type": "string", "example": "New Folder", "maxLength": 255, "minLength": 1 }, "parent": { "description": "フォルダのコピー先となる宛先フォルダ。", "type": "object", "properties": { "id": { "description": "親フォルダのID。", "type": "string", "example": "0" } }, "required": [ "id" ] } }, "nullable": false, "required": [ "parent" ] } } } }, "responses": { "201": { "description": "コピーされたフォルダを表す新しいフォルダオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" } } } }, "304": { "description": "`If-None-Match`ヘッダーがフォルダの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。" }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `bad_request` - パラメータが指定されていない場合に返されます。\n* `item_name_too_long` - 新しいフォルダ名が長すぎる場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーにフォルダをコピーするための適切な権限がない場合にエラーを返します。\n\n* `forbidden_by_policy`: 情報バリアの制限によりフォルダのコピーが禁止されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "元のフォルダまたは宛先フォルダのどちらも見つからないか、認証済みユーザーがどちらのフォルダにもアクセスできない場合はエラーを返します。\n\n* `not_found` - 認証済みユーザーが親フォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "宛先フォルダにこの名前のフォルダがすでに存在している場合、または宛先フォルダがロックされている場合はエラーを返します\n\n* `item_name_in_use` - 同じ名前のフォルダがすでに存在している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "ルートフォルダをコピーしようとした場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folders", "tags": [ "Folders" ] } }, "/folders/{folder_id}/collaborations": { "get": { "operationId": "get_folders_id_collaborations", "summary": "フォルダコラボレーションのリストを取得", "description": "フォルダでの保留中のコラボレーションとアクティブなコラボレーションのリストを取得します。そのフォルダに対するアクセス権限を持つか、そのフォルダに招待されているすべてのユーザーを返します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "コラボレーションオブジェクトのコレクションを返します。このフォルダでのコラボレーションが存在しない場合は、空のコレクションが返されます。\n\nこのリストには、`status`が`pending`に設定されている保留中のコラボレーションが含まれます。これは、招待が送信されたもののまだ承認されていないことを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collaborations" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "list_collaborations", "tags": [ "コラボレーション (リスト)" ] } }, "/folders/{folder_id}/trash": { "get": { "operationId": "get_folders_id_trash", "summary": "ごみ箱内のフォルダを取得", "description": "ごみ箱に移動されたフォルダを取得します。\n\nそのフォルダ自体がごみ箱に移動されている場合のみ、このAPIコールを使用して取得できることに注意してください。そうではなく、その親フォルダのいずれかがごみ箱に移動された場合、[`GET /folders/:id/trash`](e://get_folders_id_trash) APIを使用して調べることができるのは、そのフォルダのみです。\n\nごみ箱に移動されたすべての項目のリストを取得するには、[`GET /folders/trash/items`](e://get-folders-trash-items/) APIを使用します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "ごみ箱に移動された日時の情報を含め、ごみ箱内にあるフォルダを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashFolder" } } } }, "404": { "description": "フォルダがごみ箱で直接見つからない場合にエラーを返します。\n\nそのフォルダの親フォルダのいずれかがごみ箱に移動されている場合も、`HTTP 404`が返されることに注意してください。\n\nその場合、[`GET /folders/:id/trash`](e://get_folders_id_trash) APIを使用して調べることができるのは、その親フォルダのみです。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_folders", "tags": [ "ごみ箱内のフォルダ" ] }, "delete": { "operationId": "delete_folders_id_trash", "summary": "フォルダを完全に削除", "description": "ごみ箱内にあるフォルダを完全に削除します。この操作は元に戻すことができません。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "204": { "description": "フォルダが完全に削除された場合は、空のレスポンスを返します。" }, "404": { "description": "フォルダがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_folders", "tags": [ "ごみ箱内のフォルダ" ] } }, "/folders/{folder_id}/metadata": { "get": { "operationId": "get_folders_id_metadata", "summary": "フォルダのメタデータインスタンスのリストを取得", "description": "指定したフォルダのすべてのメタデータを取得します。これは、IDが`0`のルートフォルダでは使用できません。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "200": { "description": "フォルダに関連付けられたすべてのメタデータを返します。\n\nこのAPIはページ割りをサポートしていないため、常にフォルダに関連付けられたすべてのメタデータを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadatas" } } } }, "403": { "description": "リクエストパラメータが無効な場合に返されます。\n\n* `forbidden` - この操作はルートフォルダで許可されていません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_metadata", "tags": [ "メタデータインスタンス (フォルダ)" ] } }, "/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo": { "get": { "operationId": "get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "フォルダの分類を取得", "description": "フォルダに適用されている分類メタデータインスタンスを取得します。\n\nこのAPIは、`/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "200": { "description": "`securityClassification`メタデータテンプレートのインスタンスを返します。これには、この会社が使用できるすべての分類のリストを取得する`Box__Security__Classification__Key`フィールドが含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" } } } }, "403": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定したメタデータテンプレートがこのフォルダに適用されていない場合、またはユーザーがこのフォルダにアクセスできない場合に返されます。\n\n* `instance_not_found` - メタデータテンプレートがフォルダに適用されていなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_classifications", "tags": [ "フォルダの分類" ] }, "post": { "operationId": "post_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "フォルダに分類を追加", "description": "追加する分類のラベルを指定することで、フォルダに分類を追加します。\n\nこのAPIは、`/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Box__Security__Classification__Key": { "description": "このフォルダに適用する分類の名前。\n\n会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される[分類テンプレート](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)を取得します。", "type": "string", "example": "Sensitive" } } } } } }, "responses": { "201": { "description": "フォルダに適用された分類テンプレートインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。\n\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできません。\n* `instance_tuple_not_found` - メタデータテンプレートが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "このメタデータテンプレートのインスタンスがすでにフォルダに存在する場合はエラーを返します。\n\n* `tuple_already_exists` - メタデータテンプレートのインスタンスがすでにフォルダに存在する場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_classifications", "tags": [ "フォルダの分類" ] }, "put": { "operationId": "put_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "フォルダの分類を更新", "description": "フォルダの分類を更新します。\n\n分類を更新できるのは、分類がすでにフォルダに適用されている場合のみです。分類を編集する際は、会社に対して定義されている値のみを使用できます。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "分類ラベルを更新するために加える1つの変更を含むリスト。", "type": "array", "items": { "type": "object", "description": "分類メタデータテンプレートのインスタンスに対して実行する操作。この場合、`Box__Security__Classification__Key`フィールドに格納された値を新しい値で置き換えるために使用されます。", "required": [ "op", "path", "value" ], "properties": { "op": { "description": "値は常に`replace`になります。", "type": "string", "example": "replace", "enum": [ "replace" ] }, "path": { "description": "企業で使用できる分類を定義します。", "type": "string", "example": "/Box__Security__Classification__Key", "enum": [ "/Box__Security__Classification__Key" ] }, "value": { "description": "このフォルダに適用する分類の名前。\n\n会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される[分類テンプレート](e://get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema)を取得します。", "type": "string", "example": "Sensitive" } } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "更新された分類メタデータテンプレートインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Classification" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `bad_request` - リクエスト本文の形式が有効なJSON Patch操作の配列ではありません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "リクエスト本文が有効なJSON Patch項目の配列でない場合、一部のエッジケースでエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_classifications", "tags": [ "フォルダの分類" ] }, "delete": { "operationId": "delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo", "summary": "フォルダから分類を削除", "description": "フォルダからすべての分類を削除します。\n\nこのAPIは、`/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "204": { "description": "分類が正常に削除された場合は空のレスポンスを返します。" }, "400": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダに分類が適用されていない場合、またはユーザーがフォルダにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - 分類メタデータテンプレートのインスタンスがこのフォルダに見つかりませんでした。\n* `not_found` - フォルダが見つからなかったか、ユーザーがフォルダにアクセスできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_classifications", "tags": [ "フォルダの分類" ] } }, "/folders/{folder_id}/metadata/{scope}/{template_key}": { "get": { "operationId": "get_folders_id_metadata_id_id", "summary": "フォルダのメタデータインスタンスを取得", "description": "フォルダに適用されているメタデータテンプレートのインスタンスを取得します。これは、IDが`0`のルートフォルダでは使用できません。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "responses": { "201": { "description": "ユーザーまたはアプリケーションによって定義された追加の「キー/値」ペアを含むメタデータテンプレートのインスタンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata--Full" } } } }, "403": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定したメタデータテンプレートがこのフォルダに適用されていない場合、またはユーザーがこのフォルダにアクセスできない場合に返されます。\n\n* `instance_not_found` - メタデータテンプレートがフォルダに適用されていなかった場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。これは、フォルダIDが無効であるか、IDが`0`のルートフォルダである場合によく発生します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_metadata", "tags": [ "メタデータインスタンス (フォルダ)" ] }, "post": { "operationId": "post_folders_id_metadata_id_id", "summary": "フォルダにメタデータインスタンスを作成", "description": "メタデータテンプレートのインスタンスをフォルダに適用します。\n\nほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できる`global.properties`テンプレートは除きます。\n\nBoxウェブアプリでメタデータテンプレートを表示するために、企業では、管理コンソールでユーザーの \\[**フォルダレベルメタデータのカスケード**] を有効にするよう設定する必要があります。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "name": "Aaron Levie" }, "additionalProperties": { "allOf": [ {}, { "example": "Aaron Levie" }, { "description": "メタデータテンプレートに存在する各フィールドの値。`global.properties`テンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。" } ] }, "x-box-example-key": "name" } } } }, "responses": { "201": { "description": "テンプレートに適用されたデータを含む、フォルダに適用されたテンプレートのインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata--Full" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataError" } } } }, "404": { "description": "フォルダテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。\n\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできません。\n* `instance_tuple_not_found` - メタデータテンプレートが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "このメタデータテンプレートのインスタンスがすでにフォルダに存在する場合はエラーを返します。\n\n* `tuple_already_exists` - メタデータテンプレートのインスタンスがすでにフォルダに存在する場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_metadata", "tags": [ "メタデータインスタンス (フォルダ)" ], "x-box-enable-explorer": false }, "put": { "operationId": "put_folders_id_metadata_id_id", "summary": "フォルダのメタデータインスタンスを更新", "description": "フォルダのメタデータを更新します。\n\nメタデータインスタンスを更新できるのは、テンプレートがすでにフォルダに適用されている場合のみです。メタデータを編集する際には、メタデータテンプレートのスキーマに一致した値のみを使用できます。\n\n更新はアトミックに適用されます。操作の適用中にエラーが発生した場合、メタデータインスタンスは変更されません。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "メタデータインスタンスに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)の指定。\n\n変更は操作オブジェクトのJSON配列として表されます。", "type": "array", "items": { "title": "メタデータインスタンスの更新操作", "description": "メタデータインスタンスに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)操作。", "type": "object", "properties": { "op": { "description": "テンプレートに対して実行する変更のタイプ。その中には、既存のテンプレートを変更する際に危険を伴うものもあります。", "type": "string", "example": "add", "enum": [ "add", "replace", "remove", "test", "move", "copy" ] }, "path": { "description": "変更を適用するメタデータJSONオブジェクト内の場所を、[JSON-Pointer](https://tools.ietf.org/html/rfc6901)の形式で指定します。\n\nパスの先頭にはテンプレートのルートを表す`/`を必ず付ける必要があります。文字`~`と`/`は予約文字であるため、キー内ではエスケープする必要があります。", "type": "string", "example": "/currentState" }, "value": { "$ref": "#/components/schemas/MetadataInstanceValue" }, "from": { "description": "値の移動元またはコピー元であるメタデータJSONオブジェクト内の場所。`move`または`copy`操作には必須であり、[JSON-Pointer](https://tools.ietf.org/html/rfc6901)の形式である必要があります。", "type": "string", "example": "/nextState" } } } } } } }, "responses": { "200": { "description": "カスタムテンプレートデータを含め、更新されたメタデータテンプレートインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Metadata--Full" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `bad_request` - リクエスト本文の形式が有効なJSON Patchオブジェクトの配列ではありません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "リクエスト本文が有効なJSON Patch項目の配列でない場合、一部のエッジケースでエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_metadata", "tags": [ "メタデータインスタンス (フォルダ)" ] }, "delete": { "operationId": "delete_folders_id_metadata_id_id", "summary": "フォルダからメタデータインスタンスを削除", "description": "フォルダのメタデータを削除します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "responses": { "204": { "description": "メタデータが正常に削除された場合は空のレスポンスを返します。" }, "400": { "description": "リクエストのパラメータが無効な場合に返されます。これは、`scope`が無効な場合に発生する可能性があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダにメタデータテンプレートのインスタンスが適用されていない場合、またはユーザーがフォルダにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - 指定された`scope`および`templateKey`を持つメタデータテンプレートのインスタンスがこのフォルダに見つかりませんでした。\n* `not_found` - フォルダが見つからなかったか、ユーザーがフォルダにアクセスできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "メソッドが許可されなかった場合に返されます。これは、フォルダIDが無効であるか、IDが`0`のルートフォルダである場合によく発生します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_metadata", "tags": [ "メタデータインスタンス (フォルダ)" ] } }, "/folders/trash/items": { "get": { "operationId": "get_folders_trash_items", "summary": "ごみ箱内の項目のリストを取得", "description": "ごみ箱に移動されたファイルとフォルダを取得します。\n\n`fields`パラメータを使用して完全版のファイルオブジェクトまたはフォルダオブジェクト内の任意の属性を渡すと、デフォルトでは返されない特定の属性を取得できます。\n\nこのエンドポイントはデフォルトでオフセットベースのページ割りを使用しますが、`marker`パラメータを使用したマーカーベースのページ割りもサポートしています。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "name": "usemarker", "in": "query", "description": "オフセットベースのページ割り方式ではなくマーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は1つのみです。\n\nこの値をtrueに設定すると、APIは、レスポンスの次のページを取得するために、このエンドポイントにパラメータとして渡すことができる`marker`フィールドを返します。", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "direction", "in": "query", "description": "結果を並べ替える方向。アルファベットの昇順 (`ASC`) または降順 (`DESC`) のいずれかを指定できます。", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" }, { "name": "sort", "in": "query", "description": "項目並べ替えの**2番目**の基準として使用される属性を定義します。\n\n項目は必ず最初に`type`を基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。\n\nマーカーベースのページ割りを使用している場合、このパラメータはサポートされません。", "required": false, "schema": { "type": "string", "enum": [ "name", "date", "size" ] }, "example": "name" } ], "responses": { "200": { "description": "削除された項目のリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Items" } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `invalid_parameter`は、マーカーベースのページ割りの使用時に`sort`、`direction`、または`offset`パラメータを指定した場合か、`marker`パラメータが指定されているのに`usemarker`が`false`または`null`に設定されている場合に返されることがあります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_items", "tags": [ "ごみ箱内の項目" ] } }, "/folders/{folder_id}/watermark": { "get": { "operationId": "get_folders_id_watermark", "summary": "フォルダの電子すかしを取得", "description": "フォルダの電子すかしを取得します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "200": { "description": "このフォルダに関連付けられている電子すかしに関する情報を含むオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watermark" } } } }, "404": { "description": "フォルダに電子すかしが適用されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_watermarks", "tags": [ "電子すかし (フォルダ)" ] }, "put": { "operationId": "put_folders_id_watermark", "summary": "フォルダに電子すかしを適用", "description": "フォルダの電子すかしを適用または更新します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "watermark": { "description": "フォルダに適用する電子すかし。", "type": "object", "properties": { "imprint": { "description": "適用する電子すかしのタイプ。\n\n現在サポートされているオプションは1つのみです。", "type": "string", "example": "default", "enum": [ "default" ] } }, "required": [ "imprint" ] } }, "required": [ "watermark" ] } } } }, "responses": { "200": { "description": "このフォルダに電子すかしがすでに適用されている場合は、更新された電子すかしを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watermark" } } } }, "201": { "description": "このフォルダにまだ電子すかしが適用されていない場合は、新しい電子すかしを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Watermark" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_watermarks", "tags": [ "電子すかし (フォルダ)" ] }, "delete": { "operationId": "delete_folders_id_watermark", "summary": "フォルダから電子すかしを削除", "description": "フォルダから電子すかしを削除します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "204": { "description": "電子すかしが正常に削除された場合は、空のレスポンスが返されます。" }, "404": { "description": "フォルダに電子すかしが適用されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_watermarks", "tags": [ "電子すかし (フォルダ)" ] } }, "/folder_locks": { "get": { "operationId": "get_folder_locks", "summary": "フォルダロックのリストを取得", "description": "指定したフォルダのフォルダロックの詳細を取得します。\n\nこのエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。", "parameters": [ { "name": "folder_id", "in": "query", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "200": { "description": "フォルダに適用されたすべてのフォルダロックの詳細 (ロックの種類やロックを適用したユーザーを含む) を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderLocks" } } } }, "403": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_locks", "tags": [ "フォルダロック" ] }, "post": { "operationId": "post_folder_locks", "summary": "フォルダロックを作成", "description": "フォルダにフォルダロックを作成し、フォルダが移動または削除されないようにします。\n\nこのエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "locked_operations": { "description": "フォルダをロックする操作。`locked_operations`がリクエストに含まれている場合は、`move`と`delete`の両方も含めたうえで、どちらも`true`に設定する必要があります。", "type": "object", "properties": { "move": { "description": "フォルダの移動をロックするかどうか。", "type": "boolean", "example": true }, "delete": { "description": "フォルダの削除をロックするかどうか。", "example": true, "type": "boolean" } }, "required": [ "move", "delete" ] }, "folder": { "description": "ロックの適用先となるフォルダ。", "type": "object", "properties": { "type": { "description": "ロックが適用されているコンテンツタイプ。`folder`のみがサポートされています。", "type": "string", "example": "folder" }, "id": { "description": "フォルダのID。", "type": "string", "example": "1234567890" } }, "required": [ "type", "id" ] } }, "required": [ "folder" ] } } } }, "responses": { "200": { "description": "ロックを適用したユーザーや設定された操作など、フォルダに適用されたフォルダロックのインスタンスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderLock" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからなかった場合にエラーを返します。\n\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできないか、または呼び出しを行うユーザーがフォルダの所有者または共同所有者ではない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_locks", "tags": [ "フォルダロック" ], "x-box-enable-explorer": false } }, "/folder_locks/{folder_lock_id}": { "delete": { "operationId": "delete_folder_locks_id", "summary": "フォルダロックを削除", "description": "指定したフォルダに適用されているフォルダロックを削除します。\n\nこのエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。", "parameters": [ { "name": "folder_lock_id", "in": "path", "description": "フォルダロックのID。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" } ], "responses": { "204": { "description": "フォルダロックが正常に削除された場合は、空のレスポンスを返します。" }, "403": { "description": "ユーザーにこのアクションを実行するためのアクセス権限がない場合はエラーを返します。\n\n* `access_denied_insufficient_permissions`: ユーザーにフォルダへのアクセス権限がない場合に返されます。\n\n* `insufficient_scope`: アプリケーションにフォルダを削除するための適切なスコープがない場合にエラーが返されます。Boxに格納されているすべてのファイルとフォルダに対して読み取りと書き込みを行えるようにアプリケーションが設定されていることを確認してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからないか、認証済みユーザーが親フォルダにアクセスできない場合は、エラーを返します。\n\n* `not_found` - 認証済みユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "folder_locks", "tags": [ "フォルダロック" ] } }, "/metadata_templates": { "get": { "operationId": "get_metadata_templates", "summary": "インスタンスIDでメタデータテンプレートを検索", "description": "テンプレートのインスタンスのIDを検索することにより、メタデータテンプレートを見つけます。", "parameters": [ { "name": "metadata_instance_id", "in": "query", "description": "検索するメタデータテンプレートのインスタンスのID。", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "01234500-12f1-1234-aa12-b1d234cb567e" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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": "インスタンスIDと一致する1つのメタデータテンプレートを含むリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataTemplates" } } } }, "400": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] } }, "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema": { "get": { "operationId": "get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema", "summary": "すべての分類のリストを取得", "description": "分類メタデータテンプレートを取得し、この会社が使用できるすべての分類のリストを取得します。\n\nこのAPIは、`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "responses": { "200": { "description": "`securityClassification`メタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得する`Box__Security__Classification__Key`フィールドが含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationTemplate" } } } }, "400": { "description": "リクエストパラメータのいずれかが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "classifications", "tags": [ "Classifications" ] } }, "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add": { "put": { "operationId": "put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#add", "summary": "分類を追加", "description": "会社が使用できる分類のリストに1つ以上の新しい分類を追加します。\n\nこのAPIは、`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "requestBody": { "content": { "application/json": { "schema": { "description": "会社の分類のリストに追加する1つ以上の分類を含む配列。", "type": "array", "items": { "type": "object", "description": "会社に追加する1つの分類。", "required": [ "op", "fieldKey", "data" ], "properties": { "op": { "description": "分類オブジェクトに対して実行する変更の種類。", "type": "string", "example": "addEnumOption", "enum": [ "addEnumOption" ] }, "fieldKey": { "description": "企業で使用できる分類を定義します。", "type": "string", "example": "Box__Security__Classification__Key", "enum": [ "Box__Security__Classification__Key" ] }, "data": { "description": "追加する分類の詳細。", "type": "object", "properties": { "key": { "description": "ウェブインターフェースおよびモバイルインターフェースに表示される分類のラベル。これは、分類を追加するために必要な唯一のフィールドです。", "type": "string", "example": "Sensitive" }, "staticConfig": { "description": "分類の静的な構成。", "type": "object", "properties": { "classification": { "description": "分類の追加情報。", "type": "object", "properties": { "classificationDefinition": { "description": "分類の詳しい説明。", "type": "string", "example": "Sensitive information that must not be shared." }, "colorID": { "description": "分類ラベルに色を割り当てる際に使用される内部のBox識別子。\n\n`colorID`と色の間のマッピングは予告なしに変更される場合があります。現在、色のマッピングは以下のとおりです。\n\n* `0`: 黄。\n* `1`: オレンジ。\n* `2`: 赤。\n* `3`: 紫。\n* `4`: ライトブルー。\n* `5`: ダークブルー。\n* `6`: ライトグリーン。\n* `7`: グレー。", "type": "integer", "format": "int64", "example": 4 } } } } } }, "required": [ "key" ] } } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "更新された`securityClassification`メタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得する`Box__Security__Classification__Key`フィールドが含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationTemplate" } } } }, "400": { "description": "リクエストパラメータのいずれかが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "classifications", "tags": [ "Classifications" ] } }, "/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update": { "put": { "operationId": "put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#update", "summary": "分類を更新", "description": "会社が使用できる1つ以上の分類のラベルと説明を更新します。\n\nこのAPIは、`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。", "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "更新する1つ以上の分類を含む配列。", "type": "array", "items": { "type": "object", "description": "更新する1つの分類。", "required": [ "op", "fieldKey", "enumOptionKey", "data" ], "properties": { "op": { "description": "分類オブジェクトに対して実行する変更の種類。", "type": "string", "example": "editEnumOption", "enum": [ "editEnumOption" ] }, "fieldKey": { "description": "企業で使用できる分類を定義します。", "type": "string", "example": "Box__Security__Classification__Key", "enum": [ "Box__Security__Classification__Key" ] }, "enumOptionKey": { "description": "変更する分類の元のラベル。", "type": "string", "example": "Sensitive" }, "data": { "description": "更新された分類の詳細。", "type": "object", "properties": { "key": { "description": "ウェブインターフェースおよびモバイルインターフェースに表示される、分類の新しいラベル。", "type": "string", "example": "Very Sensitive" }, "staticConfig": { "description": "分類の静的な構成。", "type": "object", "properties": { "classification": { "description": "分類の追加情報。", "type": "object", "properties": { "classificationDefinition": { "description": "分類の詳しい説明。", "type": "string", "example": "Sensitive information that must not be shared." }, "colorID": { "description": "分類ラベルに色を割り当てる際に使用される内部のBox識別子。\n\n`colorID`と色の間のマッピングは予告なしに変更される場合があります。現在、色のマッピングは以下のとおりです。\n\n* `0`: 黄。\n* `1`: オレンジ。\n* `2`: 赤。\n* `3`: 紫。\n* `4`: ライトブルー。\n* `5`: ダークブルー。\n* `6`: ライトグリーン。\n* `7`: グレー。", "type": "integer", "format": "int64", "example": 4 } } } } } }, "required": [ "key" ] } } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "更新された`securityClassification`メタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得する`Box__Security__Classification__Key`フィールドが含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationTemplate" } } } }, "400": { "description": "リクエストパラメータのいずれかが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "classifications", "tags": [ "Classifications" ] } }, "/metadata_templates/{scope}/{template_key}/schema": { "get": { "operationId": "get_metadata_templates_id_id_schema", "summary": "名前を指定してメタデータテンプレートを取得", "description": "`scope`と`templateKey`の値でメタデータテンプレートを取得します。\n\nテンプレートの`scope`と`templateKey`を調べるには、会社のすべてのテンプレートまたはグローバルテンプレートのリストを取得するか、ファイルまたはフォルダに適用されているすべてのテンプレートのリストを取得します。", "parameters": [ { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "responses": { "200": { "description": "`scope`および`template`の名前と一致するメタデータテンプレートを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataTemplate" } } } }, "400": { "description": "リクエストパラメータのいずれかが無効な場合に返されます。\n\n* `bad_request`: テンプレートのスコープが認識されていない場合によく返されます。`scope`の値として必ず`enterprise`または`global`を使用してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定された`scope`および`template_key`を持つテンプレートが見つからない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] }, "put": { "operationId": "put_metadata_templates_id_id_schema", "summary": "メタデータテンプレートを更新", "description": "メタデータテンプレートを更新します。\n\nメタデータテンプレートを更新できるのは、テンプレートがすでに存在する場合のみです。\n\n更新はアトミックに適用されます。操作の適用中にエラー場が発生した場合、メタデータテンプレートは変更されません。", "parameters": [ { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "description": "メタデータテンプレートに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)の指定。\n\n変更は操作オブジェクトのJSON配列として表されます。", "type": "array", "items": { "title": "メタデータテンプレートの更新操作", "description": "メタデータインスタンスに変更を加えるための[JSON-Patch](https://tools.ietf.org/html/rfc6902)操作。", "type": "object", "required": [ "op" ], "properties": { "op": { "description": "テンプレートに対して実行する変更のタイプ。その中には、既存のテンプレートを変更する際に危険を伴うものもあります。", "type": "string", "example": "addEnumOption", "enum": [ "editTemplate", "addField", "reorderFields", "addEnumOption", "reorderEnumOptions", "reorderMultiSelectOptions", "addMultiSelectOption", "editField", "removeField", "editEnumOption", "removeEnumOption", "editMultiSelectOption", "removeMultiSelectOption" ] }, "data": { "description": "操作するデータ。これは、実行される操作によって異なります。", "type": "object", "example": { "name": "Aaron Levie" }, "additionalProperties": { "allOf": [ {}, { "example": "Aaron Levie" }, { "description": "メタデータテンプレートに存在する各フィールドの値。`global.properties`テンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。" } ], "x-box-example-key": "name" } }, "fieldKey": { "description": "1つのフィールドに影響する操作の場合は、影響を受けるフィールドのキーを定義します。", "type": "string", "example": "category" }, "fieldKeys": { "description": "複数のフィールドに影響する操作の場合は、影響を受けるフィールドのキーを定義します。", "type": "array", "items": { "type": "string" }, "example": [ "category", "name" ] }, "enumOptionKey": { "description": "1つの`enum`オプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。", "type": "string", "example": "option1" }, "enumOptionKeys": { "description": "複数の`enum`オプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。", "type": "array", "items": { "type": "string" }, "example": [ "option1", "option2", "option3" ] }, "multiSelectOptionKey": { "description": "1つの複数選択オプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。", "type": "string", "example": "option1" }, "multiSelectOptionKeys": { "description": "複数の複数選択オプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。", "type": "array", "items": { "type": "string" }, "example": [ "option1", "option2", "option3" ] } } } } } } }, "responses": { "200": { "description": "カスタムテンプレートデータを含め、更新されたメタデータテンプレートを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataTemplate" } } } }, "400": { "description": "リクエスト本文に有効なメタデータスキーマが含まれていません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーがテンプレートを作成できないスコープがリクエスト本文に含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "リクエストしたテンプレートが見つかりませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] }, "delete": { "operationId": "delete_metadata_templates_id_id_schema", "summary": "メタデータテンプレートを削除", "description": "メタデータテンプレートとそのインスタンスを削除します。これは完全削除であり、元に戻すことはできません。", "parameters": [ { "name": "scope", "in": "path", "description": "メタデータテンプレートのスコープ。", "required": true, "schema": { "type": "string", "enum": [ "global", "enterprise" ] }, "example": "global" }, { "name": "template_key", "in": "path", "description": "メタデータテンプレートの名前。", "required": true, "schema": { "type": "string" }, "example": "properties" } ], "responses": { "204": { "description": "メタデータテンプレートが正常に削除された場合は、空のレスポンスを返します。" }, "400": { "description": "リクエスト本文に有効なメタデータスキーマが含まれていません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーがテンプレートを作成できないスコープがリクエスト本文に含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] } }, "/metadata_templates/{template_id}": { "get": { "operationId": "get_metadata_templates_id", "summary": "IDを指定してメタデータテンプレートを取得", "description": "IDを指定してメタデータテンプレートを取得します。", "parameters": [ { "name": "template_id", "in": "path", "description": "テンプレートのID。", "required": true, "schema": { "type": "string" }, "example": "f7a9891f" } ], "responses": { "200": { "description": "IDと一致するメタデータテンプレートを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataTemplate" } } } }, "400": { "description": "リクエストパラメータのいずれかが無効な場合に返されます。\n\n* `bad_request`: テンプレートのIDが認識されていない場合によくメッセージとともに返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataTemplate" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] } }, "/metadata_templates/global": { "get": { "operationId": "get_metadata_templates_global", "summary": "すべてのグローバルメタデータテンプレートのリストを取得", "description": "Boxを使用するすべての会社が利用できる、すべての汎用グローバルメタデータテンプレートを取得する場合に使用します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/MetadataTemplates" } } } }, "400": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] } }, "/metadata_templates/enterprise": { "get": { "operationId": "get_metadata_templates_enterprise", "summary": "企業のすべてのメタデータテンプレートのリストを取得", "description": "特にユーザーの企業内で使用するために作成されたメタデータテンプレートをすべて取得する場合に使用します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/MetadataTemplates" } } } }, "400": { "description": "リクエストパラメータが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ] } }, "/metadata_templates/schema": { "post": { "operationId": "post_metadata_templates_schema", "summary": "メタデータテンプレートを作成", "description": "ファイルやフォルダに適用可能な新しいメタデータテンプレートを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "description": "作成するメタデータテンプレートのスコープ。アプリケーションで作成できるのは、認証済みユーザーの会社内で使用するテンプレートのみです。\n\nこの値は`enterprise`に設定する必要があります。`global`スコープはアプリケーションで作成できないからです。", "type": "string", "example": "enterprise" }, "templateKey": { "description": "テンプレートの一意の識別子。この識別子は、メタデータテンプレート作成の対象となる会社全体で一意である必要があります。\n\n指定しなかった場合、APIにより`displayName`の値に基づいて一意の`templateKey`が作成されます。", "type": "string", "example": "productInfo", "maxLength": 64, "pattern": "^[a-zA-Z_][-a-zA-Z0-9_]*$" }, "displayName": { "description": "テンプレートの表示名。", "type": "string", "example": "Product Info", "maxLength": 4096 }, "hidden": { "description": "このテンプレートをBoxウェブアプリのUIに表示するか、APIを介した使用のみを目的とするかを定義します。", "type": "boolean", "example": true, "default": false }, "fields": { "description": "テンプレートに含まれるテンプレートフィールドの順序付きリスト。各フィールドは、通常のテキストフィールド、日付フィールド、数値フィールド、単一または複数選択リストのいずれかになります。", "type": "array", "items": { "title": "メタデータフィールド (書き込み)", "description": "メタデータテンプレート内のフィールド。フィールドは、基本テキスト、日付、または数値フィールドか、オプションのリストのいずれかになります。", "required": [ "type", "key", "displayName" ], "type": "object", "properties": { "type": { "description": "フィールドのタイプ。基本のフィールドは、テキストを表す`string`フィールド、数値を表す`float`フィールド、およびユーザーに日時選択機能を表示するための`date`フィールドです。\n\nさらに、メタデータテンプレートは、基本の項目リストを表す`enum`フィールドのほか、ユーザーが複数の値を選択できる同様の項目リストを表す` multiSelect`フィールドをサポートしています。", "type": "string", "example": "string", "enum": [ "string", "float", "date", "enum", "multiSelect" ] }, "key": { "description": "フィールドの一意の識別子。この識別子は、そのフィールドが属するテンプレート内で一意である必要があります。", "type": "string", "example": "category", "maxLength": 256 }, "displayName": { "description": "ウェブアプリおよびモバイルアプリでユーザーに表示されるフィールドの表示名。", "type": "string", "example": "Category", "maxLength": 4096 }, "description": { "description": "フィールドの説明。ユーザーには表示されません。", "type": "string", "example": "The category", "maxLength": 4096 }, "hidden": { "description": "このフィールドをUI上でユーザーに対して非表示にし、代わりにAPIを介してのみ設定できるようにするかどうか。", "type": "boolean", "example": true }, "options": { "description": "このフィールドのオプションのリスト。`enum`および`multiSelect`フィールドタイプと組み合わせて使用します。", "type": "array", "items": { "title": "メタデータオプション (書き込み)", "type": "object", "description": "メタデータテンプレートフィールドのオプション。\n\nオプションは、`enum`タイプおよび`multiSelect`タイプのフィールドのみに指定する必要があります。オプションは、ユーザーがUIまたはAPIを介してそのフィールドに選択できる値を表します。", "required": [ "key" ], "properties": { "key": { "description": "オプションのテキスト値。オプションの表示名と、テンプレートの更新時に使用される内部キーの両方を表します。", "type": "string", "example": "Category 1" } } } } } } }, "copyInstanceOnItemCopy": { "description": "ファイルまたはフォルダをコピーするときに、追加されているメタデータをコピーするかどうか。デフォルトでは、ファイルまたはフォルダのコピー時に、メタデータは一緒にコピーされません。", "type": "boolean", "example": true, "default": false } }, "required": [ "scope", "displayName" ] } } } }, "responses": { "201": { "description": "作成されたメタデータテンプレートを表すスキーマ。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataTemplate" } } } }, "400": { "description": "リクエストのパラメータまたは本文が無効な場合に返されます。\n\n* `bad_request` - 本文に有効なリクエストが含まれていない場合に返されます。多くの場合、このレスポンスには、不足しているフィールドに関する追加の詳細が含まれます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーにメタデータテンプレートを作成する権限がない場合に返されます。その理由はいくつかありますが、最も一般的なのは、ユーザーが (共同) 管理者権限を持っていないこと、またはアプリケーションが`global`スコープのテンプレートを作成しようとしていることです。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_templates", "tags": [ "メタデータテンプレート" ], "x-box-requires-admin": true } }, "/metadata_templates/schema#classifications": { "post": { "operationId": "post_metadata_templates_schema#classifications", "summary": "最初の分類を追加", "description": "会社にまだ分類がない場合は、このAPIコールによって、分類テンプレートが最初の一連の分類で初期化されます。\n\n会社にすでに分類がある場合は、テンプレートがすでに存在するため、さらに分類を追加するためにAPIコールが行われます。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "description": "分類を作成するスコープ。これには、`enterprise`または`enterprise_{id}` (`id`は会社の一意のID) を指定する必要があります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "templateKey": { "description": "メタデータテンプレートのリストを定義します。", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ "securityClassification-6VMVochwUWo" ] }, "displayName": { "description": "ウェブインターフェースおよびモバイルインターフェースに表示されるテンプレートの名前。", "type": "string", "example": "Classification", "enum": [ "Classification" ] }, "hidden": { "description": "分類テンプレートをウェブおよびモバイルデバイスで非表示にするか使用可能にするかを決定します。", "type": "boolean", "example": false }, "copyInstanceOnItemCopy": { "description": "ファイルまたはフォルダをコピーするときに分類もコピーするかどうかを決定します。", "type": "boolean", "example": false }, "fields": { "description": "分類テンプレートにはフィールドが1つだけ必要で、このフィールドでは、有効な分類の値がすべて保持されます。", "type": "array", "items": { "required": [ "type", "key", "displayName", "options" ], "type": "object", "description": "有効な分類の値をすべて保持する`enum`フィールド。", "properties": { "type": { "description": "常に列挙型となるフィールドのタイプ。", "type": "string", "example": "enum", "enum": [ "enum" ] }, "key": { "description": "企業で使用できる分類を定義します。", "type": "string", "example": "Box__Security__Classification__Key", "enum": [ "Box__Security__Classification__Key" ] }, "displayName": { "description": "分類の表示名。", "type": "string", "example": "Classification", "enum": [ "Classification" ] }, "hidden": { "description": "分類テンプレートをウェブおよびモバイルデバイスで非表示にするか使用可能にするかを決定します。", "type": "boolean", "example": false }, "options": { "description": "このテンプレートに存在する実際の分類のリスト。", "type": "array", "items": { "required": [ "key" ], "type": "object", "description": "個々の分類。", "properties": { "key": { "description": "この分類の表示名とキー。これはBox UIに表示されます。", "type": "string", "example": "Sensitive" }, "staticConfig": { "description": "分類に関する追加情報。", "type": "object", "properties": { "classification": { "description": "分類に関する追加情報。", "type": "object", "properties": { "classificationDefinition": { "description": "分類の詳しい説明。", "type": "string", "example": "Sensitive information" }, "colorID": { "description": "分類ラベルに色を割り当てる際に使用される識別子。\n\n`colorID`と色の間のマッピングは予告なしに変更される場合があります。現在、色のマッピングは以下のとおりです。\n\n* `0`: 黄。\n* `1`: オレンジ。\n* `2`: 赤。\n* `3`: 紫。\n* `4`: ライトブルー。\n* `5`: ダークブルー。\n* `6`: ライトグリーン。\n* `7`: グレー。", "type": "integer", "format": "int64", "example": 4 } } } } } } } } } } } }, "required": [ "scope", "displayName", "fields", "templateKey" ] } } } }, "responses": { "200": { "description": "新しい`securityClassification`メタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得する`Box__Security__Classification__Key`フィールドが含まれています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassificationTemplate" } } } }, "400": { "description": "リクエストパラメータのいずれかが無効な場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "classifications", "tags": [ "Classifications" ] } }, "/metadata_cascade_policies": { "get": { "operationId": "get_metadata_cascade_policies", "summary": "メタデータカスケードポリシーのリストを取得", "description": "指定したフォルダに適用されているすべてのメタデータカスケードポリシーのリストを取得します。これは、IDが`0`のルートフォルダでは使用できません。", "parameters": [ { "name": "folder_id", "in": "query", "description": "どのフォルダのポリシーを返すかを指定します。これは、IDが`0`のルートフォルダでは使用できません。", "required": true, "schema": { "type": "string" }, "example": "31232" }, { "name": "owner_enterprise_id", "in": "query", "description": "メタデータカスケードポリシーを検索するEnterprise ID。指定されていない場合は、デフォルトで現在のEnterpriseに設定されます。", "schema": { "type": "string" }, "example": "31232" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "メタデータカスケードポリシーのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataCascadePolicies" } } } }, "400": { "description": "パラメータのいずれかが有効な形式でない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "フォルダにアクセスできない場合にエラーを返します。このエラーは、IDが`0`のルートフォルダにアクセスした場合によく発生します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合はエラーを返します。\n\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_cascade_policies", "tags": [ "メタデータカスケードポリシー" ] }, "post": { "operationId": "post_metadata_cascade_policies", "summary": "メタデータカスケードポリシーを作成", "description": "指定したメタデータテンプレートを指定したフォルダに適用し、そのフォルダ内のすべてのファイルに自動的にカスケードする新しいメタデータカスケードポリシーを作成します。\n\nポリシーを適用するには、まず、ポリシーの適用先となるフォルダにメタデータインスタンスを適用する必要があります。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "folder_id": { "description": "ポリシーを適用するフォルダのID。このフォルダには、ターゲットメタデータテンプレートのインスタンスがすでに適用されている必要があります。", "type": "string", "example": "1234567" }, "scope": { "description": "ターゲットメタデータテンプレートのスコープ。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。", "type": "string", "example": "enterprise", "enum": [ "global", "enterprise" ] }, "templateKey": { "description": "ターゲットメタデータテンプレートのキー。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。\n\n多くの場合、テンプレートキーはその表示名から自動的に派生します。たとえば、`Contract Template`の場合は`contractTemplate`となります。場合によっては、テンプレートの作成者が独自のテンプレートキーを指定することもあります。\n\nテンプレートのキーを調べるには、[会社のテンプレートのリストを取得する][list]か、[ファイル][file]または[フォルダ][folder]上のすべてのインスタンスを取得してください。\n\n[list]: e://get-metadata-templates-enterprise\n\n[file]: e://get-files-id-metadata\n\n[folder]: e://get-folders-id-metadata", "type": "string", "example": "productInfo" } }, "required": [ "folder_id", "scope", "templateKey" ] } } } }, "responses": { "201": { "description": "新しいメタデータカスケードポリシーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataCascadePolicy" } } } }, "400": { "description": "パラメータのいずれかが有効な形式でない場合はエラーを返します。\n\n* `bad_request` - `scope`、`templateKey`、または`folder_id`が有効な形式ではありません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "制限されたフォルダ (IDが`0`のルートフォルダなど) にポリシーを適用しようとした場合にエラーを返します。\n\n* `forbidden` - フォルダIDが有効で、ユーザーはこのフォルダにアクセスできますが、ポリシーをこのフォルダに割り当てられませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "テンプレートまたはフォルダが見つからないか、ユーザーがフォルダまたはテンプレートにアクセスできない場合はエラーを返します。\n\n* `instance_tuple_not_found` - テンプレートが見つからないか、ユーザーがテンプレートにアクセスできません。\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "このフォルダとテンプレートのポリシーがすでに設定されている場合はエラーを返します。\n\n* `tuple_already_exists` - この`folder_id`、`scope`、および`templateKey`の組み合わせのカスケードポリシーがすでに存在する場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_cascade_policies", "tags": [ "メタデータカスケードポリシー" ] } }, "/metadata_cascade_policies/{metadata_cascade_policy_id}": { "get": { "operationId": "get_metadata_cascade_policies_id", "summary": "メタデータカスケードポリシーを取得", "description": "フォルダに割り当てられた特定のメタデータカスケードポリシーを取得します。", "parameters": [ { "name": "metadata_cascade_policy_id", "in": "path", "description": "メタデータカスケードポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" } ], "responses": { "200": { "description": "メタデータカスケードポリシーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataCascadePolicy" } } } }, "404": { "description": "ポリシーが見つからないか、ユーザーがフォルダにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - ポリシーが見つかりませんでした。\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_cascade_policies", "tags": [ "メタデータカスケードポリシー" ] }, "delete": { "operationId": "delete_metadata_cascade_policies_id", "summary": "メタデータカスケードポリシーを削除", "description": "メタデータカスケードポリシーを削除します。", "parameters": [ { "name": "metadata_cascade_policy_id", "in": "path", "description": "メタデータカスケードポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" } ], "responses": { "204": { "description": "ポリシーが正常に削除された場合は、空のレスポンスを返します。" }, "404": { "description": "ポリシーが見つからないか、ユーザーがフォルダにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - ポリシーが見つかりませんでした。\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_cascade_policies", "tags": [ "メタデータカスケードポリシー" ] } }, "/metadata_cascade_policies/{metadata_cascade_policy_id}/apply": { "post": { "operationId": "post_metadata_cascade_policies_id_apply", "summary": "フォルダにメタデータカスケードポリシーを強制適用", "description": "メタデータカスケードポリシーを持つフォルダのメタデータをそのすべての子に強制的に適用します。これは、新しいカスケードポリシーの作成後、そのフォルダ内にある既存のすべてのファイルにカスケードされるメタデータを適用するのに使用できます。", "parameters": [ { "name": "metadata_cascade_policy_id", "in": "path", "description": "強制的に適用するカスケードポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "conflict_resolution": { "description": "メタデータテンプレートですでにインスタンスが子に適用されているという競合に対処する際の最適な動作を説明します。\n\n* `none`を指定すると、ファイルの既存の値が保持されます。\n* `overwrite`を指定すると、既存の値を無視してテンプレートの値が強制的に適用されます。", "type": "string", "example": "none", "enum": [ "none", "overwrite" ] } }, "required": [ "conflict_resolution" ] } } } }, "responses": { "202": { "description": "APIコールが成功した場合は空のレスポンスを返します。メタデータのカスケード操作は非同期的に実行されます。\n\nAPIコールは、カスケード操作が完了していなくても直ちに復帰します。現時点では、この操作のステータスを確認するためのAPIはありません。" }, "404": { "description": "ポリシーが見つからないか、ユーザーがフォルダにアクセスできない場合はエラーを返します。\n\n* `instance_not_found` - ポリシーが見つかりませんでした。\n* `not_found` - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "metadata_cascade_policies", "tags": [ "メタデータカスケードポリシー" ] } }, "/metadata_queries/execute_read": { "post": { "operationId": "post_metadata_queries_execute_read", "summary": "メタデータによるファイル/フォルダに対するクエリ", "description": "SQLに似た構文で特定のメタデータと一致する項目を返す検索を作成します。\n\nデフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。各項目のその他のフィールド (メタデータのいずれかを含む) を取得するには、クエリで`fields`属性を使用します。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataQuery" } } } }, "responses": { "200": { "description": "このメタデータクエリと一致するファイルおよびフォルダのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataQueryResults" } } } }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `invalid_query` - 指定した本文パラメータのいずれかが正しくない可能性があります。これは、`query`に誤りがあることと、`from`値が有効なテンプレートを表していない場合があることを意味します。\n* `unexpected_json_type` - `query`文字列からの引数が`query_param`に存在しません。たとえば、`name = :name`の`query`では、`{ \"name\": \"Box, Inc\" }`のように、`query_param`に`name`引数の値を含める必要があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定された`scope`と`templateKey`のメタデータテンプレートが見つからない場合にエラーを返します。エラーレスポンスには追加の詳細が含まれます。\n\n* `instance_not_found` - テンプレートが見つからなかった場合に返されます。Enterprise ID (`enterprise_12345`など) を含むテンプレート全体のスコープを必ず使用してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "search", "tags": [ "検索" ] } }, "/comments/{comment_id}": { "get": { "operationId": "get_comments_id", "summary": "コメントを取得", "description": "特定のコメントのメッセージとメタデータに加え、コメントを作成したユーザーに関する情報を取得します。", "parameters": [ { "name": "comment_id", "in": "path", "description": "コメントのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "Full版のコメントオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "comments", "tags": [ "Comments" ] }, "put": { "operationId": "put_comments_id", "summary": "コメントを更新", "description": "コメントのメッセージを更新します。", "parameters": [ { "name": "comment_id", "in": "path", "description": "コメントのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "description": "更新するコメントのテキスト。", "type": "string", "example": "Review completed!" } } } } } }, "responses": { "200": { "description": "更新されたコメントオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "comments", "tags": [ "Comments" ] }, "delete": { "operationId": "delete_comments_id", "summary": "コメントを削除", "description": "コメントを完全に削除します。", "parameters": [ { "name": "comment_id", "in": "path", "description": "コメントのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "コメントが削除された場合は、空のレスポンスを返します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "comments", "tags": [ "Comments" ] } }, "/comments": { "post": { "operationId": "post_comments", "summary": "コメントを作成", "description": "ユーザーによるコメントを特定のファイルに追加するか、他のコメントへの返信として追加します。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "description": "コメントのテキスト。\n\n特定のユーザーをメンションするには、 代わりに`tagged_message`パラメータを使用します。", "type": "string", "example": "Review completed!" }, "tagged_message": { "description": "メッセージ内のどこかで`@[user_id:name]`を使用して他のユーザーをメンションしているコメントのテキスト。メンションされたユーザーには、メンションされたことを知らせるメール通知が送信されます。\n\n`user_id`はターゲットユーザーのIDで、`name`には任意のカスタムフレーズを使用できます。Box UIでは、この名前がユーザーのプロフィールにリンクされます。\n\n他のユーザーをメンションしていない場合は、代わりに`message`を使用します。", "type": "string", "example": "@[1234:John] Review completed!" }, "item": { "description": "コメントを追加する項目。", "type": "object", "properties": { "id": { "description": "項目のID。", "type": "string", "example": "11446498" }, "type": { "description": "このコメントが追加される項目の種類。", "type": "string", "example": "file", "enum": [ "file", "comment" ] } }, "required": [ "id", "type" ] } }, "required": [ "message", "item" ] } } } }, "responses": { "201": { "description": "新しく作成されたコメントオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、[fields](#param-fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "comments", "tags": [ "Comments" ], "x-box-enable-explorer": false } }, "/collaborations/{collaboration_id}": { "get": { "operationId": "get_collaborations_id", "summary": "コラボレーションを取得", "description": "1つのコラボレーションを取得します。", "parameters": [ { "name": "collaboration_id", "in": "path", "description": "コラボレーションのID。", "required": true, "schema": { "type": "string" }, "example": "1234" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "コラボレーションオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collaboration" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "user_collaborations", "tags": [ "Collaborations" ] }, "put": { "operationId": "put_collaborations_id", "summary": "コラボレーションを更新", "description": "コラボレーションを更新します。項目の所有者を変更したり、コラボレーションへの招待を承認したりする場合に使用します。", "parameters": [ { "name": "collaboration_id", "in": "path", "description": "コラボレーションのID。", "required": true, "schema": { "type": "string" }, "example": "1234" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "description": "付与されるアクセスレベル。", "type": "string", "example": "editor", "enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner", "owner" ] }, "status": { "description": "コラボレーション招待のステータスとして、保留中 (`pending`)、承認、拒否のいずれかを設定します。", "type": "string", "example": "accepted", "enum": [ "pending", "accepted", "rejected" ] }, "expires_at": { "description": "コラボレーションの有効期限を更新します。この日付になると、項目から自動的にコラボレーションが削除されます。\n\nこの機能が動作するのは、**管理コンソール**の \\[**Enterprise設定**] で **\\[招待したコラボレータを自動的に削除する] の \\[フォルダの所有者に有効期限の延長を許可する]** の設定が有効になっている場合のみです。この設定が有効になっていない場合、コラボレーションに有効期限を設定できず、このフィールドの値によってエラーが返されます。\n\nさらに、コラボレーションに有効期限を指定できるのは、**\\[招待したコラボレータを自動的に削除する]** の設定を有効にした後に作成した場合のみです。", "type": "string", "format": "date-time", "example": "2019-08-29T23:59:00-07:00" }, "can_view_path": { "description": "招待されたユーザーが招待に関連付けられているフォルダへの親パス全体を見ることができるかどうかを示します。招待されたユーザーには親フォルダ内の権限が付与されないため、自身が参加しているコラボレーションに関係しないコンテンツを閲覧することはできません。\n\nこれにより、招待されたユーザーの \\[**すべてのファイル**] ページの読み込みに必要な時間が有意に増加することに注意してください。`can_view_path`が有効になっているコラボレーションの数を1ユーザーあたり1,000に制限することをお勧めします。\n\n`can_view_path`が`true`に設定されているコラボレータを招待できるのは、所有者と共同所有者のみです。\n\n`can_view_path`は、フォルダのコラボレーションのみに使用できます。", "type": "boolean", "example": true } }, "required": [ "role" ] } } } }, "responses": { "200": { "description": "所有者が変わっていない限り、更新されたコラボレーションオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collaboration" } } } }, "204": { "description": "ロールが`owner`に変更されるとコラボレーションが削除されて、新しいコラボレーションが作成されます。古いコラボレーションの`owner`は、新しいコラボレーションの`co-owner`になります。" }, "403": { "description": "認証済みユーザーにコラボレーションを更新するための適切な権限がない場合にエラーを返します。\n\nさらに、このエラーは、企業の管理ダッシュボードで **\\[招待したコラボレータを自動的に削除する] の \\[フォルダの所有者に有効期限の延長を許可する]** の設定が有効になっていないコラボレーションの`expires_at`フィールドを更新しようとすると発生する可能性があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "user_collaborations", "tags": [ "Collaborations" ] }, "delete": { "operationId": "delete_collaborations_id", "summary": "コラボレーションを削除", "description": "1つのコラボレーションを削除します。", "parameters": [ { "name": "collaboration_id", "in": "path", "description": "コラボレーションのID。", "required": true, "schema": { "type": "string" }, "example": "1234" } ], "responses": { "204": { "description": "コラボレーションが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "user_collaborations", "tags": [ "Collaborations" ] } }, "/collaborations": { "get": { "operationId": "get_collaborations", "summary": "保留中のコラボレーションのリストを取得", "description": "このユーザーに関連する保留中のコラボレーション招待をすべて取得します。", "parameters": [ { "name": "status", "in": "query", "description": "取得するコラボレーションのステータス。", "required": true, "schema": { "type": "string", "enum": [ "pending" ] }, "example": "pending" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 } ], "responses": { "200": { "description": "保留中のコラボレーションオブジェクトのコレクションを返します。\n\nユーザーに保留中のコラボレーションがない場合、このコレクションは空になります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsOffsetPaginated" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "list_collaborations", "tags": [ "コラボレーション (リスト)" ] }, "post": { "operationId": "post_collaborations", "summary": "コラボレーションを作成", "description": "ファイルまたはフォルダに個々のユーザーまたはグループのコラボレーションを追加します。\n\nコラボレーションは、メールアドレス、ユーザーID、またはグループIDを使用して作成できます。\n\nグループを使用してコラボレーションを作成する場合、このエンドポイントにアクセスできるかどうかは、そのグループを招待できるかどうかによって決まります。\n\nコラボレーションが`pending`ステータスの場合、以下のフィールドが編集されます。\n\n* `user_id`を使用してコラボレーションが作成された場合、`login`と`name`は非表示になります。\n* `login`を使用してコラボレーションが作成された場合、`name`は非表示になります。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "notify", "in": "query", "description": "実行されたアクションについてのメール通知をユーザーに送信するかどうかを決定します。", "required": false, "schema": { "type": "boolean" }, "example": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "description": "コメントを追加する項目。", "type": "object", "properties": { "type": { "description": "このコラボレーションでアクセス権限が付与される項目の種類。", "type": "string", "example": "file", "enum": [ "file", "folder" ] }, "id": { "description": "アクセス権限が付与される項目のID。", "type": "string", "example": "11446498" } } }, "accessible_by": { "description": "その項目に対するアクセス権限を付与するユーザーまたはグループ。", "type": "object", "properties": { "type": { "description": "招待するコラボレータのタイプ。", "type": "string", "example": "user", "enum": [ "user", "group" ] }, "id": { "description": "ユーザーまたはグループのID。\n\n`login`を使用してメールアドレスでユーザーを指定することもできます。", "type": "string", "example": "23522323" }, "login": { "description": "項目に対するアクセス権限を付与するユーザーのメールアドレス。\n\n`id`を使用してユーザーIDでユーザーを指定することもできます。", "type": "string", "example": "john@example.com" } }, "required": [ "type" ] }, "role": { "description": "付与されるアクセスレベル。", "type": "string", "example": "editor", "enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ] }, "is_access_only": { "description": "`true`に設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は \\[すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。", "type": "boolean", "example": true }, "can_view_path": { "description": "招待されたユーザーが招待に関連付けられているフォルダへの親パス全体を見ることができるかどうかを示します。招待されたユーザーには親フォルダ内の権限が付与されないため、自身が参加しているコラボレーションに関係しないコンテンツを閲覧することはできません。\n\nこれにより、招待されたユーザーの \\[**すべてのファイル**] ページの読み込みに必要な時間が有意に増加することに注意してください。`can_view_path`が有効になっているコラボレーションの数を1ユーザーあたり1,000に制限することをお勧めします。\n\n`can_view_path`が`true`に設定されているコラボレータを招待できるのは、所有者と共同所有者のみです。\n\n`can_view_path`は、フォルダのコラボレーションのみに使用できます。", "type": "boolean", "example": true }, "expires_at": { "description": "コラボレーションの有効期限を設定します。この日付になると、項目から自動的にコラボレーションが削除されます。\n\nこの機能が動作するのは、**管理コンソール**の \\[**Enterprise設定**] で **\\[招待したコラボレータを自動的に削除する] の \\[フォルダの所有者に有効期限の延長を許可する]** の設定が有効になっている場合のみです。この設定が有効になっていない場合、コラボレーションに有効期限を設定できず、このフィールドの値によってエラーが返されます。", "type": "string", "format": "date-time", "example": "2019-08-29T23:59:00-07:00" } }, "required": [ "item", "accessible_by", "role" ] } } } }, "responses": { "201": { "description": "新しいコラボレーションオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collaboration" } } } }, "403": { "description": "ユーザーにコラボレーションを作成するための適切な権限がない場合にエラーを返します。\n\n* `forbidden_by_policy`: 情報バリアの制限によりコラボレーションの作成が禁止されています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "user_collaborations", "tags": [ "Collaborations" ] } }, "/search": { "get": { "operationId": "get_search", "summary": "コンテンツを検索", "description": "ユーザーのコンテンツまたは会社全体でファイル、フォルダ、ウェブリンク、および共有ファイルを検索します。", "parameters": [ { "name": "query", "in": "query", "description": "検索する文字列。このクエリは、項目名、説明、ファイルのテキストコンテンツなど、さまざまな項目タイプのフィールドと照合されます。\n\nこのパラメータでは、返された結果をさらに絞り込むためのさまざまな演算子がサポートされます。\n\n* `\"\"` - クエリを二重引用符で囲むと、APIによって完全一致のみが返されます。完全一致検索では、特定の文字の並びに基づいた検索結果は返されません。代わりに、フレーズ (つまり、単語の並び) に基づいた一致が返されます。たとえば、`\"Blue-Box\"`を検索すると、`\"blue.box\"`、`\"Blue Box\"`、`\"Blue-Box\"`などの並びを含む、検索結果が返されます。つまり、`Blue`および`Box`という単語が指定した順序で連続して含まれている項目です。\n* `AND` - 両方の検索語句を含む項目が返されます。たとえば、`marketing AND BoxWorks`を検索すると、`marketing`と`BoxWorks`の両方が任意の順番でテキストに含まれている項目が返されます。テキストに`BoxWorks`のみが含まれる結果は返されません。\n* `OR` - 検索語句のいずれかを含む項目が返されます。たとえば、`marketing OR BoxWorks`を検索すると、`marketing`と`BoxWorks`のいずれかがテキストに含まれている結果が返されます。サポートされている別のブール条件が使用されている場合を除き、複数語のクエリは暗黙的に`OR`として解釈されるため、この演算子の使用は必須ではありません。\n* `NOT` - 指定された検索語句が含まれていない項目が返されます。たとえば、`marketing AND NOT BoxWorks`を検索すると、テキストに`marketing`のみが含まれている結果が返され、`BoxWorks`が含まれる結果は省略されます。\n\n小文字の演算子 (`and`、`or`および`not`) および大文字と小文字を組み合わせた演算子 (`And`、`Or`および`Not`) はサポートされていません。\n\nこのフィールドは、`mdfilters`パラメータが定義されていない場合に必須です。", "required": false, "schema": { "type": "string" }, "example": "sales" }, { "name": "scope", "in": "query", "description": "ユーザーがアクセスできるファイルまたは会社全体で利用可能なファイルに検索結果を絞り込みます。\n\nスコープは、デフォルトで`user_content`に設定されます。これにより、検索結果は、現在認証されているユーザーが使用できるコンテンツに絞り込まれます。\n\n`enterprise_content`は、管理者がサポートチャネルを通じてリクエストできます。このスコープがユーザーに対して有効になっていると、そのユーザーは、アクセスできるコンテンツだけでなく、会社全体のコンテンツに対してクエリを実行できます。", "required": false, "schema": { "type": "string", "default": "user_content", "enum": [ "user_content", "enterprise_content" ] }, "example": "user_content" }, { "name": "file_extensions", "in": "query", "description": "指定したファイル拡張子のいずれかと一致するファイルのみに検索結果を絞り込みます。このリストは、ドットなしのファイル拡張子のコンマ区切りリストです。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "pdf", "png", "gif" ], "explode": false }, { "name": "created_at_range", "in": "query", "description": "指定した日付範囲内に作成されたすべての項目に検索結果を絞り込みます。\n\n日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。\n\n開始日が省略されている場合 (`,2014-05-17T13:35:01-07:00`)、終了日より前に作成された項目がすべて返されます。\n\n終了日が省略されている場合 (`2014-05-15T13:35:01-07:00,`)、代わりに現在の日付が終了日として使用されます。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "2014-05-15T13:35:01-07:00", "2014-05-17T13:35:01-07:00" ], "explode": false }, { "name": "updated_at_range", "in": "query", "description": "指定した日付範囲内に更新された項目に検索結果を絞り込みます。\n\n日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。\n\n開始日が省略されている場合 (`,2014-05-17T13:35:01-07:00`)、終了日より前に更新された項目が返されます。\n\n終了日が省略されている場合 (`2014-05-15T13:35:01-07:00,`)、代わりに現在の日付が終了日として使用されます。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "2014-05-15T13:35:01-07:00", "2014-05-17T13:35:01-07:00" ], "explode": false }, { "name": "size_range", "in": "query", "description": "特定のファイルサイズ範囲内のサイズの項目に検索結果を絞り込みます。これはファイルとフォルダに適用されます。\n\nサイズ範囲は、バイトサイズの下限と上限 (下限と上限も含む) のコンマ区切りリストとして定義します。\n\n上限または下限を省略すると、上限または下限のないサイズ範囲を指定できます。", "required": false, "schema": { "type": "array", "items": { "type": "integer" } }, "example": [ 1000000, 5000000 ], "explode": false }, { "name": "owner_user_ids", "in": "query", "description": "指定した所有者リスト (ユーザーIDのコンマ区切りリストとして定義) によって所有される項目のみに検索結果を絞り込みます。\n\n検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要もあります。いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。\n\n会社全体で検索するには、サポートチームにリクエスト可能な`enterprise_content`スコープパラメータを使用することをお勧めします。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "123422", "23532", "3241212" ], "explode": false }, { "name": "recent_updater_user_ids", "in": "query", "description": "指定したユーザーリスト (ユーザーIDのコンマ区切りリストとして定義) によって更新された項目のみに検索結果を絞り込みます。\n\n検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要もあります。いずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。\n\nこの機能では、項目の過去10バージョンのみを検索します。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "123422", "23532", "3241212" ], "explode": false }, { "name": "ancestor_folder_ids", "in": "query", "description": "フォルダIDのコンマ区切りリストとして定義された、指定したフォルダリスト内の項目のみに検索結果を絞り込みます。\n\n検索結果には、これらの先祖フォルダのサブフォルダ内の項目も含まれます。\n\nフォルダは現在認証されているユーザーによって所有または共有されている必要もあります。このユーザーがフォルダにアクセスできない場合、またはフォルダがない場合は、代わりに`HTTP 404`エラーコードが返されます。\n\n会社全体で検索するには、サポートチームにリクエスト可能な`enterprise_content`スコープパラメータを使用することをお勧めします。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "4535234", "234123235", "2654345" ], "explode": false }, { "name": "content_types", "in": "query", "description": "ファイルの説明など、ファイルの特定の部分に対する検索クエリと一致する項目のみに検索結果を絞り込みます。\n\nコンテンツタイプの定義には、Boxで認識されるコンテンツタイプのコンマ区切りリストを使用します。許可されるコンテンツタイプは以下のとおりです。\n\n* `name` - `name`フィールドで定義されている、項目の名前。\n* `description` - `description`フィールドで定義されている、項目の説明。\n* `file_content` - ファイルの実際のコンテンツ。\n* `comments` - ファイルまたはフォルダに対するコメントのコンテンツ。\n* `tags` - `tags`フィールドで定義されている、項目に適用されるタグ。", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "file_content", "comments", "tag" ] } }, "example": [ "name", "description" ], "explode": false }, { "name": "type", "in": "query", "description": "このタイプの項目に検索結果を絞り込みます。このパラメータが受け取る値は1つだけです。デフォルトでは、このAPIによって、以下のいずれかのタイプと一致する項目が返されます。\n\n* `file` - 検索結果をファイルに絞り込みます。\n* `folder` - 検索結果をフォルダに絞り込みます。\n* `web_link` - 検索結果をウェブリンク (ブックマークとも呼ばれます) に絞り込みます。", "required": false, "schema": { "type": "string", "enum": [ "file", "folder", "web_link" ] }, "example": "file" }, { "name": "trash_content", "in": "query", "description": "検索時にごみ箱で項目を探すかどうかを決定します。\n\nデフォルトでは、このAPIで返されるのは、現在ごみ箱にない項目の検索結果のみです (`non_trashed_only`)。\n\n* `trashed_only` - 現在ごみ箱にある項目のみを検索します。\n* `non_trashed_only` - 現在ごみ箱にない項目のみを検索します。\n* `all_items` - ごみ箱内の項目とごみ箱にない項目の両方を検索します。", "required": false, "schema": { "type": "string", "default": "non_trashed_only", "enum": [ "non_trashed_only", "trashed_only", "all_items" ] }, "example": "non_trashed_only" }, { "name": "mdfilters", "in": "query", "description": "指定したフィルタとメタデータが一致する項目のみに検索結果を絞り込みます。このパラメータは、検索結果のフィルタに使用するメタデータテンプレートを**1つ**だけ指定するリストです。このパラメータは、`query`パラメータが指定されていない場合に必須です。", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataFilter" }, "maxItems": 1, "minItems": 1 }, "example": [ { "scope": "enterprise", "templateKey": "contract", "filters": [ { "category": "online" }, { "contractValue": 100000 } ] } ] }, { "name": "sort", "in": "query", "description": "結果が返される順序を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、関連度を基準として項目を返します。\n\n* `relevance` (デフォルト) を指定すると、クエリの検索語句との関連度を基準として並べ替えられた結果が返されます。関連度は、項目の名前、説明、コンテンツ、およびその他のプロパティでの検索語句の出現回数に基づきます。\n* `modified_at`を指定すると、項目が最後に変更された日付を基準にして降順で並べ替えられた結果が返されます。", "required": false, "schema": { "type": "string", "default": "relevance", "enum": [ "modified_at", "relevance" ] }, "example": "modified_at" }, { "name": "direction", "in": "query", "description": "検索結果の並べ替えの方向を定義します。このパラメータが明示的に指定されていない限り、このAPIはデフォルトで、降順 (`DESC`) で項目を返します。\n\n結果が`relevance`を基準にして並べ替えられると、関連度の降順で項目が返されるよう並べ替えはロックされ、このパラメータは無視されます。", "required": false, "schema": { "type": "string", "default": "DESC", "enum": [ "DESC", "ASC" ] }, "example": "ASC" }, { "name": "limit", "in": "query", "description": "結果ページの一部として返す項目の最大数を定義します。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 30, "maximum": 200 }, "example": 100 }, { "name": "include_recent_shared_links", "in": "query", "description": "ユーザーが最近共有リンクを介してアクセスした項目を検索結果に含めるかどうかを定義します。\n\nこのパラメータがtrueに設定されている場合は、[共有リンクを含む検索結果](r://search_results_with_shared_links)のリストを返すよう、このAPIのレスポンス形式が変更されます。", "required": false, "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "name": "deleted_user_ids", "in": "query", "description": "指定したユーザーリスト (ユーザーIDのコンマ区切りリストとして定義) によって削除された項目に検索結果を絞り込みます。\n\n`trash_content`パラメータは`trashed_only`に設定する必要があります。\n\nごみ箱内検索が実行されていない場合は、空の結果セットが返されます。検索結果に項目が表示されるように、項目は現在認証されているユーザーによって所有または共有されている必要があります。\n\nいずれかのユーザーが所有するファイルにユーザーがアクセスできない場合は、空の結果セットが返されます。\n\n2023年2月1日以降利用できるデータです。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "123422", "23532", "3241212" ] }, { "name": "deleted_at_range", "in": "query", "description": "指定した日付範囲内に削除されたすべての項目に検索結果を絞り込みます。\n\n日付範囲はコンマ区切りのRFC3339タイムスタンプとして定義されます。\n\n開始日が省略されている場合 (`2014-05-17T13:35:01-07:00`)、終了日より前に削除された項目がすべて返されます。\n\n終了日が省略されている場合 (`2014-05-15T13:35:01-07:00`)、代わりに現在の日付が終了日として使用されます。\n\n`trash_content`パラメータは`trashed_only`に設定する必要があります。\n\nごみ箱内検索が実行されていない場合は、空の結果が返されます。\n\n2023年2月1日以降利用できるデータです。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "2014-05-15T13:35:01-07:00", "2014-05-17T13:35:01-07:00" ] } ], "responses": { "200": { "description": "検索結果のコレクションを返します。一致する検索結果がない場合、`entries`配列は空になります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultsResponse" } } } }, "400": { "description": "リクエストが無効だった場合にエラーを返します。これには、複数の理由があり、`context_info`オブジェクトによって詳細が示されます。\n\n* `missing_parameter` - 検索で少なくとも`query`または`mdfilters`クエリパラメータを指定してください。\n* `invalid_parameter` - いずれかのフィールドの形式に誤りがある可能性があります。たとえば、RFC3339日付のいずれかが正しくないか、整数が想定されている場所に文字列が指定されることを意味します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "このAPIコールを行う権限がユーザーにない場合にエラーを返します。\n\n* 開発者は、`scope`として`enterprise_content`を指定しましたが、Boxのサポートチャネルを通じて、このスコープをユーザーに対して有効にするようリクエストしませんでした。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ユーザーが、リクエストで取り上げられた項目にアクセスできない場合にエラーを返します。\n\n* 開発者は、存在しないフォルダIDまたはユーザーがアクセスできないフォルダIDを`ancestor_folder_ids`で指定しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "search", "tags": [ "検索" ] } }, "/tasks": { "post": { "operationId": "post_tasks", "summary": "タスクを作成", "description": "ファイルに対する1個のタスクを作成します。このタスクはいずれのユーザーにも割り当てられていないため、個別に割り当てる必要があります。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "item": { "description": "タスクを添付するファイル。", "type": "object", "properties": { "id": { "description": "ファイルのID。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`file`になります。", "type": "string", "example": "file", "enum": [ "file" ] } } }, "action": { "description": "タスク担当者が実行を求められるアクション。次のいずれかを指定する必要があります。\n\n* `review` - 承認または拒否できる承認タスクを定義します。\n* `complete` - 完了できる一般タスクを定義します。", "type": "string", "example": "review", "default": "review", "enum": [ "review", "complete" ] }, "message": { "description": "タスクに含めるメッセージ (省略可)。", "type": "string", "example": "Please review", "default": "" }, "due_at": { "description": "タスクの期限を定義します。指定しない場合は、デフォルトで`null`に設定されます。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { "description": "タスクが完了と見なされる前にそのタスクを完了する必要がある担当者を定義します。\n\n* `all_assignees` (デフォルト) - タスクが完了と見なされるには、すべての担当者がそのタスクをレビューまたは承認する必要があります。\n* `any_assignee` - いずれか1人の担当者がタスクをレビューまたは承認すれば、タスクが完了と見なされます。", "type": "string", "example": "all_assignees", "default": "all_assignees", "enum": [ "all_assignees", "any_assignee" ] } }, "required": [ "item" ] } } } }, "responses": { "201": { "description": "新しく作成されたタスクを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "リクエストのパラメータまたは本文が無効な場合に返されます。\n\n* `bad_request` - 本文に有効なリクエストが含まれていない場合に返されます。これは、`action`または`completion_rule`が許可された値のいずれでもないことが原因である可能性があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ファイルに対するタスクを作成する権限がユーザーにない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "tasks", "tags": [ "Tasks" ] } }, "/tasks/{task_id}": { "get": { "operationId": "get_tasks_id", "summary": "タスクを取得", "description": "特定のタスクに関する情報を取得します。", "parameters": [ { "name": "task_id", "in": "path", "description": "タスクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "タスクオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "404": { "description": "タスクが見つからなかった場合、またはタスクが割り当てられているファイルにユーザーがアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "tasks", "tags": [ "Tasks" ] }, "put": { "operationId": "put_tasks_id", "summary": "タスクを更新", "description": "タスクを更新します。これは、タスクの構成を更新するため、またはその完了状態を更新するために使用できます。", "parameters": [ { "name": "task_id", "in": "path", "description": "タスクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "description": "タスク担当者が実行を求められるアクション。次のいずれかを指定する必要があります。\n\n* `review` - 承認または拒否できる承認タスクを定義します。\n* `complete` - 完了できる一般タスクを定義します。", "type": "string", "example": "review", "enum": [ "review", "complete" ] }, "message": { "description": "タスクに含まれるメッセージ。", "type": "string", "example": "Please review" }, "due_at": { "description": "タスクの期限。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { "description": "タスクが完了と見なされる前にそのタスクを完了する必要がある担当者を定義します。\n\n* `all_assignees` (デフォルト) - タスクが完了と見なされるには、すべての担当者がそのタスクをレビューまたは承認する必要があります。\n* `any_assignee` - いずれか1人の担当者がタスクをレビューまたは承認すれば、タスクが完了と見なされます。", "type": "string", "example": "all_assignees", "enum": [ "all_assignees", "any_assignee" ] } } } } } }, "responses": { "200": { "description": "更新されたタスクオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "400": { "description": "リクエストのパラメータまたは本文が無効な場合に返されます。\n\n* `bad_request` - 本文に有効なリクエストが含まれていない場合に返されます。これは、`action`または`completion_rule`が許可された値のいずれでもないことが原因である可能性があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ファイルに関するタスクを更新する権限がユーザーにない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "tasks", "tags": [ "Tasks" ] }, "delete": { "operationId": "delete_tasks_id", "summary": "タスクを削除", "description": "ファイルからタスクを削除します。", "parameters": [ { "name": "task_id", "in": "path", "description": "タスクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "タスクが正常に削除された場合は、空のレスポンスを返します。" }, "404": { "description": "タスクが見つからなかった場合、またはタスクが割り当てられているファイルにユーザーがアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "tasks", "tags": [ "Tasks" ] } }, "/tasks/{task_id}/assignments": { "get": { "operationId": "get_tasks_id_assignments", "summary": "タスク割り当てのリストを取得", "description": "指定したタスクのすべての割り当てのリストを取得します。", "parameters": [ { "name": "task_id", "in": "path", "description": "タスクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "ファイルに対するどのようなタスクを誰が誰に割り当てているかを定義するタスク割り当てのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskAssignments" } } } }, "404": { "description": "タスクが見つからなかった場合、またはタスクが割り当てられているファイルにユーザーがアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "リクエストでタスク割り当てIDが省略されている場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "task_assignments", "tags": [ "タスク割り当て" ] } }, "/task_assignments": { "post": { "operationId": "post_task_assignments", "summary": "タスクを割り当て", "description": "ユーザーにタスクを割り当てます。\n\n複数の割り当てを作成することで、1つのタスクを複数のユーザーに割り当てることができます。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "description": "ユーザーに割り当てるタスク。", "type": "object", "properties": { "id": { "description": "タスクのID。", "type": "string", "example": "11446498" }, "type": { "description": "割り当てる項目の種類。", "type": "string", "example": "task", "enum": [ "task" ] } }, "required": [ "id", "type" ] }, "assign_to": { "description": "タスクを割り当てるユーザー。", "type": "object", "properties": { "id": { "description": "タスクに割り当てるユーザーのID。\n\nメールアドレスでユーザーを指定するには、`login`パラメータを使用します。", "type": "string", "example": "3242343" }, "login": { "description": "タスクに割り当てるユーザーのメールアドレス。ユーザーIDを使用してユーザーを指定するには、`id`パラメータを使用します。", "type": "string", "example": "john@example.com" } } } }, "required": [ "task", "assign_to" ] } } } }, "responses": { "201": { "description": "新しいタスク割り当てオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskAssignment" } } } }, "403": { "description": "完了したタスクに対して変更が試行された場合、または指定されたタスク割り当てのタスクにリンクされた項目にユーザーがアクセスできない場合に、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "タスクが見つからない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "このリクエストのIDのいずれかが無効である場合、またはターゲットユーザーがファイルにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "task_assignments", "tags": [ "タスク割り当て" ] } }, "/task_assignments/{task_assignment_id}": { "get": { "operationId": "get_task_assignments_id", "summary": "タスク割り当てを取得", "description": "タスク割り当てに関する情報を取得します。", "parameters": [ { "name": "task_assignment_id", "in": "path", "description": "タスク割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "タスクが割り当てられているユーザーとタスクを割り当てたユーザーを示す、タスク割り当てを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskAssignment" } } } }, "404": { "description": "タスク割り当てが見つからない場合、またはタスクが割り当てられているファイルにユーザーがアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "task_assignments", "tags": [ "タスク割り当て" ] }, "put": { "operationId": "put_task_assignments_id", "summary": "タスク割り当てを更新", "description": "タスク割り当てを更新します。このエンドポイントは、ユーザーに割り当てられたタスクの状態を更新する場合に使用できます。", "parameters": [ { "name": "task_assignment_id", "in": "path", "description": "タスク割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "description": "タスクに追加できる担当者によるメッセージ (省略可)。", "type": "string", "example": "Looks good to me" }, "resolution_state": { "description": "ユーザーに割り当てられたタスクの状態。\n\n* `action`値が`complete`のタスクの場合は`incomplete`または`completed`になります。\n* `action`が`review`のタスクの場合は`incomplete`、`approved`、または`rejected`になります。", "type": "string", "example": "completed", "enum": [ "completed", "incomplete", "approved", "rejected" ] } } } } } }, "responses": { "200": { "description": "更新されたタスク割り当てオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskAssignment" } } } }, "400": { "description": "解決状態がタスクのアクションタイプと互換性がない場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "タスク割り当てが見つからない場合、またはタスクが割り当てられているファイルにユーザーがアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "task_assignments", "tags": [ "タスク割り当て" ] }, "delete": { "operationId": "delete_task_assignments_id", "summary": "タスク割り当てを解除", "description": "特定のタスク割り当てを削除します。", "parameters": [ { "name": "task_assignment_id", "in": "path", "description": "タスク割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "タスク割り当てが正常に削除された場合は、空のレスポンスを返します。" }, "404": { "description": "指定したIDのタスク割り当てが存在しないかアカウントにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "task_assignments", "tags": [ "タスク割り当て" ] } }, "/shared_items": { "get": { "operationId": "get_shared_items", "summary": "共有リンクのファイルを検索", "description": "共有リンクで表されるファイルを返します。\n\n共有ファイルは、共有リンクで表すことが可能で、現在の会社内に存在する項目である場合も、別の会社内に存在する項目である場合もあります。\n\nアプリケーションからこのエンドポイントを呼び出すと、共有ファイルについての情報を取得できます (共有リンクが存在する場合のみ)。\n\n`shared_link_permission_options`の配列フィールドは、`fields`クエリパラメータでリクエストすると、返されます。", "parameters": [ { "name": "if-none-match", "in": "header", "description": "項目が変更されている場合にのみ、その項目を返します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは`304 Not Modified`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "boxapi", "in": "header", "description": "共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。\n\nこのヘッダーの形式は次のようになります。\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" } ], "responses": { "200": { "description": "共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、Full版のファイルリソースを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" } } } }, "304": { "description": "`If-None-Match`ヘッダーがファイルの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、ファイルが前回リクエストされたときから変更されていないことを示します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_files", "tags": [ "共有リンク (ファイル)" ] } }, "/files/{file_id}#get_shared_link": { "get": { "operationId": "get_files_id#get_shared_link", "summary": "ファイルの共有リンクを取得", "description": "ファイルの共有リンクの情報を取得します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "responses": { "200": { "description": "追加の共有リンク情報を含むファイルのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "file", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": true } } } } } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_files", "tags": [ "共有リンク (ファイル)" ] } }, "/files/{file_id}#add_shared_link": { "put": { "operationId": "put_files_id#add_shared_link", "summary": "ファイルに共有リンクを追加", "description": "ファイルに共有リンクを追加します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "ファイルに作成する共有リンクの設定。共有リンクにデフォルト設定を使用するには、空のオブジェクト (`{}`) を使用します。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、ファイルに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true }, "can_preview": { "description": "共有リンクからのファイルのプレビューが許可されているかどうか。この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true }, "can_edit": { "description": "共有リンクからのファイルの編集が許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。`can_download`が`true`の場合、この値も`true`にしか設定できません。", "type": "boolean", "example": true } } } } } } } } } }, "responses": { "200": { "description": "新しい共有リンクが追加されているファイルのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "file", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": true } } } } } } } }, "400": { "description": "権限の組み合わせが正しくない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_files", "tags": [ "共有リンク (ファイル)" ] } }, "/files/{file_id}#update_shared_link": { "put": { "operationId": "put_files_id#update_shared_link", "summary": "ファイルの共有リンクを更新", "description": "ファイルの共有リンクを更新します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "更新する共有リンクの設定。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true }, "can_preview": { "description": "共有リンクからのファイルのプレビューが許可されているかどうか。この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true }, "can_edit": { "description": "共有リンクからのファイルの編集が許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。`can_download`が`true`の場合、この値も`true`にしか設定できません。", "type": "boolean", "example": true } } } } } } } } } }, "responses": { "200": { "description": "更新された共有リンクが追加されているファイルのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "file", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": true } } } } } } } }, "400": { "description": "権限の組み合わせが正しくない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_files", "tags": [ "共有リンク (ファイル)" ] } }, "/files/{file_id}#remove_shared_link": { "put": { "operationId": "put_files_id#remove_shared_link", "summary": "ファイルから共有リンクを削除", "description": "ファイルから共有リンクを削除します。", "parameters": [ { "name": "file_id", "in": "path", "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "この値を`null`に設定することで、共有リンクがファイルから削除されます。", "type": "object", "example": null, "nullable": true } } } } } }, "responses": { "200": { "description": "共有リンクが削除されているファイルのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/File--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "file", "etag": "1", "shared_link": null } } } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_files", "tags": [ "共有リンク (ファイル)" ] } }, "/shared_items#folders": { "get": { "operationId": "get_shared_items#folders", "summary": "共有リンクのフォルダを検索", "description": "共有リンクで表されるフォルダを返します。\n\n共有フォルダは、共有リンクで表すことが可能で、現在の会社内に存在する項目である場合も、別の会社内に存在する項目である場合もあります。\n\nアプリケーションからこのエンドポイントを呼び出すと、共有フォルダについての情報を取得できます (共有リンクが存在する場合のみ)。", "parameters": [ { "name": "if-none-match", "in": "header", "description": "項目が変更されている場合にのみ、その項目を返します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは`304 Not Modified`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "boxapi", "in": "header", "description": "共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。\n\nこのヘッダーの形式は次のようになります。\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" } ], "responses": { "200": { "description": "共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、Full版のフォルダリソースを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" } } } }, "304": { "description": "`If-None-Match`ヘッダーがフォルダの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_folders", "tags": [ "共有リンク (フォルダ)" ] } }, "/folders/{folder_id}#get_shared_link": { "get": { "operationId": "get_folders_id#get_shared_link", "summary": "フォルダの共有リンクを取得", "description": "フォルダの共有リンクの情報を取得します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "responses": { "200": { "description": "追加の共有リンク情報を含むフォルダのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "folder", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": false } } } } } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_folders", "tags": [ "共有リンク (フォルダ)" ] } }, "/folders/{folder_id}#add_shared_link": { "put": { "operationId": "put_folders_id#add_shared_link", "summary": "フォルダに共有リンクを追加", "description": "フォルダに共有リンクを追加します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "フォルダに作成する共有リンクの設定。\n\n共有リンクにデフォルト設定を使用するには、空のオブジェクト (`{}`) を使用します。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true }, "can_preview": { "description": "共有リンクからのファイルのプレビューが許可されているかどうか。この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true }, "can_edit": { "description": "`type`が`folder`の項目の場合、この値は`false`にしか設定できません。", "type": "boolean", "example": false } } } } } } } } } }, "responses": { "200": { "description": "新しい共有リンクが追加されているフォルダのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "folder", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": false } } } } } } } }, "400": { "description": "権限の組み合わせが正しくない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがフォルダの現在の`etag`値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_folders", "tags": [ "共有リンク (フォルダ)" ] } }, "/folders/{folder_id}#update_shared_link": { "put": { "operationId": "put_folders_id#update_shared_link", "summary": "フォルダの共有リンクを更新", "description": "フォルダの共有リンクを更新します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "更新する共有リンクの設定。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password" }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true }, "can_preview": { "description": "共有リンクからのファイルのプレビューが許可されているかどうか。この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true }, "can_edit": { "description": "`type`が`folder`の項目の場合、この値は`false`にしか設定できません。", "type": "boolean", "example": false } } } } } } } } } }, "responses": { "200": { "description": "更新された共有リンクが追加されているフォルダのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "folder", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": false } } } } } } } }, "400": { "description": "権限の組み合わせが正しくない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがフォルダの現在の`etag`値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_folders", "tags": [ "共有リンク (フォルダ)" ] } }, "/folders/{folder_id}#remove_shared_link": { "put": { "operationId": "put_folders_id#remove_shared_link", "summary": "フォルダから共有リンクを削除", "description": "フォルダから共有リンクを削除します。", "parameters": [ { "name": "folder_id", "in": "path", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "この値を`null`に設定することで、共有リンクがフォルダから削除されます。", "type": "object", "example": null, "nullable": true } } } } } }, "responses": { "200": { "description": "共有リンクが削除されているフォルダのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" }, "examples": { "default": { "value": { "id": "12345", "type": "folder", "etag": "1", "shared_link": null } } } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`folder_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがフォルダの現在の`etag`値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_folders", "tags": [ "共有リンク (フォルダ)" ] } }, "/web_links": { "post": { "operationId": "post_web_links", "summary": "ウェブリンクを作成", "description": "フォルダ内にウェブリンクオブジェクトを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "description": "このウェブリンクのリンク先となるURL。`\"http://\"`または`\"https://\"`で始まっている必要があります。", "type": "string", "example": "https://box.com" }, "parent": { "description": "ウェブリンクの作成先となる親フォルダ。", "type": "object", "properties": { "id": { "description": "親フォルダのID。", "type": "string", "example": "0" } }, "required": [ "id" ] }, "name": { "description": "ウェブリンクの名前。設定されてない場合は、デフォルトでURLに設定されます。", "type": "string", "example": "Box Website" }, "description": { "description": "ウェブリンクの説明。", "type": "string", "example": "Cloud Content Management" } }, "required": [ "parent", "url" ] } } } }, "responses": { "200": { "description": "新しく作成されたウェブリンクオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "web_links", "tags": [ "ウェブリンク" ] } }, "/web_links/{web_link_id}": { "get": { "operationId": "get_web_links_id", "summary": "ウェブリンクを取得", "description": "ウェブリンクに関する情報を取得します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "boxapi", "in": "header", "description": "この項目の共有リンクのURLと省略可能なパスワード。\n\nこのヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。\n\n`shared_link=[link]`形式を使用するか、パスワードが必要な場合は`shared_link=[link]&shared_link_password=[password]`を使用します。\n\nこのヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。", "required": false, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" } ], "responses": { "200": { "description": "ウェブリンクオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "web_links", "tags": [ "ウェブリンク" ] }, "post": { "operationId": "post_web_links_id", "summary": "ウェブリンクを復元", "description": "ごみ箱に移動されたウェブリンクを復元します。\n\n元のフォルダが削除されている場合にウェブリンクの復元先となる新しい親ID (省略可) を指定することができます。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "ウェブリンクの新しい名前 (省略可)。", "type": "string", "example": "Restored.docx" }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" } } }, { "description": "元のフォルダがすでに存在しない場合にウェブリンクの復元先となるフォルダのID (省略可) を指定します。\n\nこのIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にウェブリンクの復元先となるフォールバックの場所を指定します。" } ] } } } } } }, "responses": { "201": { "description": "ウェブリンクオブジェクトが復元された場合は、そのオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashWebLinkRestored" } } } }, "403": { "description": "ウェブリンクの復元先フォルダに対してユーザーがアクセス権限を持っていない場合、またはごみ箱からウェブリンクを復元する権限を持っていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ウェブリンクがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "ウェブリンクの復元先フォルダに同じ名前のウェブリンクが存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_web_links", "tags": [ "ごみ箱内のウェブリンク" ] }, "put": { "operationId": "put_web_links_id", "summary": "ウェブリンクを更新", "description": "ウェブリンクオブジェクトを更新します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "description": "ウェブリンクのリンク先となる新しいURL。`\"http://\"`または`\"https://\"`で始まっている必要があります。", "type": "string", "example": "https://box.com" }, "parent": { "allOf": [ { "type": "object", "description": "この項目の親。", "properties": { "id": { "description": "親項目のID。", "type": "string", "example": "123" }, "user_id": { "description": "`user_id`の入力は省略可能です。`user_id`が存在する場合、ルート以外のフォルダへの移動は許可されません。`user_id`が指定されている場合、親フォルダIDはゼロにする必要があります。", "type": "string", "example": "12346930" } } }, { "description": "ウェブリンクが配置される新しい親フォルダ。これを利用してウェブリンクを別のフォルダに移動します。" } ] }, "name": { "description": "ウェブリンクの新しい名前。設定されていない場合は、デフォルトでURLに設定されます。", "type": "string", "example": "Box Website" }, "description": { "description": "ウェブリンクの新しい説明。", "type": "string", "example": "Cloud Content Management" }, "shared_link": { "description": "更新する共有リンクの設定。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-not-use-this-password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } } } } } }, "responses": { "200": { "description": "更新されたウェブリンクオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "web_links", "tags": [ "ウェブリンク" ] }, "delete": { "operationId": "delete_web_links_id", "summary": "ウェブリンクを削除", "description": "ウェブリンクを削除します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "ウェブリンクが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "web_links", "tags": [ "ウェブリンク" ] } }, "/web_links/{web_link_id}/trash": { "get": { "operationId": "get_web_links_id_trash", "summary": "ごみ箱に移動されたウェブリンクを取得", "description": "ごみ箱に移動されたウェブリンクを取得します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "ごみ箱に移動された日時の情報を含め、ごみ箱内にあるウェブリンクを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashWebLink" } } } }, "404": { "description": "ウェブリンクがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_web_links", "tags": [ "ごみ箱内のウェブリンク" ] }, "delete": { "operationId": "delete_web_links_id_trash", "summary": "ウェブリンクを完全に削除", "description": "ごみ箱内にあるウェブリンクを完全に削除します。この操作は元に戻すことができません。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "ウェブリンクが完全に削除された場合は、空のレスポンスを返します。" }, "404": { "description": "ウェブリンクがごみ箱内にない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "trashed_web_links", "tags": [ "ごみ箱内のウェブリンク" ] } }, "/shared_items#web_links": { "get": { "operationId": "get_shared_items#web_links", "summary": "共有リンクのウェブリンクを検索", "description": "共有リンクで表されるウェブリンクを返します。\n\n共有ウェブリンクは、共有リンクで表すことが可能で、現在の企業内に存在する項目である場合も、別の企業内に存在する項目である場合もあります。\n\nアプリケーションからこのエンドポイントを呼び出すと、共有ウェブリンクについての情報を取得できます (共有リンクが存在する場合のみ)。", "parameters": [ { "name": "if-none-match", "in": "header", "description": "項目が変更されている場合にのみ、その項目を返します。\n\nその項目の最後に認識された`etag`値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは`304 Not Modified`を返して失敗します。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "boxapi", "in": "header", "description": "共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。\n\nこのヘッダーの形式は次のようになります。\n\n`shared_link=[link]&shared_link_password=[password]`.", "required": true, "schema": { "type": "string" }, "example": "shared_link=[link]&shared_link_password=[password]" } ], "responses": { "200": { "description": "共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、Full版のウェブリンクリソースを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" } } } }, "304": { "description": "`If-None-Match`ヘッダーがウェブリンクの現在の`etag`値と一致する場合は、空のレスポンスを返します。これは、ウェブリンクが前回リクエストされたときから変更されていないことを示します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_web_links", "tags": [ "共有リンク (ウェブリンク)" ] } }, "/web_links/{web_link_id}#get_shared_link": { "get": { "operationId": "get_web_links_id#get_shared_link", "summary": "ウェブリンクの共有リンクを取得", "description": "ウェブリンクの共有リンクの情報を取得します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "responses": { "200": { "description": "追加の共有リンク情報を含むウェブリンクのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" }, "examples": { "default": { "value": { "id": "12345", "type": "web_link", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": false } } } } } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_web_links", "tags": [ "共有リンク (ウェブリンク)" ] } }, "/web_links/{web_link_id}#add_shared_link": { "put": { "operationId": "put_web_links_id#add_shared_link", "summary": "ウェブリンクに共有リンクを追加", "description": "ウェブリンクに共有リンクを追加します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "ウェブリンクに作成する共有リンクの設定。\n\n共有リンクにデフォルト設定を使用するには、空のオブジェクト (`{}`) を使用します。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、ファイルに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true }, "can_preview": { "description": "共有リンクからのファイルのプレビューが許可されているかどうか。この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true }, "can_edit": { "description": "`type`が`file`の場合のみ、この値を`true`に設定できます。", "type": "boolean", "example": false } } } } } } } } } }, "responses": { "200": { "description": "新しい共有リンクが追加されているウェブリンクのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" }, "examples": { "default": { "value": { "id": "12345", "type": "web_link", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": false } } } } } } } }, "400": { "description": "権限の組み合わせが正しくない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_web_links", "tags": [ "共有リンク (ウェブリンク)" ] } }, "/web_links/{web_link_id}#update_shared_link": { "put": { "operationId": "put_web_links_id#update_shared_link", "summary": "ウェブリンクの共有リンクを更新", "description": "ウェブリンクの共有リンクを更新します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "更新する共有リンクの設定。", "type": "object", "properties": { "access": { "description": "共有リンクのアクセスレベル。これは、リンクを知っている全員 (`open`)、会社内のユーザーのみ (`company`)、フォルダに招待されたユーザーのみ (`collaborators`) のいずれかに制限できます。\n\n設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、`{ \"shared_link\": {} }`のように、`access`フィールドを指定せずに`shared_link`オブジェクトを渡します。\n\n`company`アクセスレベルは、有料アカウントのみで使用できます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ] }, "password": { "description": "共有リンクへのアクセスに必要なパスワード。パスワードを`null`に設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。`access`が`open`に設定されている場合にのみ、パスワードを設定できます。", "type": "string", "example": "do-n8t-use-this-Password", "nullable": true }, "vanity_name": { "description": "共有リンクのURLで使用するカスタムバニティ名を定義します (例: `https://app.box.com/v/my-shared-link`)。\n\nバニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。", "type": "string", "example": "my-shared-link", "minLength": 12 }, "unshared_at": { "description": "この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "permissions": { "type": "object", "properties": { "can_download": { "description": "共有リンクからのファイルのダウンロードが許可されているかどうか。`access`が`open`または`company`に設定されている場合にのみ設定できます。", "type": "boolean", "example": true }, "can_preview": { "description": "共有リンクからのファイルのプレビューが許可されているかどうか。この値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true }, "can_edit": { "description": "`type`が`file`の場合のみ、この値を`true`に設定できます。", "type": "boolean", "example": true } } } } } } } } } }, "responses": { "200": { "description": "更新された共有リンクが追加されているウェブリンクのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" }, "examples": { "default": { "value": { "id": "12345", "type": "web_link", "etag": "1", "shared_link": { "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1", "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf", "vanity_url": null, "vanity_name": null, "effective_access": "open", "effective_permission": "can_download", "is_password_enabled": false, "unshared_at": "2020-09-21T10:34:41-07:00", "download_count": 0, "preview_count": 0, "access": "open", "permissions": { "can_preview": true, "can_download": true, "can_edit": false } } } } } } } }, "400": { "description": "権限の組み合わせが正しくない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_web_links", "tags": [ "共有リンク (ウェブリンク)" ] } }, "/web_links/{web_link_id}#remove_shared_link": { "put": { "operationId": "put_web_links_id#remove_shared_link", "summary": "ウェブリンクから共有リンクを削除", "description": "ウェブリンクから共有リンクを削除します。", "parameters": [ { "name": "web_link_id", "in": "path", "description": "ウェブリンクのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "この項目に返される`shared_link`フィールドを明示的にリクエストします。", "required": true, "schema": { "type": "string" }, "example": "shared_link" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shared_link": { "description": "この値を`null`に設定することで、共有リンクがウェブリンクから削除されます。", "type": "object", "example": null, "nullable": true } } } } } }, "responses": { "200": { "description": "共有リンクが削除されているウェブリンクのBase版の表示を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebLink" }, "examples": { "default": { "value": { "id": "12345", "type": "web_link", "etag": "1", "shared_link": null } } } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "更新を完了するための権限がユーザーに不足している場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "405": { "description": "`file_id`が認識されていない形式で指定されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "412": { "description": "`If-Match`ヘッダーがファイルの現在の`etag`値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_web_links", "tags": [ "共有リンク (ウェブリンク)" ] } }, "/shared_items#app_items": { "get": { "operationId": "get_shared_items#app_items", "summary": "共有リンクのアプリ項目を検索", "description": "共有リンクで表されるアプリ項目を返します。\n\nリンク元は、現在の企業でも別の企業でもかまいません。", "parameters": [ { "name": "boxapi", "in": "header", "description": "共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。\n\nこのヘッダーの形式は`shared_link=[link]&shared_link_password=[password]`です。", "required": true, "schema": { "type": "string" }, "example": "shared_link=[example.com]&shared_link_password=[xyz123]" } ], "responses": { "200": { "description": "共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、Full版のアプリ項目リソースを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppItem" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shared_links_app_items", "tags": [ "共有リンク (アプリ項目)" ] } }, "/users": { "get": { "operationId": "get_users", "summary": "会社ユーザーのリストを取得", "description": "会社の全ユーザーのリストを、各ユーザーの`user_id`、`public_name`、`login`とともに返します。\n\n会社全体のユーザーを参照するには、アプリケーションと認証済みユーザーに適切な権限が付与されている必要があります。", "parameters": [ { "name": "filter_term", "in": "query", "description": "`name`または`login`が検索語句で始まるユーザーのみに結果を絞り込みます。\n\n外部で管理されているユーザーを検索するには、ユーザー名またはログインが検索語句と完全に一致している必要があります。同時に返されるユーザーは1人のみです。", "required": false, "schema": { "type": "string" }, "example": "john" }, { "name": "user_type", "in": "query", "description": "指定したタイプのユーザーのみに結果を絞り込みます。\n\n* `all`を指定すると、`login`または`name`が`filter_term`と部分的に一致するすべての種類のユーザーが返されます。ログインが`filter_term`と完全に一致した場合は、外部ユーザーのみが返され、その場合に返されるユーザーは、完全に一致したユーザーのみです。\n* `managed`を指定すると、`login`または`name`が`filter_term`と部分的に一致するすべての管理対象ユーザーおよびApp Userが返されます。\n* `external`を指定すると、`login`が`filter_term`と完全に一致するすべての外部ユーザーが返されます。", "required": false, "schema": { "type": "string", "enum": [ "all", "managed", "external" ] }, "example": "managed" }, { "name": "external_app_user_id", "in": "query", "description": "指定した`external_app_user_id`値を持つApp Userに結果を絞り込みます。\n\nApp Userの作成時に、`external_app_user_id`値を設定できます。その後、この値をこのエンドポイントで使用すると、その`external_app_user_id`値に一致するすべてのユーザーが見つかります。", "required": false, "schema": { "type": "string" }, "example": "my-user-1234" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "usemarker", "in": "query", "description": "オフセットベースのページ割り方式ではなくマーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は1つのみです。\n\nこの値をtrueに設定すると、APIは、レスポンスの次のページを取得するために、このエンドポイントにパラメータとして渡すことができる`marker`フィールドを返します。", "required": false, "schema": { "type": "boolean" }, "example": true }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "企業内のすべてのユーザーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Users" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "users", "tags": [ "Users" ] }, "post": { "operationId": "post_users", "summary": "ユーザーを作成", "description": "会社内の管理対象ユーザーを新規に作成します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "ユーザーの名前。", "type": "string", "example": "Aaron Levie", "maxLength": 50 }, "login": { "description": "ユーザーがログインに使用するメールアドレス\n\n`is_platform_access_only`が`true`に設定されている場合を除いて必須です。", "type": "string", "example": "boss@box.com" }, "is_platform_access_only": { "description": "ユーザーがApp Userであることを示します。", "type": "boolean", "example": true }, "role": { "description": "ユーザーの企業でのロール。", "type": "string", "example": "user", "enum": [ "coadmin", "user" ] }, "language": { "description": "修正版の[ISO 639-1](/guides/api-calls/language-codes)形式で表されるユーザーの言語。", "type": "string", "example": "en" }, "is_sync_enabled": { "description": "ユーザーがBox Syncを使用できるかどうか。", "type": "boolean", "example": true }, "job_title": { "description": "ユーザーの役職。", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { "description": "ユーザーの電話番号。", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { "description": "ユーザーの住所。", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 }, "space_amount": { "description": "ユーザーが利用可能な容量の合計 (バイト数)。これを`-1`に設定するとストレージ容量が無制限になります。", "type": "integer", "format": "int64", "example": 11345156112 }, "tracking_codes": { "description": "追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。", "type": "array", "items": { "$ref": "#/components/schemas/TrackingCode" } }, "can_see_managed_users": { "description": "ユーザーが自身の連絡先リストで企業の他のユーザーを参照できるかどうか。", "type": "boolean", "example": true }, "timezone": { "description": "ユーザーのタイムゾーン。", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "is_external_collab_restricted": { "description": "ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか。", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { "description": "企業のデバイス制限からユーザーを除外するかどうか。", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { "description": "ユーザーが2要素認証を使用する必要があるかどうか。", "type": "boolean", "example": true }, "status": { "description": "ユーザーのアカウントのステータス。", "type": "string", "example": "active", "enum": [ "active", "inactive", "cannot_delete_edit", "cannot_delete_edit_upload" ] }, "external_app_user_id": { "description": "ユーザーの検索に使用できる、App Userの外部識別子。これを使用して、外部IDプロバイダのユーザーIDをBoxユーザーに結び付けることができます。", "type": "string", "example": "my-user-1234" } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "新しく作成されたユーザーのユーザーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "users", "tags": [ "Users" ] } }, "/users/me": { "get": { "operationId": "get_users_me", "summary": "現在のユーザーを取得", "description": "現在認証されているユーザーに関する情報を取得します。\n\nクライアント側で認証されるOAuth 2.0アプリケーションの場合、これはアプリケーションを承認したユーザーになります。\n\nサーバー側でアプリケーションが認証されるJWTの場合、これはデフォルトでアプリケーションに属するサービスアカウントになります。\n\nこのAPIコールに使用するユーザーを変更するには、`As-User`ヘッダーを使用します。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "1つのユーザーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "users", "tags": [ "Users" ] } }, "/users/terminate_sessions": { "post": { "operationId": "post_users_terminate_sessions", "summary": "ユーザーのセッションを終了させるジョブを作成", "description": "ユーザーのロールと権限を検証し、ユーザーのセッションを終了させる非同期ジョブを作成します。POSTリクエストのステータスを返します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user_ids": { "description": "ユーザーIDのリスト。", "type": "array", "items": { "type": "string" }, "example": [ "123456", "456789" ] }, "user_logins": { "description": "ユーザーログインのリスト。", "type": "array", "items": { "type": "string" }, "example": [ "user@sample.com", "user2@sample.com" ] } }, "required": [ "user_ids", "user_logins" ] } } } }, "responses": { "202": { "description": "リクエストのステータスに関するメッセージを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTerminationMessage" } } } }, "400": { "description": "一部のパラメータが無効な場合にエラーを返します。\n\n* `Users can not be NULL or EMPTY`: 値が指定されていない場合。\n* `User id format is string`: 指定されたユーザーIDの形式が正しくない場合。\n* `Supported payload format is JSON`: 指定されたペイロードの形式が正しくない場合。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "権限が不足している場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "リソースが見つからなかった場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "レート制限を超えた場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "内部サーバーの問題が発生している場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "503": { "description": "リクエストがタイムアウトした場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "session_termination", "tags": [ "セッション終了" ] } }, "/users/{user_id}": { "get": { "operationId": "get_users_id", "summary": "ユーザーを取得", "description": "企業内のユーザーに関する情報を取得します。\n\n会社全体のユーザーを参照するには、アプリケーションと認証済みユーザーに適切な権限が付与されている必要があります。\n\nまた、このエンドポイントは、適切なスコープを持つ認証済みユーザー用として会社が所有するコンテンツでコラボレーションを行う外部ユーザーに対しては、一部の情報のみを返します。その場合、権限が与えられていないフィールドについては、nullが返されます。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "1つのユーザーオブジェクトを返します。\n\n使用可能なすべてのフィールドがデフォルトで返されるとは限りません。[fields](#param-fields)パラメータを使用して特定のフィールドを明示的にリクエストするには、[fields](#get-users-id--request--fields)クエリパラメータを使用します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "users", "tags": [ "Users" ] }, "put": { "operationId": "put_users_id", "summary": "ユーザーを更新", "description": "企業内の管理対象ユーザーまたはApp Userを更新します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enterprise": { "description": "これを`null`に設定すると、ユーザーが企業のメンバーではなくなり、無料ユーザーになります。", "type": "string", "example": null, "nullable": true }, "notify": { "description": "ユーザーが企業のメンバーでなくなった後もメールを受信できるようにするかどうか。", "type": "boolean", "example": true }, "name": { "description": "ユーザーの名前。", "type": "string", "example": "Aaron Levie", "maxLength": 50 }, "login": { "description": "ユーザーがログインに使用するメールアドレス\n\n注: ターゲットユーザーのメールアドレスが確認されていない場合は、プライマリログインアドレスを変更できません。", "type": "string", "example": "somename@box.com" }, "role": { "description": "ユーザーの企業でのロール。", "type": "string", "example": "user", "enum": [ "coadmin", "user" ] }, "language": { "description": "修正版の[ISO 639-1](/guides/api-calls/language-codes)形式で表されるユーザーの言語。", "type": "string", "example": "en" }, "is_sync_enabled": { "description": "ユーザーがBox Syncを使用できるかどうか。", "type": "boolean", "example": true }, "job_title": { "description": "ユーザーの役職。", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { "description": "ユーザーの電話番号。", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { "description": "ユーザーの住所。", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 }, "tracking_codes": { "description": "追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。", "type": "array", "items": { "$ref": "#/components/schemas/TrackingCode" } }, "can_see_managed_users": { "description": "ユーザーが自身の連絡先リストで企業の他のユーザーを参照できるかどうか。", "type": "boolean", "example": true }, "timezone": { "description": "ユーザーのタイムゾーン。", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "is_external_collab_restricted": { "description": "ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか。", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { "description": "企業のデバイス制限からユーザーを除外するかどうか。", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { "description": "ユーザーが2要素認証を使用する必要があるかどうか。", "type": "boolean", "example": true }, "is_password_reset_required": { "description": "ユーザーにパスワードのリセットを義務付けるかどうか。", "type": "boolean", "example": true }, "status": { "description": "ユーザーのアカウントのステータス。", "type": "string", "example": "active", "enum": [ "active", "inactive", "cannot_delete_edit", "cannot_delete_edit_upload" ] }, "space_amount": { "description": "ユーザーが利用可能な容量の合計 (バイト数)。これを`-1`に設定するとストレージ容量が無制限になります。", "type": "integer", "format": "int64", "example": 11345156112 }, "notification_email": { "description": "通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。\n\nこれを`null`に設定すると、通知メールが削除されます。", "type": "object", "nullable": true, "properties": { "email": { "description": "通知を送付するメールアドレス。", "type": "string", "example": "notifications@example.com" } } }, "external_app_user_id": { "description": "ユーザーの検索に使用できる、App Userの外部識別子。これを使用して、外部IDプロバイダのユーザーIDをBoxユーザーに結び付けることができます。\n\n注: このフィールドを更新するには、App Userを作成したアプリケーションを使用してトークンをリクエストする必要があります。", "type": "string", "example": "my-user-1234" } } } } } }, "responses": { "200": { "description": "更新されたユーザーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User--Full" } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* `invalid_parameter`: パラメータの形式が正しくない場合です。たとえば、`notification_email`に正しくない形式のメールアドレスが含まれている場合です。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーに変更が許可されていない場合にエラーを返します。\n\n* `access_denied_insufficient_permissions`: ユーザーに適切な権限がない場合です。たとえば、企業の設定で通知メールのアップデートがオフになっている場合です。\n* `denied_by_policy`: 情報バリアの制限によりユーザーに適切な権限がない場合。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "users", "tags": [ "Users" ] }, "delete": { "operationId": "delete_users_id", "summary": "ユーザーを削除", "description": "ユーザーを削除します。デフォルトでは、ユーザーがまだコンテンツを所有している状態では失敗します。削除を実行する前にユーザーが所有するコンテンツを移動するか、`force`フィールドを使用してユーザーとそのユーザーが所有するファイルを削除してください。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "notify", "in": "query", "description": "削除に関するメール通知がユーザーに送信されるかどうか。", "schema": { "type": "boolean" }, "example": true }, { "name": "force", "in": "query", "description": "まだファイルを所有していてもこのユーザーを削除するかどうか。", "schema": { "type": "boolean" }, "example": true } ], "responses": { "204": { "description": "ユーザーを削除して空のレスポンスを返します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "users", "tags": [ "Users" ] } }, "/users/{user_id}/avatar": { "get": { "operationId": "get_users_id_avatar", "summary": "ユーザーのアバターを取得", "description": "ユーザーのアバターの画像を取得します。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "ユーザーのアバターが見つかった場合は、レスポンスの本文内で画像データが返されます。", "content": { "image/jpg": { "schema": { "description": "アバター。", "type": "string", "format": "binary" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "avatars", "tags": [ "ユーザーのアバター" ] }, "post": { "operationId": "post_users_id_avatar", "summary": "ユーザーのアバターを追加または更新", "description": "ユーザーのアバターを追加または更新します。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "pic": { "description": "Boxにアップロードする画像ファイル。使用可能なファイル拡張子は`.jpg`または`.png`です。ファイルサイズの上限は1 MBです。", "type": "string", "format": "binary" } }, "required": [ "pic" ] } } } }, "responses": { "200": { "description": "`ok`: 更新された既存のユーザーのアバターへのURLを示す`pic_urls`オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvatar" } } } }, "201": { "description": "`created`: リクエストによってBoxにアップロードされたユーザーのアバターへのURLを示す`pic_urls`オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvatar" } } } }, "400": { "description": "`bad_request`: 次の場合にエラーを返します。\n\n* リクエストに画像が含まれていない\n* アップロードされたファイルが空である\n* 画像のサイズが1024 \\* 1024ピクセルまたは1 MBを超えている\n* ファイル拡張子が`.jpg`または`.png`以外である", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "`forbidden`: アバターをアップロードするために必要な権限がユーザーにない場合、またはユーザーがアクティブになっていない場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "`not_found`: ユーザーが存在しないか見つからない場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "avatars", "tags": [ "ユーザーのアバター" ] }, "delete": { "operationId": "delete_users_id_avatar", "summary": "ユーザーのアバターを削除", "description": "既存のユーザーのアバターを削除します。この操作を元に戻すことはできません。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "204": { "description": "`no_content`: アバターを削除して空のレスポンスを返します。" }, "403": { "description": "`forbidden`: ユーザーが必要な権限を持っていないかアクティブになっていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "`not_found`: ユーザーまたはユーザーのアバターが存在しないか見つからない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "avatars", "tags": [ "ユーザーのアバター" ] } }, "/users/{user_id}/folders/0": { "put": { "operationId": "put_users_id_folders_0", "summary": "所有フォルダの移動", "description": "ユーザーが所有するすべての項目 (ファイル、フォルダ、およびワークフロー) を別のユーザーのアカウントに移動します。\n\n転送できるのは、ルートフォルダ (`0`) のみです。\n\nユーザー間でフォルダを移動できるのは、管理者権限を持つユーザーのみです。\n\n既存の共有リンクとフォルダレベルのコラボレーションはすべて、操作中に転送されます。個々のファイルレベルでのコラボレーションは操作中に転送されますが、元のユーザーが削除されるとこれらのコラボレーションは削除されることに注意してください。\n\nユーザーのすべてのフォルダに多数の項目がある場合、コールは非同期的に実行されます。この操作が10分以内に完了しない場合、ユーザーには200 OKのレスポンスが返され、操作は続行されます。\n\n宛先パスのいずれかの親フォルダにメタデータカスケードポリシーが適用されている場合は、メタデータカスケード操作が非同期的に開始されます。\n\n現時点では、この操作がいつ終了したのかを確認する方法はありません。\n\n宛先フォルダの名前は、`{User}'s Files and\nFolders`形式になります。この場合、`{User}`はユーザーの表示名です。\n\nこのAPIコールを行うには、アプリケーションで \\[Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み] スコープを有効にしておく必要があります。\n\n転送先ユーザーが`Relay`または`Relay Lite`にアクセスできることと転送中のワークフローに関与するファイルやフォルダにアクセスできることを確認してください。\n\n操作が完了すると、管理者にメールが届きます。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "notify", "in": "query", "description": "実行されたアクションについてのメール通知をユーザーに送信するかどうかを決定します。", "required": false, "schema": { "type": "boolean" }, "example": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "owned_by": { "description": "フォルダの転送先になるユーザー。", "type": "object", "properties": { "id": { "description": "フォルダの転送先になるユーザーのID。", "type": "string", "example": "1232234" } }, "required": [ "id" ] } }, "required": [ "owned_by" ] } } } }, "responses": { "200": { "description": "新しく作成された宛先フォルダの情報を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder--Full" } } } }, "403": { "description": "フォルダの所有権を別のユーザーに移管できない場合にエラーを返します。\n\n* `forbidden_by_policy`: 情報バリアの制限により所有権の移管が禁止されている場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "transfer", "tags": [ "フォルダの移動" ] } }, "/users/{user_id}/email_aliases": { "get": { "operationId": "get_users_id_email_aliases", "summary": "ユーザーのメールエイリアスのリストを取得", "description": "ユーザーのすべてのメールエイリアスを取得します。コレクションにユーザーのプライマリログインは含まれません。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "メールエイリアスのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAliases" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "email_aliases", "tags": [ "メールエイリアス" ] }, "post": { "operationId": "post_users_id_email_aliases", "summary": "メールエイリアスを作成", "description": "新しいメールエイリアスをユーザーアカウントに追加します。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "description": "アカウントにエイリアスとして追加するメールアドレス。\n\n注: メールエイリアスのドメインは企業に登録されている必要があります。新しいドメインを追加する手順については、[ドメイン検証のガイド](https://support.box.com/hc/en-us/articles/4408619650579-Domain-Verification)を参照してください。", "type": "string", "example": "alias@example.com" } }, "required": [ "email" ] } } } }, "responses": { "201": { "description": "新しく作成されたメールエイリアスオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAlias" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "email_aliases", "tags": [ "メールエイリアス" ] } }, "/users/{user_id}/email_aliases/{email_alias_id}": { "delete": { "operationId": "delete_users_id_email_aliases_id", "summary": "メールエイリアスを削除", "description": "ユーザーからメールエイリアスを削除します。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "email_alias_id", "in": "path", "description": "メールエイリアスのID。", "required": true, "schema": { "type": "string" }, "example": "23432" } ], "responses": { "204": { "description": "エイリアスを削除して空のレスポンスを返します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "email_aliases", "tags": [ "メールエイリアス" ] } }, "/users/{user_id}/memberships": { "get": { "operationId": "get_users_id_memberships", "summary": "ユーザーのグループのリストを取得", "description": "ユーザーのすべてのグループを取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "user_id", "in": "path", "description": "ユーザーのID。", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "メンバーシップオブジェクトのコレクションを返します。メンバーシップが存在しない場合は、空のコレクションが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMemberships" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "memberships", "tags": [ "グループメンバーシップ" ] } }, "/invites": { "post": { "operationId": "post_invites", "summary": "ユーザー招待を作成", "description": "既存の外部ユーザーを会社に招待します。\n\nすでに他の会社に所属しているユーザーや、Boxアカウントを持たないユーザーを招待することはできません。招待されたユーザーには、Boxウェブアプリケーションで招待を承認するように促すメールが届きます。\n\nこの方法を使用する場合は、対象アプリケーションに対して「Enterpriseの管理」スコープを有効にする必要があります。これは、開発者コンソールから有効にできます。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enterprise": { "description": "ユーザーの招待先となる企業。", "type": "object", "properties": { "id": { "description": "企業のID。", "type": "string", "example": "1232234" } }, "required": [ "id" ] }, "actionable_by": { "description": "招待するユーザー。", "type": "object", "properties": { "login": { "description": "招待されたユーザーのログイン。", "type": "string", "example": "john@example.com" } }, "required": [ "id" ] } }, "required": [ "enterprise", "actionable_by" ] } } } }, "responses": { "200": { "description": "新しい招待オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invite" } } } }, "404": { "description": "ユーザーが見つからなかった場合は`not_found`を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "invites", "tags": [ "Invites" ] } }, "/invites/{invite_id}": { "get": { "operationId": "get_invites_id", "summary": "ユーザー招待ステータスを取得", "description": "ユーザー招待のステータスを返します。", "parameters": [ { "name": "invite_id", "in": "path", "description": "招待のID。", "required": true, "schema": { "type": "string" }, "example": "213723" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "招待オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invite" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "invites", "tags": [ "Invites" ] } }, "/groups": { "get": { "operationId": "get_groups", "summary": "会社のグループのリストを取得", "description": "指定した会社のすべてのグループを取得します。会社のグループを調べるには、管理者権限が必要です。", "parameters": [ { "name": "filter_term", "in": "query", "description": "`name`が検索語句で始まるグループのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "Engineering" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "グループオブジェクトのコレクションを返します。グループが存在しない場合は、空のコレクションが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Groups" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "groups", "tags": [ "Groups" ] }, "post": { "operationId": "post_groups", "summary": "グループを作成", "description": "会社内に新しいユーザーグループを作成します。新しいグループを作成できるのは、管理者権限を持つユーザーのみです。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "作成する新しいグループの名前。この名前は、企業内で一意である必要があります。", "type": "string", "example": "Customer Support" }, "provenance": { "description": "`Active Directory`や`Okta`など、このグループの元になっている外部ソースを追跡します。\n\nまた、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。\n\nこれはグループを一方向にのみ同期する場合に適しています。", "type": "string", "example": "Active Directory", "maxLength": 255 }, "external_sync_identifier": { "description": "このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。\n\nこのフィールドの値には、**Active DirectoryオブジェクトID**や**GoogleグループID**などを使用できます。\n\nBoxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。", "type": "string", "example": "AD:123456" }, "description": { "description": "グループについての人間が判読できる説明。", "type": "string", "example": "\"Customer Support Group - as imported from Active Directory\"", "maxLength": 255 }, "invitability_level": { "description": "フォルダでのコラボレーションにグループを招待できるユーザーを指定します。\n\n`admins_only`に設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。\n\n`admins_and_members`に設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。\n\n`all_managed_users`に設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。", "type": "string", "example": "admins_only", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] }, "member_viewability_level": { "description": "グループのメンバーを表示できるユーザーを指定します。\n\n* `admins_only` - 企業の管理者、共同管理者、グループのグループ管理者。\n* `admins_and_members` - すべての管理者とグループメンバー。\n* `all_managed_users` - 企業のすべての管理対象ユーザー。", "type": "string", "example": "admins_only", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "新しいグループオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group--Full" } } } }, "409": { "description": "競合が原因でグループを作成できないことを示すエラーを返します。\n\n* `invalid_parameter`: グループ名が企業内で一意でない場合によく返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "groups", "tags": [ "Groups" ] } }, "/groups/terminate_sessions": { "post": { "operationId": "post_groups_terminate_sessions", "summary": "ユーザーグループのセッションを終了させるジョブを作成", "description": "グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成します。POSTリクエストのステータスを返します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "group_ids": { "description": "グループIDのリスト。", "type": "array", "items": { "type": "string" }, "example": [ "123456", "456789" ] } }, "required": [ "group_ids" ] } } } }, "responses": { "202": { "description": "リクエストのステータスに関するメッセージを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTerminationMessage" } } } }, "400": { "description": "一部のパラメータが無効な場合にエラーを返します。\n\n* `Groups can not be NULL or EMPTY`: 値が指定されていない場合。\n* `group id format is string`: 指定されたグループIDの形式が正しくない場合。\n* `Supported payload format is JSON`: 指定されたペイロードの形式が正しくない場合。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "権限が不足している場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "リソースが見つからなかった場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "リクエスト制限を超えた場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "内部サーバーの問題が発生している場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "503": { "description": "リクエストがタイムアウトした場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "session_termination", "tags": [ "セッション終了" ] } }, "/groups/{group_id}": { "get": { "operationId": "get_groups_id", "summary": "グループを取得", "description": "グループに関する情報を取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_id", "in": "path", "description": "グループのID。", "required": true, "schema": { "type": "string" }, "example": "57645" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "グループオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group--Full" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "groups", "tags": [ "Groups" ] }, "put": { "operationId": "put_groups_id", "summary": "グループを更新", "description": "特定のグループを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_id", "in": "path", "description": "グループのID。", "required": true, "schema": { "type": "string" }, "example": "57645" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "作成する新しいグループの名前。企業内で一意である必要があります。", "type": "string", "example": "Customer Support" }, "provenance": { "description": "`Active Directory`や`Okta`など、このグループの元になっている外部ソースを追跡します。\n\nまた、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。\n\nこれはグループを一方向にのみ同期する場合に適しています。", "type": "string", "example": "Active Directory", "maxLength": 255 }, "external_sync_identifier": { "description": "このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。\n\nこのフィールドの値には、**Active DirectoryオブジェクトID**や**GoogleグループID**などを使用できます。\n\nBoxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。", "type": "string", "example": "AD:123456" }, "description": { "description": "グループについての人間が判読できる説明。", "type": "string", "example": "\"Customer Support Group - as imported from Active Directory\"", "maxLength": 255 }, "invitability_level": { "description": "フォルダでのコラボレーションにグループを招待できるユーザーを指定します。\n\n`admins_only`に設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。\n\n`admins_and_members`に設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。\n\n`all_managed_users`に設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。", "type": "string", "example": "admins_only", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] }, "member_viewability_level": { "description": "グループのメンバーを表示できるユーザーを指定します。\n\n* `admins_only` - 企業の管理者、共同管理者、グループのグループ管理者。\n* `admins_and_members` - すべての管理者とグループメンバー。\n* `all_managed_users` - 企業のすべての管理対象ユーザー。", "type": "string", "example": "admins_only", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] } } } } } }, "responses": { "200": { "description": "更新されたグループオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group--Full" } } } }, "409": { "description": "競合が原因でグループを作成できないことを示すエラーを返します。\n\n* `invalid_parameter`: グループ名が企業内で一意でない場合によく返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "groups", "tags": [ "Groups" ] }, "delete": { "operationId": "delete_groups_id", "summary": "グループを削除", "description": "グループを完全に削除します。管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_id", "in": "path", "description": "グループのID。", "required": true, "schema": { "type": "string" }, "example": "57645" } ], "responses": { "204": { "description": "グループが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "groups", "tags": [ "Groups" ] } }, "/groups/{group_id}/memberships": { "get": { "operationId": "get_groups_id_memberships", "summary": "グループのメンバーのリストを取得", "description": "グループのすべてのユーザーを取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_id", "in": "path", "description": "グループのID。", "required": true, "schema": { "type": "string" }, "example": "57645" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "メンバーシップオブジェクトのコレクションを返します。メンバーシップが存在しない場合は、空のコレクションが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMemberships" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "memberships", "tags": [ "グループメンバーシップ" ] } }, "/groups/{group_id}/collaborations": { "get": { "operationId": "get_groups_id_collaborations", "summary": "グループコラボレーションのリストを取得", "description": "グループのすべてのコラボレーションを取得します。会社のグループを調べるには、管理者権限が必要です。\n\nそれぞれのコラボレーションオブジェクトには、そのグループがどのファイルやフォルダにアクセスでき、どのロールが使用されるのかに関する詳細情報が含まれています。", "parameters": [ { "name": "group_id", "in": "path", "description": "グループのID。", "required": true, "schema": { "type": "string" }, "example": "57645" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 } ], "responses": { "200": { "description": "コラボレーションオブジェクトのコレクションを返します。コラボレーションが存在しない場合は、空のコレクションが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationsOffsetPaginated" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "list_collaborations", "tags": [ "コラボレーション (リスト)" ] } }, "/group_memberships": { "post": { "operationId": "post_group_memberships", "summary": "ユーザーをグループに追加", "description": "グループメンバーシップを作成します。管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "description": "グループに追加するユーザー。", "type": "object", "properties": { "id": { "description": "グループに追加するユーザーのID。", "type": "string", "example": "1434325" } }, "required": [ "id" ] }, "group": { "description": "ユーザーを追加するグループ。", "type": "object", "properties": { "id": { "description": "ユーザーを追加するグループのID。", "type": "string", "example": "4545523" } }, "required": [ "id" ] }, "role": { "description": "グループ内のユーザーのロール。", "type": "string", "example": "member", "enum": [ "member", "admin" ] }, "configurable_permissions": { "description": "管理者権限のカスタム設定 (グループが受け入れる場合)。このオプションは、ロールが`member`であるメンバーには影響しません。\n\nこれらの権限を設定すると、管理者のデフォルトのアクセスレベルが上書きされます。\n\nこのオブジェクトの値として`null`を指定すると、設定可能なすべての権限が無効になります。権限を指定すると、それに応じて権限が設定され、省略した権限はデフォルトで有効になります。", "type": "object", "example": { "can_run_reports": true }, "additionalProperties": { "type": "boolean", "description": "カスタム権限のキーと値のペア。", "example": true, "x-box-example-key": "can_run_reports" }, "nullable": true } }, "required": [ "user", "group" ] } } } }, "responses": { "201": { "description": "新しいグループメンバーシップオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembership" } } } }, "403": { "description": "ユーザーをグループに追加できない場合にエラーを返します。\n\n* `forbidden_by_policy`: 情報バリアの制限によりグループへのユーザーの追加が禁止されています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "memberships", "tags": [ "グループメンバーシップ" ] } }, "/group_memberships/{group_membership_id}": { "get": { "operationId": "get_group_memberships_id", "summary": "グループメンバーシップを取得", "description": "特定のグループメンバーシップを取得します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_membership_id", "in": "path", "description": "グループメンバーシップのID。", "required": true, "schema": { "type": "string" }, "example": "434534" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "グループメンバーシップオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembership" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "memberships", "tags": [ "グループメンバーシップ" ] }, "put": { "operationId": "put_group_memberships_id", "summary": "グループメンバーシップを更新", "description": "ユーザーのグループメンバーシップを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_membership_id", "in": "path", "description": "グループメンバーシップのID。", "required": true, "schema": { "type": "string" }, "example": "434534" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "description": "グループ内のユーザーのロール。", "type": "string", "example": "member", "enum": [ "member", "admin" ] }, "configurable_permissions": { "description": "管理者権限のカスタム設定 (グループが受け入れる場合)。このオプションは、ロールが`member`であるメンバーには影響しません。\n\nこれらの権限を設定すると、管理者のデフォルトのアクセスレベルが上書きされます。\n\nこのオブジェクトの値として`null`を指定すると、設定可能なすべての権限が無効になります。権限を指定すると、それに応じて権限が設定され、省略した権限はデフォルトで有効になります。", "type": "object", "example": { "can_run_reports": true }, "additionalProperties": { "type": "boolean", "description": "カスタム権限のキーと値のペア。", "example": true, "x-box-example-key": "can_run_reports" }, "nullable": true } } } } } }, "responses": { "200": { "description": "新しいグループメンバーシップオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembership" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "memberships", "tags": [ "グループメンバーシップ" ] }, "delete": { "operationId": "delete_group_memberships_id", "summary": "ユーザーをグループから削除", "description": "特定のグループメンバーシップを削除します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。", "parameters": [ { "name": "group_membership_id", "in": "path", "description": "グループメンバーシップのID。", "required": true, "schema": { "type": "string" }, "example": "434534" } ], "responses": { "204": { "description": "メンバーシップが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "memberships", "tags": [ "グループメンバーシップ" ] } }, "/webhooks": { "get": { "operationId": "get_webhooks", "summary": "すべてのWebhookのリストを取得", "description": "リクエスト元のアプリケーションに対して定義されているすべてのWebhookを返します。\n\nこのAPIは、認証済みユーザーが所有するファイルまたはフォルダに適用されているWebhookのみを返します。つまり、管理者は、それらのフォルダにアクセスできない限り、サービスアカウントによって作成されたWebhookを表示することはできません。逆もまた同様です。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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": "Webhookのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhooks" } } } }, "403": { "description": "アプリケーションにWebhookを管理する権限が付与されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "webhooks", "tags": [ "Webhooks" ] }, "post": { "operationId": "post_webhooks", "summary": "Webhookを作成", "description": "Webhookを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "description": "Webhookをトリガーする項目。", "type": "object", "properties": { "id": { "description": "Webhookをトリガーする項目のID。", "type": "string", "example": "1231232" }, "type": { "description": "Webhookをトリガーする項目のタイプ。", "type": "string", "example": "file", "enum": [ "file", "folder" ] } } }, "address": { "description": "このWebhookによって通知されるURL。", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { "description": "このWebhookがトリガーされるイベント名の配列。", "type": "array", "items": { "title": "Webhookトリガー", "example": "FILE.UPLOADED", "type": "string", "description": "このWebhookをトリガーしたイベント名。", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", "FILE.DOWNLOADED", "FILE.TRASHED", "FILE.DELETED", "FILE.RESTORED", "FILE.COPIED", "FILE.MOVED", "FILE.LOCKED", "FILE.UNLOCKED", "FILE.RENAMED", "COMMENT.CREATED", "COMMENT.UPDATED", "COMMENT.DELETED", "TASK_ASSIGNMENT.CREATED", "TASK_ASSIGNMENT.UPDATED", "METADATA_INSTANCE.CREATED", "METADATA_INSTANCE.UPDATED", "METADATA_INSTANCE.DELETED", "FOLDER.CREATED", "FOLDER.RENAMED", "FOLDER.DOWNLOADED", "FOLDER.RESTORED", "FOLDER.DELETED", "FOLDER.COPIED", "FOLDER.MOVED", "FOLDER.TRASHED", "WEBHOOK.DELETED", "COLLABORATION.CREATED", "COLLABORATION.ACCEPTED", "COLLABORATION.REJECTED", "COLLABORATION.REMOVED", "COLLABORATION.UPDATED", "SHARED_LINK.DELETED", "SHARED_LINK.CREATED", "SHARED_LINK.UPDATED", "SIGN_REQUEST.COMPLETED", "SIGN_REQUEST.DECLINED", "SIGN_REQUEST.EXPIRED", "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", "SIGN_REQUEST.SIGN_SIGNER_SIGNED", "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", "SIGN_REQUEST.SIGN_ERROR_FINALIZING" ] }, "example": [ "FILE.UPLOADED" ] } }, "required": [ "target", "triggers", "address" ] } } } }, "responses": { "201": { "description": "新しいWebhookオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "パラメータが正しくなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "アプリケーションにWebhookを管理する権限が付与されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ターゲット項目が見つからなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "同じターゲット、アプリケーション、ユーザーの組み合わせのWebhookがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "webhooks", "tags": [ "Webhooks" ] } }, "/webhooks/{webhook_id}": { "get": { "operationId": "get_webhooks_id", "summary": "Webhookを取得", "description": "特定のWebhookを取得します。", "parameters": [ { "name": "webhook_id", "in": "path", "description": "WebhookのID。", "required": true, "schema": { "type": "string" }, "example": "3321123" } ], "responses": { "200": { "description": "Webhookオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "403": { "description": "アプリケーションにWebhookを管理する権限が付与されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Webhookが見つからなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "webhooks", "tags": [ "Webhooks" ] }, "put": { "operationId": "put_webhooks_id", "summary": "Webhookを更新", "description": "Webhookを更新します。", "parameters": [ { "name": "webhook_id", "in": "path", "description": "WebhookのID。", "required": true, "schema": { "type": "string" }, "example": "3321123" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "description": "Webhookをトリガーする項目。", "type": "object", "properties": { "id": { "description": "Webhookをトリガーする項目のID。", "type": "string", "example": "1231232" }, "type": { "description": "Webhookをトリガーする項目のタイプ。", "type": "string", "example": "file", "enum": [ "file", "folder" ] } } }, "address": { "description": "このWebhookによって通知されるURL。", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { "description": "このWebhookがトリガーされるイベント名の配列。", "type": "array", "items": { "title": "Webhookトリガー", "example": "FILE.UPLOADED", "type": "string", "description": "このWebhookをトリガーしたイベント名。", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", "FILE.DOWNLOADED", "FILE.TRASHED", "FILE.DELETED", "FILE.RESTORED", "FILE.COPIED", "FILE.MOVED", "FILE.LOCKED", "FILE.UNLOCKED", "FILE.RENAMED", "COMMENT.CREATED", "COMMENT.UPDATED", "COMMENT.DELETED", "TASK_ASSIGNMENT.CREATED", "TASK_ASSIGNMENT.UPDATED", "METADATA_INSTANCE.CREATED", "METADATA_INSTANCE.UPDATED", "METADATA_INSTANCE.DELETED", "FOLDER.CREATED", "FOLDER.RENAMED", "FOLDER.DOWNLOADED", "FOLDER.RESTORED", "FOLDER.DELETED", "FOLDER.COPIED", "FOLDER.MOVED", "FOLDER.TRASHED", "WEBHOOK.DELETED", "COLLABORATION.CREATED", "COLLABORATION.ACCEPTED", "COLLABORATION.REJECTED", "COLLABORATION.REMOVED", "COLLABORATION.UPDATED", "SHARED_LINK.DELETED", "SHARED_LINK.CREATED", "SHARED_LINK.UPDATED", "SIGN_REQUEST.COMPLETED", "SIGN_REQUEST.DECLINED", "SIGN_REQUEST.EXPIRED", "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", "SIGN_REQUEST.SIGN_SIGNER_SIGNED", "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", "SIGN_REQUEST.SIGN_ERROR_FINALIZING" ] }, "example": [ "FILE.UPLOADED" ] } } } } } }, "responses": { "200": { "description": "新しいWebhookオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "パラメータが正しくなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "アプリケーションにWebhookを管理する権限が付与されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ターゲットの項目またはWebhookが見つからなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "同じターゲット、アプリケーション、ユーザーの組み合わせのWebhookがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "webhooks", "tags": [ "Webhooks" ] }, "delete": { "operationId": "delete_webhooks_id", "summary": "Webhookを削除", "description": "Webhookを削除します。", "parameters": [ { "name": "webhook_id", "in": "path", "description": "WebhookのID。", "required": true, "schema": { "type": "string" }, "example": "3321123" } ], "responses": { "204": { "description": "Webhookが正常に削除された場合は、空のレスポンスが返されます。" }, "403": { "description": "アプリケーションにWebhookを管理する権限が付与されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Webhookが見つからなかった場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "webhooks", "tags": [ "Webhooks" ] } }, "/skill_invocations/{skill_id}": { "put": { "operationId": "put_skill_invocations_id", "summary": "ファイルのすべてのBox Skillカードを更新", "description": "ファイルのすべてのBox Skillメタデータカードを上書きおよび更新するために使用できる代替方法。", "parameters": [ { "name": "skill_id", "in": "path", "description": "このメタデータを適用するスキルのID。", "required": true, "schema": { "type": "string" }, "example": "33243242" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "この呼び出しのステータスを定義します。スキルカードを設定する際は、`success`に設定します。", "type": "string", "example": "success", "enum": [ "invoked", "processing", "success", "transient_failure", "permanent_failure" ] }, "metadata": { "description": "このスキルに設定するメタデータ。Box Skillsカードのリストです。ファイルの既存のBox Skillsカードはすべてこれらのカードで上書きされます。", "type": "object", "properties": { "cards": { "description": "このファイルに適用するBox Skillカードのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/SkillCard" } } } }, "file": { "description": "カードを割り当てるファイル。", "type": "object", "properties": { "type": { "description": "値は常に`file`になります。", "type": "string", "example": "file", "enum": [ "file" ] }, "id": { "description": "ファイルのID。", "type": "string", "example": "3243244" } } }, "file_version": { "description": "カードを割り当てるファイルバージョン (省略可)。", "type": "object", "properties": { "type": { "description": "値は常に`file_version`になります。", "type": "string", "example": "file_version", "enum": [ "file_version" ] }, "id": { "description": "ファイルバージョンのID。", "type": "string", "example": "731381601045" } } }, "usage": { "description": "この呼び出しの影響を受ける項目を定義する記述子。\n\nカードを`success`状態に設定する場合はこれをデフォルト値に設定し、それ以外のほとんどの場合には省略してください。", "type": "object", "properties": { "unit": { "description": "値は常に`file`になります。", "type": "string", "example": "file" }, "value": { "description": "影響を受けるリソースの数。", "type": "number", "example": 1 } } } }, "required": [ "status", "metadata", "file" ] } } } }, "responses": { "200": { "description": "ファイルが正常に更新された場合は、空のレスポンスを返します。" }, "400": { "description": "リクエスト本文が無効な場合にエラーを返します。\n\n* `schema_validation_failed` - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、`enum`または`multiSelect`フィールドに不明なオプションが指定されている場合があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ファイルが見つからないか、ユーザーにアクセス権限がない場合はエラーを返します。\n\n* `not_found` - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "skills", "tags": [ "Skills" ] } }, "/events": { "options": { "operationId": "options_events", "summary": "イベントのLong pollingエンドポイントを取得", "tags": [ "Events" ], "x-box-tag": "events", "description": "[イベントストリーム](#get-events)へのLong polling更新に使用できるリアルタイムサーバーのリストを返します。\n\nLong pollingとは、サーバーがレスポンスを送信するまでHTTPリクエストを開いたままにしておき、そのプロセスを何度も繰り返して更新されたレスポンスを受信するというコンセプトです。\n\nイベントストリームのLong pollingは、User Eventについてのみ使用でき、Enterprise Eventについては使用できません。\n\nLong pollingを使用するには、最初にこのエンドポイントを使用してLong polling URLのリストを取得します。次に、取得した任意のURLに対してLong pollingリクエストを発行します。\n\n監視対象のアカウントでイベントが発生すると、`new_change`という値を持つレスポンスが送信されます。このレスポンスは、最新の既知の`stream_position`を使用して[eventsエンドポイント](#get-events)にリクエストを送信するなど、さらなるアクションを促すことだけを目的としているため、その他の詳細を含んでいません。\n\nサーバーは、このレスポンスを送信すると接続を閉じます。この時点でイベントのリスト化を再開するには、Long pollingプロセスを繰り返す必要があります。\n\nしばらくイベントが発生せずに接続がタイムアウトになると、`reconnect`という値を持つレスポンスが届きます。このレスポンスを受け取ったら、このエンドポイントを改めて呼び出してプロセスを再開します。\n\n`retry_timeout`の秒数以内にイベントを受信しなかった場合は、リアルタイムサーバー (このエンドポイントのレスポンスに含まれるURLの1つ) に別のリクエストを送信する必要があります。ネットワークエラーが原因で、これを実行しなければならない場合もあります。\n\nまた、リアルタイムサーバーへのリクエスト時に`max_retries`エラーを受信した場合は、まずこのエンドポイントを呼び出してからやり直す必要があります。", "responses": { "200": { "description": "Long pollingイベントの通常のエンドポイントの代わりに使用できるページ割りされたサーバーの配列を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeServers" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } } }, "get": { "operationId": "get_events", "summary": "User EventおよびEnterprise Eventのリストを取得", "description": "指定したユーザーまたは会社全体の過去のイベントを最大1年間遡って返します。\n\nデフォルトでは、認証済みユーザーのイベントが返されます。Enterprise全体のイベントを取得するには、`stream_type`を`admin_logs_streaming`に設定して新しいイベントをライブで監視するか、`admin_logs`に設定してイベントの履歴を照会します。このAPIコールを行うユーザーは管理者権限を所有していること、アプリケーションでは`manage enterprise properties`スコープが確認されていることが必要になります。", "parameters": [ { "name": "stream_type", "in": "query", "description": "返されるイベントのタイプを定義します\n\n* `all`を指定すると、ユーザーに関するすべてのイベントが返されます (デフォルト)。\n* `changes`を指定すると、ファイルの更新やコラボレーションなど、ファイルツリーを変更する可能性があるイベントが返されます。\n* `sync`は`changes`に似ていますが、同期対象フォルダのみに適用されます\n* `admin_logs`を指定すると、Enterprise全体のイベントがすべて返されるほか、このAPIコールを行うユーザーには管理者権限が必要になります。このストリームタイプは、Enterprise内の全ユーザーの1年分のイベント履歴や`created_after`から`created_before`までの期間内のイベントをプログラムによってプルすることを目的とします。履歴に含まれるすべてのイベントは、イベントの時刻に基づいて時系列で返されますが、レイテンシは`admin_logs_streaming`よりもかなり高くなります。\n* `admin_logs_streaming`を指定すると、Enterprise全体のイベントがすべて返されるほか、このAPIコールを行うユーザーには管理者権限が必要になります。このストリームタイプは、Enterprise内の全ユーザーの最近のイベントをポーリングすることを目的としています。レイテンシは`admin_logs`よりもかなり低くなりますが、イベントは時系列で返されず、重複を含む場合があります。", "schema": { "type": "string", "default": "all", "enum": [ "all", "changes", "sync", "admin_logs", "admin_logs_streaming" ] }, "example": "all" }, { "name": "stream_position", "in": "query", "description": "イベントの受け入れを開始するイベントストリーム内の位置。\n\n* `now`を指定すると、初期化のために空のリストイベントとともに最新のストリーム位置が返されます。\n* `0`または`null`を指定すると、すべてのイベントが返されます。", "schema": { "type": "string" }, "example": "1348790499819" }, { "name": "limit", "in": "query", "description": "返されるイベントの数を制限します。\n\n注: まだイベントが残っているときでも、返されるイベントの数がリクエストされた制限を下回る場合があります。これは主に、多数のイベントがすでに取得されていて、他に結果があるかどうかを確認するためにこの取得したイベントが先延ばしせずに返される場合に発生します。", "schema": { "type": "integer", "format": "int64", "default": 100, "maximum": 500 }, "example": 50 }, { "name": "event_type", "in": "query", "description": "フィルタとして使用するイベントのコンマ区切りリスト。`stream_type`が`admin_logs`または`adming_logs_streaming`のイベントをリクエストする場合にのみ使用できます。`stream_type`がその他の場合、この値は無視されます。", "schema": { "type": "array", "items": { "type": "string", "description": "フィルタに使用できるイベントタイプ。", "enum": [ "ACCESS_GRANTED", "ACCESS_REVOKED", "ADD_DEVICE_ASSOCIATION", "ADD_LOGIN_ACTIVITY_DEVICE", "ADMIN_LOGIN", "APPLICATION_CREATED", "APPLICATION_PUBLIC_KEY_ADDED", "APPLICATION_PUBLIC_KEY_DELETED", "CHANGE_ADMIN_ROLE", "CHANGE_FOLDER_PERMISSION", "COLLABORATION_ACCEPT", "COLLABORATION_EXPIRATION", "COLLABORATION_INVITE", "COLLABORATION_REMOVE", "COLLABORATION_ROLE_CHANGE", "COMMENT_CREATE", "COMMENT_DELETE", "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY", "CONTENT_WORKFLOW_AUTOMATION_ADD", "CONTENT_WORKFLOW_AUTOMATION_DELETE", "CONTENT_WORKFLOW_POLICY_ADD", "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION", "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION", "COPY", "DATA_RETENTION_CREATE_RETENTION", "DATA_RETENTION_REMOVE_RETENTION", "DELETE", "DELETE_USER", "DEVICE_TRUST_CHECK_FAILED", "DOWNLOAD", "EDIT", "EDIT_USER", "EMAIL_ALIAS_CONFIRM", "EMAIL_ALIAS_REMOVE", "ENTERPRISE_APP_AUTHORIZATION_UPDATE", "EXTERNAL_COLLAB_SECURITY_SETTINGS", "FAILED_LOGIN", "FILE_MARKED_MALICIOUS", "FILE_WATERMARKED_DOWNLOAD", "GROUP_ADD_ITEM", "GROUP_ADD_USER", "GROUP_CREATION", "GROUP_DELETION", "GROUP_EDITED", "GROUP_REMOVE_ITEM", "GROUP_REMOVE_USER", "ITEM_EMAIL_SEND", "ITEM_MODIFY", "ITEM_OPEN", "ITEM_SHARED_UPDATE", "ITEM_SYNC", "ITEM_UNSYNC", "LEGAL_HOLD_ASSIGNMENT_CREATE", "LEGAL_HOLD_ASSIGNMENT_DELETE", "LEGAL_HOLD_POLICY_CREATE", "LEGAL_HOLD_POLICY_DELETE", "LEGAL_HOLD_POLICY_UPDATE", "LOCK", "LOGIN", "METADATA_INSTANCE_CREATE", "METADATA_INSTANCE_DELETE", "METADATA_INSTANCE_UPDATE", "METADATA_TEMPLATE_CREATE", "METADATA_TEMPLATE_DELETE", "METADATA_TEMPLATE_UPDATE", "MOVE", "NEW_USER", "OAUTH2_ACCESS_TOKEN_REVOKE", "PREVIEW", "REMOVE_DEVICE_ASSOCIATION", "REMOVE_LOGIN_ACTIVITY_DEVICE", "RENAME", "RETENTION_POLICY_ASSIGNMENT_ADD", "SHARE", "SHARED_LINK_SEND", "SHARE_EXPIRATION", "SHIELD_ALERT", "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED", "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION", "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED", "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION", "SHIELD_JUSTIFICATION_APPROVAL", "SHIELD_SHARED_LINK_ACCESS_BLOCKED", "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE", "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE", "SIGN_DOCUMENT_ASSIGNED", "SIGN_DOCUMENT_CANCELLED", "SIGN_DOCUMENT_COMPLETED", "SIGN_DOCUMENT_CONVERTED", "SIGN_DOCUMENT_CREATED", "SIGN_DOCUMENT_DECLINED", "SIGN_DOCUMENT_EXPIRED", "SIGN_DOCUMENT_SIGNED", "SIGN_DOCUMENT_VIEWED_BY_SIGNED", "SIGNER_DOWNLOADED", "SIGNER_FORWARDED", "STORAGE_EXPIRATION", "TASK_ASSIGNMENT_CREATE", "TASK_ASSIGNMENT_DELETE", "TASK_ASSIGNMENT_UPDATE", "TASK_CREATE", "TASK_UPDATE", "TERMS_OF_SERVICE_ACCEPT", "TERMS_OF_SERVICE_REJECT", "UNDELETE", "UNLOCK", "UNSHARE", "UPDATE_COLLABORATION_EXPIRATION", "UPDATE_SHARE_EXPIRATION", "UPLOAD", "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE", "WATERMARK_LABEL_CREATE", "WATERMARK_LABEL_DELETE" ] } }, "example": [ "ACCESS_GRANTED" ], "explode": false }, { "name": "created_after", "in": "query", "description": "イベントを返す日時の下限。`stream_type`が`admin_logs`のイベントをリクエストする場合にのみ使用できます。`stream_type`がこれ以外の場合、この値は無視されます。", "schema": { "type": "string", "format": "date-time" }, "example": "2012-12-12T10:53:43-08:00" }, { "name": "created_before", "in": "query", "description": "イベントを返す日時の上限。`stream_type`が`admin_logs`のイベントをリクエストする場合にのみ使用できます。`stream_type`がこれ以外の場合、この値は無視されます。", "required": false, "schema": { "type": "string", "format": "date-time" }, "example": "2013-12-12T10:53:43-08:00" } ], "responses": { "200": { "description": "イベントオブジェクトのリストを返します。\n\nイベントオブジェクトは複数のページで返され、各ページ (チャンク) にイベントオブジェクトのリストが含まれます。レスポンスには、このチャンクで返されたイベント数を示す`chunk_size`パラメータに加え、クエリできる次の`stream_position`が含まれます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Events" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "events", "tags": [ "Events" ] } }, "/collections": { "get": { "operationId": "get_collections", "summary": "すべてのコレクションのリストを取得", "description": "指定したユーザーのすべてのコレクションを取得します。\n\n現在サポートされているのは、`favorites`コレクションのみです。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "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/Collections" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collections", "tags": [ "Collections" ] } }, "/collections/{collection_id}/items": { "get": { "operationId": "get_collections_id_items", "summary": "コレクション項目のリストを取得", "description": "このコレクションに含まれるファイルやフォルダを取得します。", "parameters": [ { "name": "collection_id", "in": "path", "description": "コレクションのID。", "required": true, "schema": { "type": "string" }, "example": "926489" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "offset", "in": "query", "description": "レスポンスが開始される項目のオフセット。\n\nオフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": 1000 }, { "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/ItemsOffsetPaginated" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collections", "tags": [ "Collections" ] } }, "/collections/{collection_id}": { "get": { "operationId": "get_collections_id", "summary": "IDを指定してコレクションを取得", "description": "IDでコレクションを取得します。", "parameters": [ { "name": "collection_id", "in": "path", "description": "コレクションのID。", "required": true, "schema": { "type": "string" }, "example": "926489" } ], "responses": { "200": { "description": "コレクション内の項目の配列を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collection" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collections", "tags": [ "Collections" ] } }, "/recent_items": { "get": { "operationId": "get_recent_items", "summary": "最近アクセスした項目のリストを取得", "description": "過去90日間、または最大1,000項目まで遡って、ユーザーが最近アクセスした項目に関する情報を返します。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "最近ユーザーがアクセスした項目のリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecentItems" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "recent_items", "tags": [ "最近使用した項目" ] } }, "/retention_policies": { "get": { "operationId": "get_retention_policies", "summary": "リテンションポリシーのリストを取得", "description": "会社のすべてのリテンションポリシーを取得します。", "parameters": [ { "name": "policy_name", "in": "query", "description": "指定したプレフィックスを持つリテンションポリシー名のみに結果を絞り込みます。このフィルタでは大文字と小文字が区別されます。", "required": false, "schema": { "type": "string" }, "example": "Sales Policy" }, { "name": "policy_type", "in": "query", "description": "指定したタイプのリテンションポリシーのみに結果を絞り込みます。", "required": false, "schema": { "type": "string", "enum": [ "finite", "indefinite" ] }, "example": "finite" }, { "name": "created_by_user_id", "in": "query", "description": "ポリシーを作成したユーザーのIDのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "21312321" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "企業のリテンションポリシーのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } } }, "400": { "description": "存在しない`policy_type`が指定された場合は、`bad_request`を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "`created_by_user_id`で指定されたユーザーが存在しない場合は、`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policies", "tags": [ "リテンションポリシー" ] }, "post": { "operationId": "post_retention_policies", "summary": "リテンションポリシーを作成", "description": "リテンションポリシーを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policy_name": { "description": "リテンションポリシーの名前。", "type": "string", "example": "Some Policy Name" }, "description": { "description": "リテンションポリシーのテキストによる追加の説明。", "type": "string", "example": "Policy to retain all reports for at least one month" }, "policy_type": { "description": "リテンションポリシーのタイプ。リテンションポリシーのタイプは、`finite` (コンテンツを保持する期間が事前にわかっている場合)、または`indefinite` (コンテンツを保持する期間が不明な場合) のいずれかになります。", "type": "string", "example": "finite", "enum": [ "finite", "indefinite" ] }, "disposition_action": { "description": "リテンションポリシーの廃棄アクション。`permanently_delete`に設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。`remove_retention`に設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。", "type": "string", "example": "permanently_delete", "enum": [ "permanently_delete", "remove_retention" ] }, "retention_length": { "description": "リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーの`policy_type`が`indefinite`である場合は、`retention_length`も`indefinite`になります。", "example": "365", "oneOf": [ { "type": "string", "format": "int32", "nullable": true }, { "type": "number", "format": "int32", "nullable": false } ] }, "retention_type": { "description": "以下のリテンションの種類を指定します。\n\n* `modifiable`: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。\n\n* `non_modifiable`: フォルダの追加、期間の延長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。", "type": "string", "example": "modifiable", "enum": [ "modifiable", "non_modifiable" ] }, "can_owner_extend_retention": { "description": "ファイルの所有者がリテンションを延長できるかどうか。", "type": "boolean", "example": true }, "are_owners_notified": { "description": "ポリシーの有効期限が近付いたときにファイルの所有者と共同所有者に通知するかどうか。", "type": "boolean", "example": true }, "custom_notification_recipients": { "description": "リテンションポリシーの期間が終了に近づいたときに通知されるユーザーのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/User--Mini" } } }, "required": [ "policy_name", "policy_type", "disposition_action" ] } } } }, "responses": { "201": { "description": "新しいリテンションポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicy" } } } }, "400": { "description": "`infinite`リテンションポリシーに`retention_length`が指定された場合、誤った`disposition_action`が設定された場合、または説明の文字数が上限の500文字を超える場合は、`bad_request`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "指定した名前を持つリテンションポリシーがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policies", "tags": [ "リテンションポリシー" ] } }, "/retention_policies/{retention_policy_id}": { "get": { "operationId": "get_retention_policies_id", "summary": "リテンションポリシーを取得", "description": "リテンションポリシーを取得します。", "parameters": [ { "name": "retention_policy_id", "in": "path", "description": "リテンションポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "982312" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "リテンションポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicy" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policies", "tags": [ "リテンションポリシー" ] }, "put": { "operationId": "put_retention_policies_id", "summary": "リテンションポリシーを更新", "description": "リテンションポリシーを更新します。", "parameters": [ { "name": "retention_policy_id", "in": "path", "description": "リテンションポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "982312" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policy_name": { "description": "リテンションポリシーの名前。", "type": "string", "example": "Some Policy Name", "nullable": true }, "description": { "description": "リテンションポリシーのテキストによる追加の説明。", "type": "string", "example": "Policy to retain all reports for at least one month", "nullable": true }, "disposition_action": { "description": "リテンションポリシーの廃棄アクション。このアクションを`permanently_delete`に設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。`remove_retention`に設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。`disposition_action`を変更しない場合は`null`を使用できます。", "example": "permanently_delete", "anyOf": [ { "type": "string", "enum": [ "permanently_delete", "remove_retention" ] }, { "type": "string", "pattern": ".^", "nullable": true } ] }, "retention_type": { "description": "以下のリテンションの種類を指定します。\n\n* `modifiable`: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。\n* `non-modifiable`: フォルダの追加、期間の延長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。\n\nリテンションポリシーを更新する際は、`non-modifiable`の種類のみを使用できます。`modifiable`ポリシーを`non-modifiable`に変換することはできますが、その逆はできません。", "type": "string", "example": "non-modifiable", "nullable": true }, "retention_length": { "description": "リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーの`policy_type`が`indefinite`である場合は、`retention_length`も`indefinite`になります。", "example": "365", "oneOf": [ { "type": "string", "format": "int32", "nullable": true }, { "type": "number", "format": "int32", "nullable": false } ] }, "status": { "description": "リテンションポリシーを撤回する場合に使用します。\n\nポリシーを撤回しない場合は、このパラメータを含めないようにするか、 このパラメータを`null`に設定します。", "type": "string", "example": "retired", "nullable": true }, "can_owner_extend_retention": { "description": "元のリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者がリテンションを延長できるかどうかを決定します。", "type": "boolean", "example": false, "nullable": true }, "are_owners_notified": { "description": "リテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者と共同所有者に通知するかどうかを決定します。", "type": "boolean", "example": false, "nullable": true }, "custom_notification_recipients": { "description": "リテンション期間が終了に近づいたときに通知されるユーザーのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/User--Base" }, "nullable": true } } } } } }, "responses": { "200": { "description": "更新されたリテンションポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicy" } } } }, "400": { "description": "誤った`disposition_action`が設定された場合、または説明の文字数が上限の500文字を超える場合は、`bad_request`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "ユーザーが、変更不可ポリシーの期間を短縮しようとする場合または変更不可ポリシーを変更可能ポリシーに変換しようとする場合にエラーを返します。注: ポリシー期間の延長は許可されています。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "指定した名前を持つリテンションポリシーがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policies", "tags": [ "リテンションポリシー" ] }, "delete": { "operationId": "delete_retention_policies_id", "summary": "リテンションポリシーを削除", "description": "リテンションポリシーを完全に削除します。", "parameters": [ { "name": "retention_policy_id", "in": "path", "description": "リテンションポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "982312" } ], "responses": { "204": { "description": "ポリシーが削除された場合は、空のレスポンスを返します。" }, "403": { "description": "ポリシーが変更不可の場合、またはユーザーにこのアクションを実行するために必要なアクセス権限がない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ポリシーが見つからない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policies", "tags": [ "リテンションポリシー" ] } }, "/retention_policies/{retention_policy_id}/assignments": { "get": { "operationId": "get_retention_policies_id_assignments", "summary": "リテンションポリシー割り当てのリストを取得", "description": "指定したリテンションポリシーに関連付けられているすべてのリテンションポリシー割り当てのリストを返します。", "parameters": [ { "name": "retention_policy_id", "in": "path", "description": "リテンションポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "982312" }, { "name": "type", "in": "query", "description": "取得するリテンションポリシー割り当てのタイプ。", "required": false, "schema": { "type": "string", "enum": [ "folder", "enterprise", "metadata_template" ] }, "example": "metadata_template" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。", "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/RetentionPolicyAssignments" } } } }, "400": { "description": "不明な`type`が指定された場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policy_assignments", "tags": [ "リテンションポリシー割り当て" ] } }, "/retention_policy_assignments": { "post": { "operationId": "post_retention_policy_assignments", "summary": "リテンションポリシーを割り当て", "description": "リテンションポリシーを項目に割り当てます。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policy_id": { "description": "割り当てるリテンションポリシーのID。", "type": "string", "example": "173463" }, "assign_to": { "description": "ポリシーを割り当てる項目。", "type": "object", "properties": { "type": { "description": "ポリシーを割り当てる項目のタイプ。", "type": "string", "example": "metadata_template", "enum": [ "enterprise", "folder", "metadata_template" ] }, "id": { "description": "ポリシーを割り当てる項目のID。`type`が`enterprise`に設定されている場合は、`null`に設定するか省略します。", "type": "string", "example": "6564564", "nullable": true } }, "required": [ "type" ] }, "filter_fields": { "description": "`assign_to`のタイプが`metadata_template`の場合は、必要に応じて`filter_fields`パラメータを追加します。このパラメータには、フィールドエントリと値エントリを含むオブジェクトの配列が必要になります。現在、`field`および`value`のオブジェクトは1つだけサポートされています。", "type": "array", "items": { "type": "object", "properties": { "field": { "description": "メタデータ属性キーID。", "type": "string", "example": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4" }, "value": { "description": "メタデータ属性フィールドID。値については、列挙型とmultiselect型のみがサポートされています。", "type": "string", "example": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e" } } } }, "start_date_field": { "description": "リテンションポリシー割り当ての開始日。\n\n`assigned_to`のタイプが`metadata_template`の場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。", "type": "string", "example": "upload_date" } }, "required": [ "policy_id", "assign_to" ] } } } }, "responses": { "201": { "description": "新しいリテンションポリシー割り当てオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicyAssignment" } } } }, "400": { "description": "企業にリテンションポリシーを割り当てている最中に`id`が指定された場合は、エラーを返します。\n\n`start_date_field`が存在するものの、`assign_to.type`が`metadata_template`でない場合は、エラーを返します。\n\n`start_date_field`が存在するものの、`assign_to.id`で指定されたものとは異なるメタデータテンプレートに属している場合は、エラーを返します。\n\n`start_date_field`が存在するものの、`retention_policy`の`retention_length`が「indefinite」である場合は、エラーを返します。\n\n`start_date_field`が存在するものの、有効なメタデータの日付フィールドに解決できない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "指定した`policy_id`を持つリテンションポリシーが存在しない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "期間が同じであるか、それよりも長いリテンションポリシーがこの項目にすでに割り当てられている場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policy_assignments", "tags": [ "リテンションポリシー割り当て" ] } }, "/retention_policy_assignments/{retention_policy_assignment_id}": { "get": { "operationId": "get_retention_policy_assignments_id", "summary": "リテンションポリシー割り当てを取得", "description": "リテンションポリシー割り当てを取得します。", "parameters": [ { "name": "retention_policy_assignment_id", "in": "path", "description": "リテンションポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "1233123" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "リテンションポリシー割り当てオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicyAssignment" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policy_assignments", "tags": [ "リテンションポリシー割り当て" ] }, "delete": { "operationId": "delete_retention_policy_assignments_id", "summary": "リテンションポリシー割り当てを削除", "description": "コンテンツに適用されたリテンションポリシー割り当てを削除します。", "parameters": [ { "name": "retention_policy_assignment_id", "in": "path", "description": "リテンションポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "1233123" } ], "responses": { "204": { "description": "ポリシー割り当てが正常に削除された場合は、空のレスポンスを返します。" }, "403": { "description": "変更できないリテンションポリシーに割り当てが関連する場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "リテンションポリシー割り当てが存在しない場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policy_assignments", "tags": [ "リテンションポリシー割り当て" ] } }, "/retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention": { "get": { "operationId": "get_retention_policy_assignments_id_files_under_retention", "summary": "リテンションの対象となるファイルを取得", "description": "リテンションポリシー割り当てのために、リテンションの対象となるファイルのリストを返します。", "parameters": [ { "name": "retention_policy_assignment_id", "in": "path", "description": "リテンションポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "1233123" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/FilesUnderRetention" } } } }, "400": { "description": "`retention_policy_assignment_id`が指定されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policy_assignments", "tags": [ "リテンションポリシー割り当て" ] } }, "/retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention": { "get": { "operationId": "get_retention_policy_assignments_id_file_versions_under_retention", "summary": "リテンションの対象となるファイルバージョンを取得", "description": "リテンションポリシー割り当てのために、リテンションの対象となるファイルバージョンのリストを返します。", "parameters": [ { "name": "retention_policy_assignment_id", "in": "path", "description": "リテンションポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "1233123" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/FilesUnderRetention" } } } }, "400": { "description": "`retention_policy_assignment_id`が指定されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "retention_policy_assignments", "tags": [ "リテンションポリシー割り当て" ] } }, "/legal_hold_policies": { "get": { "operationId": "get_legal_hold_policies", "summary": "すべてのリーガルホールドポリシーのリストを取得", "description": "会社に属するリーガルホールドポリシーのリストを取得します。", "parameters": [ { "name": "policy_name", "in": "query", "description": "名前がこの検索語句で始まるポリシーのみに結果を絞り込みます。このフィルタではプレフィックスを指定します。大文字と小文字は区別されません。", "required": false, "schema": { "type": "string" }, "example": "Sales Policy" }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/LegalHoldPolicies" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policies", "tags": [ "リーガルホールドポリシー" ] }, "post": { "operationId": "post_legal_hold_policies", "summary": "リーガルホールドポリシーを作成", "description": "新しいリーガルホールドポリシーを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policy_name": { "description": "ポリシーの名前。", "type": "string", "example": "Sales Policy", "maxLength": 254 }, "description": { "description": "ポリシーの説明。", "type": "string", "example": "A custom policy for the sales team", "maxLength": 500 }, "filter_started_at": { "description": "フィルタの開始日。\n\n`custodian`のリーガルホールド割り当てを使用してこのポリシーが適用されている場合は、日付範囲内に作成またはアップロードされたファイルバージョンのみに適用されます。フォルダやファイルなど、他の割り当てタイプの場合、日付フィルタは無視されます。\n\n`is_ongoing`が`false`に設定されている場合は必須です。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "maxLength": 500 }, "filter_ended_at": { "description": "フィルタの終了日。\n\n`custodian`のリーガルホールド割り当てを使用してこのポリシーが適用されている場合は、日付範囲内に作成またはアップロードされたファイルバージョンのみに適用されます。フォルダやファイルなど、他の割り当てタイプの場合、日付フィルタは無視されます。\n\n`is_ongoing`が`false`に設定されている場合は必須です。", "type": "string", "format": "date-time", "example": "2012-12-18T10:53:43-08:00", "maxLength": 500 }, "is_ongoing": { "description": "このポリシーに基づく新しい割り当てを初期化後のファイルにも引き続き適用するかどうか。\n\nリーガルホールド割り当てを使用してこのポリシーを適用した場合は、ポリシーの適用後も同じポリシーが新しいファイルバージョンに引き続き適用されます。\n\nたとえば、今日リーガルホールド割り当てをユーザーに適用し、そのユーザーが明日ファイルをアップロードした場合、そのファイルは保持されます。これは、ポリシーが撤回されるまで継続されます。\n\nフィルタ日付が設定されていない場合は必須です。", "type": "boolean", "example": true } }, "required": [ "policy_name" ] } } } }, "responses": { "201": { "description": "新しいリーガルホールドポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldPolicy" } } } }, "400": { "description": "必須のパラメータが指定されていない場合や、`is_ongoing`もフィルタの日付も指定されていない場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "この名前のポリシーがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policies", "tags": [ "リーガルホールドポリシー" ] } }, "/legal_hold_policies/{legal_hold_policy_id}": { "get": { "operationId": "get_legal_hold_policies_id", "summary": "リーガルホールドポリシーを取得", "description": "リーガルホールドポリシーを取得します。", "parameters": [ { "name": "legal_hold_policy_id", "in": "path", "description": "リーガルホールドポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "324432" } ], "responses": { "200": { "description": "リーガルホールドポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldPolicy" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policies", "tags": [ "リーガルホールドポリシー" ] }, "put": { "operationId": "put_legal_hold_policies_id", "summary": "リーガルホールドポリシーを更新", "description": "リーガルホールドポリシーを更新します。", "parameters": [ { "name": "legal_hold_policy_id", "in": "path", "description": "リーガルホールドポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "324432" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policy_name": { "description": "ポリシーの名前。", "type": "string", "example": "Sales Policy", "maxLength": 254 }, "description": { "description": "ポリシーの説明。", "type": "string", "example": "A custom policy for the sales team", "maxLength": 500 }, "release_notes": { "description": "ポリシーが解除された理由に関するメモ。", "type": "string", "example": "Required for GDPR", "maxLength": 500 } } } } } }, "responses": { "200": { "description": "新しいリーガルホールドポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldPolicy" } } } }, "409": { "description": "この名前のポリシーがすでに存在する場合は、エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policies", "tags": [ "リーガルホールドポリシー" ] }, "delete": { "operationId": "delete_legal_hold_policies_id", "summary": "リーガルホールドポリシーを削除", "description": "既存のリーガルホールドポリシーを削除します。\n\nこれは非同期的プロセスです。レスポンスの返された時点では、ポリシーはまだ完全には削除されていません。", "parameters": [ { "name": "legal_hold_policy_id", "in": "path", "description": "リーガルホールドポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "324432" } ], "responses": { "202": { "description": "ポリシーが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policies", "tags": [ "リーガルホールドポリシー" ] } }, "/legal_hold_policy_assignments": { "get": { "operationId": "get_legal_hold_policy_assignments", "summary": "リーガルホールドポリシー割り当てのリストを取得", "description": "リーガルホールドポリシーが割り当てられている項目のリストを取得します。", "parameters": [ { "name": "policy_id", "in": "query", "description": "リーガルホールドポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "324432" }, { "name": "assign_to_type", "in": "query", "description": "ポリシーが適用されている項目のタイプのみに結果を絞り込みます。", "schema": { "type": "string", "enum": [ "file", "file_version", "folder", "user", "ownership", "interactions" ] }, "example": "file" }, { "name": "assign_to_id", "in": "query", "description": "ポリシーが割り当てられている項目のIDのみに結果を絞り込みます。", "schema": { "type": "string" }, "example": "1234323" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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 }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "リーガルホールドポリシー割り当てのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldPolicyAssignments" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policy_assignments", "tags": [ "リーガルホールドポリシー割り当て" ] }, "post": { "operationId": "post_legal_hold_policy_assignments", "summary": "リーガルホールドポリシーを割り当て", "description": "ファイル、ファイルバージョン、フォルダ、またはユーザーにリーガルホールドを割り当てます。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "policy_id": { "description": "割り当てるポリシーのID。", "type": "string", "example": "123244" }, "assign_to": { "description": "ポリシーを割り当てる項目。", "type": "object", "properties": { "type": { "description": "ポリシーを割り当てる項目のタイプ。", "type": "string", "example": "folder", "enum": [ "file", "file_version", "folder", "user", "ownership", "interaction" ] }, "id": { "description": "ポリシーを割り当てる項目のID。", "type": "string", "example": "6564564" } }, "required": [ "type", "id" ] } }, "required": [ "policy_id", "assign_to" ] } } } }, "responses": { "201": { "description": "新しいリーガルホールドポリシー割り当てを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldPolicyAssignment" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policy_assignments", "tags": [ "リーガルホールドポリシー割り当て" ] } }, "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}": { "get": { "operationId": "get_legal_hold_policy_assignments_id", "summary": "リーガルホールドポリシー割り当てを取得", "description": "リーガルホールドポリシー割り当てを取得します。", "parameters": [ { "name": "legal_hold_policy_assignment_id", "in": "path", "description": "リーガルホールドポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "753465" } ], "responses": { "200": { "description": "リーガルホールドポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalHoldPolicyAssignment" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policy_assignments", "tags": [ "リーガルホールドポリシー割り当て" ] }, "delete": { "operationId": "delete_legal_hold_policy_assignments_id", "summary": "リーガルホールドポリシーの割り当てを解除", "description": "項目からリーガルホールドを削除します。\n\nこれは非同期的プロセスです。レスポンスが返された時点では、ポリシーはまだ完全には削除されていません。", "parameters": [ { "name": "legal_hold_policy_assignment_id", "in": "path", "description": "リーガルホールドポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "753465" } ], "responses": { "202": { "description": "割り当てが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policy_assignments", "tags": [ "リーガルホールドポリシー割り当て" ] } }, "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold": { "get": { "operationId": "get_legal_hold_policy_assignments_id_files_on_hold", "summary": "リーガルホールドポリシー割り当てに関する現在のファイルバージョンを含むファイルのリストを取得", "description": "リーガルホールド割り当てに関する現在のファイルバージョンを含むファイルのリストを取得します。\n\n場合によっては、代わりに以前のファイルバージョンを取得できます。このような場合は、代わりに`GET /legal_hold_policy_assignments/:id/file_versions_on_hold` APIを使用すると、このリーガルホールドポリシー割り当てに関するファイルの以前のバージョンが返されます。\n\n進行中の再構築作業により、このAPIでは、このポリシーID用に保持されているすべてのファイルバージョンが返されない場合があります。代わりに、このAPIで返されるのは、新しく開発されたアーキテクチャで保持されている最新のファイルバージョンのみです。`GET\n/file_version_legal_holds` APIを使用すると、従来のアーキテクチャ内で保持されているファイルの現在のバージョンと過去のバージョンを取得できます。\n\nこのエンドポイントは、カストディアンがHubでコラボレーションしているためにリーガルホールドが設定されているコンテンツを返すことをサポートしていません。\n\n`GET /legal_hold_policy_assignments?policy_id={id}` APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。", "parameters": [ { "name": "legal_hold_policy_assignment_id", "in": "path", "description": "リーガルホールドポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "753465" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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 }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "特定のリーガルホールドポリシー割り当てに関する、リーガルホールドで保持されている現在のファイルバージョンのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilesOnHold" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policy_assignments", "tags": [ "リーガルホールドポリシー割り当て" ] } }, "/file_version_retentions": { "get": { "operationId": "get_file_version_retentions", "summary": "ファイルバージョンリテンションのリストを取得", "description": "指定した会社のすべてのファイルバージョンリテンションを取得します。\n\n**注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](e://get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](e://get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。", "parameters": [ { "name": "file_id", "in": "query", "description": "このIDを持つファイルのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "43123123" }, { "name": "file_version_id", "in": "query", "description": "このIDを持つファイルバージョンのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "1" }, { "name": "policy_id", "in": "query", "description": "このIDを持つリテンションポリシーのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "982312" }, { "name": "disposition_action", "in": "query", "description": "この廃棄アクションを使用するリテンションポリシーのみに結果を絞り込みます。", "required": false, "schema": { "type": "string", "enum": [ "permanently_delete", "remove_retention" ] }, "example": "permanently_delete" }, { "name": "disposition_before", "in": "query", "description": "この日付の前に廃棄が有効になるファイルのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "2012-12-12T10:53:43-08:00" }, { "name": "disposition_after", "in": "query", "description": "この日付の後で廃棄が有効になるファイルのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "2012-12-19T10:34:23-08:00" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "会社のすべてのファイルバージョンリテンションのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionRetentions" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_version_retentions", "tags": [ "ファイルバージョンリテンション" ] } }, "/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold": { "get": { "operationId": "get_legal_hold_policy_assignments_id_file_versions_on_hold", "summary": "リーガルホールドポリシー割り当てに関する以前のファイルバージョンのリストを取得", "description": "リーガルホールド割り当てに関する以前のファイルバージョンのリストを取得します。\n\n場合によっては、代わりに最新のファイルバージョンのみが必要になることもあります。このような場合は、代わりに`GET /legal_hold_policy_assignments/:id/files_on_hold` APIを使用すると、このリーガルホールドポリシー割り当てに関するファイルの現在 (最新) のバージョンが返されます。\n\n進行中の再構築作業により、このAPIでは、このポリシーIDの保持されているファイルがすべて返されるとは限りません。代わりに、このAPIで返されるのは、新しく開発されたアーキテクチャで保持されている過去のファイルバージョンのみです。`GET /file_version_legal_holds` APIを使用すると、従来のアーキテクチャ内で保持されているファイルの現在のバージョンと過去のバージョンを取得できます。\n\nこのエンドポイントは、カストディアンがHubでコラボレーションしているためにリーガルホールドが設定されているコンテンツを返すことをサポートしていません。\n\n`GET /legal_hold_policy_assignments?policy_id={id}` APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。", "parameters": [ { "name": "legal_hold_policy_assignment_id", "in": "path", "description": "リーガルホールドポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "753465" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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 }, { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false } ], "responses": { "200": { "description": "特定のリーガルホールドポリシー割り当てに関する、リーガルホールドで保持されている以前のファイルバージョンのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionsOnHold" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "legal_hold_policy_assignments", "tags": [ "リーガルホールドポリシー割り当て" ] } }, "/file_version_retentions/{file_version_retention_id}": { "get": { "operationId": "get_file_version_retentions_id", "summary": "ファイルのリテンションを取得", "description": "ファイルバージョンリテンションに関する情報を返します。\n\n**注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](e://get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](e://get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。", "parameters": [ { "name": "file_version_retention_id", "in": "path", "description": "ファイルバージョンリテンションのID。", "required": true, "schema": { "type": "string" }, "example": "3424234" } ], "responses": { "200": { "description": "ファイルバージョンリテンションオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionRetention" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_version_retentions", "tags": [ "ファイルバージョンリテンション" ] } }, "/file_version_legal_holds/{file_version_legal_hold_id}": { "get": { "operationId": "get_file_version_legal_holds_id", "summary": "ファイルバージョンリーガルホールドを取得", "description": "ファイルバージョンに割り当てられているリーガルホールドポリシーに関する情報を取得します。", "parameters": [ { "name": "file_version_legal_hold_id", "in": "path", "description": "ファイルバージョンリーガルホールドのID。", "required": true, "schema": { "type": "string" }, "example": "2348213" } ], "responses": { "200": { "description": "ファイルバージョンのリーガルホールドポリシー割り当てを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileVersionLegalHold" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_version_legal_holds", "tags": [ "ファイルバージョンリーガルホールド" ] } }, "/file_version_legal_holds": { "get": { "operationId": "get_file_version_legal_holds", "summary": "ファイルバージョンリーガルホールドのリストを取得", "description": "リーガルホールド割り当てに関する、リーガルホールドのファイルバージョンのリストを取得します。\n\n進行中の再構築作業により、このAPIでは、このポリシーIDのファイルバージョンがすべて返されるとは限りません。\n\n代わりに、このAPIで返されるのは、従来のアーキテクチャで保持されているファイルバージョンのみです。新しいアーキテクチャで保持されているすべてのファイルバージョンをリクエストするために2つの新しいエンドポイントが使用可能になります。\n\n新しいアーキテクチャで保持されるファイルバージョンについては、`GET\n/legal_hold_policy_assignments/:id/file_versions_on_hold` APIを使用すると、このポリシー割り当てに使用できる過去のファイルバージョンをすべて返すことができます。また、`GET /legal_hold_policy_assignments/:id/files_on_hold` APIを使用すると、リーガルホールドの対象となるファイルの現在 (最新) バージョンを返すこともできます。\n\n`GET /legal_hold_policy_assignments?policy_id={id}` APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。\n\n再構築が完了すると、このAPIは非推奨になります。", "parameters": [ { "name": "policy_id", "in": "query", "description": "ファイルバージョンリーガルホールドを取得するためのリーガルホールドポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "133870" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/FileVersionLegalHolds" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "file_version_legal_holds", "tags": [ "ファイルバージョンリーガルホールド" ] } }, "/shield_information_barriers/{shield_information_barrier_id}": { "get": { "operationId": "get_shield_information_barriers_id", "summary": "指定したIDのShield情報バリアを取得", "description": "指定されたIDに基づいてShield情報バリアを取得します。", "parameters": [ { "name": "shield_information_barrier_id", "in": "path", "description": "Shield情報バリアのID。", "required": true, "schema": { "type": "string" }, "example": "1910967" } ], "responses": { "200": { "description": "Shield情報バリアオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrier" } } } }, "404": { "description": "Shield情報バリアが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barriers", "tags": [ "Shield情報バリア" ] } }, "/shield_information_barriers/change_status": { "post": { "operationId": "post_shield_information_barriers_change_status", "summary": "指定したIDのShield情報バリアの変更されたステータスを追加", "description": "指定されたIDのShield情報バリアのステータスを変更します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Shield情報バリアのID。", "type": "string", "example": "1910967" }, "status": { "description": "Shield情報バリアの任意のステータス。", "type": "string", "example": "pending", "enum": [ "pending", "disabled" ] } }, "required": [ "id", "status" ] } } } }, "responses": { "200": { "description": "更新されたShield情報バリアオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrier" } } } }, "404": { "description": "Shield情報バリアが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "既存の情報バリアとの競合が存在する場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barriers", "tags": [ "Shield情報バリア" ] } }, "/shield_information_barriers": { "get": { "operationId": "get_shield_information_barriers", "summary": "Shield情報バリアのリストを取得", "description": "JWTを使用している企業のShield情報バリアオブジェクトのリストを取得します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。", "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": "Shield情報バリアオブジェクトのページ割りされたリストを返します。現在バリアがない場合は空のリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarriers" } } } }, "404": { "description": "JWTを使用している企業が見つからない場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barriers", "tags": [ "Shield情報バリア" ] }, "post": { "operationId": "post_shield_information_barriers", "summary": "Shield情報バリアを作成", "description": "Shield情報バリアを作成して、同じ会社内で個人/グループを分離し、機密情報が互いにやり取りされるのを防ぎます。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enterprise": { "description": "このバリアが配置されている企業の`type`と`id`。", "allOf": [ { "$ref": "#/components/schemas/Enterprise--Base" } ] } }, "required": [ "enterprise" ] } } } }, "responses": { "201": { "description": "新しいShield情報バリアオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrier" } } } }, "404": { "description": "企業が見つからない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barriers", "tags": [ "Shield情報バリア" ] } }, "/shield_information_barrier_reports": { "get": { "operationId": "get_shield_information_barrier_reports", "summary": "Shield情報バリアレポートのリストを取得", "description": "Shield情報バリアレポートのリストを取得します。", "parameters": [ { "name": "shield_information_barrier_id", "in": "query", "description": "Shield情報バリアのID。", "required": true, "schema": { "type": "string" }, "example": "1910967" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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": "Shield情報バリアレポートオブジェクトのページ割りされたリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierReports" } } } }, "404": { "description": "Shield情報バリアが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_reports", "tags": [ "Shield情報バリアレポート" ] }, "post": { "operationId": "post_shield_information_barrier_reports", "summary": "Shield情報バリアレポートを作成", "description": "指定されたバリアのShield情報バリアレポートを作成します。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierReference" } } } }, "responses": { "201": { "description": "Shield情報バリアレポートの情報オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierReport" } } } }, "404": { "description": "Shield情報バリアレポートが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "Shield情報バリアレポートが現在作成中の場合は`conflict`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_reports", "tags": [ "Shield情報バリアレポート" ] } }, "/shield_information_barrier_reports/{shield_information_barrier_report_id}": { "get": { "operationId": "get_shield_information_barrier_reports_id", "summary": "IDを指定してShield情報バリアレポートを取得", "description": "IDを指定してShield情報バリアレポートを取得します。", "parameters": [ { "name": "shield_information_barrier_report_id", "in": "path", "description": "Shield情報バリアレポートのID。", "required": true, "schema": { "type": "string" }, "example": "3423" } ], "responses": { "200": { "description": "Shield情報バリアレポートオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierReport" } } } }, "404": { "description": "Shield情報バリアレポートが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_reports", "tags": [ "Shield情報バリアレポート" ] } }, "/shield_information_barrier_segments/{shield_information_barrier_segment_id}": { "get": { "operationId": "get_shield_information_barrier_segments_id", "summary": "指定したIDのShield情報バリアのセグメントを取得", "description": "指定されたIDに基づいてShield情報バリアのセグメントを取得します。", "parameters": [ { "name": "shield_information_barrier_segment_id", "in": "path", "description": "Shield情報バリアのセグメントのID。", "required": true, "schema": { "type": "string" }, "example": "3423" } ], "responses": { "200": { "description": "Shield情報バリアのセグメントオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegment" } } } }, "404": { "description": "Shield情報バリアのセグメントが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segments", "tags": [ "Shield情報バリアのセグメント" ] }, "delete": { "operationId": "delete_shield_information_barrier_segments_id", "summary": "Shield情報バリアのセグメントを削除", "description": "指定されたIDに基づいてShield情報バリアのセグメントを削除します。", "parameters": [ { "name": "shield_information_barrier_segment_id", "in": "path", "description": "Shield情報バリアのセグメントのID。", "required": true, "schema": { "type": "string" }, "example": "3423" } ], "responses": { "204": { "description": "レスポンスの本文は空です。" }, "404": { "description": "指定されたIDのShield情報バリアのセグメントが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segments", "tags": [ "Shield情報バリアのセグメント" ] }, "put": { "operationId": "put_shield_information_barrier_segments_id", "summary": "指定したIDのShield情報バリアのセグメントを更新", "description": "指定されたIDに基づいてShield情報バリアのセグメントを更新します。", "parameters": [ { "name": "shield_information_barrier_segment_id", "in": "path", "description": "Shield情報バリアのセグメントのID。", "required": true, "schema": { "type": "string" }, "example": "3423" } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Shield情報バリアのセグメントに対して行われる更新を含むオブジェクト。使用可能なプロパティには「name」と「description」があり、オブジェクトの値が更新内容となります。", "type": "object", "properties": { "name": { "description": "Shield情報バリアのセグメントの更新した名前。", "type": "string", "example": "Investment Banking", "pattern": "\\S+" }, "description": { "description": "Shield情報バリアのセグメントの更新した説明。", "type": "string", "example": "'Corporate division that engages in advisory_based\nfinancial transactions on behalf of individuals,\ncorporations, and governments.'", "nullable": true } } } } } }, "responses": { "200": { "description": "更新されたShield情報バリアのセグメントオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegment" } } } }, "404": { "description": "Shield情報バリアのセグメントが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "同じ名前のShield情報バリアのセグメントが存在する場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segments", "tags": [ "Shield情報バリアのセグメント" ] } }, "/shield_information_barrier_segments": { "get": { "operationId": "get_shield_information_barrier_segments", "summary": "Shield情報バリアのセグメントのリストを取得", "description": "指定した情報バリアIDのShield情報バリアのセグメントオブジェクトのリストを取得します。", "parameters": [ { "name": "shield_information_barrier_id", "in": "query", "description": "Shield情報バリアのID。", "required": true, "schema": { "type": "string" }, "example": "1910967" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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": "Shield情報バリアのセグメントオブジェクトのページ割りされたリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegments" } } } }, "404": { "description": "指定されたIDのShield情報バリアが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segments", "tags": [ "Shield情報バリアのセグメント" ] }, "post": { "operationId": "post_shield_information_barrier_segments", "summary": "Shield情報バリアのセグメントを作成", "description": "Shield情報バリアのセグメントを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "name": { "description": "Shield情報バリアのセグメントの名前。", "type": "string", "example": "Investment Banking" }, "description": { "description": "Shield情報バリアのセグメントの説明。", "type": "string", "example": "'Corporate division that engages in\n advisory_based financial\ntransactions on behalf of individuals,\ncorporations, and governments.'" } }, "required": [ "shield_information_barrier", "name" ] } } } }, "responses": { "201": { "description": "新しいShield情報バリアのセグメントオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegment" } } } }, "404": { "description": "Shield情報バリアが見つからなかった場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "同じ名前のShield情報バリアのセグメントが存在する場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segments", "tags": [ "Shield情報バリアのセグメント" ] } }, "/shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}": { "get": { "operationId": "get_shield_information_barrier_segment_members_id", "summary": "IDを指定してShield情報バリアのセグメントメンバーを取得", "description": "IDを指定してShield情報バリアのセグメントメンバーを取得します。", "parameters": [ { "name": "shield_information_barrier_segment_member_id", "in": "path", "description": "Shield情報バリアのセグメントメンバーのID。", "required": true, "schema": { "type": "string" }, "example": "7815" } ], "responses": { "200": { "description": "Shield情報バリアのセグメントメンバーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember" } } } }, "404": { "description": "Shield情報バリアのセグメントメンバーが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_members", "tags": [ "Shield情報バリアのセグメントメンバー" ] }, "delete": { "operationId": "delete_shield_information_barrier_segment_members_id", "summary": "IDを指定してShield情報バリアのセグメントメンバーを削除", "description": "指定されたIDに基づいてShield情報バリアのセグメントメンバーを削除します。", "parameters": [ { "name": "shield_information_barrier_segment_member_id", "in": "path", "description": "Shield情報バリアのセグメントメンバーのID。", "required": true, "schema": { "type": "string" }, "example": "7815" } ], "responses": { "204": { "description": "セグメントメンバーが正常に削除された場合は空のレスポンスを返します。" }, "404": { "description": "Shield情報バリアのセグメントメンバーが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_members", "tags": [ "Shield情報バリアのセグメントメンバー" ] } }, "/shield_information_barrier_segment_members": { "get": { "operationId": "get_shield_information_barrier_segment_members", "summary": "Shield情報バリアのセグメントメンバーのリストを取得", "description": "指定されたセグメントIDに基づいてShield情報バリアのセグメントメンバーのリストを取得します。", "parameters": [ { "name": "shield_information_barrier_segment_id", "in": "query", "description": "Shield情報バリアのセグメントのID。", "required": true, "schema": { "type": "string" }, "example": "3423" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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": "Shield情報バリアのセグメントメンバーオブジェクトのページ割りされたリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMembers" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_members", "tags": [ "Shield情報バリアのセグメントメンバー" ] }, "post": { "operationId": "post_shield_information_barrier_segment_members", "summary": "Shield情報バリアのセグメントメンバーを作成", "description": "新しいShield情報バリアのセグメントメンバーを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "Shieldバリアのセグメントメンバーのタイプ。", "type": "string", "example": "shield_information_barrier_segment_member", "enum": [ "shield_information_barrier_segment_member" ] }, "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "shield_information_barrier_segment": { "description": "リクエストされたShield情報バリアのセグメントの`type`と`id`。", "type": "object", "properties": { "id": { "description": "リクエストしているShield情報バリアのセグメントのID参照。", "type": "string", "example": "432554" }, "type": { "description": "このメンバーのShieldバリアのセグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] } } }, "user": { "description": "制限が適用されるユーザー。", "allOf": [ { "$ref": "#/components/schemas/User--Base" } ] } }, "required": [ "shield_information_barrier_segment", "user" ] } } } }, "responses": { "201": { "description": "新しいShield情報バリアのセグメントメンバーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember" } } } }, "404": { "description": "Shield情報バリアまたはセグメントが見つからなかった場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_members", "tags": [ "Shield情報バリアのセグメントメンバー" ] } }, "/shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}": { "get": { "operationId": "get_shield_information_barrier_segment_restrictions_id", "summary": "IDを指定してShield情報バリアのセグメント制限を取得", "description": "指定されたIDに基づいてShield情報バリアのセグメント制限を取得します。", "parameters": [ { "name": "shield_information_barrier_segment_restriction_id", "in": "path", "description": "Shield情報バリアのセグメント制限のID。", "required": true, "schema": { "type": "string" }, "example": "4563" } ], "responses": { "200": { "description": "Shield情報バリアのセグメント制限オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction" } } } }, "404": { "description": "Shield情報バリアのセグメント制限が見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_restrictions", "tags": [ "Shield情報バリアのセグメント制限" ] }, "delete": { "operationId": "delete_shield_information_barrier_segment_restrictions_id", "summary": "IDを指定してShield情報バリアのセグメント制限を削除", "description": "指定されたIDに基づいてShield情報バリアのセグメント制限を削除します。", "parameters": [ { "name": "shield_information_barrier_segment_restriction_id", "in": "path", "description": "Shield情報バリアのセグメント制限のID。", "required": true, "schema": { "type": "string" }, "example": "4563" } ], "responses": { "204": { "description": "レスポンスの本文は空です。" }, "404": { "description": "Shield情報バリアのセグメント制限が見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_restrictions", "tags": [ "Shield情報バリアのセグメント制限" ] } }, "/shield_information_barrier_segment_restrictions": { "get": { "operationId": "get_shield_information_barrier_segment_restrictions", "summary": "Shield情報バリアのセグメント制限のリストを取得", "description": "指定されたセグメントIDに基づいてShield情報バリアのセグメント制限のリストを取得します。", "parameters": [ { "name": "shield_information_barrier_segment_id", "in": "query", "description": "Shield情報バリアのセグメントのID。", "required": true, "schema": { "type": "string" }, "example": "3423" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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": "Shield情報バリアのセグメント制限オブジェクトのページ割りされたリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestrictions" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_restrictions", "tags": [ "Shield情報バリアのセグメント制限" ] }, "post": { "operationId": "post_shield_information_barrier_segment_restrictions", "summary": "Shield情報バリアのセグメント制限を作成", "description": "Shield情報バリアのセグメント制限オブジェクトを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "このメンバーのShieldバリアのセグメント制限のタイプ。", "type": "string", "example": "shield_information_barrier_segment_restriction", "enum": [ "shield_information_barrier_segment_restriction" ] }, "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "shield_information_barrier_segment": { "description": "リクエストされたShield情報バリアのセグメントの`type`と`id`。", "type": "object", "properties": { "id": { "description": "リクエストしているShield情報バリアのセグメントのID参照。", "type": "string", "example": "1910967" }, "type": { "description": "このメンバーのShieldバリアのセグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] } } }, "restricted_segment": { "description": "制限されたShield情報バリアのセグメントの`type`と`id`。", "type": "object", "properties": { "id": { "description": "制限されたShield情報バリアのセグメントのID参照。", "type": "string", "example": "1910967" }, "type": { "description": "制限されたShield情報バリアのセグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] } } } }, "required": [ "type", "shield_information_barrier_segment", "restricted_segment" ] } } } }, "responses": { "201": { "description": "新しく作成されたShield情報バリアのセグメント制限オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction" } } } }, "404": { "description": "Shield情報バリアまたはセグメントが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_information_barrier_segment_restrictions", "tags": [ "Shield情報バリアのセグメント制限" ] } }, "/device_pinners/{device_pinner_id}": { "get": { "operationId": "get_device_pinners_id", "summary": "デバイスピンを取得", "description": "個々のデバイスピンに関する情報を取得します。", "parameters": [ { "name": "device_pinner_id", "in": "path", "description": "デバイスピンのID。", "required": true, "schema": { "type": "string" }, "example": "2324234" } ], "responses": { "200": { "description": "単一のデバイスピンに関する情報を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicePinner" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "device_pinners", "tags": [ "Device Pinners" ] }, "delete": { "operationId": "delete_device_pinners_id", "summary": "デバイスピンを削除", "description": "個々のデバイスピンを削除します。", "parameters": [ { "name": "device_pinner_id", "in": "path", "description": "デバイスピンのID。", "required": true, "schema": { "type": "string" }, "example": "2324234" } ], "responses": { "204": { "description": "ピンが削除された場合は、空のレスポンスを返します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "device_pinners", "tags": [ "Device Pinners" ] } }, "/enterprises/{enterprise_id}/device_pinners": { "get": { "operationId": "get_enterprises_id_device_pinners", "summary": "会社のデバイスピンのリストを取得", "description": "会社内のすべてのデバイスピンを取得します。\n\nこの呼び出しを行うにはユーザーに管理者権限が必要で、アプリケーションに「Enterpriseの管理」スコープが必要です。", "parameters": [ { "name": "enterprise_id", "in": "path", "description": "企業のID。", "required": true, "schema": { "type": "string" }, "example": "3442311" }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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 }, { "name": "direction", "in": "query", "description": "結果を並べ替える方向。アルファベットの昇順 (`ASC`) または降順 (`DESC`) のいずれかを指定できます。", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" } ], "responses": { "200": { "description": "指定した会社のデバイスピンのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicePinners" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "device_pinners", "tags": [ "Device Pinners" ] } }, "/terms_of_services": { "get": { "operationId": "get_terms_of_services", "summary": "サービス利用規約のリストを取得", "description": "企業の現在のサービス利用規約のテキストと設定を返します。", "parameters": [ { "name": "tos_type", "in": "query", "description": "指定した種類のサービス利用規約のみに結果を絞り込みます。", "required": false, "schema": { "type": "string", "enum": [ "external", "managed" ] }, "example": "managed" } ], "responses": { "200": { "description": "企業のサービス利用規約のテキストおよび設定のコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfServices" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_services", "tags": [ "サービス利用規約" ] }, "post": { "operationId": "post_terms_of_services", "summary": "サービス利用規約を作成", "description": "指定した企業とユーザータイプに適用されるサービス利用規約を作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "このサービス利用規約がアクティブであるかどうか。", "type": "string", "example": "enabled", "enum": [ "enabled", "disabled" ] }, "tos_type": { "description": "サービス利用規約を設定するユーザーのタイプ。", "type": "string", "example": "managed", "enum": [ "external", "managed" ] }, "text": { "description": "ユーザーに対して表示されるサービス利用規約のテキスト。\n\n`status`が`disabled`に設定されている場合は、テキストを空に設定できます。", "type": "string", "example": "By collaborating on this file you are accepting..." } }, "required": [ "status", "text" ] } } } }, "responses": { "200": { "description": "新しいタスクオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfService" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_services", "tags": [ "サービス利用規約" ] } }, "/terms_of_services/{terms_of_service_id}": { "get": { "operationId": "get_terms_of_services_id", "summary": "サービス利用規約を取得", "description": "特定のサービス利用規約を取得します。", "parameters": [ { "name": "terms_of_service_id", "in": "path", "description": "サービス利用規約のID。", "required": true, "schema": { "type": "string" }, "example": "324234" } ], "responses": { "200": { "description": "サービス利用規約オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfService" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_services", "tags": [ "サービス利用規約" ] }, "put": { "operationId": "put_terms_of_services_id", "summary": "サービス利用規約を更新", "description": "特定のサービス利用規約を更新します。", "parameters": [ { "name": "terms_of_service_id", "in": "path", "description": "サービス利用規約のID。", "required": true, "schema": { "type": "string" }, "example": "324234" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "description": "このサービス利用規約がアクティブであるかどうか。", "type": "string", "example": "enabled", "enum": [ "enabled", "disabled" ] }, "text": { "description": "ユーザーに対して表示されるサービス利用規約のテキスト。\n\n`status`が`disabled`に設定されている場合は、テキストを空に設定できます。", "type": "string", "example": "By collaborating on this file you are accepting..." } }, "required": [ "status", "text" ] } } } }, "responses": { "200": { "description": "更新されたサービス利用規約オブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfService" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_services", "tags": [ "サービス利用規約" ] } }, "/terms_of_service_user_statuses": { "get": { "operationId": "get_terms_of_service_user_statuses", "summary": "サービス利用規約のユーザーステータスのリストを取得", "description": "ユーザーとそのユーザーに適用されるサービス利用規約のステータスの概要 (ユーザーが利用規約に同意したかどうかや、いつ同意したかなど) を取得します。", "parameters": [ { "name": "tos_id", "in": "query", "description": "サービス利用規約のID。", "required": true, "schema": { "type": "string" }, "example": "324234" }, { "name": "user_id", "in": "query", "description": "指定したユーザーIDのみに結果を絞り込みます。", "required": false, "schema": { "type": "string" }, "example": "123334" } ], "responses": { "200": { "description": "サービス利用規約のステータスのリストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfServiceUserStatuses" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_service_user_statuses", "tags": [ "サービス利用規約のユーザーステータス" ] }, "post": { "operationId": "post_terms_of_service_user_statuses", "summary": "新規ユーザーのサービス利用規約のステータスを作成", "description": "ユーザーのサービス利用規約のステータスを設定します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tos": { "description": "ステータスを設定するサービス利用規約。", "type": "object", "properties": { "type": { "description": "オブジェクトのタイプ。", "type": "string", "example": "terms_of_service", "enum": [ "terms_of_service" ] }, "id": { "description": "サービス利用規約のID。", "type": "string", "example": "1232132" } }, "required": [ "id", "type" ] }, "user": { "description": "ステータスを設定するユーザー。", "type": "object", "properties": { "type": { "description": "オブジェクトのタイプ。", "type": "string", "example": "user", "enum": [ "user" ] }, "id": { "description": "ユーザーのID。", "type": "string", "example": "3423423" } }, "required": [ "id", "type" ] }, "is_accepted": { "description": "ユーザーが利用規約に同意したかどうか。", "type": "boolean", "example": true } }, "required": [ "tos", "user", "is_accepted" ] } } } }, "responses": { "201": { "description": "サービス利用規約ステータスオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfServiceUserStatus" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_service_user_statuses", "tags": [ "サービス利用規約のユーザーステータス" ] } }, "/terms_of_service_user_statuses/{terms_of_service_user_status_id}": { "put": { "operationId": "put_terms_of_service_user_statuses_id", "summary": "既存ユーザーのサービス利用規約のステータスを更新", "description": "ユーザーのサービス利用規約のステータスを更新します。", "parameters": [ { "name": "terms_of_service_user_status_id", "in": "path", "description": "サービス利用規約ステータスのID。", "required": true, "schema": { "type": "string" }, "example": "324234" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_accepted": { "description": "ユーザーが利用規約に同意したかどうか。", "type": "boolean", "example": true } }, "required": [ "is_accepted" ] } } } }, "responses": { "200": { "description": "更新されたサービス利用規約のステータスオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsOfServiceUserStatus" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "terms_of_service_user_statuses", "tags": [ "サービス利用規約のユーザーステータス" ] } }, "/collaboration_whitelist_entries": { "get": { "operationId": "get_collaboration_whitelist_entries", "summary": "許可されたコラボレーションドメインのリストを取得", "description": "現在の会社内でコラボレーションを作成しても安全であると見なされているドメインのリストを返します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/CollaborationAllowlistEntries" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_entries", "tags": [ "コラボレーションに対するドメインを制限" ] }, "post": { "operationId": "post_collaboration_whitelist_entries", "summary": "許可されたコラボレーションドメインのリストにドメインを追加", "description": "コラボレーションが許可されているドメインのリストに新しいエントリを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "description": "許可されたドメインのリストに追加するドメイン。", "type": "string", "example": "example.com" }, "direction": { "description": "コラボレーションを許可する方向。", "type": "string", "example": "inbound", "enum": [ "inbound", "outbound", "both" ] } }, "required": [ "domain", "direction" ] } } } }, "responses": { "200": { "description": "許可されたドメインのリストに新しいエントリを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationAllowlistEntry" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_entries", "tags": [ "コラボレーションに対するドメインを制限" ] } }, "/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}": { "get": { "operationId": "get_collaboration_whitelist_entries_id", "summary": "許可されたコラボレーションドメインを取得", "description": "現在の会社内でコラボレーションを作成しても安全であると見なされているドメインを返します。", "parameters": [ { "name": "collaboration_whitelist_entry_id", "in": "path", "description": "リスト内のエントリのID。", "required": true, "schema": { "type": "string" }, "example": "213123" } ], "responses": { "200": { "description": "許可されたドメインのリストにエントリを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationAllowlistEntry" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_entries", "tags": [ "コラボレーションに対するドメインを制限" ] }, "delete": { "operationId": "delete_collaboration_whitelist_entries_id", "summary": "許可されたコラボレーションドメインのリストからドメインを削除", "description": "現在の会社内でコラボレーションを作成しても安全であると見なされているドメインのリストからドメインを削除します。", "parameters": [ { "name": "collaboration_whitelist_entry_id", "in": "path", "description": "リスト内のエントリのID。", "required": true, "schema": { "type": "string" }, "example": "213123" } ], "responses": { "204": { "description": "エントリが正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_entries", "tags": [ "コラボレーションに対するドメインを制限" ] } }, "/collaboration_whitelist_exempt_targets": { "get": { "operationId": "get_collaboration_whitelist_exempt_targets", "summary": "コラボレーションドメインの制限から除外するユーザーのリストを取得", "description": "コラボレーションドメインの制限から除外されているユーザーのリストを返します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/CollaborationAllowlistExemptTargets" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_exempt_targets", "tags": [ "ドメインの制限 (ユーザーの除外)" ] }, "post": { "operationId": "post_collaboration_whitelist_exempt_targets", "summary": "コラボレーションドメインの制限からのユーザー除外を作成", "description": "コラボレーションが許可されたドメインリストで設定された制限からユーザーを除外します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "description": "除外するユーザー。", "type": "object", "properties": { "id": { "description": "除外するユーザーのID。", "type": "string", "example": "23522323" } }, "required": [ "id" ] } }, "required": [ "user" ] } } } }, "responses": { "200": { "description": "新しい除外エントリを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationAllowlistExemptTarget" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_exempt_targets", "tags": [ "ドメインの制限 (ユーザーの除外)" ] } }, "/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}": { "get": { "operationId": "get_collaboration_whitelist_exempt_targets_id", "summary": "コラボレーションドメインの制限から除外するユーザーを取得", "description": "コラボレーションドメインの制限から除外されているユーザーを返します。", "parameters": [ { "name": "collaboration_whitelist_exempt_target_id", "in": "path", "description": "リストに対する除外のID。", "required": true, "schema": { "type": "string" }, "example": "984923" } ], "responses": { "200": { "description": "コラボレーションドメインのリストから除外されたユーザーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollaborationAllowlistExemptTarget" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_exempt_targets", "tags": [ "ドメインの制限 (ユーザーの除外)" ] }, "delete": { "operationId": "delete_collaboration_whitelist_exempt_targets_id", "summary": "ドメインの制限から除外されるユーザーのリストからユーザーを削除", "description": "コラボレーションが許可されたドメインリストで設定された制限からユーザーの除外を削除します。", "parameters": [ { "name": "collaboration_whitelist_exempt_target_id", "in": "path", "description": "リストに対する除外のID。", "required": true, "schema": { "type": "string" }, "example": "984923" } ], "responses": { "204": { "description": "例外が正常に削除された場合は、空のレスポンスが返されます。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "collaboration_allowlist_exempt_targets", "tags": [ "ドメインの制限 (ユーザーの除外)" ] } }, "/storage_policies": { "get": { "operationId": "get_storage_policies", "summary": "ストレージポリシーのリストを取得", "description": "企業のすべてのストレージポリシーを取得します。", "parameters": [ { "name": "fields", "in": "query", "description": "レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。\n\nこのパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "id", "type", "name" ], "explode": false }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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/StoragePolicies" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policies", "tags": [ "標準およびZonesのストレージポリシー" ] } }, "/storage_policies/{storage_policy_id}": { "get": { "operationId": "get_storage_policies_id", "summary": "ストレージポリシーを取得", "description": "特定のストレージポリシーを取得します。", "parameters": [ { "name": "storage_policy_id", "in": "path", "description": "ストレージポリシーのID。", "required": true, "schema": { "type": "string" }, "example": "34342" } ], "responses": { "200": { "description": "ストレージポリシーオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePolicy" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policies", "tags": [ "標準およびZonesのストレージポリシー" ] } }, "/storage_policy_assignments": { "get": { "operationId": "get_storage_policy_assignments", "summary": "ストレージポリシー割り当てのリストを取得", "description": "会社またはユーザーのすべてのストレージポリシー割り当てを取得します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "resolved_for_type", "in": "query", "description": "割り当てを返すターゲットのタイプ。", "required": true, "schema": { "type": "string", "enum": [ "user", "enterprise" ] }, "example": "user" }, { "name": "resolved_for_id", "in": "query", "description": "割り当てを返すユーザーまたは企業のID。", "required": true, "schema": { "type": "string" }, "example": "984322" } ], "responses": { "200": { "description": "会社またはユーザーのストレージポリシーのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePolicyAssignments" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policy_assignments", "tags": [ "標準およびZonesのストレージポリシー割り当て" ] }, "post": { "operationId": "post_storage_policy_assignments", "summary": "ストレージポリシーを割り当て", "description": "会社またはユーザーに対するストレージポリシー割り当てを作成します。", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "storage_policy": { "description": "ユーザーまたは企業に割り当てるストレージポリシー。", "type": "object", "properties": { "type": { "description": "割り当てるタイプ。", "type": "string", "example": "storage_policy", "enum": [ "storage_policy" ] }, "id": { "description": "割り当てるストレージポリシーのID。", "type": "string", "example": "1434325" } }, "required": [ "type", "id" ] }, "assigned_to": { "description": "ストレージポリシーを割り当てるユーザーまたは会社。", "type": "object", "properties": { "type": { "description": "ポリシーを割り当てるタイプ。", "type": "string", "example": "user", "enum": [ "user", "enterprise" ] }, "id": { "description": "ユーザーまたは企業のID。", "type": "string", "example": "9987987" } }, "required": [ "type", "id" ] } }, "required": [ "storage_policy", "assigned_to" ] } } } }, "responses": { "200": { "description": "作成された新しいストレージポリシー割り当てを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePolicyAssignment" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policy_assignments", "tags": [ "標準およびZonesのストレージポリシー割り当て" ] } }, "/storage_policy_assignments/{storage_policy_assignment_id}": { "get": { "operationId": "get_storage_policy_assignments_id", "summary": "ストレージポリシー割り当てを取得", "description": "特定のストレージポリシー割り当てを取得します。", "parameters": [ { "name": "storage_policy_assignment_id", "in": "path", "description": "ストレージポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "932483" } ], "responses": { "200": { "description": "ストレージポリシー割り当てオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePolicyAssignment" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policy_assignments", "tags": [ "標準およびZonesのストレージポリシー割り当て" ] }, "put": { "operationId": "put_storage_policy_assignments_id", "summary": "ストレージポリシー割り当てを更新", "description": "特定のストレージポリシー割り当てを更新します。", "parameters": [ { "name": "storage_policy_assignment_id", "in": "path", "description": "ストレージポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "932483" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "storage_policy": { "description": "ユーザーまたは企業に割り当てるストレージポリシー。", "type": "object", "properties": { "type": { "description": "割り当てるタイプ。", "type": "string", "example": "storage_policy", "enum": [ "storage_policy" ] }, "id": { "description": "割り当てるストレージポリシーのID。", "type": "string", "example": "1434325" } }, "required": [ "type", "id" ] } }, "required": [ "storage_policy" ] } } } }, "responses": { "200": { "description": "更新されたストレージポリシー割り当てオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePolicyAssignment" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policy_assignments", "tags": [ "標準およびZonesのストレージポリシー割り当て" ] }, "delete": { "operationId": "delete_storage_policy_assignments_id", "summary": "ストレージポリシーの割り当てを解除", "description": "ストレージポリシーの割り当てを削除します。\n\nユーザーに対するストレージポリシーの割り当てを削除すると、そのユーザーは会社のデフォルトのストレージポリシーを継承します。\n\nこのエンドポイントの呼び出しには、24時間につき1ユーザーあたり2回までというレート制限が適用されます。", "parameters": [ { "name": "storage_policy_assignment_id", "in": "path", "description": "ストレージポリシー割り当てのID。", "required": true, "schema": { "type": "string" }, "example": "932483" } ], "responses": { "204": { "description": "ストレージポリシー割り当てが正常に削除された場合は、空のレスポンスを返します。" }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "storage_policy_assignments", "tags": [ "標準およびZonesのストレージポリシー割り当て" ] } }, "/zip_downloads": { "post": { "operationId": "post_zip_downloads", "summary": "zipダウンロードを作成", "description": "複数のファイルやフォルダを1つの`zip`アーカイブファイルとしてダウンロードするためのリクエストを作成します。このAPIでは、アーカイブは返されませんが、代わりにユーザーがすべての項目にアクセスできるかどうかを確認するチェックがすべて実行され、アーカイブのダウンロードに使用できる`download_url`および`status_url`が返されます。\n\nアーカイブの上限は、アカウントのアップロード上限または10,000ファイルのいずれかで、最初に達した上限が適用されます。\n\n**注**: 大きいファイルをダウンロードする場合は、距離、ネットワーク遅延、帯域幅、輻輳のほか、パケット損失率や現在のサーバー負荷など、さまざまな要因の影響を受けることがあります。このような理由から、Boxでは、ZIPアーカイブの合計サイズが25 GBを超えないようにすることをお勧めします。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipDownloadRequest" } } } }, "responses": { "202": { "description": "`zip`アーカイブをダウンロードする準備ができている場合、このAPIによって、`download_url`、`status_url`のほか、リクエストの作成時に発生した可能性のある競合を含むレスポンスが返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipDownload" }, "examples": { "default": { "value": { "download_url": "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content", "status_url": "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status", "expires_at": "2020-07-22T11:26:08Z", "name_conflicts": [ [ { "id": "12345", "type": "file", "original_name": "Report.pdf", "download_name": "3aa6a7.pdf" }, { "id": "34325", "type": "file", "original_name": "Report.pdf", "download_name": "5d53f2.pdf" } ] ] } } } } } }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\nほとんどの場合、このエラーは、JSONリクエスト本文が有効なJSONではないこと、項目のいずれかでIDが誤っているか指定されていないこと、いずれかの項目がファイルでもフォルダでもないこと、またはIDが`0`のルートフォルダがアーカイブに追加するフォルダのリストに追加されたことが原因で発生する可能性があります。\n\n以下は、このレスポンスに対する共通エラーコードのリストです。\n\n* `bad_request` - リクエスト本文がないか無効である、またはファイルリストとフォルダリストの両方が空です。さらに、このエラーは、IDが`0`のルートフォルダをアーカイブに追加しようとすると返される場合があります。\n* `zip_download_file_count_exceeded_limit` - リクエストされたファイルおよびフォルダによって、アーカイブのファイル数が10,000を超えます。アーカイブあたりのファイル数を減らすには、リクエストを複数のリクエストに分割する必要があります。\n* `zip_download_pre_compressed_bytes_exceeded_limit` - リクエストされたファイルおよびフォルダにより、アーカイブが、許可されたダウンロード上限を超えます。アーカイブのサイズを縮小するには、リクエストを複数のリクエストに分割する必要があります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "承認ヘッダーが指定されていても、ユーザーが項目にアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "zip_downloads", "tags": [ "zipダウンロード" ], "x-box-reference-category": "zip_downloads" } }, "/zip_downloads/{zip_download_id}/content": { "get": { "operationId": "get_zip_downloads_id_content", "summary": "zipアーカイブをダウンロード", "description": "`zip`アーカイブのコンテンツをバイナリ形式で返します。このURLは、どのような形式の認証も要求せず、ユーザーのブラウザでユーザーのデバイスにアーカイブをダウンロードする際に使用できます。\n\nデフォルトでは、このURLの有効期間は、このアーカイブに対するリクエストを作成してから数秒間だけです。一度ダウンロードが開始されると、停止して再開することはできません。代わりに、zipアーカイブに対する新しいリクエストを作成する必要があります。\n\nこのエンドポイントのURLは固定であるとは考えないでください。代わりに、[zipダウンロードを作成](e://post_zip_downloads)APIを使用して`zip`アーカイブの作成をリクエストした後、このエンドポイントのレスポンスにある`download_url`フィールドに従ってください。", "parameters": [ { "name": "zip_download_id", "in": "path", "description": "この`zip`アーカイブを表す一意の識別子。", "required": true, "schema": { "type": "string" }, "example": "Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd" } ], "responses": { "200": { "description": "`zip`アーカイブのファイルおよびフォルダをストリームの形式にして、このダウンロードに対してリクエストされた項目のコンテンツを返します。", "headers": { "Content-Disposition": { "description": "ダウンロードするアーカイブの名前。", "schema": { "type": "string", "example": "attachment;filename=\"Avatars.zip\";filename*=UTF-8''Avatars.zip" } } }, "content": { "application/octet-stream": { "schema": { "description": "アーカイブのバイナリコンテンツ。これには、このダウンロードに対してリクエストされた項目が含まれます。", "type": "string", "format": "binary" } } } }, "404": { "description": "このダウンロードリクエストのIDが無効な場合にエラーを返します。また、このエラーは、以前にこのURLが呼び出されている場合にも返されます。このアーカイブを再度ダウンロードするには、zipダウンロードの新しいリクエストを作成してください。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "ユーザーまたは会社の同時実行zipダウンロード数に達した場合にエラーを返します。\n\n* `user_too_many_concurrent_downloads` - ユーザーあたりのzipアーカイブの並行ダウンロード数が最大値5に達しました。\n* `enterprise_too_many_concurrent_downloads` - 企業あたりのzipアーカイブの並行ダウンロード数が最大値10に達しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "zip_downloads", "security": [], "servers": [ { "url": "https://dl.boxcloud.com/2.0", "description": "zipダウンロードを実行するための不明瞭なサーバーURL。このURL形式は、時間が経つと変わる可能性があります。" } ], "tags": [ "zipダウンロード" ], "x-box-reference-category": "zip_downloads" } }, "/zip_downloads/{zip_download_id}/status": { "get": { "operationId": "get_zip_downloads_id_status", "summary": "zipダウンロードのステータスを取得", "description": "`zip`アーカイブのダウンロードステータスを返します。これにより、アプリケーションは、ダウンロードの進行状況のほか、スキップされた可能性のある項目の数を確認できます。\n\nこのエンドポイントにアクセスできるのは、ダウンロードが開始された後だけです。このエンドポイントの有効期間は、ダウンロードを開始してから12時間です。\n\nこのエンドポイントのURLは固定であるとは考えないでください。代わりに、[zipダウンロードを作成](e://post_zip_downloads)APIを使用して`zip`アーカイブの作成をリクエストした後、このエンドポイントのレスポンスにある`status_url`フィールドに従ってください。", "parameters": [ { "name": "zip_download_id", "in": "path", "description": "この`zip`アーカイブを表す一意の識別子。", "required": true, "schema": { "type": "string" }, "example": "Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd" } ], "responses": { "200": { "description": "ダウンロード中の`zip`アーカイブのステータスを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipDownloadStatus" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "承認ヘッダーが指定されていても、ユーザーが項目にアクセスできない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "このダウンロードリクエストのIDが無効な場合、またはダウンロードが開始される前にダウンロードのステータスがリクエストされた場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "zip_downloads", "tags": [ "zipダウンロード" ], "x-box-reference-category": "zip_downloads" } }, "/sign_requests/{sign_request_id}/cancel": { "post": { "operationId": "post_sign_requests_id_cancel", "summary": "Box Signリクエストをキャンセル", "description": "署名リクエストをキャンセルします。", "parameters": [ { "name": "sign_request_id", "in": "path", "description": "署名リクエストのID。", "required": true, "schema": { "type": "string" }, "example": "33243242" } ], "responses": { "200": { "description": "署名リクエストオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignRequest" } } } }, "404": { "description": "署名リクエストが見つからない場合、またはユーザーが署名リクエストにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "sign_requests", "tags": [ "Box Signリクエスト" ] } }, "/sign_requests/{sign_request_id}/resend": { "post": { "operationId": "post_sign_requests_id_resend", "summary": "Box Signリクエストを再送信", "description": "未署名の署名者全員に署名リクエストのメールを再送信します。", "parameters": [ { "name": "sign_request_id", "in": "path", "description": "署名リクエストのID。", "required": true, "schema": { "type": "string" }, "example": "33243242" } ], "responses": { "202": { "description": "APIコールが成功した場合に空のレスポンスを返します。メール通知が非同期的に送信されます。" }, "404": { "description": "署名リクエストが見つからない場合、またはユーザーが署名リクエストにアクセスできない場合はエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "sign_requests", "tags": [ "Box Signリクエスト" ] } }, "/sign_requests/{sign_request_id}": { "get": { "operationId": "get_sign_requests_id", "summary": "IDを指定してBox Signリクエストを取得", "description": "IDを指定して署名リクエストを取得します。", "parameters": [ { "name": "sign_request_id", "in": "path", "description": "署名リクエストのID。", "required": true, "schema": { "type": "string" }, "example": "33243242" } ], "responses": { "200": { "description": "署名リクエストを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignRequest" } } } }, "404": { "description": "署名リクエストが見つからない場合、ユーザーが署名リクエストにアクセスできない場合、または`sign_files`や`parent_folder`が削除された場合にエラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "sign_requests", "tags": [ "Box Signリクエスト" ] } }, "/sign_requests": { "get": { "operationId": "get_sign_requests", "summary": "Box Signリクエストのリストを取得", "description": "ユーザーが作成した署名リクエストを取得します。`sign_files`や`parent_folder`が削除された場合、署名リクエストはリストで返されません。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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 }, { "name": "senders", "in": "query", "description": "送信者で署名リクエストにフィルタをかけるための送信者のメールアドレスのリスト。指定した場合、`shared_requests`は`true`に設定する必要があります。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "sender1@boxdemo.com", "sender2@boxdemo.com" ] }, { "name": "shared_requests", "in": "query", "description": "`true`に設定した場合、ユーザーが所有者ではなくコラボレータであるリクエストのみが含まれます。コラボレータのアクセス権限は、リクエストの署名ファイルのユーザーアクセスレベルによって決まります。デフォルト値は`false`です。`senders`が指定されている場合は`true`に設定する必要があります。", "required": false, "schema": { "type": "boolean", "default": false }, "example": true } ], "responses": { "200": { "description": "署名リクエストのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignRequests" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "sign_requests", "tags": [ "Box Signリクエスト" ] }, "post": { "operationId": "post_sign_requests", "summary": "Box Signリクエストを作成", "description": "署名リクエストを作成します。これには、署名用ドキュメントの準備と署名者への署名リクエストの送信が含まれます。", "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-box-tag": "sign_requests", "tags": [ "Box Signリクエスト" ] } }, "/workflows": { "get": { "operationId": "get_workflows", "summary": "ワークフローのリストを取得", "description": "指定した`folder ID`に作用し、トリガータイプが`WORKFLOW_MANUAL_START`のフローを含むワークフローのリストを返します。\n\nアプリケーションは、このエンドポイントを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。", "parameters": [ { "name": "folder_id", "in": "query", "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folder/123`の場合、`folder_id`は`123`です。\n\nBoxアカウントのルートフォルダは常にID `0`で表されます。", "required": true, "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "trigger_type", "in": "query", "description": "検索するトリガーのタイプ。", "required": false, "schema": { "type": "string", "nullable": false }, "example": "WORKFLOW_MANUAL_START" }, { "name": "limit", "in": "query", "description": "返す項目の1ページあたりの最大数。", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`usemarker`を`true`に設定する必要があります。", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "ワークフローを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflows" } } } }, "400": { "description": "トリガータイプが`WORKFLOW_MANUAL_START`ではない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "workflows", "tags": [ "Workflows" ] } }, "/workflows/{workflow_id}/start": { "post": { "operationId": "post_workflows_id_start", "summary": "リクエスト本文に基づいてワークフローを開始", "description": "トリガータイプが`WORKFLOW_MANUAL_START`のフローを開始します。\n\nアプリケーションは、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。", "parameters": [ { "name": "workflow_id", "in": "path", "description": "ワークフローのID。", "required": true, "schema": { "type": "string" }, "example": "12345" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "description": "パラメータオブジェクトのタイプ。", "type": "string", "example": "workflow_parameters", "enum": [ "workflow_parameters" ] }, "flow": { "description": "トリガーされるフロー。", "type": "object", "properties": { "type": { "description": "フローオブジェクトのタイプ。", "type": "string", "example": "flow" }, "id": { "description": "フローのID。", "type": "string", "example": "123456789" } } }, "files": { "description": "ワークフローが開始されるファイルの配列。すべてのファイルは、ワークフローの設定済みフォルダに存在する必要があります。", "type": "array", "items": { "type": "object", "description": "ワークフローが開始されるファイル。", "properties": { "type": { "description": "ファイルオブジェクトのタイプ。", "type": "string", "example": "file", "enum": [ "file" ] }, "id": { "description": "ファイルのID。", "type": "string", "example": "12345678" } } } }, "folder": { "description": "ワークフローが設定されているフォルダオブジェクト。", "type": "object", "properties": { "type": { "description": "フォルダオブジェクトのタイプ。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "フォルダのID。", "type": "string", "example": "87654321" } } }, "outcomes": { "description": "ワークフローで完了する必要がある設定可能な結果。", "type": "array", "items": { "$ref": "#/components/schemas/Outcome" } } }, "required": [ "flow", "files", "folder" ] } } } }, "responses": { "204": { "description": "ワークフローを開始します。" }, "400": { "description": "パラメータが不足しているか無効の場合はエラーを返します。\n\n* ワークフローが有効でない場合は`workflow_is_not_enabled`。\n* 指定されたフォルダIDに対してワークフローが有効でない場合は`workflow_not_active_on_provided_folder`。\n* 指定されたパラメータが予期されたパラメータと一致しない場合は`parameters_provided_do_not_match_target_outcome`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "権限が不足している場合にエラーを返します。\n\n* ユーザーにファイルまたはフォルダへのアクセス権限がない場合は`insufficient_access`。\n* ユーザーにRelay全体へのアクセス権限がない場合は`missing_relay_full_access`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "ワークフローが見つからない場合、または認証済みユーザーがワークフローにアクセスできない場合はエラーを返します。\n\n* ワークフローが見つからない場合は`workflow_not_found`。\n* フローが手動開始フローでない場合は`flow_missing_or_inaccessible`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "workflows", "tags": [ "Workflows" ] } }, "/sign_templates": { "get": { "operationId": "get_sign_templates", "summary": "Box Signテンプレートのリストを取得", "description": "ユーザーによって作成されたBox Signテンプレートを取得します。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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-box-tag": "sign_templates", "tags": [ "Box Signテンプレート" ] } }, "/sign_templates/{template_id}": { "get": { "operationId": "get_sign_templates_id", "summary": "IDを指定してBox Signテンプレートを取得", "description": "特定のBox Signテンプレートの詳細を取得します。", "parameters": [ { "name": "template_id", "in": "path", "description": "Box SignテンプレートのID。", "required": true, "schema": { "type": "string" }, "example": "123075213-7d117509-8f05-42e4-a5ef-5190a319d41d" } ], "responses": { "200": { "description": "テンプレートの詳細を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignTemplate" } } } }, "401": { "description": "`Authorization`ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "テンプレートが見つからない場合、または関連付けられたテンプレートへのアクセス権限がユーザーに与えられていない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "sign_templates", "tags": [ "Box Signテンプレート" ] } }, "/integration_mappings/slack": { "get": { "operationId": "get_integration_mappings_slack", "summary": "Slack統合マッピングのリストを取得", "description": "ユーザーの企業内の[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)のリストを取得します。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "parameters": [ { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。\n\nこれを使用するには、`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 }, { "name": "partner_item_type", "in": "query", "description": "マッピングが返される、マッピングされた項目タイプ。", "schema": { "type": "string", "enum": [ "channel" ] }, "example": "channel" }, { "name": "partner_item_id", "in": "query", "description": "マッピングが返される、マッピングされた項目のID。", "schema": { "type": "string" }, "example": "12345" }, { "name": "box_item_id", "in": "query", "description": "マッピングが返される、Box項目ID。", "schema": { "type": "string", "nullable": false }, "example": "12345" }, { "name": "box_item_type", "in": "query", "description": "マッピングが返される、Box項目タイプ。", "schema": { "type": "string", "enum": [ "folder" ], "nullable": false }, "example": "folder" }, { "name": "is_manually_created", "in": "query", "description": "マッピングが手動で作成されたかどうか。", "schema": { "type": "boolean", "nullable": false }, "example": true } ], "responses": { "200": { "description": "統合マッピングのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMappings" } } } }, "400": { "description": "クライアントエラーが原因で、サーバーはリクエストを処理できないか、処理しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "統合マッピングが見つからなかった場合、`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] }, "post": { "operationId": "post_integration_mappings_slack", "summary": "Slack統合マッピングを作成", "description": "SlackチャンネルをBox項目にマッピングすることで、[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)を作成します。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMappingSlackCreateRequest" } } } }, "responses": { "201": { "description": "作成された統合マッピングを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapping" } } } }, "400": { "description": "誤った`options`が指定された場合またはBoxフォルダをこの`partner_item_id`にマッピングできない場合に`bad_request`を返します。エラーコードは以下のとおりです。\n\n* `SERVICE_ACCOUNT_IS_NOT_A_COOWNER_OR_OWNER` - サービスアカウントに共同所有者のコラボレーションがないか、サービスアカウントが`box_item_id`の所有者ではありません。\n* `CHANNEL_ALREADY_MAPPED` - チャンネルがすでに別の`box_item_id`にマッピングされています。\n* `CHANNEL_NOT_FOUND` - チャンネルが見つかりませんでした。\n* `CHANNEL_NOT_SUITABLE_FOR_CFS` - コネクトチャンネルのため、SlackのコンテンツレイヤーとしてBoxを使用するのに適していません。\n* `BOX_ENTERPRISE_MISMATCH` - Boxフォルダは、BoxをSlackのコンテンツレイヤーとして使用するよう構成されている企業が所有している必要があります。\n* `CFS_DISABLED` - SlackのコンテンツレイヤーとしてのBoxの使用を、指定したSlackワークスペースまたはオーガナイゼーションに対して有効にする必要があります。\n* `BOX_FOLDER_EXTERNALLY_OWNED` - Boxフォルダは、管理者の企業内で所有されている必要があります。\n* `JWT_APP_NOT_AUTHORIZED` - JWT承認エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "統合マッピングが見つからなかった場合、`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] } }, "/integration_mappings/slack/{integration_mapping_id}": { "put": { "operationId": "put_integration_mappings_slack_id", "summary": "Slack統合マッピングを更新", "description": "[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)を更新します。BoxフォルダIDおよびオプションの更新をサポートします。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "parameters": [ { "name": "integration_mapping_id", "in": "path", "description": "統合マッピングのID。", "required": true, "schema": { "type": "string" }, "example": "11235432" } ], "requestBody": { "description": "At least one of `box_item` and `options` must be provided.", "content": { "application/json": { "schema": { "type": "object", "properties": { "box_item": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingBoxItemSlack" } ] }, "options": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingSlackOptions" } ] } } } } } }, "responses": { "200": { "description": "更新された統合マッピングオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMapping" } } } }, "400": { "description": "誤った`options`が指定された場合またはBoxフォルダをこの`partner_item`にマッピングできない場合に`bad_request`を返します。エラーコードは以下のとおりです。\n\n* `SERVICE_ACCOUNT_IS_NOT_A_COOWNER_OR_OWNER` - サービスアカウントに共同所有者のコラボレーションがないか、サービスアカウントが`box_item_id`の所有者ではありません。\n* `BOX_FOLDER_EXTERNALLY_OWNED` - Boxフォルダは、管理者の企業内で所有されている必要があります。\n* `JWT_APP_NOT_AUTHORIZED` - JWT承認エラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "統合マッピングオブジェクトが見つからなかった場合は`not_found`を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] }, "delete": { "operationId": "delete_integration_mappings_slack_id", "summary": "Slack統合マッピングを削除", "description": "[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)を削除します。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "parameters": [ { "name": "integration_mapping_id", "in": "path", "description": "統合マッピングのID。", "required": true, "schema": { "type": "string" }, "example": "11235432" } ], "responses": { "204": { "description": "レスポンスの本文は空です。" }, "404": { "description": "統合マッピングが見つからなかった場合、`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] } }, "/integration_mappings/teams": { "get": { "operationId": "get_integration_mappings_teams", "summary": "Teams統合マッピングのリストを取得", "description": "ユーザーの企業内の[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)のリストを取得します。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "x-stability-level": "stable", "parameters": [ { "name": "partner_item_type", "in": "query", "description": "マッピングが返される、マッピングされた項目タイプ。", "schema": { "type": "string", "enum": [ "channel", "team" ] }, "example": "channel" }, { "name": "partner_item_id", "in": "query", "description": "マッピングが返される、マッピングされた項目のID。", "schema": { "type": "string" }, "example": "12345" }, { "name": "box_item_id", "in": "query", "description": "マッピングが返される、Box項目ID。", "schema": { "type": "string" }, "example": "12345" }, { "name": "box_item_type", "in": "query", "description": "マッピングが返される、Box項目タイプ。", "schema": { "type": "string", "enum": [ "folder" ] }, "example": "folder" } ], "responses": { "200": { "description": "統合マッピングのコレクションを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMappingsTeams" } } } }, "400": { "description": "クライアントエラーが原因で、サーバーはリクエストを処理できないか、処理しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "統合マッピングが見つからなかった場合、`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] }, "post": { "operationId": "post_integration_mappings_teams", "summary": "Teams統合マッピングを作成", "description": "TeamsチャネルをBox項目にマッピングすることで、[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)を作成します。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "x-stability-level": "stable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMappingTeamsCreateRequest" } } } }, "responses": { "201": { "description": "作成された統合マッピングを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMappingTeams" } } } }, "400": { "description": "誤った`options`が指定された場合またはBoxフォルダをこの`partner_item_id`にマッピングできない場合に`bad_request`を返します。エラーコードは以下のとおりです。\n\n* `SERVICE_ACCOUNT_IS_NOT_A_COOWNER_OR_OWNER` - サービスアカウントに共同所有者のコラボレーションがないか、サービスアカウントが`box_item_id`の所有者ではありません。\n* `CHANNEL_ALREADY_MAPPED` - チャンネルがすでに別の`box_item_id`にマッピングされています。\n* `TEAM_ALREADY_MAPPED` - チームがすでに別の`box_item_id`にマッピングされています。\n* `BOX_ENTERPRISE_MISMATCH` - Boxフォルダは、BoxをTeamsのコンテンツレイヤーとして使用するよう構成されている企業が所有している必要があります。\n* `BOX_FOLDER_EXTERNALLY_OWNED` - Boxフォルダは、管理者の企業内で所有されている必要があります。\n* `FOLDER_ALREADY_MAPPED` - Boxフォルダは別の統合マッピングにマッピングできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "統合マッピング、レコード、またはフォルダが見つからなかった場合は`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] } }, "/integration_mappings/teams/{integration_mapping_id}": { "put": { "operationId": "put_integration_mappings_teams_id", "summary": "Teams統合マッピングを更新", "description": "[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)を更新します。BoxフォルダIDおよびオプションの更新をサポートします。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "x-stability-level": "stable", "parameters": [ { "name": "integration_mapping_id", "in": "path", "description": "統合マッピングのID。", "required": true, "schema": { "type": "string" }, "example": "11235432" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "box_item": { "allOf": [ { "$ref": "#/components/schemas/FolderReference" }, { "description": "パートナーアプリのドメインのオブジェクトのマッピング先であるBoxフォルダ。" } ] } } } } } }, "responses": { "200": { "description": "更新された統合マッピングオブジェクトを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationMappingTeams" } } } }, "400": { "description": "誤った`options`が指定された場合またはBoxフォルダをこの`partner_item`にマッピングできない場合に`bad_request`を返します。エラーコードは以下のとおりです。\n\n* `SERVICE_ACCOUNT_IS_NOT_A_COOWNER_OR_OWNER` - サービスアカウントに共同所有者のコラボレーションがないか、サービスアカウントが`box_item_id`の所有者ではありません。\n* `BOX_FOLDER_EXTERNALLY_OWNED` - Boxフォルダは、管理者の企業内で所有されている必要があります。\n* `FOLDER_ALREADY_MAPPED` - Boxフォルダは別の統合マッピングにマッピングできません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "統合マッピングオブジェクトが見つからなかった場合は`not_found`を返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] }, "delete": { "operationId": "delete_integration_mappings_teams_id", "summary": "Teams統合マッピングを削除", "description": "[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)を削除します。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。", "x-stability-level": "stable", "parameters": [ { "name": "integration_mapping_id", "in": "path", "description": "統合マッピングのID。", "required": true, "schema": { "type": "string" }, "example": "11235432" } ], "responses": { "204": { "description": "レスポンスの本文は空です。" }, "404": { "description": "統合マッピングが見つからなかった場合、`not_found`エラーを返します。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "integration_mappings", "tags": [ "統合マッピング" ] } }, "/ai/ask": { "post": { "operationId": "post_ai_ask", "summary": "質問を送信", "description": "サポートされているLLMにAIリクエストを送信し、提供されたコンテキストを考慮してユーザーの質問に特化した回答を返します。", "x-stability-level": "stable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiAsk" } } } }, "responses": { "200": { "description": "LLMからの回答を含む成功したレスポンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiResponse--Full" } } } }, "204": { "description": "質問への回答に使用できるコンテンツがありません。これは、リクエストの項目がHubであっても、Hubのコンテンツにインデックスが作成されていない場合に返されます。Hub内のコンテンツにインデックスが作成されるようにするには、Hubを作成する前に、管理コンソールでBox AI for Hubsが有効になっていることを確認してください。" }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai", "tags": [ "AI" ], "x-box-enable-explorer": false } }, "/ai/text_gen": { "post": { "operationId": "post_ai_text_gen", "summary": "テキストを生成", "description": "サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、提供されたプロンプトに基づいて生成されたテキストを返します。", "x-stability-level": "stable", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiTextGen" } } } }, "responses": { "200": { "description": "LLMからの回答を含む成功したレスポンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiResponse" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai", "tags": [ "AI" ], "x-box-enable-explorer": false } }, "/ai_agent_default": { "get": { "operationId": "get_ai_agent_default", "summary": "AIエージェントのデフォルト構成を取得", "description": "AIエージェントのデフォルト構成を取得します。", "x-stability-level": "stable", "parameters": [ { "name": "mode", "in": "query", "description": "返されるエージェント構成にフィルタをかけるためのモード。", "required": true, "schema": { "type": "string", "enum": [ "ask", "text_gen", "extract", "extract_structured" ] }, "example": "ask" }, { "name": "language", "in": "query", "description": "返されるエージェント構成のISO言語コード。その言語がサポートされていない場合は、デフォルトのエージェント構成が返されます。", "required": false, "schema": { "type": "string" }, "example": "ja" }, { "name": "model", "in": "query", "description": "返されるデフォルトのエージェント構成のモデル。", "required": false, "schema": { "type": "string" }, "example": "azure__openai__gpt_4o_mini" } ], "responses": { "200": { "description": "デフォルトのエージェント構成を含む成功したレスポンス。このレスポンスは、以下の4つのオブジェクトのいずれかになります。\n\n* 質問用のAIエージェント\n* テキスト生成用のAIエージェント\n* 自由形式のメタデータ抽出用のAIエージェント\n* 構造化メタデータ抽出用のAIエージェント。レスポンスは、このエンドポイントでリクエストされたエージェント構成によって決まります。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiAgent" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai", "tags": [ "AI" ], "x-box-enable-explorer": false } }, "/ai/extract": { "post": { "operationId": "post_ai_extract", "summary": "メタデータを抽出 (自由形式)", "description": "サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、メタデータをキー/値ペアの形式で抽出します。このリクエストでは、プロンプトと出力の両方を自由形式にすることができます。リクエストを送信する前に、メタデータテンプレートの設定は必要ありません。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiExtract" } } } }, "responses": { "200": { "description": "LLMからの回答を含むレスポンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiResponse" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai", "tags": [ "AI" ], "x-box-enable-explorer": false } }, "/ai/extract_structured": { "post": { "operationId": "post_ai_extract_structured", "summary": "メタデータを抽出 (構造化)", "description": "サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、抽出されたメタデータを一連のキー/値ペアとして返します。このリクエストには、メタデータテンプレートか、抽出するフィールドのリストが必要です。入力は、メタデータテンプレート、または構造を確保するためのフィールドのリストの**いずれか**です。テンプレートの作成の詳細については、[メタデータテンプレートのカスタマイズ](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)を参照するか、[メタデータテンプレートAPI](g://metadata/templates/create)を使用してください。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiExtractStructured" } } } }, "responses": { "200": { "description": "LLMからの回答を含む成功したレスポンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiExtractStructuredResponse" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "予期しないエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai", "tags": [ "AI" ], "x-box-enable-explorer": false } }, "/ai_agents": { "get": { "operationId": "get_ai_agents", "summary": "AIエージェントのリストを取得", "description": "指定されたパラメータに基づいてAIエージェントのリストを取得します。", "parameters": [ { "name": "mode", "in": "query", "description": "返されるエージェント構成にフィルタをかけるためのモード。使用可能な値は`ask`、`text_gen`、`extract`です。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "ask", "text_gen", "extract" ], "explode": false }, { "name": "fields", "in": "query", "description": "レスポンスで返されるフィールド。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "ask", "text_gen", "extract" ], "explode": false }, { "name": "agent_state", "in": "query", "description": "返されるエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "enabled" ], "explode": false }, { "name": "include_box_default", "in": "query", "description": "レスポンスにBoxのデフォルトエージェントを含めるかどうか。", "required": false, "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "marker", "in": "query", "description": "結果が返される開始位置のマーカー。", "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/AiMultipleAgentResponse" } } } }, "400": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai_studio", "tags": [ "AI Studio" ] }, "post": { "operationId": "post_ai_agents", "summary": "AIエージェントを作成", "description": "AIエージェントを作成します。`ask`、`text_gen`、`extract`の機能のうち1つ以上を指定する必要があります。", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAiAgent" } } } }, "responses": { "200": { "description": "作成されたAIエージェントの定義。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSingleAgentResponse--Full" } } } }, "400": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai_studio", "tags": [ "AI Studio" ] } }, "/ai_agents/{agent_id}": { "put": { "operationId": "put_ai_agents_id", "summary": "AIエージェントを更新", "description": "AIエージェントを更新します。", "parameters": [ { "name": "agent_id", "in": "path", "description": "更新するエージェントのID。", "required": true, "schema": { "type": "string" }, "example": "1234" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAiAgent" } } } }, "responses": { "200": { "description": "作成されたAIエージェントの定義。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSingleAgentResponse--Full" } } } }, "400": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai_studio", "tags": [ "AI Studio" ] }, "get": { "operationId": "get_ai_agents_id", "summary": "エージェントIDを指定してAIエージェントを取得", "description": "`agent_id`パラメータを使用してAIエージェントを取得します。", "parameters": [ { "name": "agent_id", "in": "path", "description": "取得するエージェントID。", "required": true, "schema": { "type": "string" }, "example": "1234" }, { "name": "fields", "in": "query", "description": "レスポンスで返されるフィールド。", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "ask", "text_gen", "extract" ], "explode": false } ], "responses": { "200": { "description": "エージェントを含む成功したレスポンス。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiSingleAgentResponse--Full" } } } }, "400": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai_studio", "tags": [ "AI Studio" ] }, "delete": { "operationId": "delete_ai_agents_id", "summary": "AIエージェントを削除", "description": "指定されたパラメータを使用してAIエージェントを削除します。", "parameters": [ { "name": "agent_id", "in": "path", "description": "削除するエージェントのID。", "required": true, "schema": { "type": "string" }, "example": "1234" } ], "responses": { "204": { "description": "コンテンツなしの成功したレスポンス。" }, "400": { "description": "予期しないクライアントエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "AIエージェントが見つからない場合に返されます。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "予期しないサーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "ai_studio", "tags": [ "AI Studio" ] } } }, "components": { "schemas": { "AccessToken": { "description": "認証済みのAPIコールを行うために使用できるトークン。", "type": "object", "properties": { "access_token": { "description": "リクエストされたアクセストークン。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" }, "expires_in": { "description": "このトークンが期限切れになるまでの秒数。", "type": "integer", "format": "int64", "example": 3600 }, "token_type": { "description": "返されるアクセストークンのタイプ。", "type": "string", "example": "bearer", "enum": [ "bearer" ] }, "restricted_to": { "description": "このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど) のリストと、各リソースで許可されるスコープが提供されます。", "type": "array", "items": { "$ref": "#/components/schemas/ResourceScope" } }, "refresh_token": { "description": "このアクセストークンの更新トークン。現在のトークンの有効期限が切れて新しいアクセストークンをリクエストするときに使用できます。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" }, "issued_token_type": { "description": "返されたダウンスコープ済みアクセストークンのタイプ。これは、アクセストークンがダウンスコープされている場合にのみ返されます。", "type": "string", "format": "urn", "example": "urn:ietf:params:oauth:token-type:access_token", "enum": [ "urn:ietf:params:oauth:token-type:access_token" ] } }, "title": "アクセストークン", "x-box-resource-id": "access_token", "x-box-tag": "authorization" }, "AiAgent": { "description": "以下のオブジェクトのいずれかを指定できます。\n\n* 質問用のAIエージェント\n* テキスト生成用のAIエージェント\n* 自由形式のメタデータ抽出用のAIエージェント\n* 構造化メタデータ抽出用のAIエージェント。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiAgentAsk" }, { "$ref": "#/components/schemas/AiAgentTextGen" }, { "$ref": "#/components/schemas/AiAgentExtract" }, { "$ref": "#/components/schemas/AiAgentExtractStructured" } ], "title": "AIエージェント" }, "AiAgentAllowedEntity": { "description": "タイプとIDが指定されたエンティティ。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/User--Base" }, { "$ref": "#/components/schemas/Group--Base" } ], "title": "タイプとIDが指定されたエンティティ", "x-box-resource-id": "ai_agent_allowed_entity" }, "AiAgentAsk": { "description": "クエリの処理に使用されるAIエージェント。", "type": "object", "properties": { "type": { "description": "クエリの処理に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_ask", "enum": [ "ai_agent_ask" ], "nullable": false }, "long_text": { "$ref": "#/components/schemas/AiAgentLongTextTool" }, "basic_text": { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, "spreadsheet": { "$ref": "#/components/schemas/AiAgentSpreadsheetTool" }, "long_text_multi": { "$ref": "#/components/schemas/AiAgentLongTextTool" }, "basic_text_multi": { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, "basic_image": { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, "basic_image_multi": { "$ref": "#/components/schemas/AiAgentBasicTextTool" } }, "required": [ "type" ], "title": "質問リクエスト用のAIエージェント", "x-box-resource-id": "ai_agent_ask", "x-box-tag": "ai" }, "AiAgentBasicGenTool": { "description": "テキストの生成に使用されるAIエージェントの基本ツール。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentLongTextToolTextGen" }, { "properties": { "content_template": { "description": "LLMへのリクエストにコンテンツを含める方法。`{content}`の入力は、用途に応じて省略できます。", "type": "string", "example": "---{content}---" } } } ], "title": "AIエージェントの基本テキスト生成ツール", "x-box-tag": "ai" }, "AiAgentBasicTextTool": { "description": "基本テキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentBasicTextToolBase" }, { "properties": { "system_message": { "description": "LLMが、その役割と実行するべき内容を「理解」するのを支援するためのシステムメッセージ。", "type": "string", "example": "You are a helpful travel assistant specialized in budget travel" }, "prompt_template": { "description": "プロンプトテンプレートには、リクエストのコンテキスト情報とユーザープロンプトが含まれます。`prompt_template`パラメータを渡す場合、`{user_question}`および`{content}`の入力を**含める必要があります**。`{current_date}`は、用途に応じて省略できます。", "type": "string", "example": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.", "maxLength": 10000, "pattern": "(\\{user_question\\}[\\s\\S]*?\\{content\\}|\\{content\\}[\\s\\S]*?\\{user_question\\})" } } } ], "title": "AIエージェントの基本テキストツール", "x-box-tag": "ai" }, "AiAgentBasicTextToolBase": { "description": "基本テキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "properties": { "model": { "description": "基本テキストに対するAIエージェントで使用されるモデル。特定のモデル値については、[利用可能なモデルのリスト](g://box-ai/supported-models)を参照してください。", "type": "string", "example": "azure__openai__gpt_4o_mini" }, "num_tokens_for_completion": { "description": "完了に必要なトークンの数。", "type": "integer", "example": 8400, "minimum": 1 }, "llm_endpoint_params": { "$ref": "#/components/schemas/AiLlmEndpointParams" } }, "title": "AIエージェントの基本テキストツール", "x-box-tag": "ai" }, "AiAgentBasicTextToolTextGen": { "description": "基本テキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentBasicTextToolBase" }, { "properties": { "system_message": { "description": "LLMが、その役割と実行するべき内容を理解するのを支援することを目的としたシステムメッセージ。`{current_date}`の入力は、用途に応じて省略できます。", "type": "string", "example": "You are a helpful travel assistant specialized in budget travel" }, "prompt_template": { "description": "プロンプトテンプレートには、リクエストのコンテキスト情報とユーザープロンプトが含まれます。\n\n`prompt_template`パラメータを使用する場合、`{user_question}`の入力を**含める必要があります**。`{current_date}`と`{content}`の入力は、用途に応じて省略できます。", "type": "string", "example": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`", "maxLength": 10000, "pattern": "\\{user_question\\}" } } } ], "title": "AIエージェントの基本テキストツール", "x-box-tag": "ai" }, "AiAgentExtract": { "description": "抽出に使用されるAIエージェント。", "type": "object", "properties": { "type": { "description": "抽出に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_extract", "enum": [ "ai_agent_extract" ], "nullable": false }, "long_text": { "$ref": "#/components/schemas/AiAgentLongTextTool" }, "basic_text": { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, "basic_image": { "$ref": "#/components/schemas/AiAgentBasicTextTool" } }, "required": [ "type" ], "title": "抽出リクエスト用のAIエージェント", "x-box-resource-id": "ai_agent_extract", "x-box-tag": "ai" }, "AiAgentExtractStructured": { "description": "抽出 (構造化) に使用されるAIエージェント。", "type": "object", "properties": { "type": { "description": "抽出に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_extract_structured", "enum": [ "ai_agent_extract_structured" ], "nullable": false }, "long_text": { "$ref": "#/components/schemas/AiAgentLongTextTool" }, "basic_text": { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, "basic_image": { "$ref": "#/components/schemas/AiAgentBasicTextTool" } }, "required": [ "type" ], "title": "抽出 (構造化) リクエスト用のAIエージェント", "x-box-resource-id": "ai_agent_extract_structured", "x-box-tag": "ai" }, "AiAgentInfo": { "description": "リクエストで使用されるモデルおよびプロセッサに関する情報。", "type": "object", "properties": { "models": { "description": "リクエストに使用されるモデル。", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "リクエストに使用されるモデルの名前。", "type": "string", "example": "azure__openai__text_embedding_ada_002" }, "provider": { "description": "リクエストに使用されるモデルを所有するプロバイダ。", "type": "string", "example": "azure" }, "supported_purpose": { "description": "リクエストに使用されるモデルで利用されるサポートされている目的。", "type": "string", "example": "embedding" } } } }, "processor": { "description": "リクエストに使用されるプロセッサ。", "type": "string", "example": "basic_text" } }, "title": "リクエストで使用されるモデルおよびプロセッサに関する情報。" }, "AiAgentLongTextTool": { "description": "長いテキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, { "properties": { "embeddings": { "type": "object", "properties": { "model": { "description": "埋め込みを計算するためのAIエージェントに使用されるモデル。", "type": "string", "example": "azure__openai__text_embedding_ada_002" }, "strategy": { "type": "object", "properties": { "id": { "description": "埋め込みを計算するためのAIエージェントに使用される戦略。", "type": "string", "example": "basic" }, "num_tokens_per_chunk": { "description": "チャンクごとのトークンの数。", "type": "integer", "example": 64, "maximum": 512, "minimum": 1 } } } } } } } ], "title": "AIエージェントの長いテキストツール", "x-box-tag": "ai" }, "AiAgentLongTextToolTextGen": { "description": "長いテキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentBasicTextToolTextGen" }, { "properties": { "embeddings": { "type": "object", "properties": { "model": { "description": "埋め込みを計算するためのAIエージェントに使用されるモデル。", "type": "string", "example": "azure__openai__text_embedding_ada_002" }, "strategy": { "type": "object", "properties": { "id": { "description": "埋め込みを計算するためのAIエージェントに使用される戦略。", "type": "string", "example": "basic" }, "num_tokens_per_chunk": { "description": "チャンクごとのトークンの数。", "type": "integer", "example": 64, "maximum": 512, "minimum": 1 } } } } } } } ], "title": "AIエージェントの長いテキストツール", "x-box-tag": "ai" }, "AiAgentReference": { "description": "クエリの処理に使用されるAIエージェント。", "type": "object", "properties": { "type": { "description": "クエリの処理に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_id", "enum": [ "ai_agent_id" ], "nullable": false }, "id": { "description": "エージェントのID。", "type": "string", "example": "14031", "nullable": false } }, "required": [ "type" ], "title": "AIエージェントの参照", "x-box-resource-id": "ai_agent_reference", "x-box-tag": "ai" }, "AiAgentSpreadsheetTool": { "description": "スプレッドシートや表形式データの処理に使用されるAIエージェントツール。", "type": "object", "properties": { "model": { "description": "スプレッドシートに対するAIエージェントで使用されるモデル。特定のモデル値については、[利用可能なモデルのリスト](g://box-ai/supported-models)を参照してください。", "type": "string", "example": "azure__openai__gpt_4o_mini" }, "num_tokens_for_completion": { "description": "完了に必要なトークンの数。", "type": "integer", "example": 8400, "minimum": 1 }, "llm_endpoint_params": { "$ref": "#/components/schemas/AiLlmEndpointParams" } }, "title": "AIエージェントのスプレッドシートツール", "x-box-tag": "ai" }, "AiAgentTextGen": { "description": "テキストの生成に使用されるAIエージェント。", "type": "object", "properties": { "type": { "description": "テキストの生成に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_text_gen", "enum": [ "ai_agent_text_gen" ], "nullable": false }, "basic_gen": { "$ref": "#/components/schemas/AiAgentBasicGenTool" } }, "required": [ "type" ], "title": "テキスト生成リクエスト用のAIエージェント", "x-box-resource-id": "ai_agent_text_gen", "x-box-tag": "ai" }, "AiAsk": { "description": "AIへの質問リクエストオブジェクト。", "type": "object", "properties": { "mode": { "description": "Box AIは、最大1 MBのテキストレプリゼンテーションを含むテキストドキュメント、または最大25ファイルを処理します (いずれか先に到達した方)。ファイルサイズが1 MBを超える場合は、テキストレプリゼンテーションの最初の1 MBが処理されます。Box AIは、解像度が1024 x 1024ピクセルの画像ドキュメントを処理し、最大5つの画像か、複数ページの画像の場合は5ページを処理します。画像数または画像ページ数が5を超える場合は、最初の5つの画像または5ページが処理されます。modeパラメータを`single_item_qa`に設定した場合、items配列に含めることができる要素は1つのみです。現在、Box AIでは、マルチモーダルリクエストがサポートされていません。画像とテキストの両方が送信された場合、Box AIで処理されるのはテキストのみです。", "type": "string", "example": "multiple_item_qa", "enum": [ "multiple_item_qa", "single_item_qa" ], "nullable": false }, "prompt": { "description": "LLMが回答するようにクライアントが提供するプロンプト。プロンプトの長さは10000文字に制限されています。", "type": "string", "example": "What is the value provided by public APIs based on this document?" }, "items": { "description": "LLMで処理する項目 (多くの場合はファイル)。", "type": "array", "items": { "$ref": "#/components/schemas/AiItemAsk" }, "maxItems": 25, "minItems": 1, "uniqueItems": true }, "dialogue_history": { "description": "これまでにLLMに渡されたプロンプトおよび回答の履歴。これにより、レスポンスの生成時にLLMに追加のコンテキストが提供されます。", "type": "array", "items": { "$ref": "#/components/schemas/AiDialogueHistory" } }, "include_citations": { "description": "引用情報を返すかどうかを示すフラグ。", "type": "boolean", "example": true }, "ai_agent": { "allOf": [ { "$ref": "#/components/schemas/AiAskAgent" }, { "description": "リクエストの処理に使用されるAIエージェント。" } ] } }, "required": [ "prompt", "items", "mode" ], "title": "AIへの質問リクエスト", "x-box-tag": "ai" }, "AiAskAgent": { "description": "AIへの質問リクエストの処理に使用されるAIエージェント。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiAgentReference" }, { "$ref": "#/components/schemas/AiAgentAsk" } ], "title": "AIへの質問リクエストのエージェント" }, "AiCitation": { "description": "LLMの回答で参照された部分の引用情報。", "type": "object", "properties": { "content": { "description": "回答が参照された部分の具体的な内容。", "example": "Public APIs are key drivers of innovation and growth.", "type": "string" }, "id": { "description": "項目のID。", "type": "string", "example": "123" }, "type": { "description": "項目のタイプ。", "type": "string", "example": "file", "enum": [ "file" ] }, "name": { "description": "項目の名前。", "type": "string", "example": "The importance of public APIs.pdf" } }, "title": "LLMの回答で参照された部分の引用情報" }, "AiDialogueHistory": { "description": "以前のプロンプトや回答を保持できるコンテキストオブジェクト。", "type": "object", "properties": { "prompt": { "description": "以前にクライアントによって提供され、LLMが回答したプロンプト。", "type": "string", "example": "Make my email about public APIs sound more professional." }, "answer": { "description": "以前にLLMから提供された回答。", "type": "string", "example": "Here is the first draft of your professional email about public APIs." }, "created_at": { "description": "プロンプトに対する前回の回答が作成された時点のISO日付形式のタイムスタンプ。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "title": "会話履歴" }, "AiExtract": { "description": "AIへのメタデータ抽出 (自由形式) リクエストオブジェクト。", "type": "object", "properties": { "prompt": { "description": "リクエストで大規模言語モデル (LLM) に提供されるプロンプト。プロンプトには、最大10,000文字を指定できるほか、XMLまたはJSONスキーマを使用することができます。", "type": "string", "example": "\\\"fields\\\":[{\\\"type\\\":\\\"string\\\",\\\"key\\\":\\\"name\\\",\\\"displayName\\\":\\\"Name\\\",\\\"description\\\":\\\"The customer name\\\",\\\"prompt\\\":\\\"Name is always the first word in the document\\\"},{\\\"type\\\":\\\"date\\\",\\\"key\\\":\\\"last_contacted_at\\\",\\\"displayName\\\":\\\"Last Contacted At\\\",\\\"description\\\":\\\"When this customer was last contacted at\\\"}]" }, "items": { "description": "LLMで処理される項目。現在使用できるのはファイルのみです。", "type": "array", "items": { "$ref": "#/components/schemas/AiItem--Base" }, "maxItems": 25, "minItems": 1, "uniqueItems": true }, "ai_agent": { "allOf": [ { "$ref": "#/components/schemas/AiExtractAgent" }, { "description": "抽出に使用されるAIエージェント。" } ] } }, "required": [ "prompt", "items" ], "title": "AIへのメタデータ抽出 (自由形式) リクエスト", "x-box-tag": "ai" }, "AiExtractAgent": { "description": "AIへのメタデータ抽出 (自由形式) リクエストの処理に使用されるAIエージェント。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiAgentReference" }, { "$ref": "#/components/schemas/AiAgentExtract" } ], "title": "AIへのメタデータ抽出 (自由形式) リクエストのエージェント" }, "AiExtractResponse": { "description": "AIによる抽出のレスポンス。このレスポンスのコンテンツは、リクエストされた構成に応じて異なる場合があります。", "type": "object", "title": "AIによる抽出のレスポンス", "x-box-resource-id": "ai_extract_response", "x-box-tag": "ai" }, "AiExtractStructured": { "description": "AIによる抽出 (構造化) リクエストオブジェクト。", "type": "object", "properties": { "items": { "description": "LLMで処理する項目。現在使用できるのはファイルのみです。", "type": "array", "items": { "$ref": "#/components/schemas/AiItem--Base" }, "maxItems": 25, "minItems": 1, "uniqueItems": true }, "metadata_template": { "description": "抽出するフィールドを含むメタデータテンプレート。リクエストを機能させるには、`metadata_template`または`fields`を指定する必要がありますが、両方を指定することはできません。", "type": "object", "properties": { "template_key": { "description": "メタデータテンプレートの名前。", "type": "string", "example": "invoiceTemplate" }, "type": { "description": "値は常に`metadata_template`。", "type": "string", "example": "metadata_template", "enum": [ "metadata_template" ] }, "scope": { "description": "メタデータテンプレートのスコープ。globalまたはenterpriseを指定できます。\n\n* **global**スコープは、任意のBox Enterpriseで利用できるテンプレートに使用されます。\n* **enterprise**スコープは、特定のEnterprise内で作成されたテンプレートを表し、そのEnterpriseのIDが含まれます。", "type": "string", "example": "enterprise_12345", "maxLength": 40 } } }, "fields": { "description": "指定された項目から抽出するフィールド。リクエストを機能させるには、`metadata_template`または`fields`を指定する必要がありますが、両方を指定することはできません。", "type": "array", "items": { "type": "object", "description": "指定された項目から抽出するフィールド。", "required": [ "key" ], "properties": { "key": { "description": "フィールドの一意の識別子。", "type": "string", "example": "name" }, "description": { "description": "フィールドの説明。", "type": "string", "example": "The name of the person." }, "displayName": { "description": "フィールドの表示名。", "type": "string", "example": "Name" }, "prompt": { "description": "キーに関するコンテキスト。キーの確認方法や形式が含まれている場合があります。", "type": "string", "example": "Name is the first and last name from the email address" }, "type": { "description": "フィールドのタイプ。これには、文字列、浮動小数点、日付、列挙型、multiSelectが含まれますが、これらに限定されるものではありません。", "type": "string", "example": "enum" }, "options": { "description": "このフィールドのオプションのリスト。これは、ほとんどの場合、列挙型およびmultiSelectフィールドタイプと組み合わせて使用します。", "type": "array", "items": { "type": "object", "required": [ "key" ], "properties": { "key": { "description": "フィールドの一意の識別子。", "type": "string", "example": "First Name" } } }, "example": [ { "key": "First Name" }, { "key": "Last Name" } ] } } }, "minItems": 1, "uniqueItems": true }, "ai_agent": { "allOf": [ { "$ref": "#/components/schemas/AiExtractStructuredAgent" }, { "description": "抽出 (構造化) に使用されるAIエージェント。" } ] } }, "required": [ "items" ], "title": "AIによる抽出 (構造化) リクエスト", "x-box-tag": "ai" }, "AiExtractStructuredAgent": { "description": "AIによる抽出 (構造化) リクエストの処理に使用されるAIエージェント。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiAgentReference" }, { "$ref": "#/components/schemas/AiAgentExtractStructured" } ], "title": "AIによる抽出 (構造化) リクエストのエージェント" }, "AiExtractStructuredResponse": { "description": "AIによる抽出 (構造化) のレスポンス。", "type": "object", "properties": { "answer": { "$ref": "#/components/schemas/AiExtractResponse" }, "created_at": { "description": "プロンプトに対する回答が作成された時点のISO日付形式のタイムスタンプ。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "completion_reason": { "description": "応答が終了した理由。", "type": "string", "example": "done" }, "ai_agent_info": { "$ref": "#/components/schemas/AiAgentInfo" } }, "required": [ "answer", "created_at" ], "title": "AIによる抽出 (構造化) のレスポンス", "x-box-resource-id": "ai_extract_structured_response", "x-box-tag": "ai" }, "AiItem--Base": { "description": "LLMで処理する項目。", "type": "object", "properties": { "id": { "description": "ファイルのID。", "type": "string", "example": "123" }, "type": { "description": "項目の種類。現在、この値に指定できるのは`file`のみです。", "type": "string", "example": "file", "enum": [ "file" ] }, "content": { "description": "項目のコンテンツ (多くの場合はテキストレプリゼンテーション)。", "example": "This is file content.", "type": "string" } }, "required": [ "id", "type" ], "title": "AI項目 (Base)", "x-box-variant": "base", "x-box-variants": [ "base" ] }, "AiItemAsk": { "description": "質問リクエストのためにLLMで処理する項目。", "type": "object", "properties": { "id": { "description": "ファイルのID。", "type": "string", "example": "123" }, "type": { "description": "項目の種類。`hubs`項目は、単一の項目として使用する必要があります。", "type": "string", "example": "file", "enum": [ "file", "hubs" ] }, "content": { "description": "項目のコンテンツ (多くの場合はテキストレプリゼンテーション)。", "example": "This is file content.", "type": "string" } }, "required": [ "id", "type" ], "title": "項目に関するAIへの質問" }, "AiLlmEndpointParams": { "description": "モデル固有のLLMエンドポイントのパラメータ。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiLlmEndpointParamsOpenAi" }, { "$ref": "#/components/schemas/AiLlmEndpointParamsGoogle" }, { "$ref": "#/components/schemas/AiLlmEndpointParamsAWS" }, { "$ref": "#/components/schemas/AiLlmEndpointParamsIBM" } ], "title": "AI LLMエンドポイントパラメータ" }, "AiLlmEndpointParamsAWS": { "description": "AI LLMエンドポイントパラメータ (AWS) オブジェクト。", "type": "object", "properties": { "type": { "description": "AWS用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。", "type": "string", "example": "aws_params", "enum": [ "aws_params" ], "nullable": false }, "temperature": { "description": "使用するサンプリングtemperature (0～1の間)。0.8のような高い値を指定すると、出力がよりランダムになるのに対し、0.2のような低い値を指定すると、出力はより焦点を絞った、決定的なものになります。一般的には、この値と`top_p`の両方ではなく、いずれかを変更することをお勧めします。", "type": "number", "example": 0.5, "maximum": 1, "minimum": 0, "nullable": true }, "top_p": { "description": "temperatureによるサンプリングの代替手段 (核サンプリングと呼ばれます)。この場合、モデルは`top_p`の確率質量を持つトークンの結果を考慮します。つまり、0.1の場合は、上位10%の確率質量で構成されるトークンのみが考慮されます。一般的には、この値とtemperatureの両方ではなく、いずれかを変更することをお勧めします。", "type": "number", "example": 0.5, "maximum": 1, "minimum": 0, "nullable": true } }, "required": [ "type" ], "title": "AI LLMエンドポイントパラメータ (AWS)", "x-box-resource-id": "ai_llm_endpoint_params_aws" }, "AiLlmEndpointParamsGoogle": { "description": "AI LLMエンドポイントパラメータ (Google) オブジェクト。", "type": "object", "properties": { "type": { "description": "Google用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。", "type": "string", "example": "google_params", "enum": [ "google_params" ], "nullable": false }, "temperature": { "description": "temperatureはレスポンス生成時のサンプリングに使用されます。レスポンス生成は`top-P`と`top-K`が適用された場合に発生します。temperatureは、トークン選択におけるランダム性の程度を制御します。", "type": "number", "example": 0, "maximum": 2, "minimum": 0, "nullable": true }, "top_p": { "description": "`Top-P`では、モデルが出力用にトークンを選択する方法を変更します。トークンは、確率の合計が`top-P`値に等しくなるまで、確率の高いもの (`top-K`を参照) から低いものへと選択されます。", "type": "number", "example": 1, "maximum": 2, "minimum": 0.1, "nullable": true }, "top_k": { "description": "`Top-K`では、モデルが出力用にトークンを選択する方法を変更します。`top-K`が小さい場合、次に選択されるトークンは、モデルの語彙に含まれるすべてのトークンの中で最も確率の高いものであることになります (グリーディデコードとも呼ばれます)。`top-K`が大きい場合は、temperatureを使用して、最も確率が高い上位3つのトークンから次のトークンが選択されることになります。", "type": "number", "example": 1, "maximum": 2, "minimum": 0.1, "nullable": true } }, "required": [ "type" ], "title": "AI LLMエンドポイントパラメータ (Google)", "x-box-resource-id": "ai_llm_endpoint_params_google" }, "AiLlmEndpointParamsIBM": { "description": "AI LLMエンドポイントパラメータ (IBM) オブジェクト。", "type": "object", "properties": { "type": { "description": "IBM用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。", "type": "string", "example": "ibm_params", "enum": [ "ibm_params" ], "nullable": false }, "temperature": { "description": "使用するサンプリングtemperature (0～1の間)。0.8のような高い値を指定すると、出力がよりランダムになるのに対し、0.2のような低い値を指定すると、出力はより焦点を絞った、決定的なものになります。一般的には、この値と`top_p`の両方ではなく、いずれかを変更することをお勧めします。", "type": "number", "example": 0.5, "nullable": true }, "top_p": { "description": "temperatureによるサンプリングの代替手段 (核サンプリングと呼ばれます)。この場合、モデルは`top_p`の確率質量を持つトークンの結果を考慮します。つまり、0.1の場合は、上位10%の確率質量で構成されるトークンのみが考慮されます。一般的には、この値とtemperatureの両方ではなく、いずれかを変更することをお勧めします。", "type": "number", "example": 0.5, "maximum": 1, "minimum": 0.1, "nullable": true }, "top_k": { "description": "`Top-K`では、モデルが出力用にトークンを選択する方法を変更します。`top-K`が小さい場合、次に選択されるトークンは、モデルの語彙に含まれるすべてのトークンの中で最も確率の高いものであることになります (グリーディデコードとも呼ばれます)。`top-K`が大きい場合は、temperatureを使用して、最も確率が高い上位3つのトークンから次のトークンが選択されることになります。", "type": "number", "example": 1, "nullable": true } }, "required": [ "type" ], "title": "AI LLMエンドポイントパラメータ (IBM)", "x-box-resource-id": "ai_llm_endpoint_params_ibm" }, "AiLlmEndpointParamsOpenAi": { "description": "AI LLMエンドポイントパラメータ (OpenAI) オブジェクト。", "type": "object", "properties": { "type": { "description": "OpenAI用のAI LLMエンドポイントパラメータオブジェクトのタイプ。このパラメータは**必須**です。", "type": "string", "example": "openai_params", "enum": [ "openai_params" ], "nullable": false }, "temperature": { "description": "使用するサンプリングtemperature (0～2の間)。0.8のような高い値を指定すると、出力がよりランダムになるのに対し、0.2のような低い値を指定すると、出力はより焦点を絞った、決定的なものになります。一般的には、この値と`top_p`の両方ではなく、いずれかを変更することをお勧めします。", "type": "number", "example": 0, "maximum": 2, "minimum": 0, "nullable": true }, "top_p": { "description": "temperatureによるサンプリングの代替手段 (核サンプリングと呼ばれます)。この場合、モデルは`top_p`の確率質量を持つトークンの結果を考慮します。つまり、0.1の場合は、上位10%の確率質量で構成されるトークンのみが考慮されます。一般的には、この値とtemperatureの両方ではなく、いずれかを変更することをお勧めします。", "type": "number", "example": 1, "maximum": 1, "minimum": 0.1, "nullable": true }, "frequency_penalty": { "description": "\\-2.0から2.0までの数値。正の値の場合は、新しいトークンがこれまでにテキストに出現した回数に基づいてそのトークンにペナルティを与え、モデルが同じ行をそのまま繰り返す可能性を低減させます。", "type": "number", "example": 1.5, "maximum": 2, "minimum": -2, "nullable": true }, "presence_penalty": { "description": "\\-2.0から2.0までの数値。正の値の場合は、新しいトークンがこれまでにテキストに出現したかどうかに基づいてそのトークンにペナルティを与え、モデルが新しいトピックについて語る可能性を引き上げます。", "type": "number", "example": 1.5, "maximum": 2, "minimum": -2, "nullable": true }, "stop": { "description": "APIがトークンをそれ以上生成するのを停止する、最大4つのシーケンス。", "type": "string", "example": "<|im_end|>", "nullable": true } }, "required": [ "type" ], "title": "AI LLMエンドポイントパラメータ (OpenAI)", "x-box-resource-id": "ai_llm_endpoint_params_openai" }, "AiMultipleAgentResponse": { "description": "ページ割りを使用したAIエージェントのリスト。", "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": "AIエージェントのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/AiSingleAgentResponse--Full" } } } } ], "required": [ "entries" ], "title": "AIエージェントのリスト", "x-box-resource-id": "ai_multiple_agent_response", "x-box-tag": "ai_studio" }, "AiResponse": { "description": "AIの応答。", "type": "object", "properties": { "answer": { "description": "LLMから提供された回答。", "type": "string", "example": "Public APIs are important because of key and important reasons." }, "created_at": { "description": "プロンプトに対する回答が作成された時点のISO日付形式のタイムスタンプ。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "completion_reason": { "description": "応答が終了した理由。", "type": "string", "example": "done" }, "ai_agent_info": { "$ref": "#/components/schemas/AiAgentInfo" } }, "required": [ "answer", "created_at" ], "title": "AIの応答", "x-box-resource-id": "ai_response", "x-box-tag": "ai", "x-box-variant": "standard", "x-box-variants": [ "standard", "full" ] }, "AiResponse--Full": { "description": "AIの質問への応答。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiResponse" }, { "properties": { "citations": { "description": "LLMの回答で参照された部分の引用情報。", "type": "array", "items": { "$ref": "#/components/schemas/AiCitation" } } } } ], "required": [ "answer", "created_at" ], "title": "AIの応答 (Full)", "x-box-resource-id": "ai_response--full", "x-box-tag": "ai", "x-box-variant": "full", "x-box-variants": [ "standard", "full" ] }, "AiSingleAgentResponse": { "description": "AIエージェントインスタンスのStandard版の表示。", "type": "object", "properties": { "id": { "description": "AIエージェントの一意の識別子。", "type": "string", "example": "1234567890" }, "type": { "description": "クエリの処理に使用されるエージェントのタイプ。", "type": "string", "example": "ai_agent", "enum": [ "ai_agent" ] }, "origin": { "description": "AIエージェントのプロバイダ。", "type": "string", "example": "CUSTOM" }, "name": { "description": "AIエージェントの名前。", "type": "string", "example": "This is my Agent" }, "access_state": { "description": "AIエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。", "type": "string", "example": "enabled", "title": "アクセス状態", "x-box-tag": "ai_studio" }, "created_by": { "description": "このエージェントを作成したユーザー。", "allOf": [ { "$ref": "#/components/schemas/User--Base" } ] }, "created_at": { "description": "このAIエージェントが作成された時点のISO日時形式のタイムスタンプ。", "type": "string", "format": "date-time", "example": "2022-01-01T00:00:00Z" }, "modified_by": { "description": "このエージェントを直近で変更したユーザー。", "allOf": [ { "$ref": "#/components/schemas/User--Base" } ] }, "modified_at": { "description": "このAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。", "type": "string", "format": "date-time", "example": "2022-01-01T00:00:00Z" }, "icon_reference": { "description": "AIエージェントのアイコン参照。", "type": "string", "example": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg", "minLength": 1 }, "allowed_entities": { "description": "許可するユーザーまたはグループのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/AiAgentAllowedEntity" } } }, "required": [ "id", "origin", "name", "access_state" ], "title": "AIエージェント", "x-box-resource-id": "ai_single_agent_response", "x-box-tag": "ai_studio", "x-box-variant": "standard", "x-box-variants": [ "standard", "full" ] }, "AiSingleAgentResponse--Full": { "description": "AIエージェントインスタンスのFull版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiSingleAgentResponse" }, { "properties": { "ask": { "$ref": "#/components/schemas/AiStudioAgentAskResponse" }, "text_gen": { "$ref": "#/components/schemas/AiStudioAgentTextGenResponse" }, "extract": { "$ref": "#/components/schemas/AiStudioAgentExtractResponse" } } } ], "required": [ "id", "origin", "name", "access_state" ], "title": "AIエージェント (Full)", "x-box-resource-id": "ai_single_agent_response--full", "x-box-tag": "ai_studio", "x-box-variant": "full", "x-box-variants": [ "standard", "full" ] }, "AiStudioAgentAsk": { "description": "クエリの処理に使用するAIエージェント。", "type": "object", "properties": { "type": { "description": "クエリの処理に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_ask", "enum": [ "ai_agent_ask" ], "nullable": false }, "access_state": { "description": "AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。", "type": "string", "example": "enabled", "title": "機能のアクセス状態", "x-box-tag": "ai_studio" }, "description": { "description": "AIエージェントの説明。", "type": "string", "example": "This is ASK Agent" }, "custom_instructions": { "description": "AIエージェントに対するカスタム指示。", "type": "string", "example": "This is a custom instruction", "nullable": true }, "suggested_questions": { "description": "AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。", "type": "array", "items": { "type": "string" }, "example": [ "What is in this file?", "What are the main highlights of this document?" ], "maxItems": 4 }, "long_text": { "$ref": "#/components/schemas/AiStudioAgentLongTextTool" }, "basic_text": { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" }, "basic_image": { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" }, "spreadsheet": { "$ref": "#/components/schemas/AiStudioAgentSpreadsheetTool" }, "long_text_multi": { "$ref": "#/components/schemas/AiStudioAgentLongTextTool" }, "basic_text_multi": { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" }, "basic_image_multi": { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" } }, "required": [ "type", "access_state", "description" ], "title": "AIエージェントの機能 (質問リクエスト)", "x-box-resource-id": "ai_studio_agent_ask", "x-box-tag": "ai_studio" }, "AiStudioAgentAskResponse": { "description": "質問に使用するAIエージェント。", "type": "object", "properties": { "type": { "description": "質問に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_ask", "enum": [ "ai_agent_ask" ], "nullable": false }, "access_state": { "description": "AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。", "type": "string", "example": "enabled", "title": "機能のアクセス状態", "x-box-tag": "ai_studio" }, "description": { "description": "AIエージェントの説明。", "type": "string", "example": "This is ASK Agent" }, "custom_instructions": { "description": "AIエージェントに対するカスタム指示。", "type": "string", "example": "This is a custom instruction", "nullable": true }, "suggested_questions": { "description": "AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。", "type": "array", "items": { "type": "string" }, "example": [ "What is in this file?", "What are the main highlights of this document?" ], "maxItems": 4 }, "long_text": { "$ref": "#/components/schemas/AiStudioAgentLongTextToolResponse" }, "basic_text": { "$ref": "#/components/schemas/AiStudioAgentBasicTextToolResponse" }, "basic_image": { "$ref": "#/components/schemas/AiStudioAgentBasicTextToolResponse" }, "spreadsheet": { "$ref": "#/components/schemas/AiStudioAgentSpreadsheetToolResponse" }, "long_text_multi": { "$ref": "#/components/schemas/AiStudioAgentLongTextToolResponse" }, "basic_text_multi": { "$ref": "#/components/schemas/AiStudioAgentBasicTextToolResponse" }, "basic_image_multi": { "$ref": "#/components/schemas/AiStudioAgentBasicTextToolResponse" } }, "required": [ "type", "access_state", "description" ], "title": "AIエージェントの機能 (質問)", "x-box-resource-id": "ai_studio_agent_ask_response", "x-box-tag": "ai_studio" }, "AiStudioAgentBasicGenTool": { "description": "テキストの生成に使用されるAIエージェントの基本ツール。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentBasicGenTool" }, { "properties": { "is_custom_instructions_included": { "description": "システムメッセージにカスタム指示のプレースホルダが含まれる場合はtrue、それ以外の場合はfalse。", "type": "boolean", "example": false } } } ], "title": "AIエージェントの基本テキスト生成ツールのリクエスト", "x-box-tag": "ai" }, "AiStudioAgentBasicGenToolResponse": { "description": "テキストの生成に使用されるAIエージェントの基本ツール。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiStudioAgentBasicGenTool" }, { "properties": { "warnings": { "description": "ツールに関する警告。", "type": "array", "items": { "type": "string" }, "example": [ "MODEL_INACTIVE" ] } } } ], "title": "AIエージェントの基本テキスト生成ツール", "x-box-tag": "ai" }, "AiStudioAgentBasicTextTool": { "description": "基本テキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentBasicTextTool" }, { "properties": { "is_custom_instructions_included": { "description": "システムメッセージにカスタム指示のプレースホルダが含まれる場合はtrue、それ以外の場合はfalse。", "type": "boolean", "example": false } } } ], "title": "AIエージェントの基本テキストツールのリクエスト", "x-box-tag": "ai" }, "AiStudioAgentBasicTextToolResponse": { "description": "基本テキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" }, { "properties": { "warnings": { "description": "ツールに関する警告。", "type": "array", "items": { "type": "string" }, "example": [ "MODEL_INACTIVE" ] } } } ], "title": "AIエージェントの基本テキストツール", "x-box-tag": "ai" }, "AiStudioAgentExtract": { "description": "メタデータ抽出に使用するAIエージェント。", "type": "object", "properties": { "type": { "description": "メタデータ抽出に使用するAIエージェントのタイプ。", "type": "string", "example": "ai_agent_extract", "enum": [ "ai_agent_extract" ], "nullable": false }, "access_state": { "description": "AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。", "type": "string", "example": "enabled", "title": "機能のアクセス状態", "x-box-tag": "ai_studio" }, "description": { "description": "AIエージェントの説明。", "type": "string", "example": "This is ASK Agent" }, "custom_instructions": { "description": "AIエージェントに対するカスタム指示。", "type": "string", "example": "This is a custom instruction", "nullable": true }, "long_text": { "$ref": "#/components/schemas/AiStudioAgentLongTextTool" }, "basic_text": { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" }, "basic_image": { "$ref": "#/components/schemas/AiStudioAgentBasicTextTool" } }, "required": [ "type", "access_state", "description" ], "title": "AIエージェントの機能 (抽出リクエスト)", "x-box-resource-id": "ai_studio_agent_extract", "x-box-tag": "ai_studio" }, "AiStudioAgentExtractResponse": { "description": "メタデータ抽出に使用するAIエージェント。", "type": "object", "properties": { "type": { "description": "メタデータ抽出に使用するAIエージェントのタイプ。", "type": "string", "example": "ai_agent_extract", "enum": [ "ai_agent_extract" ], "nullable": false }, "access_state": { "description": "AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。", "type": "string", "example": "enabled", "title": "機能のアクセス状態", "x-box-tag": "ai_studio" }, "description": { "description": "AIエージェントの説明。", "type": "string", "example": "This is ASK Agent" }, "custom_instructions": { "description": "AIエージェントに対するカスタム指示。", "type": "string", "example": "This is a custom instruction", "nullable": true }, "long_text": { "$ref": "#/components/schemas/AiStudioAgentLongTextToolResponse" }, "basic_text": { "$ref": "#/components/schemas/AiStudioAgentBasicTextToolResponse" }, "basic_image": { "$ref": "#/components/schemas/AiStudioAgentBasicTextToolResponse" } }, "required": [ "type", "access_state", "description" ], "title": "AIエージェントの機能 (抽出)", "x-box-resource-id": "ai_studio_agent_extract_response", "x-box-tag": "ai_studio" }, "AiStudioAgentLongTextTool": { "description": "長いテキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentLongTextTool" }, { "properties": { "is_custom_instructions_included": { "description": "システムメッセージにカスタム指示のプレースホルダが含まれる場合はtrue、それ以外の場合はfalse。", "type": "boolean", "example": false } } } ], "title": "AIエージェントの長いテキストツールのリクエスト", "x-box-tag": "ai" }, "AiStudioAgentLongTextToolResponse": { "description": "長いテキストの処理に使用されるAIエージェントプロセッサ。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiStudioAgentLongTextTool" }, { "properties": { "warnings": { "description": "ツールに関する警告。", "type": "array", "items": { "type": "string" }, "example": [ "MODEL_INACTIVE" ] } } } ], "title": "AIエージェントの長いテキストツール", "x-box-tag": "ai" }, "AiStudioAgentSpreadsheetTool": { "description": "スプレッドシートや表形式データの処理に使用されるAIエージェントツール。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiAgentSpreadsheetTool" }, { "properties": {} } ], "title": "AIエージェントのスプレッドシートツール", "x-box-tag": "ai" }, "AiStudioAgentSpreadsheetToolResponse": { "description": "スプレッドシートや表形式データの処理に使用されるAIエージェントツール。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/AiStudioAgentSpreadsheetTool" }, { "properties": { "warnings": { "description": "ツールに関する警告。", "type": "array", "items": { "type": "string" }, "example": [ "MODEL_INACTIVE" ] } } } ], "title": "AIエージェントのスプレッドシートツール", "x-box-tag": "ai" }, "AiStudioAgentTextGen": { "description": "テキストの生成に使用するAIエージェント。", "type": "object", "properties": { "type": { "description": "テキストの生成に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_text_gen", "enum": [ "ai_agent_text_gen" ], "nullable": false }, "access_state": { "description": "AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。", "type": "string", "example": "enabled", "title": "機能のアクセス状態", "x-box-tag": "ai_studio" }, "description": { "description": "AIエージェントの説明。", "type": "string", "example": "This is ASK Agent" }, "custom_instructions": { "description": "AIエージェントに対するカスタム指示。", "type": "string", "example": "This is a custom instruction", "nullable": true }, "suggested_questions": { "description": "AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。", "type": "array", "items": { "type": "string" }, "example": [ "What is in this file?", "What are the main highlights of this document?" ], "maxItems": 4 }, "basic_gen": { "$ref": "#/components/schemas/AiStudioAgentBasicGenTool" } }, "required": [ "type", "access_state", "description" ], "title": "AIエージェントの機能 (テキスト生成リクエスト)", "x-box-resource-id": "ai_studio_agent_text_gen", "x-box-tag": "ai_studio" }, "AiStudioAgentTextGenResponse": { "description": "テキストの生成に使用するAIエージェント。", "type": "object", "properties": { "type": { "description": "テキストの生成に使用されるAIエージェントのタイプ。", "type": "string", "example": "ai_agent_text_gen", "enum": [ "ai_agent_text_gen" ], "nullable": false }, "access_state": { "description": "AIエージェントの機能の状態。使用可能な値は`enabled`、`disabled`です。", "type": "string", "example": "enabled", "title": "機能のアクセス状態", "x-box-tag": "ai_studio" }, "description": { "description": "AIエージェントの説明。", "type": "string", "example": "This is ASK Agent" }, "custom_instructions": { "description": "AIエージェントに対するカスタム指示。", "type": "string", "example": "This is a custom instruction", "nullable": true }, "suggested_questions": { "description": "AIエージェントに対する質問の候補。nullの場合、質問の候補が生成されます。空の場合は、質問の候補が表示されません。", "type": "array", "items": { "type": "string" }, "example": [ "What is in this file?", "What are the main highlights of this document?" ], "maxItems": 4 }, "basic_gen": { "$ref": "#/components/schemas/AiStudioAgentBasicGenToolResponse" } }, "required": [ "type", "access_state", "description" ], "title": "AIエージェントの機能 (テキスト生成)", "x-box-resource-id": "ai_studio_agent_text_gen_response", "x-box-tag": "ai_studio" }, "AiTextGen": { "description": "AIへのテキスト生成リクエストオブジェクト。", "type": "object", "properties": { "prompt": { "description": "LLMが回答するようにクライアントが提供するプロンプト。プロンプトの長さは10000文字に制限されています。", "type": "string", "example": "Write an email to a client about the importance of public APIs." }, "items": { "description": "LLMで処理する項目 (多くの場合はファイル)。この配列に含めることができる要素は**1つだけ**です。\n\n**注**: Box AIは、最大1 MBのテキストレプリゼンテーションを含むドキュメントを処理します。ファイルサイズが1 MBを超えた場合は、テキストレプリゼンテーションの最初の1 MBが処理されます。", "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "description": "LLMで処理する項目。", "properties": { "id": { "description": "項目のID。", "type": "string", "example": "123" }, "type": { "description": "項目のタイプ。", "type": "string", "example": "file", "enum": [ "file" ] }, "content": { "description": "新規テキストを生成したり既存テキストを編集したりする場合にコンテキストとして使用するコンテンツ。", "example": "This is file content that is relevant to the text gen request.", "type": "string" } } }, "maxItems": 1, "minItems": 1, "uniqueItems": true }, "dialogue_history": { "description": "これまでにLLMに渡されたプロンプトおよび回答の履歴。このパラメータにより、レスポンスの生成時にLLMに追加のコンテキストが提供されます。", "type": "array", "items": { "$ref": "#/components/schemas/AiDialogueHistory" } }, "ai_agent": { "allOf": [ { "$ref": "#/components/schemas/AiTextGenAgent" }, { "description": "テキストの生成に使用されるAIエージェント。" } ] } }, "required": [ "prompt", "items" ], "title": "AIへのテキスト生成リクエスト", "x-box-tag": "ai" }, "AiTextGenAgent": { "description": "AIへのテキスト生成リクエストの処理に使用されるAIエージェント。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AiAgentReference" }, { "$ref": "#/components/schemas/AiAgentTextGen" } ], "title": "AIへのテキスト生成リクエストのエージェント" }, "AppItem": { "description": "アプリ項目は、アプリケーションが所有するコンテンツオブジェクトを表します。これは、さまざまなパスからファイルやフォルダをまとめてグループ化でき、そのセットは、コラボレーションを利用して共有できます。", "type": "object", "properties": { "id": { "description": "このアプリ項目の一意の識別子。", "type": "string", "example": "12345678" }, "type": { "description": "値は常に`app_item`になります。", "type": "string", "example": "app_item", "enum": [ "app_item" ] }, "application_type": { "description": "このアプリ項目を所有するアプリの種類。", "type": "string", "example": "hubs" } }, "required": [ "id", "type", "application_type" ], "title": "アプリ項目", "x-box-resource-id": "app_item", "x-box-tag": "app_item_associations" }, "AppItemAssociatedItem": { "description": "アプリ項目に関連付けられているファイル、フォルダ、またはウェブリンク。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File--Base" }, { "$ref": "#/components/schemas/Folder--Base" }, { "$ref": "#/components/schemas/WebLink--Base" } ], "title": "アプリ項目に関連付けられた項目" }, "AppItemAssociation": { "description": "アプリ項目の関連付けは、ファイルやフォルダとアプリ項目の関連付けを表します。フォルダとアプリ項目の関連付けは、そのフォルダのすべての子孫にカスケードされます。", "type": "object", "properties": { "id": { "description": "このアプリ項目の関連付けの一意の識別子。", "type": "string", "example": "12345678", "nullable": false }, "type": { "description": "値は常に`app_item_association`になります。", "type": "string", "example": "app_item_association", "enum": [ "app_item_association" ], "nullable": false }, "app_item": { "allOf": [ { "$ref": "#/components/schemas/AppItem" }, { "description": "ファイルまたはフォルダに関連付けられているアプリ項目。" } ], "nullable": false }, "item": { "$ref": "#/components/schemas/AppItemAssociatedItem" } }, "required": [ "id", "type", "app_item", "item" ], "title": "アプリ項目の関連付け", "x-box-resource-id": "app_item_association", "x-box-tag": "app_item_associations" }, "AppItemAssociations": { "description": "アプリ項目の関連付けのリスト。", "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": { "type": "array", "items": { "$ref": "#/components/schemas/AppItemAssociation" } } } } ], "title": "アプリ項目の関連付け", "x-box-resource-id": "app_item_associations", "x-box-tag": "app_item_associations" }, "AppItemEventSource": { "description": "イベントストリーム内のイベントをトリガーしたAppItem。", "type": "object", "properties": { "id": { "description": "`AppItem`のID。", "type": "string", "example": "6374669741" }, "type": { "description": "このイベントが表すソースのタイプ。`app_item`のみになります。", "type": "string", "example": "app_item", "enum": [ "app_item" ], "nullable": false }, "app_item_type": { "description": "`AppItem`のタイプ。", "type": "string", "example": "hubs" }, "user": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このイベントをトリガーしたユーザー。" } ] }, "group": { "allOf": [ { "$ref": "#/components/schemas/Group--Mini" }, { "description": "このイベントをトリガーしたグループ。" } ] } }, "required": [ "id", "type", "app_item_type" ], "title": "AppItemイベントソース", "x-box-resource-id": "app_item_event_source" }, "Classification": { "description": "ファイルまたはフォルダに適用される分類を含む、分類メタデータテンプレートのインスタンス。\n\n項目に適用される分類に関する詳細を取得するには、分類メタデータテンプレートをリクエストしてください。", "type": "object", "properties": { "Box__Security__Classification__Key": { "description": "項目に適用される分類の名前。", "type": "string", "example": "Sensitive" }, "$parent": { "description": "このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。", "type": "string", "example": "folder_59449484661," }, "$template": { "description": "値は常に`securityClassification-6VMVochwUWo`になります。", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ "securityClassification-6VMVochwUWo" ] }, "$scope": { "description": "この分類が適用されている会社のスコープ。\n\nこれは`enterprise_{enterprise_id}`形式になります。", "type": "string", "example": "enterprise_27335" }, "$version": { "description": "メタデータインスタンスのバージョン。このバージョンは0から始まり、分類が更新されるたびに増加します。", "type": "integer", "example": 1 }, "$type": { "description": "この分類インスタンスの一意のID。これには、分類テンプレートの名前と一意のIDが含まれます。", "type": "string", "example": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8" }, "$typeVersion": { "description": "メタデータテンプレートのバージョン。このバージョンは0から始まり、テンプレートが更新されるたびに増加します。これはほとんどの場合、内部で使用されます。", "type": "number", "example": 5 }, "$canEdit": { "description": "エンドユーザーが分類を変更できるかどうか。", "type": "boolean", "example": true } }, "title": "分類", "x-box-resource-id": "classification", "x-box-tag": "classifications" }, "ClassificationTemplate": { "description": "会社が定義したセキュリティ分類を保持するメタデータテンプレート。", "type": "object", "properties": { "id": { "description": "分類テンプレートのID。", "type": "string", "example": "58063d82-4128-7b43-bba9-92f706befcdf" }, "type": { "description": "値は常に`metadata_template`になります。", "type": "string", "example": "metadata_template", "enum": [ "metadata_template" ], "nullable": false }, "scope": { "description": "分類テンプレートのスコープ。これは`enterprise_{id}`形式 (`id`はEnterprise ID) になります。", "type": "string", "example": "enterprise_123456" }, "templateKey": { "description": "値は常に`securityClassification-6VMVochwUWo`になります。", "type": "string", "example": "securityClassification-6VMVochwUWo", "enum": [ "securityClassification-6VMVochwUWo" ] }, "displayName": { "description": "ウェブインターフェースおよびモバイルインターフェースに表示されるこのテンプレートの名前。", "type": "string", "example": "Classification", "enum": [ "Classification" ] }, "hidden": { "description": "このテンプレートを常にウェブインターフェースおよびモバイルインターフェースで使用可能にするかどうかを決定します。", "type": "boolean", "example": false }, "copyInstanceOnItemCopy": { "description": "ファイルまたはフォルダをコピーするときに分類もコピーするかどうかを決定します。", "type": "boolean", "example": true }, "fields": { "description": "この分類テンプレートのフィールドのリスト。これには、`Box__Security__Classification__Key`というフィールドが1つだけ含まれています。これにより、この会社で使用できるさまざまな分類が定義されます。", "type": "array", "items": { "type": "object", "required": [ "id", "type", "key", "displayName", "options" ], "description": "使用可能な分類を表すメタデータテンプレートフィールド。", "properties": { "id": { "description": "フィールドの一意のID。", "type": "string", "example": "822227e0-47a5-921b-88a8-494760b2e6d2" }, "type": { "description": "配列の項目のタイプ。", "type": "string", "example": "enum", "enum": [ "enum" ] }, "key": { "description": "企業で使用できる分類を定義します。", "type": "string", "example": "Box__Security__Classification__Key", "enum": [ "Box__Security__Classification__Key" ] }, "displayName": { "description": "値は常に`Classification`になります。", "type": "string", "example": "Classification", "enum": [ "Classification" ] }, "hidden": { "description": "分類は常にウェブユーザーおよびモバイルユーザーに表示されます。", "type": "boolean", "example": false }, "options": { "description": "この会社で使用できる分類のリスト。", "type": "array", "items": { "required": [ "key", "id" ], "type": "object", "description": "この会社で使用できる1つの分類。", "properties": { "id": { "description": "この分類の一意のID。", "type": "string", "example": "46aea176-3483-4431-856c-6b5b13d1cc50" }, "key": { "description": "この分類の表示名とキー。", "type": "string", "example": "Sensitive" }, "staticConfig": { "description": "分類に関する追加情報。", "type": "object", "properties": { "classification": { "description": "分類に関する追加情報。\n\nこれはプロパティの唯一のリストではなく、より多くのオブジェクトフィールドが返される場合があります。これらのフィールドは内部のBox ShieldおよびBox Governanceの目的で使用されるため、これらのフィールドからさらなる値が派生しないようにしてください。", "type": "object", "properties": { "classificationDefinition": { "description": "分類の詳しい説明。", "type": "string", "example": "Sensitive information" }, "colorID": { "description": "分類ラベルに色を割り当てる際に使用される内部のBox識別子。\n\n`colorID`と色の間のマッピングは予告なしに変更される場合があります。現在、色のマッピングは以下のとおりです。\n\n* `0`: 黄。\n* `1`: オレンジ。\n* `2`: 赤。\n* `3`: 紫。\n* `4`: ライトブルー。\n* `5`: ダークブルー。\n* `6`: ライトグリーン。\n* `7`: グレー。", "type": "integer", "format": "int64", "example": 4 } } } } } } }, "minItems": 1 } } }, "maxItems": 1, "minItems": 1 } }, "required": [ "id", "type", "scope", "displayName", "fields", "templateKey" ], "title": "分類テンプレート", "x-box-resource-id": "classification_template", "x-box-tag": "classifications" }, "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" }, "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" }, "Collaboration": { "description": "アクセス制御リストと同様に、コラボレーションではファイルとフォルダに 対するユーザーおよびグループのアクセス権限が定義されます。コラボレーションオブジェクトは、特定のロールによって定義される権限を含んだファイルまたはフォルダへのアクセス権限をユーザーまたはグループに付与します。", "type": "object", "properties": { "id": { "description": "このコラボレーションの一意の識別子。", "type": "string", "example": "12345678" }, "type": { "description": "値は常に`collaboration`になります。", "type": "string", "example": "collaboration", "enum": [ "collaboration" ] }, "item": { "allOf": [ { "$ref": "#/components/schemas/CollaborationItem" }, { "description": "アクセスが許可されているファイルまたはフォルダ。コラボレーションの`status`が`pending`の場合またはコラボレーションがアプリ項目に作成されている場合 (`app_item`フィールド参照)、このフィールドは`null`です。" } ], "nullable": true }, "app_item": { "allOf": [ { "$ref": "#/components/schemas/AppItem" }, { "description": "アクセスが許可されている`app_item`。コラボレーションが項目に作成されている場合 (`item`フィールド参照) または`app_item`にアクセスできない場合、このフィールドは`null`です。ロールは、`app_item`に関連付けられたすべての項目にカスケードされます。" } ], "nullable": true }, "accessible_by": { "$ref": "#/components/schemas/CollaborationAccessGrantee" }, "invite_email": { "description": "登録済みユーザーでない未登録コラボレータを招待するために使用されたメールアドレス。", "type": "string", "example": "john@example.com", "nullable": true }, "role": { "description": "付与されるアクセスレベル。", "type": "string", "example": "editor", "enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner", "owner" ] }, "expires_at": { "description": "コラボレーションの有効期限。有効期限が設定されていない場合は`null`。", "type": "string", "format": "date-time", "example": "2012-12-26T10:53:43-08:00", "nullable": true }, "is_access_only": { "description": "`true`に設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は \\[すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。", "type": "boolean", "example": true }, "status": { "description": "コラボレーション招待のステータス。ステータスが`pending`の場合、`login`と`name`は空の文字列を返します。", "type": "string", "example": "accepted", "enum": [ "accepted", "pending", "rejected" ] }, "acknowledged_at": { "description": "コラボレーションオブジェクトの`status`が`accepted`または`rejected`に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:55:20-08:00" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Collaborations" }, { "description": "コラボレーションオブジェクトを作成したユーザー。" }, { "example": [ { "id": 33224412 }, { "type": "user" }, { "login": "dylan@example.com" }, { "name": "Dylan Smith" } ] } ] }, "created_at": { "description": "コラボレーションオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "コラボレーションオブジェクトが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "acceptance_requirements_status": { "type": "object", "properties": { "terms_of_service_requirement": { "type": "object", "properties": { "is_accepted": { "description": "サービス利用規約に同意済みかどうか。利用規約への同意が必要ない場合、このフィールドは`null`です。", "type": "boolean", "example": true, "nullable": true }, "terms_of_service": { "allOf": [ { "$ref": "#/components/schemas/TermsOfService--Base" }, { "description": "コラボレーションが承認される前に同意する必要があるサービス利用規約。利用規約への同意が必要ない場合、このフィールドは`null`です。" } ] } } }, "strong_password_requirement": { "type": "object", "properties": { "enterprise_has_strong_password_required_for_external_users": { "description": "コンテンツを所有する企業が、コンテンツのコラボレーションに強力なパスワードを要求するかどうか、または外部コラボレータに対して漏えいが確認されたパスワードの検出を適用するかどうか。", "type": "boolean", "example": true }, "user_has_strong_password": { "description": "ユーザーのアカウントに対して、強力なパスワードの要求と漏えいが確認されたパスワードの検出が設定されているかどうか。強力なパスワードが要求されていない場合、このフィールドは`null`になります。", "type": "boolean", "example": true, "nullable": true } } }, "two_factor_authentication_requirement": { "type": "object", "properties": { "enterprise_has_two_factor_auth_enabled": { "description": "このコンテンツを所有する会社が、このコンテンツでのコラボレーションを行うために2要素認証を有効にする必要があるかどうか。", "type": "boolean", "example": true }, "user_has_two_factor_authentication_enabled": { "description": "ユーザーが2要素認証を有効にしているかどうか。2要素認証が必要ない場合、このフィールドは`null`です。", "type": "boolean", "example": true, "nullable": true } } } } } }, "required": [ "id", "type" ], "title": "Collaboration", "x-box-resource-id": "collaboration", "x-box-tag": "user_collaborations" }, "CollaborationAccessGrantee": { "description": "アクセス権限が付与されるユーザーまたはグループ。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/User--Collaborations" }, { "$ref": "#/components/schemas/Group--Mini" } ], "title": "コラボレーションのアクセス権限付与者" }, "CollaborationAllowlistEntries": { "description": "コラボレーションが許可されたドメインのリスト。", "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/CollaborationAllowlistEntry" } } } } ], "title": "許可されたコラボレーションドメイン", "x-box-resource-id": "collaboration_allowlist_entries", "x-box-tag": "collaboration_allowlist_entries" }, "CollaborationAllowlistEntry": { "description": "ユーザーが社内のファイルやフォルダでコラボレーションできる (またはコラボレーションできない) 承認済みドメインを表すエントリ。", "type": "object", "properties": { "id": { "description": "このエントリの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`collaboration_whitelist_entry`になります。", "type": "string", "example": "collaboration_whitelist_entry", "enum": [ "collaboration_whitelist_entry" ] }, "domain": { "description": "許可リストに登録されるドメイン。", "type": "string", "example": "example.com" }, "direction": { "description": "許可するコラボレーションの方向。", "type": "string", "example": "both", "enum": [ "inbound", "outbound", "both" ] }, "enterprise": { "allOf": [ { "title": "Enterprise", "type": "object", "description": "Box Enterpriseのレプリゼンテーション。", "properties": { "id": { "description": "この会社の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "name": { "description": "企業の名前。", "type": "string", "example": "Acme Inc." } } }, { "description": "このリストが適用される企業。" } ] }, "created_at": { "description": "エントリが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "title": "許可されたコラボレーションドメイン", "x-box-resource-id": "collaboration_allowlist_entry", "x-box-tag": "collaboration_allowlist_entries" }, "CollaborationAllowlistExemptTarget": { "description": "この会社に許可されたコラボレーションドメインのリストによって課せられた制限から除外されるユーザー。", "type": "object", "properties": { "id": { "description": "この除外の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`collaboration_whitelist_exempt_target`になります。", "type": "string", "example": "collaboration_whitelist_exempt_target", "enum": [ "collaboration_whitelist_exempt_target" ] }, "enterprise": { "allOf": [ { "title": "Enterprise", "type": "object", "description": "Box Enterpriseのレプリゼンテーション。", "properties": { "id": { "description": "この会社の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "name": { "description": "企業の名前。", "type": "string", "example": "Acme Inc." } } }, { "description": "このエントリが属する企業。" } ] }, "user": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "除外されているユーザー。" } ] }, "created_at": { "description": "エントリが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "エントリが変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "title": "許可されたコラボレーションドメインからユーザーを除外", "x-box-resource-id": "collaboration_allowlist_exempt_target", "x-box-tag": "collaboration_allowlist_exempt_targets" }, "CollaborationAllowlistExemptTargets": { "description": "この企業に許可されたコラボレーションドメインのリストによって課せられた制限から除外されるユーザーのリスト。", "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/CollaborationAllowlistExemptTarget" } } } } ], "title": "許可されたコラボレーションドメインからユーザーを除外", "x-box-resource-id": "collaboration_allowlist_exempt_targets", "x-box-tag": "collaboration_allowlist_exempt_targets" }, "CollaborationItem": { "description": "コラボレーション項目。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File" }, { "$ref": "#/components/schemas/Folder" }, { "$ref": "#/components/schemas/WebLink" } ], "title": "コラボレーション項目" }, "Collaborations": { "description": "コラボレーションのリスト。", "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/Collaboration" } } } } ], "title": "Collaborations", "x-box-resource-id": "collaborations", "x-box-tag": "user_collaborations" }, "CollaborationsOffsetPaginated": { "description": "コラボレーションのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 } } }, { "properties": { "entries": { "description": "コラボレーションのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Collaboration" } } } } ], "title": "Collaborations", "x-box-resource-id": "collaborations_offset_paginated", "x-box-tag": "user_collaborations" }, "CollaboratorVariable": { "description": "コラボレータオブジェクト。ワークフローの結果の影響を受けるユーザーIDのリストを指定できます。", "type": "object", "properties": { "type": { "description": "コラボレータオブジェクトタイプ。", "type": "string", "example": "variable", "enum": [ "variable" ] }, "variable_type": { "description": "コラボレータオブジェクトの変数タイプ。", "type": "string", "example": "user_list", "enum": [ "user_list" ] }, "variable_value": { "description": "ユーザーIDのリスト。", "type": "array", "items": { "type": "object", "required": [ "type", "id" ], "description": "ワークフローの結果で使用されるユーザー変数。", "properties": { "type": { "description": "オブジェクトタイプ。", "type": "string", "example": "user", "enum": [ "user" ] }, "id": { "description": "ユーザーのID。", "type": "string", "example": "636281" } } } } }, "required": [ "type", "variable_type", "variable_value" ], "title": "コラボレータ変数" }, "Collection": { "description": "ファイルやフォルダなどの項目のコレクション。\n\n現時点で利用可能なコレクションは、`favorites`コレクションのみです。\n\nコレクションのコンテンツは、フォルダのコンテンツと同じ方法で調べることができます。", "type": "object", "properties": { "id": { "description": "このコレクションの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`collection`になります。", "type": "string", "example": "collection", "enum": [ "collection" ] }, "name": { "description": "コレクションの名前。", "type": "string", "example": "Favorites", "enum": [ "Favorites" ] }, "collection_type": { "description": "コレクションのタイプ。これは、コレクションの視覚効果を適切に決定するために使用されます。", "type": "string", "example": "favorites", "enum": [ "favorites" ] } }, "title": "Collection", "x-box-resource-id": "collection", "x-box-tag": "collections" }, "Collections": { "description": "コレクションのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "コレクションのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Collection" } } } } ], "title": "Collections", "x-box-resource-id": "collections", "x-box-tag": "collections" }, "Comment": { "description": "コメントのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Comment--Base" }, { "properties": { "is_reply_comment": { "description": "このコメントが他のコメントへの返信かどうか。", "type": "boolean", "example": true }, "message": { "description": "ユーザーが入力したコメントのテキスト。", "type": "string", "example": "@Aaron Levie these tigers are cool!" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "コメント作成者をMini版のユーザーオブジェクトで表示。" } ] }, "created_at": { "description": "このコメントが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "このコメントが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "item": { "allOf": [ { "title": "Reference", "description": "オブジェクトの最も基本的な参照。", "type": "object", "properties": { "id": { "description": "このオブジェクトの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "このオブジェクトのタイプ。", "type": "string", "example": "file" } } }, { "description": "このコメントが追加されたファイル。" } ] } } } ], "title": "Comment", "x-box-resource-id": "comment", "x-box-variant": "standard" }, "Comment--Base": { "description": "コメントのBase版の表示。", "type": "object", "properties": { "id": { "description": "このコメントの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`comment`になります。", "type": "string", "example": "comment", "enum": [ "comment" ] } }, "title": "コメント (Base)", "x-box-resource-id": "comment--base", "x-box-tag": "comments", "x-box-variant": "base", "x-box-variants": [ "base", "standard", "full" ] }, "Comment--Full": { "description": "コメントとは、ファイルに関して作成されるメッセージです。コメントは単独で作成することも、他のコメントへの返答として作成することもできます。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Comment" }, { "properties": { "tagged_message": { "description": "@メンションを含むコメントテキストを表す文字列。@メンションの形式は@\\[id:username] で、`id`はユーザーのBox ID、`username`はユーザーの表示名になります。", "type": "string", "example": "@[1234567:Aaron Levie] these tigers are cool!" } } } ], "title": "コメント (Full)", "x-box-resource-id": "comment--full", "x-box-variant": "full" }, "Comments": { "description": "コメントのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "コメントのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Comment--Full" } } } } ], "title": "Comments", "x-box-resource-id": "comments", "x-box-tag": "comments" }, "CompletionRuleVariable": { "description": "完了ルールオブジェクト。操作をすべての担当者が完了する必要があるか、一人でも完了すればよいかを決定します。", "type": "object", "properties": { "type": { "description": "完了ルールオブジェクトタイプ。", "type": "string", "example": "variable", "enum": [ "variable" ] }, "variable_type": { "description": "完了ルールオブジェクトの変数タイプ。", "type": "string", "example": "task_completion_rule", "enum": [ "task_completion_rule" ] }, "variable_value": { "description": "完了ルールの変数値。", "type": "string", "example": "all_assignees", "enum": [ "all_assignees", "any_assignees" ] } }, "required": [ "type", "variable_type", "variable_value" ], "title": "完了ルール変数" }, "ConflictError": { "description": "競合が原因でファイルを作成できなかったときに発生するエラー。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ClientError" }, { "properties": { "context_info": { "type": "object", "properties": { "conflicts": { "description": "このエラーの原因であるファイル競合のリスト。", "type": "array", "items": { "$ref": "#/components/schemas/FileConflict" } } } } } } ], "title": "競合エラー", "x-box-resource-id": "conflict_error", "x-box-tag": "uploads" }, "CreateAiAgent": { "description": "AIエージェント作成リクエストのスキーマ。", "type": "object", "properties": { "type": { "description": "クエリの処理に使用されるエージェントのタイプ。", "type": "string", "example": "ai_agent", "enum": [ "ai_agent" ] }, "name": { "description": "AIエージェントの名前。", "type": "string", "example": "My AI Agent" }, "access_state": { "description": "AIエージェントの状態。使用可能な値は`enabled`、`disabled`、`enabled_for_selected_users`です。", "type": "string", "example": "enabled", "title": "アクセス状態", "x-box-tag": "ai_studio" }, "icon_reference": { "description": "AIエージェントのアイコン参照。これは、URL `https://cdn01.boxcdn.net/app-assets/aistudio/avatars/`の形式で指定する必要があります。この場合、`file_name`に使用可能な値は`logo_boxAi.png`、`logo_stamp.png`、`logo_legal.png`、`logo_finance.png`、`logo_config.png`、`logo_handshake.png`、`logo_analytics.png`、`logo_classification.png`です。", "type": "string", "example": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg", "minLength": 1 }, "allowed_entities": { "description": "許可するユーザーまたはグループのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/AiAgentAllowedEntity" } }, "ask": { "$ref": "#/components/schemas/AiStudioAgentAsk" }, "text_gen": { "$ref": "#/components/schemas/AiStudioAgentTextGen" }, "extract": { "$ref": "#/components/schemas/AiStudioAgentExtract" } }, "required": [ "type", "name", "access_state" ], "title": "AIエージェント作成リクエスト", "x-box-tag": "ai_studio" }, "DevicePinner": { "description": "デバイスピンを使用すると、どのデバイスでネイティブBoxアプリケーションの使用を許可するかを会社レベルで制御できます。", "type": "object", "properties": { "id": { "description": "このデバイスピンの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`device_pinner`になります。", "type": "string", "example": "device_pinner", "enum": [ "device_pinner" ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "デバイスピンが属するユーザー。" } ] }, "product_name": { "description": "ピンが設定されているデバイスのタイプ。", "type": "string", "example": "iPad" } }, "title": "Device Pinner", "x-box-resource-id": "device_pinner", "x-box-tag": "device_pinners" }, "DevicePinners": { "description": "デバイスピンのリスト。", "type": "object", "properties": { "entries": { "description": "デバイスピンのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/DevicePinner" } }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。", "type": "integer", "format": "int64", "example": 200, "default": 100 }, "next_marker": { "description": "次の検索結果ページの開始場所のマーカー。", "type": "integer", "format": "int64", "example": 3000 }, "order": { "description": "項目が返される順序。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "id", "enum": [ "id" ] }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "asc", "enum": [ "asc", "desc" ] } } } } }, "title": "Device Pinners", "x-box-resource-id": "device_pinners", "x-box-tag": "device_pinners" }, "EmailAlias": { "description": "ユーザーのメールエイリアス。", "type": "object", "properties": { "id": { "description": "このオブジェクトの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`email_alias`になります。", "type": "string", "example": "email_alias", "enum": [ "email_alias" ] }, "email": { "description": "メールアドレス。", "type": "string", "example": "alias@example.com" }, "is_confirmed": { "description": "メールアドレスが確認済みかどうか。", "type": "boolean", "example": true } }, "title": "メールエイリアス", "x-box-resource-id": "email_alias", "x-box-tag": "email_aliases" }, "EmailAliases": { "description": "メールエイリアスのリスト。", "type": "object", "properties": { "total_count": { "description": "メールエイリアスの数。", "type": "integer", "format": "int64", "example": 5000 }, "entries": { "description": "メールエイリアスのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/EmailAlias" } } }, "title": "メールエイリアス", "x-box-resource-id": "email_aliases", "x-box-tag": "email_aliases" }, "Enterprise--Base": { "description": "他のリソース内にネストされたときに使用される企業のMini版の表示。", "type": "object", "properties": { "id": { "description": "この会社の一意の識別子。", "type": "string", "example": "1910967" }, "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ], "nullable": false } }, "title": "企業 (Base)", "x-box-resource-id": "enterprise--base", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard", "full" ] }, "Event": { "description": "Box内で発生したイベントの説明。", "type": "object", "properties": { "type": { "description": "値は常に`event`になります。", "type": "string", "example": "event" }, "created_at": { "description": "イベントオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2022-12-12T10:53:43-08:00" }, "recorded_at": { "description": "イベントオブジェクトがデータベースに記録された日時。", "type": "string", "format": "date-time", "example": "2022-12-12T10:54:43-08:00" }, "event_id": { "description": "イベントオブジェクトのID。これは、重複したイベントの検出に使用できます。", "type": "string", "example": "f82c3ba03e41f7e8a7608363cc6c0390183c3f83" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "イベントが表すアクションを実行したユーザー。イベントの中には、Boxにログインしていないユーザーによって実行されるものもあります。その場合は、オブジェクトの一部の属性が設定されず、イベントの実行者は不明なユーザー (`user_id = 2`) に設定されます。" } ] }, "event_type": { "allOf": [ { "title": "イベントタイプ", "example": "FILE_MARKED_MALICIOUS", "type": "string", "description": "イベントをトリガーできるイベントタイプ。", "enum": [ "ACCESS_GRANTED", "ACCESS_REVOKED", "ADD_DEVICE_ASSOCIATION", "ADD_LOGIN_ACTIVITY_DEVICE", "ADMIN_LOGIN", "APPLICATION_CREATED", "APPLICATION_PUBLIC_KEY_ADDED", "APPLICATION_PUBLIC_KEY_DELETED", "CHANGE_ADMIN_ROLE", "CHANGE_FOLDER_PERMISSION", "COLLABORATION_ACCEPT", "COLLABORATION_EXPIRATION", "COLLABORATION_INVITE", "COLLABORATION_REMOVE", "COLLABORATION_ROLE_CHANGE", "COLLAB_ADD_COLLABORATOR", "COLLAB_INVITE_COLLABORATOR", "COLLAB_REMOVE_COLLABORATOR", "COLLAB_ROLE_CHANGE", "COMMENT_CREATE", "COMMENT_DELETE", "CONTENT_ACCESS", "CONTENT_WORKFLOW_ABNORMAL_DOWNLOAD_ACTIVITY", "CONTENT_WORKFLOW_AUTOMATION_ADD", "CONTENT_WORKFLOW_AUTOMATION_DELETE", "CONTENT_WORKFLOW_POLICY_ADD", "CONTENT_WORKFLOW_SHARING_POLICY_VIOLATION", "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION", "COPY", "DATA_RETENTION_CREATE_RETENTION", "DATA_RETENTION_REMOVE_RETENTION", "DELETE", "DELETE_USER", "DEVICE_TRUST_CHECK_FAILED", "DOWNLOAD", "EDIT", "EDIT_USER", "EDR_CROWDSTRIKE_DEVICE_DETECTED", "EDR_CROWDSTRIKE_NO_BOX_TOOLS", "EDR_CROWDSTRIKE_BOX_TOOLS_OUTDATED", "EDR_CROWDSTRIKE_DRIVE_OUTDATED", "EDR_CROWDSTRIKE_ACCESS_ALLOWED_NO_CROWDSTRIKE_DEVICE", "EDR_CROWDSTRIKE_ACCESS_REVOKED", "EMAIL_ALIAS_CONFIRM", "EMAIL_ALIAS_REMOVE", "ENABLE_TWO_FACTOR_AUTH", "ENTERPRISE_APP_AUTHORIZATION_UPDATE", "FAILED_LOGIN", "FILE_MARKED_MALICIOUS", "FILE_WATERMARKED_DOWNLOAD", "GROUP_ADD_ITEM", "GROUP_ADD_USER", "GROUP_CREATION", "GROUP_DELETION", "GROUP_EDITED", "GROUP_REMOVE_ITEM", "GROUP_REMOVE_USER", "ITEM_COPY", "ITEM_CREATE", "ITEM_DOWNLOAD", "ITEM_EMAIL_SEND", "ITEM_MAKE_CURRENT_VERSION", "ITEM_MODIFY", "ITEM_MOVE", "ITEM_OPEN", "ITEM_PREVIEW", "ITEM_RENAME", "ITEM_SHARED", "ITEM_SHARED_CREATE", "ITEM_SHARED_UNSHARE", "ITEM_SHARED_UPDATE", "ITEM_SYNC", "ITEM_TRASH", "ITEM_UNDELETE_VIA_TRASH", "ITEM_UNSYNC", "ITEM_UPLOAD", "LEGAL_HOLD_ASSIGNMENT_CREATE", "LEGAL_HOLD_ASSIGNMENT_DELETE", "LEGAL_HOLD_POLICY_CREATE", "LEGAL_HOLD_POLICY_DELETE", "LEGAL_HOLD_POLICY_UPDATE", "LOCK", "LOCK_CREATE", "LOCK_DESTROY", "LOGIN", "MASTER_INVITE_ACCEPT", "MASTER_INVITE_REJECT", "METADATA_INSTANCE_CREATE", "METADATA_INSTANCE_DELETE", "METADATA_INSTANCE_UPDATE", "METADATA_TEMPLATE_CREATE", "METADATA_TEMPLATE_DELETE", "METADATA_TEMPLATE_UPDATE", "MOVE", "NEW_USER", "PREVIEW", "REMOVE_DEVICE_ASSOCIATION", "REMOVE_LOGIN_ACTIVITY_DEVICE", "RENAME", "RETENTION_POLICY_ASSIGNMENT_ADD", "SHARE", "SHARED_LINK_SEND", "SHARE_EXPIRATION", "SHIELD_ALERT", "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED", "SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION", "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED", "SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION", "SHIELD_JUSTIFICATION_APPROVAL", "SHIELD_SHARED_LINK_ACCESS_BLOCKED", "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_CREATE", "SHIELD_SHARED_LINK_STATUS_RESTRICTED_ON_UPDATE", "SIGN_DOCUMENT_ASSIGNED", "SIGN_DOCUMENT_CANCELLED", "SIGN_DOCUMENT_COMPLETED", "SIGN_DOCUMENT_CONVERTED", "SIGN_DOCUMENT_CREATED", "SIGN_DOCUMENT_DECLINED", "SIGN_DOCUMENT_EXPIRED", "SIGN_DOCUMENT_SIGNED", "SIGN_DOCUMENT_VIEWED_BY_SIGNED", "SIGNER_DOWNLOADED", "SIGNER_FORWARDED", "STORAGE_EXPIRATION", "TAG_ITEM_CREATE", "TASK_ASSIGNMENT_CREATE", "TASK_ASSIGNMENT_DELETE", "TASK_ASSIGNMENT_UPDATE", "TASK_CREATE", "TASK_UPDATE", "TERMS_OF_SERVICE_ACCEPT", "TERMS_OF_SERVICE_REJECT", "UNDELETE", "UNLOCK", "UNSHARE", "UPDATE_COLLABORATION_EXPIRATION", "UPDATE_SHARE_EXPIRATION", "UPLOAD", "USER_AUTHENTICATE_OAUTH2_ACCESS_TOKEN_CREATE", "WATERMARK_LABEL_CREATE", "WATERMARK_LABEL_DELETE" ] }, { "description": "このイベントをトリガーしたイベントタイプ。" } ] }, "session_id": { "description": "アクションを実行したユーザーのセッション。この属性にすべてのイベントが入るわけではありません。", "type": "string", "example": "70090280850c8d2a1933c1" }, "source": { "allOf": [ { "$ref": "#/components/schemas/EventSourceResource" }, { "description": "このイベントをトリガーしたリソース。詳細については、イベントトリガーに関するガイドを確認してください。" } ] }, "additional_details": { "description": "このオブジェクトは、イベントに関する追加情報を提供します (利用可能な場合)。\n\nこれには、ユーザーがイベントを実行した方法に加え、イベントを外部のKeySafeログに関連付けるための追加情報が含まれます。すべてのイベントに`additional_details`オブジェクトがあるわけではありません。このオブジェクトは、Enterprise Eventのみに存在します。", "type": "object", "example": { "key": "value" } } }, "title": "Event", "x-box-resource-id": "event", "x-box-tag": "events" }, "EventSource": { "description": "イベントストリーム内のイベントを開始させるソースファイルまたはフォルダ。", "type": "object", "properties": { "item_type": { "description": "イベントを表す項目の種類。`file`または`folder`になります。", "type": "string", "example": "file", "enum": [ "file", "folder" ], "nullable": false }, "item_id": { "description": "項目を表す一意の識別子。", "type": "string", "example": "560284318361", "nullable": false }, "item_name": { "description": "項目の名前。", "type": "string", "example": "report.pdf", "nullable": false }, "classification": { "description": "イベントをトリガーした項目の分類情報を格納しているオブジェクト。項目に分類が設定されていない場合、このフィールドは表示されません。", "type": "object", "properties": { "name": { "description": "分類の名前。", "type": "string", "example": "Top Secret" } } }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このフォルダが配置されているフォルダ (省略可)\n\nルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。" } ], "nullable": true }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "この項目を所有するユーザー" }, { "nullable": false } ] } }, "required": [ "item_type", "item_id", "item_name" ], "title": "イベントソース", "x-box-resource-id": "event_source" }, "EventSourceResource": { "description": "イベントをトリガーしたリソース。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/User" }, { "$ref": "#/components/schemas/EventSource" }, { "$ref": "#/components/schemas/File" }, { "$ref": "#/components/schemas/Folder" }, { "$ref": "#/components/schemas/GenericSource" }, { "$ref": "#/components/schemas/AppItemEventSource" } ], "title": "イベントソースのリソース" }, "Events": { "description": "イベントオブジェクトのリスト。", "type": "object", "properties": { "chunk_size": { "description": "このレスポンスで返されるイベントの数。", "type": "integer", "format": "int64", "example": 2 }, "next_stream_position": { "description": "次のイベントページ (チャンク) のストリーム開始位置。", "example": "1152922976252290886", "anyOf": [ { "type": "string" }, { "type": "integer", "format": "int64" } ] }, "entries": { "description": "イベントのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Event" } } }, "title": "Events", "x-box-resource-id": "events", "x-box-tag": "events" }, "File": { "description": "任意のファイルAPIエンドポイントからデフォルトで返されるファイルのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/File--Mini" }, { "properties": { "description": { "description": "このファイルの説明 (省略可)。説明が255文字を超える場合は、最初の255文字がファイルの説明として設定され、残りは無視されます。", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 255, "nullable": false }, "size": { "description": "ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。", "type": "integer", "example": 629644, "nullable": false }, "path_collection": { "allOf": [ { "title": "パスのコレクション", "description": "項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目の親フォルダ。", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" }, "nullable": false } } }, { "description": "ルートフォルダを起点にした、このファイルを含むフォルダツリー。" }, { "nullable": false } ] }, "created_at": { "description": "Box上でこのファイルが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": false }, "modified_at": { "description": "Boxでこのファイルが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": false }, "trashed_at": { "description": "このファイルがごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "purged_at": { "description": "このファイルがごみ箱から削除される予定日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_created_at": { "description": "このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_modified_at": { "description": "このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを作成したユーザー。" } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを最後に変更したユーザー。" }, { "nullable": false } ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを所有するユーザー。" }, { "nullable": false } ] }, "shared_link": { "allOf": [ { "title": "共有リンク", "description": "共有リンクを作成すると、Box上のファイルやフォルダに対する読み取り専用アクセスを直接実行できます。\n\nアクセスレベルがopenに設定されている共有リンクの場合は、URLを知っているすべてのユーザーが項目にアクセスでき、アクセスレベルがcompanyまたはcollaboratorsに設定されている共有リンクの場合は、適切に認証されたBoxユーザーのみが項目にアクセスできます。", "type": "object", "required": [ "url", "accessed", "effective_access", "effective_permission", "is_password_enabled", "download_count", "preview_count" ], "properties": { "url": { "description": "Box上の項目にアクセスするために使用できるURL。\n\nこのURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。\n\nこのURLは、この共有リンクに対してカスタムの`vanity_url`が 設定されている場合でも動作します。", "type": "string", "format": "url", "example": "https://www.box.com/s/vspke7y05sb214wjokpk", "nullable": false }, "download_url": { "description": "ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。\n\nフォルダの場合、このプロパティは`null`になります。", "type": "string", "format": "url", "example": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "nullable": true, "x-box-premium-feature": true }, "vanity_url": { "description": "Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。", "type": "string", "format": "url", "example": "https://acme.app.box.com/v/my_url/", "nullable": true }, "vanity_name": { "description": "`vanity_url`フィールドで使用される、共有リンクのカスタム名。", "type": "string", "example": "my_url", "nullable": true }, "access": { "description": "この共有リンクのアクセスレベル\n\n* `open` - このリンクを知っている全員にこの項目へのアクセスを許可します\n* `company` - 同じ会社のユーザーにのみこの項目へのアクセスを許可します\n* `collaborators` - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します\n\n共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ], "nullable": false }, "effective_access": { "description": "共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、`access`フィールドの値よりも低いアクセスレベルになることがあります。", "type": "string", "example": "company", "enum": [ "open", "company", "collaborators" ], "nullable": false }, "effective_permission": { "description": "この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。", "type": "string", "example": "can_download", "enum": [ "can_edit", "can_download", "can_preview", "no_access" ], "nullable": false }, "unshared_at": { "description": "このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00", "nullable": true }, "is_password_enabled": { "description": "共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。", "type": "boolean", "example": true, "nullable": false }, "permissions": { "description": "このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。", "type": "object", "properties": { "can_download": { "description": "共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。\n\n実際のアクセスレベルが`collaborators`ではなく、`open`または`company`に設定されている場合は、この値を`true`に設定できます。", "type": "boolean", "example": true, "nullable": false }, "can_preview": { "description": "共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。\n\nこの値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true, "nullable": false }, "can_edit": { "description": "共有リンクからの項目の編集を許可するかどうかを定義します。\n\n`can_download`が`true`で、項目のタイプが`file`の場合のみ、この値も`true`に設定できます。", "type": "boolean", "example": false, "nullable": false } }, "required": [ "can_download", "can_preview", "can_edit" ] }, "download_count": { "description": "この項目がダウンロードされた回数。", "type": "integer", "example": 3, "nullable": false }, "preview_count": { "description": "この項目がプレビューされた回数。", "type": "integer", "example": 3, "nullable": false } } }, { "description": "このファイルの共有リンク。このファイルに対してまだ共有リンクが作成されていない場合、この値は`null`になります。" }, { "nullable": true } ] }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このフォルダが配置されているフォルダ。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる可能性があります。" } ], "nullable": true }, "item_status": { "description": "この項目が削除されたかどうかを定義します。\n\n* `active` - 項目がごみ箱に移動されていない場合。\n* `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。\n* `deleted` - 項目がすでに完全に削除されている場合。", "type": "string", "example": "active", "enum": [ "active", "trashed", "deleted" ], "nullable": false } } } ], "title": "File", "x-box-resource-id": "file", "x-box-variant": "standard" }, "File--Base": { "description": "最も基本的なファイルのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。", "type": "object", "properties": { "id": { "description": "ファイルを表す一意の識別子。\n\nファイル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" ] }, "File--Full": { "description": "任意のファイルAPIエンドポイントからデフォルトで返される可能性があるファイルのFull版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/File" }, { "properties": { "version_number": { "description": "このファイルのバージョン番号。", "type": "string", "example": "1" }, "comment_count": { "description": "このファイルに関するコメントの数。", "type": "integer", "example": 10 }, "permissions": { "allOf": [ { "type": "object", "description": "このファイルに対して認証済みユーザーが持っている権限。", "required": [ "can_annotate", "can_comment", "can_preview", "can_upload", "can_view_annotations_all", "can_view_annotations_self" ], "allOf": [ { "type": "object", "description": "この項目に対して認証済みユーザーが持っている権限。", "required": [ "can_delete", "can_download", "can_invite_collaborator", "can_rename", "can_set_share_access", "can_share" ], "properties": { "can_delete": { "description": "現在のユーザーがこの項目を削除できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_download": { "description": "現在のユーザーがこの項目をダウンロードできるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_invite_collaborator": { "description": "現在のユーザーがこの項目でのコラボレーションに新しいユーザーを招待できるかどうかと、この項目ですでにコラボレーションしているユーザーのロールを更新できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_rename": { "description": "ユーザーがこの項目の名前を変更できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_set_share_access": { "description": "ユーザーがこの項目の既存の共有リンクのアクセスレベルを変更できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_share": { "description": "ユーザーがこの項目の共有リンクを作成できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false } } }, { "properties": { "can_annotate": { "description": "ユーザーがこのファイルに注釈を付けられるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_comment": { "description": "ユーザーがこのファイルにコメントを追加できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_preview": { "description": "ユーザーがこのファイルをプレビューできるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_upload": { "description": "ユーザーがこのファイルの新しいバージョンをアップロードできるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_view_annotations_all": { "description": "ユーザーに対してこのファイルに付けられたすべての注釈を表示するかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_view_annotations_self": { "description": "ユーザーに対して自分がファイルに付けた注釈を表示するかどうかを指定します。", "type": "boolean", "example": true, "nullable": false } } } ] }, { "description": "このファイルに対して現在のユーザーが持っている権限について説明します。" }, { "nullable": false } ] }, "tags": { "allOf": [ { "type": "array", "example": [ "approved" ], "items": { "type": "string" }, "minItems": 1, "maxItems": 100, "description": "この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。\n\nタグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。\n\nタグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。" }, { "nullable": false } ] }, "lock": { "allOf": [ { "title": "Lock", "type": "object", "description": "ファイルで保持されているロック。ロックにより、ロックを作成したユーザー以外は、ファイルを移動、名前変更、および変更できません。", "properties": { "id": { "description": "このロックの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`lock`になります。", "type": "string", "example": "lock", "enum": [ "lock" ] }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "ロックを作成したユーザー。" } ] }, "created_at": { "description": "このロックが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "expired_at": { "description": "このロックが期限切れになる日時。過去の日時になる場合もあります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "is_download_prevented": { "description": "ロック中でもファイルのダウンロードを許可するかどうか。", "type": "boolean", "example": true }, "app_type": { "description": "ロックを管理しているのがユーザーではなくアプリケーションの場合、このフィールドは、ロックを保持しているアプリケーションの種類を示します。これはオープンな列挙型で、今後、値の追加により拡張される可能性があります。", "type": "string", "example": "office_wopiplus", "enum": [ "gsuite", "office_wopi", "office_wopiplus", "other" ], "nullable": true } } }, { "description": "このファイルで保持されているロック。ロックが存在しない場合は`null`になるか、過去のタイムスタンプになります。" } ], "nullable": true }, "extension": { "description": "このファイルのファイル拡張子 (省略可) を示します。デフォルトでは、空の文字列に設定されます。", "type": "string", "example": "pdf" }, "is_package": { "description": "ファイルがパッケージかどうかを示します。パッケージはMacアプリケーションで一般的に使用され、iWorkファイルを含めることができます。", "type": "boolean", "example": true }, "expiring_embed_link": { "allOf": [ { "title": "有効期限付き埋め込みリンク", "type": "object", "description": "有効期限付きのBox Embedリンク。", "allOf": [ { "type": "object", "description": "アクセストークンの基本情報。", "properties": { "access_token": { "description": "リクエストされたアクセストークン。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" }, "expires_in": { "description": "このトークンが期限切れになるまでの秒数。", "type": "integer", "format": "int64", "example": 3600 }, "token_type": { "description": "返されるアクセストークンのタイプ。", "type": "string", "example": "bearer", "enum": [ "bearer" ] }, "restricted_to": { "description": "このアクセストークンで許可される権限を返します。これにより、リソース (ファイルやフォルダなど) のリストと、各リソースで許可されるスコープが提供されます。", "type": "array", "items": { "$ref": "#/components/schemas/ResourceScope" } } } }, { "properties": { "url": { "description": "このファイルの実際の有効期限付き埋め込みURL。このオブジェクトで指定されたファイルIDとアクセストークンから作成されます。", "type": "string", "format": "url", "example": "https://cloud.app.box.com/preview/expiring_embed/..." } } } ] }, { "description": "このフィールドをリクエストすると、`iframe`に埋め込まれたプレビューセッション用の有効期限付きBox Embed URLが作成されます。\n\nこのURLは60秒後に有効期限切れとなり、セッションはその60分後に有効期限切れとなります。\n\n一部のファイルタイプは、これらの埋め込みURLでサポートされていません。Box Embedはモバイルブラウザ向けに最適化されていないため、モバイルデバイス用に設計されたウェブエクスペリエンスでは使用しないでください。多くのUI Element (**ダウンロード**オプションや**印刷**オプションなど) はモバイルブラウザに表示されない可能性があります。" } ] }, "watermark_info": { "allOf": [ { "type": "object", "description": "この項目に適用された電子すかしに関する詳細。", "properties": { "is_watermarked": { "description": "この項目に電子すかしが適用されているかどうかを指定します。", "type": "boolean", "example": true, "nullable": false } } }, { "description": "このファイルに適用された電子すかしに関する詳細。" } ] }, "is_accessible_via_shared_link": { "description": "直接共有リンクまたは親フォルダへの共有リンクを使用してファイルにアクセスできるかどうかを指定します。", "type": "boolean", "example": true }, "allowed_invitee_roles": { "description": "このファイルを共有するときに招待できるユーザーの役割タイプのリスト。", "type": "array", "items": { "type": "string", "enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ] }, "example": [ "editor" ], "nullable": false }, "is_externally_owned": { "description": "このファイルが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "has_collaborations": { "description": "このファイルに他のコラボレータが存在するかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "metadata": { "allOf": [ { "title": "項目メタデータインスタンス", "type": "object", "description": "`scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。\n\nファイルまたはフォルダのメタデータにアクセスするには、最初にメタデータエンドポイントを使用して、会社で使用できるメタデータテンプレートを特定します。\n\nその後、`fields`クエリパラメータを指定して`GET /files/:id`または`GET /folder/:id`エンドポイントを使用すると、IDを指定してメタデータを取得できます。\n\n特定の`scope`および`templateKey`のメタデータインスタンスをリクエストするには、`fields`パラメータに`metadata..`の形式を使用してください。\n\nたとえば、`?fields=metadata.enterprise_27335.marketingCollateral`のようになります。", "example": { "enterprise_27335": { "marketingCollateral": { "$canEdit": true, "$id": "01234500-12f1-1234-aa12-b1d234cb567e", "$parent": "folder_59449484661", "$scope": "enterprise_27335", "$template": "marketingCollateral", "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0", "$typeVersion": 2, "$version": 1 } } }, "additionalProperties": { "type": "object", "description": "`scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。", "example": { "marketingCollateral": { "$canEdit": true, "$id": "01234500-12f1-1234-aa12-b1d234cb567e", "$parent": "folder_59449484661", "$scope": "enterprise_27335", "$template": "marketingCollateral", "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0", "$typeVersion": 2, "$version": 1 } }, "additionalProperties": { "$ref": "#/components/schemas/Metadata--Full" } } }, { "description": "このファイルに追加されたメタデータインスタンスを含むオブジェクト。\n\n各メタデータインスタンスは、その`scope`と`templateKey`によって一意に識別されます。各ファイルに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとして`templateKey`が指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとして`scope`が指定されているオブジェクト内にネストされます。" } ] }, "expires_at": { "description": "ファイルが自動的に削除される日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "representations": { "allOf": [ { "title": "Representations", "description": "ファイルレプリゼンテーションのリスト。", "type": "object", "properties": { "entries": { "description": "ファイルのリスト。", "type": "array", "items": { "type": "object", "description": "ファイルレプリゼンテーション。", "properties": { "content": { "description": "レプリゼンテーションを実際に取得するために使用できるURLを含むオブジェクト。", "properties": { "url_template": { "description": "レプリゼンテーションを取得するために使用できるダウンロードURL。このエンドポイントに対しては必ず認証済みAPIコールを行ってください。\n\nこのURLはテンプレートであるため、`{+asset_path}`を実際のパスに置き換える必要があります。通常、ページ付けが行われていないレプリゼンテーションの場合は、空の文字列に置き換えることができます。\n\nページ割りされたレプリゼンテーションの場合は、`1.pdf`など、リクエストするページにファイル拡張子を付けた文字列で`{+asset_path}`を置き換えます。\n\nダウンロードURLをリクエストする際には、以下の追加クエリパラメータを渡すことができます。\n\n* `set_content_disposition_type` - 配置タイプとして`inline`または`attachment`のいずれかを指定してAPIレスポンスの`Content-Disposition`ヘッダーを設定します。このパラメータを指定しない場合、レスポンスに`Content-Disposition`ヘッダーは含まれません。\n\n* `set_content_disposition_filename` - `Content-Disposition`ヘッダーで使用するレプリゼンテーションのファイル名をアプリケーションで定義できます。定義しない場合は、Boxのソースファイル名から派生したファイル名とレプリゼンテーション拡張子の組み合わせがファイル名になります。", "type": "string", "example": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567" } }, "type": "object" }, "info": { "description": "このレプリゼンテーションの詳細を取得するために使用できるURLを含むオブジェクト。", "type": "object", "properties": { "url": { "description": "このファイルレプリゼンテーションの詳細を取得するために使用できるAPI URL。このエンドポイントに対しては必ず認証済みAPIコールを行ってください。", "type": "string", "example": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048" } } }, "properties": { "description": "このプレゼンテーションのサイズとタイプを含むオブジェクト。", "type": "object", "properties": { "dimensions": { "type": "string", "format": "x", "example": "2048x2048", "description": "このレプリゼンテーションの幅と高さ。" }, "paged": { "type": "string", "example": "true", "description": "レプリゼンテーションが複数のページで構成されているかどうかを示します。" }, "thumb": { "type": "string", "example": "true", "description": "そのレプリゼンテーションをファイルのサムネイルとして使用できるかどうかを示します。" } } }, "representation": { "description": "返されたレプリゼンテーションのファイルタイプを示します。", "type": "string", "example": "png" }, "status": { "description": "このレプリゼンテーションのステータスを含むオブジェクト。", "type": "object", "properties": { "state": { "description": "レプリゼンテーションのステータス。\n\n* `success`はそのレプリゼンテーションが表示可能な状態であることを示します。\n* `viewable`は視聴可能な動画であることを示します。\n* `pending`はそのレプリゼンテーションがこれから生成されることを示します。ステータスを再確認するにはこのエンドポイントを再試行します。\n* `none`はリクエストされたときにレプリゼンテーションが再作成されることを示します。この生成をトリガーするには、`info`オブジェクトで定義されたURLをリクエストします。", "type": "string", "example": "success", "enum": [ "success", "viewable", "pending", "none" ] } } } } } } } }, { "description": "アプリケーション内でファイルのプレースホルダを表示するために使用できるレプリゼンテーションのリスト。デフォルトでは、すべてのレプリゼンテーションが返されるため、`x-rep-hints`ヘッダーを使用して目的のレプリゼンテーションをさらにカスタマイズすることをお勧めします。" } ] }, "classification": { "allOf": [ { "type": "object", "description": "項目に適用される分類。", "properties": { "name": { "description": "分類の名前。", "type": "string", "example": "Top Secret" }, "definition": { "description": "この分類の意味の説明。", "type": "string", "example": "Content that should not be shared outside the company." }, "color": { "description": "ユーザーインターフェースでの分類ラベルの表示に使用される色。色は、Boxウェブアプリで分類を作成した管理者または共同管理者によって定義されます。", "type": "string", "example": "#FF0000" } } }, { "description": "このファイルに適用された分類に関する詳細" }, { "nullable": true } ] }, "uploader_display_name": { "allOf": [ { "title": "アップローダーの表示名", "type": "string", "example": "Ellis Wiggins", "nullable": false, "description": "ファイルをアップロードしたユーザーの表示名。ほとんどの場合、これはアップロード時点でログインしているユーザーの名前です。\n\nこのファイルのアップロードに、ユーザーに対してメールアドレスの入力を要求するファイルリクエストフォームが使用された場合、このフィールドにはそのメールアドレスが設定されます。メールアドレスがファイルリクエストフォームで要求されなかった場合、このフィールドは、`File Request`という値を返すように設定されます。\n\nメールアドレスが指定されなかったその他すべての匿名のケースでは、このフィールドの値がデフォルトで`Someone`になります。" } ] }, "disposition_at": { "description": "特定のファイルのリテンションの有効期限のタイムスタンプ。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "shared_link_permission_options": { "description": "このファイルを共有するときに招待できるユーザーの役割タイプのリスト。", "type": "array", "items": { "type": "string", "enum": [ "can_preview", "can_download", "can_edit" ] }, "example": [ "can_preview" ], "nullable": true }, "is_associated_with_app_item": { "description": "ファイルまたはファイルの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのファイルに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。", "type": "boolean", "example": true, "nullable": false } } } ], "title": "ファイル (Full)", "x-box-resource-id": "file--full", "x-box-variant": "full" }, "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を表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、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-variant": "mini" }, "FileConflict": { "description": "以前出力されていたファイルの表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/File--Mini" }, { "properties": { "sha1": { "description": "ファイルのSHA1ハッシュ。", "type": "string", "example": "85136C79CBF9FE36BB9D05D0639C70C265C18D37" }, "file_version": { "$ref": "#/components/schemas/FileVersion--Mini" } } } ], "title": "ファイル (競合)", "x-box-resource-id": "file_conflict", "x-box-tag": null }, "FileRequest": { "description": "任意のファイルリクエストAPIエンドポイントからデフォルトで返されるファイルリクエストのStandard版の表示。", "type": "object", "properties": { "id": { "description": "このファイルリクエストの一意の識別子。", "type": "string", "example": "42037322", "readOnly": true }, "type": { "description": "値は常に`file_request`になります。", "type": "string", "example": "file_request", "enum": [ "file_request" ], "readOnly": true }, "title": { "description": "ファイルリクエストのタイトル。これは、Box UIで、ファイルをアップロードしているユーザーに表示されます。\n\nデフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストのタイトルになります。", "type": "string", "example": "Please upload documents" }, "description": { "description": "このファイルリクエストの説明 (省略可)。これは、Box UIで、ファイルをアップロードしているユーザーに表示されます。\n\nデフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの説明になります。", "type": "string", "example": "Following documents are requested for your process", "nullable": true }, "status": { "description": "ファイルリクエストのステータス。デフォルトでは`active`になります。\n\nこのステータスを`inactive`に設定すると、ファイルリクエストでは新しい送信を受け付けなくなり、ファイルリクエストのURLにアクセスした場合は`HTTP 404`ステータスコードが返されます。\n\nデフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストのステータスになります。", "type": "string", "example": "active", "enum": [ "active", "inactive" ] }, "is_email_required": { "description": "ファイルリクエストの送信者に、メールアドレスの指定を義務付けるかどうか。\n\nこれをtrueに設定すると、Box UIのファイルリクエストフォームにメールフィールドが表示されます。\n\nデフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの設定になります。", "type": "boolean", "example": true }, "is_description_required": { "description": "ファイルリクエストの送信者に、送信するファイルの説明の指定を義務付けるかどうか。\n\nこれをtrueに設定すると、Box UIのファイルリクエストフォームに説明フィールドが表示されます。\n\nデフォルトでは、このファイルリクエストを作成するためにコピーされたファイルリクエストの設定になります。", "type": "boolean", "example": true }, "expires_at": { "description": "ファイルリクエストが新しい送信を受け付けなくなる日付。\n\nこの日付を過ぎると、`status`は自動的に`inactive`に設定されます。", "type": "string", "format": "date-time", "example": "2020-09-28T10:53:43-08:00" }, "folder": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このファイルリクエストが関連付けられているフォルダ。\n\nファイルリクエストフォームを使用して送信されたファイルは、このフォルダにアップロードされます。" } ], "nullable": false }, "url": { "description": "このファイルリクエストに対して生成されたURL。このURLをユーザーと共有すると、ユーザーが関連付けられたフォルダにファイルをアップロードできるようになります。", "type": "string", "example": "/f/19e57f40ace247278a8e3d336678c64a", "readOnly": true }, "etag": { "description": "このファイルのHTTP `etag`。これは、ファイルリクエストの更新時に`If-Match`ヘッダーと組み合わせて使用できます。そのヘッダーを指定すると、`If-Match`ヘッダーで指定された`etag`とファイルリクエストの`etag`がまだ一致している場合のみ、ファイルリクエストが変更されます。", "type": "string", "example": "1", "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルリクエストを作成したユーザー。" } ] }, "created_at": { "description": "ファイルリクエストが作成された日時。", "type": "string", "format": "date-time", "example": "2020-09-28T10:53:43-08:00", "nullable": false }, "updated_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルリクエストを最後に変更したユーザー。" }, { "nullable": false } ] }, "updated_at": { "description": "ファイルリクエストが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2020-09-28T10:53:43-08:00", "nullable": false } }, "required": [ "id", "type", "folder", "created_at", "updated_at" ], "title": "ファイルリクエスト", "x-box-resource-id": "file_request", "x-box-tag": "file_requests" }, "FileRequestCopyRequest": { "description": "ファイルリクエストをコピーするためのリクエスト本文。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileRequestUpdateRequest" }, { "properties": { "folder": { "description": "新しいファイルリクエストを関連付けるフォルダ。", "type": "object", "properties": { "type": { "description": "値は常に`folder`になります。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "新しいファイルリクエストを関連付けるフォルダのID。", "type": "string", "example": "42037322" } }, "required": [ "id" ] } } } ], "required": [ "folder" ], "title": "ファイルリクエスト (コピー)" }, "FileRequestUpdateRequest": { "description": "ファイルリクエストを更新するためのリクエスト本文。", "type": "object", "properties": { "title": { "description": "ファイルリクエストの新しいタイトル (省略可)。これを使用して、ファイルリクエストのタイトルを変更できます。\n\nデフォルトでは、既存のファイルリクエストの値になります。", "type": "string", "example": "Please upload required documents" }, "description": { "description": "ファイルリクエストの新しい説明 (省略可)。これを使用して、ファイルリクエストの説明を変更できます。\n\nデフォルトでは、既存のファイルリクエストの値になります。", "type": "string", "example": "Please upload required documents" }, "status": { "description": "ファイルリクエストの新しいステータス (省略可)。\n\nこのステータスを`inactive`に設定すると、ファイルリクエストでは新しい送信を受け付けなくなり、ファイルリクエストのURLにアクセスした場合は`HTTP 404`ステータスコードが返されます。\n\nデフォルトでは、既存のファイルリクエストの値になります。", "type": "string", "example": "active", "enum": [ "active", "inactive" ] }, "is_email_required": { "description": "ファイルリクエストの送信者に、メールアドレスの指定を義務付けるかどうか。\n\nこれをtrueに設定すると、Box UIのファイルリクエストフォームにメールフィールドが表示されます。\n\nデフォルトでは、既存のファイルリクエストの値になります。", "type": "boolean", "example": true }, "is_description_required": { "description": "ファイルリクエストの送信者に、送信するファイルの説明の指定を義務付けるかどうか。\n\nこれをtrueに設定すると、Box UIのファイルリクエストフォームに説明フィールドが表示されます。\n\nデフォルトでは、既存のファイルリクエストの値になります。", "type": "boolean", "example": true }, "expires_at": { "description": "ファイルリクエストが新しい送信を受け付けなくなる日付。\n\nこの日付を過ぎると、`status`は自動的に`inactive`に設定されます。\n\nデフォルトでは、既存のファイルリクエストの値になります。", "type": "string", "format": "date-time", "example": "2020-09-28T10:53:43-08:00" } }, "title": "ファイルリクエスト (更新)" }, "FileVersion": { "description": "ファイルバージョンのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileVersion--Mini" }, { "properties": { "name": { "description": "ファイルバージョンの名前。", "type": "string", "example": "tigers.jpeg" }, "size": { "description": "ファイルバージョンのサイズ (バイト単位)。", "type": "integer", "format": "int64", "example": 629644 }, "created_at": { "description": "ファイルバージョンオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "ファイルバージョンオブジェクトが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "ファイルバージョンを最後に更新したユーザー。" } ] }, "trashed_at": { "description": "ファイルバージョンオブジェクトがごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "trashed_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "ファイルバージョンをごみ箱に移動したユーザー。" } ] }, "restored_at": { "description": "ファイルバージョンがごみ箱から復元された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "restored_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "ごみ箱からファイルバージョンを復元したユーザー。" } ] }, "purged_at": { "description": "ファイルバージョンオブジェクトが完全に削除される日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "uploader_display_name": { "allOf": [ { "title": "アップローダーの表示名", "type": "string", "example": "Ellis Wiggins", "nullable": false, "description": "ファイルをアップロードしたユーザーの表示名。ほとんどの場合、これはアップロード時点でログインしているユーザーの名前です。\n\nこのファイルのアップロードに、ユーザーに対してメールアドレスの入力を要求するファイルリクエストフォームが使用された場合、このフィールドにはそのメールアドレスが設定されます。メールアドレスがファイルリクエストフォームで要求されなかった場合、このフィールドは、`File Request`という値を返すように設定されます。\n\nメールアドレスが指定されなかったその他すべての匿名のケースでは、このフィールドの値がデフォルトで`Someone`になります。" } ] } } } ], "title": "ファイルバージョン", "x-box-resource-id": "file_version", "x-box-variant": "standard" }, "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" ] }, "FileVersion--Full": { "description": "任意のファイルバージョンAPIエンドポイントからデフォルトで返される可能性がある、ファイルバージョンのFull版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/FileVersion" }, { "properties": { "version_number": { "description": "このファイルバージョンのバージョン番号。", "type": "string", "example": "1" } } } ], "title": "ファイルバージョン (Full)", "x-box-resource-id": "file_version--full", "x-box-variant": "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" }, "FileVersionLegalHold": { "description": "ファイルバージョンリーガルホールドは、ファイルバージョンのすべてのリーガルホールドを表すエンティティです。", "type": "object", "properties": { "id": { "description": "このファイルバージョンリーガルホールドの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`file_version_legal_hold`になります。", "type": "string", "example": "file_version_legal_hold", "enum": [ "file_version_legal_hold" ] }, "file_version": { "allOf": [ { "$ref": "#/components/schemas/FileVersion--Mini" }, { "description": "保持されているファイルバージョン。" } ] }, "file": { "allOf": [ { "$ref": "#/components/schemas/File--Mini" }, { "description": "保持されているファイルバージョンのファイル。常にそのファイルの最新バージョンが保持されるとは限りません。" } ] }, "legal_hold_policy_assignments": { "description": "このホールドに貢献する割り当てのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/LegalHoldPolicyAssignment" } }, "deleted_at": { "description": "このFile-Version-Legal-Holdが削除された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "title": "ファイルバージョンリーガルホールド", "x-box-resource-id": "file_version_legal_hold", "x-box-tag": "file_version_legal_holds" }, "FileVersionLegalHolds": { "description": "リーガルホールドが設定されたファイルバージョンのリスト。", "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/FileVersionLegalHold" } } } } ], "title": "ファイルバージョンリーガルホールド", "x-box-resource-id": "file_version_legal_holds", "x-box-tag": "file_version_legal_holds" }, "FileVersionRetention": { "description": "リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はポリシーを特定のフォルダや企業全体に適用できます。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対して \\[リテンションポリシーを管理する] スコープを有効にする必要があります。\n\n**注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](e://get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](e://get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。", "type": "object", "properties": { "id": { "description": "このファイルバージョンリテンションの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`file_version_retention`になります。", "type": "string", "example": "file_version_retention", "enum": [ "file_version_retention" ] }, "file_version": { "allOf": [ { "$ref": "#/components/schemas/FileVersion--Mini" }, { "description": "このファイルバージョンリテンションが適用されたファイルバージョン。" } ] }, "file": { "allOf": [ { "$ref": "#/components/schemas/File--Mini" }, { "description": "このファイルバージョンリテンションが適用されたファイル。" } ] }, "applied_at": { "description": "このファイルバージョンリテンションオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "disposition_at": { "description": "このファイルバージョンリテンションのリテンションが終了する日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "winning_retention_policy": { "allOf": [ { "$ref": "#/components/schemas/RetentionPolicy--Mini" }, { "description": "このファイルバージョンリテンションに適用されている、優先度が最も高いリテンションポリシー。ファイルバージョンには複数のリテンションポリシーが適用されている場合があります。" } ] } }, "title": "ファイルバージョンリテンション", "x-box-resource-id": "file_version_retention", "x-box-tag": "file_version_retentions" }, "FileVersionRetentions": { "description": "ファイルバージョンリテンションのリスト。\n\n**注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](e://get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](e://get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。", "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/FileVersionRetention" } } } } ], "title": "ファイルバージョンリテンション", "x-box-resource-id": "file_version_retentions", "x-box-tag": "file_version_retentions" }, "FileVersions": { "description": "ファイルバージョンのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "ファイルバージョンのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/FileVersion--Full" } } } } ], "title": "ファイルバージョン", "x-box-resource-id": "file_versions", "x-box-tag": "file_versions" }, "FileVersionsOnHold": { "description": "リーガルホールドポリシー割り当てにより、リーガルホールドが設定されているファイルのリスト。", "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/FileVersion" } } } } ], "title": "リーガルホールドが設定されているファイルバージョン", "x-box-resource-id": "file_versions_on_hold", "x-box-tag": "legal_hold_policy_assignments" }, "Files": { "description": "ファイルのリスト。", "type": "object", "properties": { "total_count": { "description": "ファイルの数。", "type": "integer", "format": "int64", "example": 1 }, "entries": { "description": "ファイルのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/File--Full" } } }, "title": "Files", "x-box-resource-id": "files", "x-box-tag": "files" }, "FilesOnHold": { "description": "リーガルホールドポリシー割り当てにより、リーガルホールドが設定されているファイルのリスト。", "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/File--Mini" } } } } ], "title": "リーガルホールドが設定されているファイル", "x-box-resource-id": "files_on_hold", "x-box-tag": "legal_hold_policy_assignments" }, "FilesUnderRetention": { "description": "リテンションの対象となるファイルのリスト。", "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/File--Mini" } } } } ], "title": "リテンションの対象となるファイル", "x-box-resource-id": "files_under_retention", "x-box-tag": "retention_policy_assignments" }, "Folder": { "description": "任意のフォルダAPIエンドポイントからデフォルトで返されるフォルダのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "properties": { "created_at": { "description": "このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "modified_at": { "description": "このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "description": { "allOf": [ { "type": "string", "description": "このフォルダの説明 (省略可)。", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false }, { "nullable": false } ] }, "size": { "description": "フォルダサイズ (バイト単位)。\n\nこの整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。", "type": "integer", "format": "int64", "example": 629644, "nullable": false }, "path_collection": { "allOf": [ { "title": "パスのコレクション", "description": "項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目の親フォルダ。", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" }, "nullable": false } } }, { "description": "ルートフォルダを起点にした、このフォルダを含むフォルダツリー。" }, { "nullable": false } ] }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを作成したユーザー。" }, { "nullable": false } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを最後に変更したユーザー。" }, { "nullable": false } ] }, "trashed_at": { "description": "このフォルダがごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "purged_at": { "description": "このフォルダがごみ箱から削除される予定日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_created_at": { "description": "このフォルダが最初に作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_modified_at": { "description": "このフォルダが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを所有するユーザー。" }, { "nullable": false } ] }, "shared_link": { "allOf": [ { "title": "共有リンク", "description": "共有リンクを作成すると、Box上のファイルやフォルダに対する読み取り専用アクセスを直接実行できます。\n\nアクセスレベルがopenに設定されている共有リンクの場合は、URLを知っているすべてのユーザーが項目にアクセスでき、アクセスレベルがcompanyまたはcollaboratorsに設定されている共有リンクの場合は、適切に認証されたBoxユーザーのみが項目にアクセスできます。", "type": "object", "required": [ "url", "accessed", "effective_access", "effective_permission", "is_password_enabled", "download_count", "preview_count" ], "properties": { "url": { "description": "Box上の項目にアクセスするために使用できるURL。\n\nこのURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。\n\nこのURLは、この共有リンクに対してカスタムの`vanity_url`が 設定されている場合でも動作します。", "type": "string", "format": "url", "example": "https://www.box.com/s/vspke7y05sb214wjokpk", "nullable": false }, "download_url": { "description": "ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。\n\nフォルダの場合、このプロパティは`null`になります。", "type": "string", "format": "url", "example": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "nullable": true, "x-box-premium-feature": true }, "vanity_url": { "description": "Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。", "type": "string", "format": "url", "example": "https://acme.app.box.com/v/my_url/", "nullable": true }, "vanity_name": { "description": "`vanity_url`フィールドで使用される、共有リンクのカスタム名。", "type": "string", "example": "my_url", "nullable": true }, "access": { "description": "この共有リンクのアクセスレベル\n\n* `open` - このリンクを知っている全員にこの項目へのアクセスを許可します\n* `company` - 同じ会社のユーザーにのみこの項目へのアクセスを許可します\n* `collaborators` - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します\n\n共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ], "nullable": false }, "effective_access": { "description": "共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、`access`フィールドの値よりも低いアクセスレベルになることがあります。", "type": "string", "example": "company", "enum": [ "open", "company", "collaborators" ], "nullable": false }, "effective_permission": { "description": "この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。", "type": "string", "example": "can_download", "enum": [ "can_edit", "can_download", "can_preview", "no_access" ], "nullable": false }, "unshared_at": { "description": "このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00", "nullable": true }, "is_password_enabled": { "description": "共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。", "type": "boolean", "example": true, "nullable": false }, "permissions": { "description": "このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。", "type": "object", "properties": { "can_download": { "description": "共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。\n\n実際のアクセスレベルが`collaborators`ではなく、`open`または`company`に設定されている場合は、この値を`true`に設定できます。", "type": "boolean", "example": true, "nullable": false }, "can_preview": { "description": "共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。\n\nこの値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true, "nullable": false }, "can_edit": { "description": "共有リンクからの項目の編集を許可するかどうかを定義します。\n\n`can_download`が`true`で、項目のタイプが`file`の場合のみ、この値も`true`に設定できます。", "type": "boolean", "example": false, "nullable": false } }, "required": [ "can_download", "can_preview", "can_edit" ] }, "download_count": { "description": "この項目がダウンロードされた回数。", "type": "integer", "example": 3, "nullable": false }, "preview_count": { "description": "この項目がプレビューされた回数。", "type": "integer", "example": 3, "nullable": false } } }, { "description": "このフォルダの共有リンク。このフォルダに対してまだ共有リンクが作成されていない場合は、`null`になります。" } ], "nullable": true }, "folder_upload_email": { "description": "以下のオプションのいずれかが**true**の場合、`folder_upload_email`パラメータは`null`ではありません。\n\n* \\[**このフォルダへのメールによるアップロードを許可する**] および \\[**このフォルダのコラボレータにのみメールによるアップロードを許可する**] が[管理コンソールで1フォルダに対して有効](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email)になっていて、ユーザーには少なくとも**アップロード**権限が付与されています。\n\n* \\[**このフォルダへのメールによるアップロードを許可する**] の設定が管理コンソールで1フォルダに対して有効になっていて、\\[**このフォルダのコラボレータにのみメールによるアップロードを許可する**] の設定が無効 (オフ) になっています。\n\n条件が満たされていない場合、パラメータには次の値が設定されます: `folder_upload_email: null`。", "type": "object", "nullable": true, "properties": { "access": { "description": "このパラメータが設定されている場合、ユーザーは、このフォルダに対して自動的に作成されたメールアドレスに メールでファイルを送信できます。\n\nメールアドレスを作成するには、フォルダを作成するとき、または更新するときにこのプロパティを設定します。\n\n`collaborators`に設定すると、コラボレータの登録済み メールアドレスからのメールのみが受け入れられます。これには、ユーザーが登録しているすべてのメールエイリアスも含まれます。\n\n`open`に設定すると、どのメールアドレスからのメールでも受け入れられます。", "type": "string", "example": "open", "enum": [ "open", "collaborators" ], "nullable": false }, "email": { "description": "このフォルダのアップロードメールアドレス (省略可)。", "type": "string", "format": "email", "example": "upload.Contracts.asd7asd@u.box.com", "nullable": false } } }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このフォルダが配置されているフォルダ (省略可)\n\nルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。" } ], "nullable": true }, "item_status": { "description": "この項目が削除されたかどうかを定義します。\n\n* `active` - 項目がごみ箱に移動されていない場合。\n* `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。\n* `deleted` - 項目がすでに完全に削除されている場合。", "type": "string", "example": "active", "enum": [ "active", "trashed", "deleted" ], "nullable": false }, "item_collection": { "allOf": [ { "$ref": "#/components/schemas/Items" }, { "description": "フォルダ内の項目のページ。\n\nこのフィールドをリクエストできるのは、フォルダの情報をクエリで照会するときのみで、フォルダの項目をクエリで照会するときにはリクエストできません。" }, { "nullable": false } ] } } } ], "title": "Folder", "x-box-resource-id": "folder", "x-box-variant": "standard" }, "Folder--Base": { "description": "最も基本的なフォルダのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。", "type": "object", "properties": { "id": { "description": "フォルダを表す一意の識別子。\n\nフォルダ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" ] }, "Folder--Full": { "description": "任意のフォルダAPIエンドポイントからデフォルトで返される可能性があるフォルダのFull版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Folder" }, { "properties": { "sync_state": { "allOf": [ { "type": "string", "example": "synced", "nullable": false, "description": "フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。これはBox Sync (廃止済み) で使用され、Box Driveでは 使用されません。", "enum": [ "synced", "not_synced", "partially_synced" ] } ] }, "has_collaborations": { "description": "このフォルダに他のコラボレータが存在するかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "permissions": { "allOf": [ { "type": "object", "description": "フォルダに対して認証済みユーザーが持っている権限。", "required": [ "can_upload" ], "allOf": [ { "type": "object", "description": "この項目に対して認証済みユーザーが持っている権限。", "required": [ "can_delete", "can_download", "can_invite_collaborator", "can_rename", "can_set_share_access", "can_share" ], "properties": { "can_delete": { "description": "現在のユーザーがこの項目を削除できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_download": { "description": "現在のユーザーがこの項目をダウンロードできるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_invite_collaborator": { "description": "現在のユーザーがこの項目でのコラボレーションに新しいユーザーを招待できるかどうかと、この項目ですでにコラボレーションしているユーザーのロールを更新できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_rename": { "description": "ユーザーがこの項目の名前を変更できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_set_share_access": { "description": "ユーザーがこの項目の既存の共有リンクのアクセスレベルを変更できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "can_share": { "description": "ユーザーがこの項目の共有リンクを作成できるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false } } }, { "properties": { "can_upload": { "description": "ユーザーがこのフォルダにアップロードできるかどうかを指定します。", "type": "boolean", "example": true, "nullable": false } } } ] }, { "description": "このフォルダに対して現在のユーザーが持っている権限について説明します。" }, { "nullable": false } ] }, "tags": { "allOf": [ { "type": "array", "example": [ "approved" ], "items": { "type": "string" }, "minItems": 1, "maxItems": 100, "description": "この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。\n\nタグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。\n\nタグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。" }, { "nullable": false } ] }, "can_non_owners_invite": { "allOf": [ { "type": "boolean", "example": true, "description": "フォルダの所有者ではないユーザーがそのフォルダに新しいコラボレータを招待できるかどうかを指定します。" }, { "nullable": false } ] }, "is_externally_owned": { "description": "このフォルダが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。", "type": "boolean", "example": true, "nullable": false }, "metadata": { "allOf": [ { "title": "項目メタデータインスタンス", "type": "object", "description": "`scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。\n\nファイルまたはフォルダのメタデータにアクセスするには、最初にメタデータエンドポイントを使用して、会社で使用できるメタデータテンプレートを特定します。\n\nその後、`fields`クエリパラメータを指定して`GET /files/:id`または`GET /folder/:id`エンドポイントを使用すると、IDを指定してメタデータを取得できます。\n\n特定の`scope`および`templateKey`のメタデータインスタンスをリクエストするには、`fields`パラメータに`metadata..`の形式を使用してください。\n\nたとえば、`?fields=metadata.enterprise_27335.marketingCollateral`のようになります。", "example": { "enterprise_27335": { "marketingCollateral": { "$canEdit": true, "$id": "01234500-12f1-1234-aa12-b1d234cb567e", "$parent": "folder_59449484661", "$scope": "enterprise_27335", "$template": "marketingCollateral", "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0", "$typeVersion": 2, "$version": 1 } } }, "additionalProperties": { "type": "object", "description": "`scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。", "example": { "marketingCollateral": { "$canEdit": true, "$id": "01234500-12f1-1234-aa12-b1d234cb567e", "$parent": "folder_59449484661", "$scope": "enterprise_27335", "$template": "marketingCollateral", "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0", "$typeVersion": 2, "$version": 1 } }, "additionalProperties": { "$ref": "#/components/schemas/Metadata--Full" } } }, { "description": "このフォルダに追加されたメタデータインスタンスを含むオブジェクト。\n\n各メタデータインスタンスは、その`scope`と`templateKey`によって一意に識別されます。各フォルダに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとして`templateKey`が指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとして`scope`が指定されているオブジェクト内にネストされます。" } ] }, "is_collaboration_restricted_to_enterprise": { "allOf": [ { "type": "boolean", "example": true, "description": "このフォルダへの招待を社内のユーザーのみに限定するかどうかを指定します。既存のコラボレーションには影響しません。" }, { "nullable": false } ] }, "allowed_shared_link_access_levels": { "description": "このフォルダで使用できるアクセスレベルのリスト。\n\nルートフォルダなどの一部のフォルダでは共有が許可されていないため、このリストは常に空になります。", "type": "array", "items": { "type": "string", "enum": [ "open", "company", "collaborators" ] }, "example": [ "open" ], "nullable": false }, "allowed_invitee_roles": { "description": "このフォルダを共有するときに招待できるユーザーの役割タイプのリスト。", "type": "array", "items": { "type": "string", "enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ] }, "example": [ "editor" ], "nullable": false }, "watermark_info": { "allOf": [ { "type": "object", "description": "この項目に適用された電子すかしに関する詳細。", "properties": { "is_watermarked": { "description": "この項目に電子すかしが適用されているかどうかを指定します。", "type": "boolean", "example": true, "nullable": false } } }, { "description": "このフォルダに適用された電子すかしに関する詳細。" }, { "nullable": false } ] }, "is_accessible_via_shared_link": { "description": "直接共有リンクまたは親フォルダへの共有リンクを使用してフォルダにアクセスできるかどうかを指定します。", "type": "boolean", "example": true }, "can_non_owners_view_collaborators": { "description": "このフォルダの所有者ではないコラボレータがこのフォルダの他のコラボレータを表示できないように制限するかどうかを指定します。\n\nこの制限を有効にした場合は、所有者ではないユーザーが新しいコラボレータを招待することも制限されます。", "type": "boolean", "example": true }, "classification": { "allOf": [ { "type": "object", "description": "項目に適用される分類。", "properties": { "name": { "description": "分類の名前。", "type": "string", "example": "Top Secret" }, "definition": { "description": "この分類の意味の説明。", "type": "string", "example": "Content that should not be shared outside the company." }, "color": { "description": "ユーザーインターフェースでの分類ラベルの表示に使用される色。色は、Boxウェブアプリで分類を作成した管理者または共同管理者によって定義されます。", "type": "string", "example": "#FF0000" } } }, { "description": "このフォルダに適用された分類に関する詳細。" }, { "nullable": true } ] }, "is_associated_with_app_item": { "description": "フォルダまたはフォルダの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのフォルダに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。", "type": "boolean", "example": true, "nullable": false } } } ], "title": "フォルダ (Full)", "x-box-resource-id": "folder--full", "x-box-variant": "full" }, "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を表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、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-variant": "mini" }, "FolderLock": { "description": "フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。", "type": "object", "properties": { "folder": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "ロックが適用されるフォルダ。" } ] }, "id": { "description": "このフォルダロックの一意の識別子。", "type": "string", "example": "12345678" }, "type": { "description": "オブジェクトタイプ (常に`folder_lock`)。", "type": "string", "example": "folder_lock" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "ロックを作成したユーザーまたはグループ。" } ] }, "created_at": { "description": "フォルダロックオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2020-09-14T23:12:53Z" }, "locked_operations": { "description": "ロックされている操作。現在、`move`操作と`delete`操作を別々にロックすることはできません。両方とも`true`に設定する必要があります。", "type": "object", "properties": { "move": { "description": "フォルダの移動が制限されるかどうか。", "type": "boolean", "example": true, "nullable": false }, "delete": { "description": "フォルダの削除が制限されるかどうか。", "example": true, "nullable": false, "type": "boolean" } }, "required": [ "move", "delete" ] }, "lock_type": { "description": "ロックの種類 (常に`freeze`)。", "type": "string", "example": "freeze" } }, "title": "フォルダロック", "x-box-resource-id": "folder_lock", "x-box-tag": "folder_locks" }, "FolderLocks": { "description": "フォルダロックのリスト。", "type": "object", "properties": { "entries": { "description": "フォルダロックのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/FolderLock" } }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "string", "example": "1000" }, "next_marker": { "description": "次の検索結果ページの開始場所のマーカー。", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } }, "title": "フォルダロック", "x-box-resource-id": "folder_locks", "x-box-tag": "folder_locks" }, "FolderReference": { "description": "フォルダの参照。", "type": "object", "properties": { "type": { "description": "値は常に`folder`になります。", "type": "string", "example": "folder", "enum": [ "folder" ], "nullable": false }, "id": { "description": "フォルダのID。", "type": "string", "example": "42037322" } }, "required": [ "type", "id" ], "title": "フォルダの参照" }, "GenericSource": { "description": "汎用的なイベントソースタイプ。", "type": "object", "additionalProperties": { "allOf": [ {}, { "description": "汎用的なイベントソースオブジェクトの定義。パラメータのセットは、オブジェクトタイプによって異なります。たとえば、Box Shieldのイベントソースでは、以下のパラメータのセットが使用されます。\n\n````yaml\n{\n\"barrier_id\": 123456,\n\"barrier_status\": \"ENABLED\",\n\"barrier_segments\": [\n {\n \"name\": \"8\",\n \"member_count\": 1\n },\n {\n \"name\": \"9\",\n \"member_count\": 1\n }\n ]\n} \n\n```.\n````" } ] }, "title": "汎用的なソース", "x-box-resource-id": "generic_source" }, "Group": { "description": "任意のグループAPIエンドポイントからデフォルトで返されるグループのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Group--Mini" }, { "properties": { "created_at": { "description": "グループオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "グループオブジェクトが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } ], "title": "Group", "x-box-resource-id": "group", "x-box-variant": "standard" }, "Group--Base": { "description": "グループのBase版の表示。", "type": "object", "properties": { "id": { "description": "このオブジェクトの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`group`になります。", "type": "string", "example": "group", "enum": [ "group" ] } }, "required": [ "id", "type" ], "title": "グループ (Base)", "x-box-resource-id": "group--base", "x-box-tag": "groups", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard", "full" ] }, "Group--Full": { "description": "グループは複数のユーザーを含み、グループを使用するとコラボレーションなどの一部の操作をユーザーの代わりに実行できます。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Group" }, { "properties": { "provenance": { "description": "このグループの元になっている外部ソース (\"Active Directory\"、\"Google Groups\"、\"Facebook Groups\"など) を追跡します。また、これを設定すると、Box管理者がBoxウェブアプリケーションからグループ名やメンバーを直接編集できなくなります。", "type": "string", "example": "Active Directory", "maxLength": 255 }, "external_sync_identifier": { "description": "このBoxグループを外部グループにリンクするために外部のグループ同期ツールで使用できる任意の識別子。このフィールドの値には、Active DirectoryオブジェクトIDやGoogleグループIDなどを使用できます。Boxまたは外部システム内でグループ名が更新されたときの問題を回避するために、このフィールドを使用することをお勧めします。", "type": "string", "example": "AD:123456" }, "description": { "description": "グループについての人間が判読できる説明。", "type": "string", "example": "Support Group - as imported from Active Directory", "maxLength": 255 }, "invitability_level": { "description": "項目でのコラボレーションにグループを招待できるユーザーを指定します。\n\n`admins_only`に設定すると、会社の管理者、共同管理者、およびグループ管理者がグループを招待できるようになります。\n\n`admins_and_members`に設定すると、上記すべての管理者に加えて、グループのメンバーもグループを招待できるようになります。\n\n`all_managed_users`に設定すると、社内のすべての管理対象ユーザーがグループを招待できるようになります。", "type": "string", "example": "admins_only", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] }, "member_viewability_level": { "description": "グループのメンバーを表示できるユーザーを指定します (グループのメンバーを取得)。\n\n* `admins_only` - 企業の管理者、共同管理者、グループのグループ管理者。\n* `admins_and_members` - すべての管理者とグループメンバー。\n* `all_managed_users` - 企業のすべての管理対象ユーザー。", "type": "string", "example": "admins_only", "enum": [ "admins_only", "admins_and_members", "all_managed_users" ] }, "permissions": { "allOf": [ { "type": "object", "description": "グループに対して認証済みユーザーが持っている権限。", "properties": { "can_invite_as_collaborator": { "description": "ユーザーが項目でのコラボレーションにグループを招待できるかどうかを指定します。", "type": "boolean", "example": true } } }, { "description": "このグループに対して現在のユーザーが持っている権限について説明します。" } ] } } } ], "title": "グループ (Full)", "x-box-resource-id": "group--full", "x-box-variant": "full" }, "Group--Mini": { "description": "グループのIDや名前を含むグループのMini版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Group--Base" }, { "properties": { "name": { "description": "グループの名前。", "type": "string", "example": "Support" }, "group_type": { "description": "グループのタイプ。", "type": "string", "example": "managed_group", "enum": [ "managed_group", "all_users_group" ] } } } ], "title": "グループ (Mini)", "x-box-resource-id": "group--mini", "x-box-variant": "mini" }, "GroupMembership": { "description": "メンバーシップは、ユーザーがグループに属していることを示すために使用されます。", "type": "object", "properties": { "id": { "description": "このグループメンバーシップの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`group_membership`になります。", "type": "string", "example": "group_membership", "enum": [ "group_membership" ] }, "user": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "メンバーシップが適用されるユーザー。" } ] }, "group": { "allOf": [ { "$ref": "#/components/schemas/Group--Mini" }, { "description": "メンバーシップが適用されるグループ。" } ] }, "role": { "description": "グループ内のユーザーのロール。", "type": "string", "example": "member", "enum": [ "member", "admin" ] }, "created_at": { "description": "このメンバーシップが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "このメンバーシップが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "title": "グループメンバーシップ", "x-box-resource-id": "group_membership", "x-box-tag": "memberships" }, "GroupMemberships": { "description": "グループメンバーシップのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "グループメンバーシップのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/GroupMembership" } } } } ], "title": "グループメンバーシップ", "x-box-resource-id": "group_memberships", "x-box-tag": "memberships" }, "Groups": { "description": "グループのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "グループのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Group--Full" } } } } ], "title": "Groups", "x-box-resource-id": "groups", "x-box-tag": "groups" }, "IntegrationMapping": { "description": "統合マッピングオブジェクトのSlack固有のレプリゼンテーション。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingBase" }, { "properties": { "integration_type": { "description": "マッピングが関連付けられているBoxパートナーアプリを示します。現在サポートされているのはSlackのみです (`id`とともに複合キーの一部)。", "type": "string", "example": "slack", "enum": [ "slack" ] }, "is_manually_created": { "description": "マッピングが (自動作成されたのではなく) 手動で設定されているかどうかを示します。", "type": "boolean", "example": true }, "options": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingSlackOptions" } ] }, "created_by": { "description": "統合マッピングを作成したユーザーを表すオブジェクト。", "allOf": [ { "$ref": "#/components/schemas/UserIntegrationMappings" } ] }, "modified_by": { "description": "統合マッピングを最後に変更したユーザー。", "allOf": [ { "$ref": "#/components/schemas/UserIntegrationMappings" } ] }, "partner_item": { "description": "Slack用にマッピングされた項目オブジェクト。", "example": { "id": "C12378991223", "type": "channel", "slack_org_id": "E1234567" }, "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" } ] }, "box_item": { "description": "パートナーアプリのドメインのオブジェクト (`partner_item_id`で参照) のマッピング先であるBoxフォルダ。", "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" } ] }, "created_at": { "description": "統合マッピングオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "統合マッピングオブジェクトが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } ], "required": [ "partner_item", "box_item" ], "title": "Slack統合マッピング", "x-box-resource-id": "integration_mapping_slack", "x-box-tag": "integration_mappings" }, "IntegrationMappingBase": { "description": "統合マッピングオブジェクトのBase版の表示。", "type": "object", "properties": { "id": { "description": "フォルダマッピングの一意の識別子 (`integration_type`とともに複合キーの一部)。", "type": "string", "example": "12345" }, "type": { "description": "マッピングタイプ。", "type": "string", "example": "integration_mapping", "enum": [ "integration_mapping" ] } }, "required": [ "id", "type" ], "title": "統合マッピング" }, "IntegrationMappingBoxItemSlack": { "description": "Slackタイプの統合マッピングのBox項目オブジェクトのスキーマ。", "type": "object", "properties": { "type": { "description": "`id`で参照されるマッピングされた項目のタイプ。", "type": "string", "example": "folder", "enum": [ "folder" ], "nullable": false }, "id": { "description": "(`type`で参照されるタイプの) マッピングされた項目のID。", "type": "string", "example": "1234567891", "nullable": false } }, "required": [ "id", "type" ], "title": "Slackタイプの統合マッピングのBox項目スキーマ" }, "IntegrationMappingPartnerItemSlack": { "description": "Slackタイプの統合マッピングのマッピングされた項目オブジェクトのスキーマ。\n\nBox for Slackがオーガナイゼーションレベルとワークスペースレベルのどちらでインストールされているかに応じて、`slack_org_id`**または**`slack_workspace_id`の**いずれか**を指定します。両方のパラメータを同時に使用しないでください。", "type": "object", "properties": { "type": { "description": "`id`で参照されるマッピングされた項目のタイプ。", "type": "string", "example": "channel", "enum": [ "channel" ], "nullable": false }, "id": { "description": "(`type`で参照されるタイプの) マッピングされた項目のID。", "type": "string", "example": "C12378991223", "nullable": false }, "slack_workspace_id": { "description": "項目が関連付けられているSlackワークスペースのID。このパラメータは、ワークスペースレベルでBox for Slackがインストールされている場合に使用します。`slack_org_id`を同時に使用しないでください。", "type": "string", "example": "T12352314", "nullable": true }, "slack_org_id": { "description": "項目が関連付けられているSlackオーガナイゼーションのID。このパラメータは、オーガナイゼーションレベルでBox for Slackがインストールされている場合に使用します。`slack_workspace_id`を同時に使用しないでください。", "type": "string", "example": "E1234567", "nullable": true } }, "required": [ "id", "type" ], "title": "Slackタイプの統合マッピングのマッピングされた項目スキーマ" }, "IntegrationMappingPartnerItemTeams": { "description": "Teamsタイプの統合マッピングのマッピングされた項目オブジェクトのスキーマ。", "type": "object", "properties": { "type": { "description": "`id`で参照されるマッピングされた項目のタイプ。", "type": "string", "example": "channel", "enum": [ "channel", "team" ] }, "id": { "description": "(`type`で参照されるタイプの) マッピングされた項目のID。", "type": "string", "example": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2" }, "tenant_id": { "description": "Microsoft Teamsに登録されているテナントのID。", "type": "string", "example": "abcd-defg-1235-7890" } }, "required": [ "id", "type", "tenant_id" ], "title": "Teamsタイプの統合マッピングのマッピングされた項目スキーマ" }, "IntegrationMappingPartnerItemTeamsCreateRequest": { "description": "Teamsタイプの統合マッピングのマッピングされた項目オブジェクトのスキーマ。", "type": "object", "properties": { "type": { "description": "`id`で参照されるマッピングされた項目のタイプ。", "type": "string", "example": "channel", "enum": [ "channel", "team" ] }, "id": { "description": "(`type`で参照されるタイプの) マッピングされた項目のID。", "type": "string", "example": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2" }, "tenant_id": { "description": "Microsoft Teamsに登録されているテナントのID。", "type": "string", "example": "abcd-defg-1235-7890" }, "team_id": { "description": "Microsoft Teamsに登録されているチームのID。", "type": "string", "example": "hjgjgjg-bhhj-564a-b643-hghgj685u" } }, "required": [ "id", "type", "tenant_id", "team_id" ], "title": "Teamsタイプの統合マッピングのマッピングされた項目スキーマ" }, "IntegrationMappingSlackCreateRequest": { "description": "Slack統合マッピングオブジェクトを作成するリクエスト。", "type": "object", "properties": { "partner_item": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemSlack" } ] }, "box_item": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingBoxItemSlack" } ] }, "options": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingSlackOptions" } ] } }, "required": [ "partner_item", "box_item" ], "title": "Slack統合マッピングリクエストを作成", "x-box-resource-id": "integration_mapping_slack_create_request" }, "IntegrationMappingSlackOptions": { "description": "Slackタイプの統合マッピングオプションオブジェクトのスキーマ。", "type": "object", "properties": { "is_access_management_disabled": { "description": "基になるBox項目に対するチャンネルメンバーのアクセスを自動で管理する必要があるかどうかを示します。チャンネルのタイプによっては、アクセスがコラボレーションまたは共有リンクの作成により管理されます。", "type": "boolean", "example": true } }, "title": "Slackタイプ用の統合マッピングオプション" }, "IntegrationMappingTeams": { "description": "統合マッピングオブジェクトのMicrosoft Teams固有のレプリゼンテーション。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingBase" }, { "properties": { "integration_type": { "description": "マッピングが関連付けられているBoxパートナーアプリを示します。SlackとTeamsがサポートされています (`id`とともに複合キーの一部)。", "type": "string", "example": "teams", "enum": [ "teams" ] }, "is_overridden_by_manual_mapping": { "description": "マッピングが (自動作成されたのではなく) チーム所有者によってチャネルのUIから手動で設定されているかどうかを示します。", "type": "boolean", "example": true }, "partner_item": { "description": "Teams用にマッピングされた項目オブジェクト。", "example": { "id": "19%3ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2", "type": "channel", "tenant_id": "E1234567", "team_id": "hjgjgjg-bhhj-564a-b643-hghgj685u" }, "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemTeams" } ] }, "box_item": { "allOf": [ { "$ref": "#/components/schemas/FolderReference" }, { "description": "パートナーアプリのドメインのオブジェクト (`partner_item_id`で参照) のマッピング先であるBoxフォルダ。" } ] }, "created_at": { "description": "統合マッピングオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "統合マッピングオブジェクトが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } ], "required": [ "partner_item", "box_item" ], "title": "Teams統合マッピング", "x-box-resource-id": "integration_mapping_teams", "x-box-tag": "integration_mappings", "x-box-variant": "standard" }, "IntegrationMappingTeamsCreateRequest": { "description": "Teams統合マッピングオブジェクトを作成するリクエスト。", "type": "object", "properties": { "partner_item": { "allOf": [ { "$ref": "#/components/schemas/IntegrationMappingPartnerItemTeamsCreateRequest" } ] }, "box_item": { "allOf": [ { "$ref": "#/components/schemas/FolderReference" }, { "description": "パートナーアプリのドメインのオブジェクト (`partner_item_id`で参照) のマッピング先であるBoxフォルダ。" } ] } }, "required": [ "partner_item", "box_item" ], "title": "Teams統合マッピングリクエストを作成", "x-box-resource-id": "integration_mapping_teams_create_request" }, "IntegrationMappings": { "description": "統合マッピングオブジェクトのリスト。", "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 } } }, { "properties": { "entries": { "description": "統合マッピングのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMapping" } } } } ], "title": "Slack統合マッピング (リスト)", "x-box-resource-id": "integration_mappings_slack", "x-box-tag": "integration_mappings" }, "IntegrationMappingsTeams": { "description": "統合マッピングオブジェクトのリスト。", "type": "object", "allOf": [ { "properties": { "entries": { "description": "統合マッピングのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/IntegrationMappingTeams" } } } } ], "title": "Teams統合マッピング (リスト)", "x-box-resource-id": "integration_mappings_teams", "x-box-tag": "integration_mappings" }, "Invite": { "description": "会社へのユーザーの招待。", "type": "object", "properties": { "id": { "description": "この招待の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`invite`になります。", "type": "string", "example": "invite", "enum": [ "invite" ] }, "invited_to": { "description": "Box Enterpriseのレプリゼンテーション。", "type": "object", "properties": { "id": { "description": "この会社の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "name": { "description": "企業の名前。", "type": "string", "example": "Acme Inc." } }, "title": "Enterprise" }, "actionable_by": { "$ref": "#/components/schemas/User--Mini" }, "invited_by": { "$ref": "#/components/schemas/User--Mini" }, "status": { "description": "招待のステータス。", "type": "string", "example": "pending" }, "created_at": { "description": "招待が作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "招待が変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "required": [ "id", "type" ], "title": "Invite", "x-box-resource-id": "invite", "x-box-tag": "invites" }, "Item": { "description": "項目は、ファイル、フォルダ、またはウェブリンクを表します。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File--Full" }, { "$ref": "#/components/schemas/Folder--Mini" }, { "$ref": "#/components/schemas/WebLink" } ], "title": "項目" }, "Items": { "description": "Mini版の表示に含まれるファイル、フォルダ、ウェブリンクのリスト。", "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 } } }, { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "このコレクション内の項目。", "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } ], "title": "Items", "x-box-resource-id": "items", "x-box-tag": "folders" }, "ItemsOffsetPaginated": { "description": "Mini版の表示に含まれるファイル、フォルダ、ウェブリンクのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "このコレクション内の項目。", "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } ], "title": "Items", "x-box-resource-id": "items_offset_paginated", "x-box-tag": "folders" }, "KeywordSkillCard": { "description": "一連のキーワードを含むスキルカード。", "type": "object", "properties": { "created_at": { "description": "このカードの作成日時 (省略可)。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00" }, "type": { "description": "値は常に`skill_card`になります。", "type": "string", "example": "skill_card", "enum": [ "skill_card" ] }, "skill_card_type": { "description": "値は常に`keyword`になります。", "type": "string", "example": "keyword", "enum": [ "keyword" ] }, "skill_card_title": { "description": "カードのタイトル。", "type": "object", "properties": { "code": { "description": "タイトルの識別子 (省略可)。", "type": "string", "example": "labels" }, "message": { "description": "UI上で表示する実際のタイトル。", "type": "string", "example": "Labels" } }, "required": [ "message" ] }, "skill": { "description": "このメタデータを適用したサービス。", "type": "object", "properties": { "type": { "description": "値は常に`service`になります。", "type": "string", "example": "service", "enum": [ "service" ] }, "id": { "description": "このメタデータを適用したサービスを表すカスタム識別子。", "type": "string", "example": "image-recognition-service" } }, "required": [ "type", "id" ] }, "invocation": { "description": "このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。", "type": "object", "properties": { "type": { "description": "値は常に`skill_invocation`になります。", "type": "string", "example": "skill_invocation", "enum": [ "skill_invocation" ] }, "id": { "description": "このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。", "type": "string", "example": "image-recognition-service-123" } }, "required": [ "type", "id" ] }, "entries": { "description": "メタデータカード内のエントリのリスト。", "type": "array", "items": { "type": "object", "description": "メタデータカードの`entries`属性のエントリ。", "properties": { "text": { "description": "キーワードのテキスト。", "type": "string", "example": "keyword1" } } } } }, "required": [ "type", "skill_card_type", "skill", "invocation", "entries" ], "title": "キーワードスキルカード", "x-box-resource-id": "keyword_skill_card", "x-box-tag": "skills" }, "LegalHoldPolicies": { "description": "リーガルホールドポリシーのリスト。", "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/LegalHoldPolicy" } } } } ], "title": "リーガルホールドポリシー", "x-box-resource-id": "legal_hold_policies", "x-box-tag": "legal_hold_policies" }, "LegalHoldPolicy": { "description": "リーガルホールドポリシー情報には、名前、説明、フィルタ日付など、ポリシーの基本的な特性が記載されています。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LegalHoldPolicy--Mini" }, { "properties": { "policy_name": { "description": "リーガルホールドポリシーの名前。", "type": "string", "example": "Policy 4", "maxLength": 254 }, "description": { "description": "リーガルホールドポリシーの説明。これは省略可能なプロパティで、最大500文字まで入力できます。", "type": "string", "example": "Postman created policy", "maxLength": 500 }, "status": { "description": "使用可能な値:\n\n* 「active」 - ポリシーは遷移中の状態ではありません。\n* 「applying」 - ポリシーの適用中です。\n* 「releasing」 - 解除処理を行っています。\n* 「released」 - ポリシーは非アクティブになりました。", "type": "string", "example": "active", "enum": [ "active", "applying", "releasing", "released" ] }, "assignment_counts": { "description": "このリーガルホールド内の項目タイプごとの割り当て数。", "type": "object", "properties": { "user": { "description": "このポリシーが適用されるユーザーの数。", "type": "integer", "format": "int64", "example": 1 }, "folder": { "description": "このポリシーが適用されるフォルダの数。", "type": "integer", "format": "int64", "example": 2 }, "file": { "description": "このポリシーが適用されるファイルの数。", "type": "integer", "format": "int64", "example": 3 }, "file_version": { "description": "このポリシーが適用されるファイルバージョンの数。", "type": "integer", "format": "int64", "example": 4 } } }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "リーガルホールドポリシーオブジェクトを作成したユーザー。" } ] }, "created_at": { "description": "リーガルホールドポリシーオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "リーガルホールドポリシーオブジェクトが変更された日時。割り当てが追加または削除されたときには更新されません。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "deleted_at": { "description": "ポリシー解除リクエストが送信された日時 (ポリシーが完全に削除されるまでに時間がかかる場合があるため、この日時はポリシーが完全に削除された日時と一致しない場合があります)。\n\n`null`の場合、ポリシーは削除されていません。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "filter_started_at": { "description": "カストディアン割り当てのみに適用されるユーザー指定の日付フィルタ (省略可)。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "filter_ended_at": { "description": "カストディアン割り当てのみに適用されるユーザー指定の日付フィルタ (省略可)。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "release_notes": { "description": "ポリシーが作成された理由に関するメモ (省略可)。", "type": "string", "example": "Example", "maxLength": 500 } } } ], "title": "リーガルホールドポリシー", "x-box-resource-id": "legal_hold_policy", "x-box-variant": "standard" }, "LegalHoldPolicy--Mini": { "description": "Mini版のリーガルホールドポリシー。", "type": "object", "properties": { "id": { "description": "このリーガルホールドポリシーの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`legal_hold_policy`になります。", "type": "string", "example": "legal_hold_policy", "enum": [ "legal_hold_policy" ] } }, "required": [ "id", "type" ], "title": "リーガルホールドポリシー (Mini)", "x-box-resource-id": "legal_hold_policy--mini", "x-box-tag": "legal_hold_policies", "x-box-variant": "mini", "x-box-variants": [ "mini", "standard" ] }, "LegalHoldPolicyAssignedItem": { "description": "リーガルホールドポリシーが割り当てられている項目。タイプとIDを含みます。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File" }, { "$ref": "#/components/schemas/Folder" }, { "$ref": "#/components/schemas/WebLink" } ], "title": "リーガルホールドポリシーの項目" }, "LegalHoldPolicyAssignment": { "description": "リーガルホールド割り当ては、ユーザー、フォルダ、ファイル、またはファイルバージョンにリーガルホールドポリシーを割り当てる目的に使用されます。\n\nリーガルホールド割り当てを作成すると、その割り当ての「apply-to」エンティティに属するファイルバージョンにホールドが適用されます。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/LegalHoldPolicyAssignment--Base" }, { "properties": { "legal_hold_policy": { "allOf": [ { "$ref": "#/components/schemas/LegalHoldPolicy--Mini" }, { "description": "そのリーガルホールドポリシー割り当てを含むポリシー。" } ] }, "assigned_to": { "allOf": [ { "$ref": "#/components/schemas/LegalHoldPolicyAssignedItem" }, { "description": "リーガルホールドポリシーが割り当てられている項目。タイプとIDを含みます。" } ] }, "assigned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "リーガルホールドポリシー割り当てを作成したユーザー。" } ] }, "assigned_at": { "description": "リーガルホールドポリシー割り当てオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "deleted_at": { "description": "割り当て解除リクエストが送信された日時 (割り当てが完全に削除されるまでに時間がかかる場合があるため、この日時は割り当てが完全に削除された日時と一致しない場合があります)。nullの場合、割り当ては削除されていません。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } ], "title": "リーガルホールドポリシー割り当て", "x-box-resource-id": "legal_hold_policy_assignment", "x-box-tag": "legal_hold_policy_assignments" }, "LegalHoldPolicyAssignment--Base": { "description": "リーガルホールド割り当ては、ユーザー、フォルダ、ファイル、またはファイルバージョンにリーガルホールドポリシーを割り当てる目的に使用されます。\n\nリーガルホールド割り当てを作成すると、その割り当ての「apply-to」エンティティに属するファイルバージョンにホールドが適用されます。", "type": "object", "properties": { "id": { "description": "このリーガルホールド割り当ての一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`legal_hold_policy_assignment`になります。", "type": "string", "example": "legal_hold_policy_assignment", "enum": [ "legal_hold_policy_assignment" ] } }, "title": "リーガルホールドポリシー割り当て (Base)", "x-box-resource-id": "legal_hold_policy_assignment--base", "x-box-tag": "legal_hold_policy_assignments", "x-box-variant": "base", "x-box-variants": [ "base", "standard" ] }, "LegalHoldPolicyAssignments": { "description": "リーガルホールドポリシー割り当てのリスト。", "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/LegalHoldPolicyAssignment" } } } } ], "title": "リーガルホールドポリシー割り当て", "x-box-resource-id": "legal_hold_policy_assignments", "x-box-tag": "legal_hold_policy_assignments" }, "Metadata": { "description": "ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata--Base" } ], "title": "メタデータインスタンス", "x-box-resource-id": "metadata", "x-box-tag": "file_metadata", "x-box-variant": "standard" }, "Metadata--Base": { "description": "メタデータインスタンスのBase版の表示。", "type": "object", "properties": { "$parent": { "description": "このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。", "type": "string", "example": "folder_59449484661," }, "$template": { "description": "テンプレートの名前。", "type": "string", "example": "marketingCollateral" }, "$scope": { "description": "このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合は`enterprise_{enterprise_id}`、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合は`global`になります。", "type": "string", "example": "enterprise_27335" }, "$version": { "description": "メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。", "type": "integer", "example": 1 } }, "title": "メタデータインスタンス (Base)", "x-box-resource-id": "metadata--base", "x-box-tag": "file_metadata", "x-box-variant": "base", "x-box-variants": [ "base", "standard", "full" ] }, "Metadata--Full": { "description": "ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Metadata" }, { "properties": { "$canEdit": { "description": "このメタデータインスタンスをユーザーが編集できるかどうか。", "type": "boolean", "example": true }, "$id": { "description": "メタデータインスタンスを識別するためのUUID。", "type": "string", "format": "uuid", "example": "01234500-12f1-1234-aa12-b1d234cb567e", "maxLength": 36 }, "$type": { "description": "このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。", "type": "string", "example": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0" }, "$typeVersion": { "description": "オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。", "type": "integer", "example": 2 } } }, { "additionalProperties": { "allOf": [ {}, { "example": "Aaron Levie" }, { "description": "メタデータテンプレートに存在する各フィールドの値。`global.properties`テンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。" } ], "x-box-example-key": "name" } } ], "title": "メタデータインスタンス (Full)", "x-box-resource-id": "metadata--full", "x-box-variant": "full" }, "MetadataCascadePolicies": { "description": "メタデータカスケードポリシーのリスト。", "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/MetadataCascadePolicy" } } } } ], "title": "メタデータカスケードポリシー", "x-box-resource-id": "metadata_cascade_policies", "x-box-tag": "metadata_cascade_policies" }, "MetadataCascadePolicy": { "description": "メタデータカスケードポリシーにより、メタデータテンプレートインスタンスが自動的にターゲットフォルダ内のすべてのファイルとフォルダに適用されます。", "type": "object", "properties": { "id": { "description": "メタデータカスケードポリシーオブジェクトのID。", "type": "string", "example": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7" }, "type": { "description": "値は常に`metadata_cascade_policy`になります。", "type": "string", "example": "metadata_cascade_policy", "enum": [ "metadata_cascade_policy" ] }, "owner_enterprise": { "description": "このポリシーを所有する会社。", "type": "object", "properties": { "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "id": { "description": "ポリシーを所有する会社のID。", "type": "string", "example": "690678" } } }, "parent": { "description": "ポリシーが適用されるフォルダを表します。", "type": "object", "properties": { "type": { "description": "値は常に`folder`になります。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "ポリシーが適用されるフォルダのID。", "type": "string", "example": "1234567" } } }, "scope": { "description": "メタデータカスケードポリシーのスコープは、`global`または`enterprise_*`のいずれかになります。`global`スコープは、任意のBox Enterpriseで利用できるポリシーに使用されます。`enterprise_*`スコープは、特定のEnterprise内で作成されたポリシーを表します (`*`はそのEnterpriseのID)。", "type": "string", "example": "enterprise_123456" }, "templateKey": { "description": "フォルダの子にカスケードされるテンプレートのキー。\n\n多くの場合、テンプレートキーはその表示名から自動的に派生します。たとえば、`Contract Template`の場合は`contractTemplate`となります。場合によっては、テンプレートの作成者が独自のテンプレートキーを指定することもあります。\n\nテンプレートのキーを調べるには、[会社のテンプレートのリストを取得する][list]か、[ファイル][file]または[フォルダ][folder]上のすべてのインスタンスを取得してください。\n\n[list]: e://get-metadata-templates-enterprise\n\n[file]: e://get-files-id-metadata\n\n[folder]: e://get-folders-id-metadata", "type": "string", "example": "productInfo" } }, "required": [ "id", "type" ], "title": "メタデータカスケードポリシー", "x-box-resource-id": "metadata_cascade_policy", "x-box-tag": "metadata_cascade_policies" }, "MetadataError": { "description": "一般的なメタデータ操作エラー。", "type": "object", "properties": { "code": { "description": "Box固有のエラーコード。", "type": "string", "example": "bad_request" }, "message": { "description": "エラーについての短い説明メッセージ。", "type": "string", "example": "Encountered invalid value for template field key=someKey field type=properties", "nullable": false }, "request_id": { "description": "Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。", "type": "string", "example": "abcdef123456", "nullable": false } }, "title": "メタデータエラー", "x-box-resource-id": "metadata_error" }, "MetadataFieldFilterDateRange": { "description": "検索結果のフィルタに使用するテンプレートの`date`フィールドを指定して、照合する日付の範囲を指定します。", "type": "object", "properties": { "lt": { "description": "メタデータフィールド値の上限 (その値を含む) を指定します。検索クエリがこのテンプレートに一致するには、フィールドの値をこの値より小さくする (`lt`) かこの値と等しくする必要があります。", "type": "string", "format": "date-time", "example": "2017-08-01T00:00:00Z" }, "gt": { "description": "メタデータフィールド値の下限 (その値を含む) を指定します。検索クエリがこのテンプレートに一致するには、フィールドの値をこの値より大きくする (`gt`) かこの値と等しくする必要があります。", "type": "string", "format": "date-time", "example": "2016-08-01T00:00:00Z" } }, "title": "メタデータフィールドのフィルタ (日付範囲)", "x-box-resource-id": "metadata_field_filter_date_range" }, "MetadataFieldFilterFloatRange": { "description": "検索結果のフィルタに使用するテンプレートの`float`フィールドを指定して、照合する値の範囲を指定します。", "type": "object", "properties": { "lt": { "description": "メタデータフィールド値の上限 (その値を含む) を指定します。検索クエリがこのテンプレートに一致するには、フィールドの値をこの値より小さくする (`lt`) かこの値と等しくする必要があります。", "type": "number", "example": 200000 }, "gt": { "description": "メタデータフィールド値の下限 (その値を含む) を指定します。検索クエリがこのテンプレートに一致するには、フィールドの値をこの値より大きくする (`gt`) かこの値と等しくする必要があります。", "type": "number", "example": 100000 } }, "title": "メタデータフィールドのフィルタ (浮動小数点の範囲)", "x-box-resource-id": "metadata_field_filter_float_range" }, "MetadataFilter": { "description": "検索結果のフィルタに使用されたメタデータテンプレート。", "type": "object", "properties": { "scope": { "description": "検索結果のフィルタに使用する、テンプレートのスコープを指定します。\n\nこれは、この会社で使用するために定義されたテンプレートの場合は`enterprise_{enterprise_id}`、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合は`global`になります。", "type": "string", "example": "enterprise", "enum": [ "global", "enterprise", "enterprise_{enterprise_id}" ] }, "templateKey": { "description": "検索結果のフィルタに使用されたテンプレートのキー。\n\n多くの場合、テンプレートキーはその表示名から自動的に派生します。たとえば、`Contract Template`の場合は`contractTemplate`となります。場合によっては、テンプレートの作成者が独自のテンプレートキーを指定することもあります。\n\nテンプレートのキーを調べるには、[会社のテンプレートのリストを取得する][list]か、[ファイル][file]または[フォルダ][folder]上のすべてのインスタンスを取得してください。\n\n[list]: e://get-metadata-templates-enterprise\n\n[file]: e://get-files-id-metadata\n\n[folder]: e://get-folders-id-metadata", "type": "string", "example": "contract" }, "filters": { "description": "検索結果のフィルタに使用するテンプレートのフィールドを指定します。複数のフィールドを指定すると、クエリでは論理`AND`が実行され、指定された各フィールドに一致するテンプレートのインスタンスが取得されます。", "type": "object", "example": { "category": "online" }, "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/MetadataFilterValue" }, { "example": "online" }, { "x-box-example-key": "category" } ] } } }, "title": "メタデータフィルタ", "x-box-resource-id": "metadata_filter", "x-box-tag": "search" }, "MetadataFilterValue": { "description": "メタデータフィルタの値。", "oneOf": [ { "type": "string" }, { "type": "number" }, { "title": "Metadata field filter (multi-select)", "type": "array", "items": { "type": "string" }, "description": "Specifies the values to match for a `multiSelect` metadata\nfield. When performing a search, the query will essentially\nperform an `OR` operation to match any template where any of\nthe provided values match this field.", "example": [ "online", "enterprise" ] }, { "$ref": "#/components/schemas/MetadataFieldFilterFloatRange" }, { "$ref": "#/components/schemas/MetadataFieldFilterDateRange" } ], "title": "メタデータフィルタ値" }, "MetadataInstanceValue": { "description": "設定またはテストする値。\n\n`add`、`replace`、`test`操作では必須です。`add`の場合、値がすでに存在するときは、古い値が新しい値で上書きされます。`replace`の場合、置換の前に値がすでに存在している必要があります。\n\n`test`の場合、`path`の位置にある既存の値が指定した値と一致している必要があります。", "example": "reviewed", "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number", "format": "float" }, { "type": "array", "items": { "type": "string" } } ], "title": "メタデータインスタンス値" }, "MetadataQuery": { "description": "SQLに似た構文で特定のメタデータと一致する項目を返す検索を作成します。", "type": "object", "properties": { "from": { "description": "クエリで使用されるテンプレートを指定します。`scope.templateKey`形式にする必要があります。このフィールドですべてのテンプレートを使用できるとは限りません。最も注目すべきは、Boxが提供する組み込みの分類テンプレートはクエリで使用できないことです。", "type": "string", "example": "enterprise_123456.someTemplate" }, "query": { "description": "実行するクエリ。クエリは、SQLの`SELECT`ステートメントによく似た論理式です。検索クエリの値は、`query_param`引数リストで指定されたパラメータに変換できるため、クエリ文字列に検索値を手動で挿入する必要がなくなります。\n\nたとえば、`:amount`という値は、`query_params`オブジェクトの`amount`値を表します。", "type": "string", "example": "value >= :amount" }, "query_params": { "description": "`query`で指定されたパラメータに対応する引数のセット。`query_params`で使用されている各パラメータのタイプは、対応するメタデータテンプレートフィールドのタイプと一致する必要があります。", "type": "object", "example": { "amount": "100" }, "additionalProperties": { "allOf": [ {}, { "description": "メタデータ検索で使用されている引数の値。\n\nこのパラメータのタイプは、対応するメタデータテンプレートフィールドのタイプと一致する必要があります。" }, { "example": "100" } ], "x-box-example-key": "amount" } }, "ancestor_folder_id": { "description": "クエリを制限しているフォルダのID。値が0の場合は、アクセスできるすべてのフォルダから結果が返されます。値が0以外の場合は、IDに対応するフォルダまたはそのサブフォルダで見つかった結果のみが返されます。", "type": "string", "example": "0" }, "order_by": { "description": "メタデータクエリの結果の並べ替えに使用するテンプレートフィールドと方向のリスト。\n\n並べ替えの`direction`は、配列内の各項目で同じにする必要があります。", "type": "array", "items": { "type": "object", "description": "メタデータクエリの結果の並べ替えに使用するメタデータテンプレートフィールドのいずれかを表すオブジェクト。", "properties": { "field_key": { "description": "並べ替えに使用するメタデータテンプレートフィールド。\n\n`field_key`は、検索対象のメタデータテンプレートのフィールドの`key`値を表します。", "type": "string", "example": "amount" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。\n\n`ordering`の方向は、配列内の各項目で同じにする必要があります。", "type": "string", "example": "asc", "enum": [ "ASC", "DESC", "asc", "desc" ] } } } }, "limit": { "description": "単一のリクエストに対して返す結果の最大数を示す0～100の値。これは、上限を示すだけで、返される結果の最小数を保証しません。", "type": "integer", "example": 50, "default": 100, "maximum": 100, "minimum": 0 }, "marker": { "description": "次ページをリクエストするために使用するマーカー。", "type": "string", "example": "AAAAAmVYB1FWec8GH6yWu2nwmanfMh07IyYInaa7DZDYjgO1H4KoLW29vPlLY173OKsci6h6xGh61gG73gnaxoS+o0BbI1/h6le6cikjlupVhASwJ2Cj0tOD9wlnrUMHHw3/ISf+uuACzrOMhN6d5fYrbidPzS6MdhJOejuYlvsg4tcBYzjauP3+VU51p77HFAIuObnJT0ff" }, "fields": { "description": "デフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。この属性を使用すると、任意の項目に対して返す追加の属性 (メタデータなど) のリストを指定できます。\n\nこの属性は、項目フィールド、メタデータテンプレート識別子、またはメタデータテンプレートフィールド識別子のリストを取得します。\n\n例:\n\n* `created_by`では、項目を作成したユーザーの詳細がレスポンスに追加されます。\n* `metadata..`では、`scope`と`templateKey`によって識別されたメタデータインスタンスのMini版の表示が返されます。\n* `metadata...`では、`scope`と`templateKey`によって識別されたメタデータインスタンスのMini版の表示に加え、`field`名で指定されたフィールドがすべて返されます。同じ`scope`および`templateKey`の複数のフィールドを定義できます。", "type": "array", "items": { "type": "string" }, "example": [ "extension", "created_at", "item_status", "metadata.enterprise_1234.contracts", "metadata.enterprise_1234.regions.location" ] } }, "required": [ "from", "ancestor_folder_id" ], "title": "メタデータクエリの検索リクエスト" }, "MetadataQueryResultItem": { "description": "ファイルまたはフォルダのMini版の表示。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File--Full" }, { "$ref": "#/components/schemas/Folder--Full" } ], "title": "メタデータクエリの検索結果項目" }, "MetadataQueryResults": { "description": "メタデータクエリと一致したファイルおよびフォルダのページ。", "type": "object", "properties": { "entries": { "description": "検索語句と一致するファイルやフォルダのMini版の表示。\n\nデフォルトでは、このエンドポイントによって、項目に関する最も基本的な情報のみが返されます。各項目のその他のフィールド (メタデータのいずれかを含む) を取得するには、クエリで`fields`属性を使用します。", "type": "array", "items": { "$ref": "#/components/schemas/MetadataQueryResultItem" }, "x-box-resource-variant": 1 }, "limit": { "description": "この検索で使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。", "type": "integer", "format": "int64", "example": 100, "default": 100 }, "next_marker": { "description": "次の検索結果ページの開始場所のマーカー。", "type": "string", "example": "0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5BsXEl1bCVLRZ2pTqo4SKp9tyqzWQK2L51KR_nC1EgF5I_TJSFw7uO2Bx4HweGETOjh5_2oPSWw5iMkM-OvGApeR0lGFO48FDKoyzJyLgz5aogxoKd8VE09CesOOnTnmZvrW0puylDc-hFjY5YLmWFBKox3SOWiSDwKFkmZGNHyjEzza1nSwbZg6CYsAdGsDwGJhuCeTNsFzP5Mo5qx9wMloS0lSPuf2CcBInbIJzl2CKlXF3FvqhANttpm2nzdBTQRSoJyJnjVBpf4Q_HjV2eb4KIZBBlLy067UCVdv2AAWQFd5E2i6s1YiGRTtgMEZntOSUYD4IYLMWWm5Ra7ke_SP32SL3GSjbBQYIyCVQ.." } }, "title": "メタデータクエリの検索結果", "x-box-resource-id": "metadata_query_results", "x-box-tag": "search" }, "MetadataTemplate": { "description": "ファイルやフォルダに適用可能なメタデータのテンプレート。", "type": "object", "properties": { "id": { "description": "メタデータテンプレートのID。", "type": "string", "example": "58063d82-4128-7b43-bba9-92f706befcdf" }, "type": { "description": "値は常に`metadata_template`になります。", "type": "string", "example": "metadata_template", "enum": [ "metadata_template" ], "nullable": false }, "scope": { "description": "メタデータテンプレートのスコープは、`global`または`enterprise_*`のいずれかになります。`global`スコープは、Boxを使用するすべての会社が利用できるテンプレートに使用されます。`enterprise_*`スコープは、特定の会社内で作成されたテンプレートを表します (`*`はその会社のID)。", "type": "string", "example": "enterprise_123456" }, "templateKey": { "description": "テンプレートの一意の識別子。この識別子は、メタデータテンプレートが適用される会社の`scope`全体で一意ですが、会社を越えて一意であるとは限りません。", "type": "string", "example": "productInfo", "maxLength": 64, "pattern": "^[a-zA-Z_][-a-zA-Z0-9_]*$" }, "displayName": { "description": "テンプレートの表示名。Boxウェブアプリとモバイルアプリに表示されます。", "type": "string", "example": "Product Info", "maxLength": 4096 }, "hidden": { "description": "このテンプレートをBoxウェブアプリのUIに表示するか、APIを介した使用のみを目的とするかを定義します。", "type": "boolean", "example": true }, "fields": { "description": "テンプレートに含まれるテンプレートフィールドの順序付きリスト。各フィールドは、通常のテキストフィールド、日付フィールド、数値フィールド、単一または複数選択リストのいずれかになります。", "type": "array", "items": { "type": "object", "description": "メタデータテンプレート内のフィールド。フィールドは、基本テキスト、日付、または数値フィールドか、オプションのリストのいずれかになります。", "allOf": [ { "title": "メタデータフィールド (読み取り)", "description": "メタデータテンプレート内のフィールド。フィールドは、基本テキスト、日付、または数値フィールドか、オプションのリストのいずれかになります。", "required": [ "type", "key", "displayName" ], "type": "object", "properties": { "type": { "description": "フィールドのタイプ。基本のフィールドは、テキストを表す`string`フィールド、数値を表す`float`フィールド、およびユーザーに日時選択機能を表示するための`date`フィールドです。\n\nさらに、メタデータテンプレートは、基本の項目リストを表す`enum`フィールドのほか、ユーザーが複数の値を選択できる同様の項目リストを表す` multiSelect`フィールドをサポートしています。\n\n**注**: `integer`値は非推奨です。レスポンスにはまだ存在していても、POSTリクエストでは使用できません。", "type": "string", "example": "string", "enum": [ "string", "float", "date", "enum", "multiSelect", "integer" ] }, "key": { "description": "フィールドの一意の識別子。この識別子は、そのフィールドが属するテンプレート内で一意である必要があります。", "type": "string", "example": "category", "maxLength": 256 }, "displayName": { "description": "ウェブアプリおよびモバイルアプリでユーザーに表示されるフィールドの表示名。", "type": "string", "example": "Category", "maxLength": 4096 }, "description": { "description": "フィールドの説明。ユーザーには表示されません。", "type": "string", "example": "The category", "maxLength": 4096 }, "hidden": { "description": "このフィールドをUI上でユーザーに対して非表示にし、代わりにAPIを介してのみ設定できるようにするかどうか。", "type": "boolean", "example": true }, "options": { "description": "このフィールドのオプションのリスト。`enum`および`multiSelect`フィールドタイプと組み合わせて使用します。", "type": "array", "items": { "title": "メタデータオプション (書き込み)", "type": "object", "description": "メタデータテンプレートフィールドのオプション。\n\nオプションは、`enum`タイプおよび`multiSelect`タイプのフィールドのみに指定する必要があります。オプションは、ユーザーがUIまたはAPIを介してそのフィールドに選択できる値を表します。", "required": [ "key" ], "properties": { "key": { "description": "オプションのテキスト値。オプションの表示名と、テンプレートの更新時に使用される内部キーの両方を表します。", "type": "string", "example": "Category 1" } } } } } }, { "properties": { "id": { "description": "メタデータテンプレートフィールドの一意のID。", "type": "string", "example": "822227e0-47a5-921b-88a8-494760b2e6d2" }, "options": { "description": "このフィールドのオプションのリスト。`enum`および`multiSelect`フィールドタイプと組み合わせて使用します。", "type": "array", "items": { "type": "object", "description": "メタデータテンプレートフィールドのオプション。\n\nオプションは、`enum`タイプおよび`multiSelect`タイプのフィールドにのみ存在します。オプションは、ユーザーがUIまたはAPIを介してそのフィールドに選択できる値を表します。", "allOf": [ { "title": "メタデータオプション (書き込み)", "type": "object", "description": "メタデータテンプレートフィールドのオプション。\n\nオプションは、`enum`タイプおよび`multiSelect`タイプのフィールドのみに指定する必要があります。オプションは、ユーザーがUIまたはAPIを介してそのフィールドに選択できる値を表します。", "required": [ "key" ], "properties": { "key": { "description": "オプションのテキスト値。オプションの表示名と、テンプレートの更新時に使用される内部キーの両方を表します。", "type": "string", "example": "Category 1" } } }, { "properties": { "id": { "description": "オプションの内部的な一意の識別子。", "type": "string", "example": "45dc2849-a4a7-40a9-a751-4a699a589190" } } } ] } } } } ] } }, "copyInstanceOnItemCopy": { "description": "ファイルまたはフォルダのコピー時にメタデータを含めるかどうか。", "type": "boolean", "example": true } }, "required": [ "type", "id" ], "title": "メタデータテンプレート", "x-box-resource-id": "metadata_template", "x-box-tag": "metadata_templates" }, "MetadataTemplates": { "description": "メタデータテンプレートのリスト。", "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/MetadataTemplate" } } } } ], "title": "メタデータテンプレート", "x-box-resource-id": "metadata_templates", "x-box-tag": "metadata_templates" }, "Metadatas": { "description": "ファイルまたはフォルダに適用されているメタデータインスタンスのリスト。", "type": "object", "properties": { "entries": { "description": "このファイルまたはフォルダに適用されるメタデータインスタンスのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Metadata" } }, "limit": { "description": "結果の現在のページに使用された制限。", "type": "integer", "example": 100 } }, "title": "メタデータインスタンス", "x-box-resource-id": "metadatas", "x-box-tag": "file_metadata" }, "OAuth2Error": { "description": "OAuth 2.0エラー。", "type": "object", "properties": { "error": { "description": "返されるエラーのタイプ。", "type": "string", "example": "invalid_client" }, "error_description": { "description": "返されるエラーのタイプ。", "type": "string", "example": "The client credentials are not valid" } }, "title": "OAuth 2.0エラー", "x-box-resource-id": "oauth2_error", "x-box-tag": "authorization" }, "Outcome": { "description": "結果のインスタンス。", "type": "object", "properties": { "id": { "description": "特定の結果のID。", "type": "string", "example": "17363629" }, "collaborators": { "allOf": [ { "$ref": "#/components/schemas/CollaboratorVariable" }, { "description": "ワークフローの結果の影響を受けたコラボレータのリストを取得します。" } ] }, "completion_rule": { "allOf": [ { "$ref": "#/components/schemas/CompletionRuleVariable" }, { "description": "操作をすべての担当者が完了する必要があるか、一人でも完了すればよいかを決定します。" } ] }, "file_collaborator_role": { "allOf": [ { "$ref": "#/components/schemas/RoleVariable" }, { "description": "特定のコラボレータの役割がファイルに関するワークフローの結果の影響を受けるかどうかを決定します。" } ] }, "task_collaborators": { "allOf": [ { "$ref": "#/components/schemas/CollaboratorVariable" }, { "description": "タスクのワークフローの結果の影響を受けたコラボレータのリストを取得します。" } ] }, "role": { "allOf": [ { "$ref": "#/components/schemas/RoleVariable" }, { "description": "特定のコラボレータの役割がワークフローの結果の影響を受けるかどうかを決定します。" } ] } }, "required": [ "id" ], "title": "結果" }, "PostOAuth2Revoke": { "description": "OAuth 2.0トークンを取り消すリクエスト。", "type": "object", "properties": { "client_id": { "description": "アクセストークンの無効化をリクエストしているアプリケーションのクライアントID。", "type": "string", "example": "ly1nj6n11vionaie65emwzk575hnnmrk" }, "client_secret": { "description": "アクセストークンの無効化をリクエストしているアプリケーションのクライアントシークレット。", "type": "string", "example": "hOzsTeFlT6ko0dme22uGbQal04SBPYc1" }, "token": { "description": "無効にするアクセストークン。", "type": "string", "format": "token", "example": "n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW" } }, "required": [ "grant_type" ], "title": "トークン無効化リクエスト" }, "PostOAuth2Token": { "description": "新しいOAuth 2.0トークンのリクエスト。", "type": "object", "properties": { "grant_type": { "description": "クライアント側で取得される承認コード、更新トークン、JWTアサーション、クライアント資格情報許可、またはトークンのダウンスコープを目的とするその他のアクセストークンを使用して行われているリクエストのタイプ。", "type": "string", "format": "urn", "example": "authorization_code", "enum": [ "authorization_code", "refresh_token", "client_credentials", "urn:ietf:params:oauth:grant-type:jwt-bearer", "urn:ietf:params:oauth:grant-type:token-exchange" ] }, "client_id": { "description": "アクセストークンをリクエストしているアプリケーションのクライアントID。\n\n`grant_type`に`authorization_code`、`client_credentials`、または`urn:ietf:params:oauth:grant-type:jwt-bearer`が指定されている場合に組み合わせて使用されます。", "type": "string", "example": "ly1nj6n11vionaie65emwzk575hnnmrk" }, "client_secret": { "description": "アクセストークンをリクエストしているアプリケーションのクライアントシークレット。\n\n`grant_type`に`authorization_code`、`client_credentials`、または`urn:ietf:params:oauth:grant-type:jwt-bearer`が指定されている場合に組み合わせて使用されます。", "type": "string", "example": "hOzsTeFlT6ko0dme22uGbQal04SBPYc1" }, "code": { "description": "ユーザーが自身の代わりにAPIコールを行う権限をアプリケーションに付与した後、ブラウザリダイレクト時にBoxからアプリケーションに渡されるクライアント側承認コード。\n\n`authorization_code`との組み合わせで`grant_type`として使用されます。", "type": "string", "format": "token", "example": "n22JPxrh18m4Y0wIZPIqYZK7VRrsMTWW" }, "refresh_token": { "description": "新しいアクセストークンを入手するために使用される更新トークン。\n\n`refresh_token`との組み合わせで`grant_type`として使用されます。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" }, "assertion": { "description": "新しいアクセストークンをリクエストするJWTアサーション。\n\n`urn:ietf:params:oauth:grant-type:jwt-bearer`との組み合わせで`grant_type`として使用されます。", "type": "string", "format": "jwt", "example": "xxxxx.yyyyy.zzzzz" }, "subject_token": { "description": "ダウンスコープされたトークンと交換するためのトークン。通常のアクセストークン、JWTアサーション、アプリトークンのいずれかを使用できます。\n\n`urn:ietf:params:oauth:grant-type:token-exchange`との組み合わせで`grant_type`として使用されます。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" }, "subject_token_type": { "description": "渡される`subject_token`のタイプ。\n\n`urn:ietf:params:oauth:grant-type:token-exchange`との組み合わせで`grant_type`として使用されます。", "type": "string", "example": "urn:ietf:params:oauth:token-type:access_token", "enum": [ "urn:ietf:params:oauth:token-type:access_token" ] }, "actor_token": { "description": "注釈トークンを作成するためのトークン。これはJWTアサーションです。\n\n`urn:ietf:params:oauth:grant-type:token-exchange`との組み合わせで`grant_type`として使用されます。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" }, "actor_token_type": { "description": "渡される`actor_token`のタイプ。\n\n`urn:ietf:params:oauth:grant-type:token-exchange`との組み合わせで`grant_type`として使用されます。", "type": "string", "format": "urn", "example": "urn:ietf:params:oauth:token-type:id_token", "enum": [ "urn:ietf:params:oauth:token-type:id_token" ] }, "scope": { "description": "新しいアクセストークンに割り当てるスコープのスペース区切りリスト。\n\n`subject_token`は、これらすべてのスコープを持っている必要があります。そうでない場合、この呼び出しを行うと、**401 Unauthorized**エラーになります。", "type": "string", "format": "space_delimited_list", "example": "item_upload item_preview base_explorer" }, "resource": { "description": "トークンを生成するファイルの完全なURL。", "type": "string", "format": "url", "example": "https://api.box.com/2.0/files/123456" }, "box_subject_type": { "description": "`client_credentials`との組み合わせで`grant_type`として使用されます。", "type": "string", "example": "enterprise", "enum": [ "enterprise", "user" ] }, "box_subject_id": { "description": "`grant_type`に`client_credentials`が指定されている場合に組み合わせて使用されます。値は`box_subject_type`によって決まります。`user`の場合はユーザーIDを使用し、`enterprise`の場合はEnterprise IDを使用します。", "type": "string", "example": "123456789" }, "box_shared_link": { "description": "トークンが生成されるファイルまたはフォルダの共有リンクの完全なURL。", "type": "string", "format": "url", "example": "https://cloud.box.com/s/123456" } }, "required": [ "grant_type" ], "title": "トークンリクエスト" }, "PostOAuth2Token--RefreshAccessToken": { "description": "アクセストークンを更新するリクエスト。有効な更新トークンを使用して期限切れのアクセストークンを更新するには、このAPIを使用します。", "type": "object", "properties": { "grant_type": { "description": "行われているリクエストのタイプ (この場合は更新リクエスト)。", "type": "string", "format": "urn", "example": "refresh_token", "enum": [ "refresh_token" ] }, "client_id": { "description": "トークンの更新をリクエストしているアプリケーションのクライアントID。", "type": "string", "example": "ly1nj6n11vionaie65emwzk575hnnmrk" }, "client_secret": { "description": "トークンの更新をリクエストしているアプリケーションのクライアントシークレット。", "type": "string", "example": "hOzsTeFlT6ko0dme22uGbQal04SBPYc1" }, "refresh_token": { "description": "更新する更新トークン。", "type": "string", "format": "token", "example": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ" } }, "required": [ "grant_type", "client_id", "client_secret", "refresh_token" ], "title": "アクセストークンを更新" }, "RealtimeServer": { "description": "Long polling User Eventに使用できるリアルタイムサーバー。", "type": "object", "properties": { "type": { "description": "値は常に`realtime_server`になります。", "type": "string", "example": "realtime_server" }, "url": { "description": "サーバーのURL。", "type": "string", "example": "http://2.realtime.services.box.net/subscribe?channel=cc807c9c4869ffb1c81a&stream_type=all" }, "ttl": { "description": "このサーバーが利用可能な時間 (分)。", "type": "string", "example": "10" }, "max_retries": { "description": "このサーバーが[サーバーの新しいリスト](#options-events)を取得して新しいLong pollingを開始するまでに実行可能な再試行回数の上限。", "type": "string", "example": "10" }, "retry_timeout": { "description": "Long polling接続を再試行するまでのレスポンスがない時間の最大秒数。\n\nこれは、Long pollingが機能しているようではあるものの、パッケージが届かない場合に、ネットワーク関連の問題を解決するのに役立ちます。", "type": "integer", "example": 610 } }, "title": "リアルタイムサーバー", "x-box-resource-id": "realtime_server" }, "RealtimeServers": { "description": "Long pollingに使用できるリアルタイムサーバーのリスト。", "type": "object", "properties": { "chunk_size": { "description": "このレスポンス内の項目の数。", "type": "integer", "format": "int64", "example": 1 }, "entries": { "description": "リアルタイムサーバーのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/RealtimeServer" } } }, "title": "リアルタイムサーバー", "x-box-resource-id": "realtime_servers", "x-box-tag": "events" }, "RecentItem": { "description": "ユーザーが最近アクセスした項目。", "type": "object", "properties": { "type": { "description": "値は常に`recent_item`になります。", "type": "string", "example": "recent_item" }, "item": { "allOf": [ { "$ref": "#/components/schemas/RecentItemResource" }, { "description": "最近アクセスした項目。" } ] }, "interaction_type": { "description": "ユーザーがこの項目に対して最近実行したアクセスのタイプ。", "type": "string", "example": "item_preview", "enum": [ "item_preview", "item_upload", "item_comment", "item_open", "item_modify" ] }, "interacted_at": { "description": "直近のやり取りの日時。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00" }, "interaction_shared_link": { "description": "項目へのアクセスが共有リンクを通じて行われた場合は、その共有リンクがここに入り、そうでない場合はnullになります。", "type": "string", "example": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg" } }, "title": "最近使用した項目", "x-box-resource-id": "recent_item", "x-box-tag": "recent_items" }, "RecentItemResource": { "description": "最近アクセスした項目リソース。ファイル、フォルダ、またはウェブリンクの場合があります。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File--Full" }, { "$ref": "#/components/schemas/Folder--Full" }, { "$ref": "#/components/schemas/WebLink" } ], "title": "最近使用した項目リソース" }, "RecentItems": { "description": "最近使用した項目のリスト。", "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/RecentItem" } } } } ], "title": "最近使用した項目", "x-box-resource-id": "recent_items" }, "Resource": { "description": "ファイルまたはフォルダのリソース。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "$ref": "#/components/schemas/File--Mini" } ], "title": "リソース" }, "ResourceScope": { "description": "リソース (ファイルまたはフォルダ) とそのリソースにアクセスできるスコープの関係。", "type": "object", "properties": { "scope": { "description": "リソースへのアクセスのスコープ。", "type": "string", "example": "item_download", "enum": [ "annotation_edit", "annotation_view_all", "annotation_view_self", "base_explorer", "base_picker", "base_preview", "base_upload", "item_delete", "item_download", "item_preview", "item_rename", "item_share", "item_upload", "item_read" ] }, "object": { "$ref": "#/components/schemas/Resource" } }, "title": "リソースのスコープ" }, "RetentionPolicies": { "description": "リテンションポリシーのリスト。", "type": "object", "allOf": [ { "properties": { "entries": { "description": "各エントリがリテンションポリシーオブジェクトを表しているリスト。", "type": "array", "items": { "$ref": "#/components/schemas/RetentionPolicy" } } } }, { "type": "object", "description": "マーカーベースのページ割りについて説明しているAPIレスポンスの部分。", "properties": { "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "次の検索結果ページの開始場所のマーカー。", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "リテンションポリシー", "x-box-resource-id": "retention_policies", "x-box-tag": "retention_policies" }, "RetentionPolicy": { "description": "リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダ、メタデータテンプレート、または企業全体に割り当てることができます。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対して \\[リテンションポリシーを管理する] スコープを有効にする必要があります。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/RetentionPolicy--Mini" }, { "properties": { "description": { "description": "リテンションポリシーのテキストによる追加の説明。", "type": "string", "example": "Policy to retain all reports for at least one month" }, "policy_type": { "description": "リテンションポリシーのタイプ。リテンションポリシーのタイプは、`finite` (コンテンツを保持する期間が事前にわかっている場合)、または`indefinite` (コンテンツを保持する期間が不明な場合) のいずれかになります。", "type": "string", "example": "finite", "enum": [ "finite", "indefinite" ] }, "retention_type": { "description": "以下のリテンションの種類を指定します。\n\n* `modifiable`: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。\n\n* `non-modifiable`: フォルダの追加、期間の延長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。", "type": "string", "example": "non_modifiable", "enum": [ "modifiable", "non_modifiable" ] }, "status": { "description": "リテンションポリシーのステータス。ポリシーのステータスは、管理者が明示的に撤回しない限り、`active`になります (撤回されたポリシーのステータスは`retired`になります)。一度廃止したポリシーを再度アクティブにすることはできません。", "type": "string", "example": "active", "enum": [ "active", "retired" ] }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "リテンションポリシーを作成したユーザーをMini版のユーザーオブジェクトで表示。" } ] }, "created_at": { "description": "リテンションポリシーオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "リテンションポリシーオブジェクトが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "can_owner_extend_retention": { "description": "元のリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者がリテンションを延長できるかどうかを決定します。", "type": "boolean", "example": false }, "are_owners_notified": { "description": "リテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者と共同所有者に通知するかどうかを決定します。", "type": "boolean", "example": false }, "custom_notification_recipients": { "description": "リテンションポリシーの期間が終了に近づいたときに通知されるユーザーのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/User--Mini" } }, "assignment_counts": { "description": "項目タイプごとに、リテンションポリシーによる割り当て数をカウントします。", "type": "object", "properties": { "enterprise": { "description": "このポリシーでの企業の割り当て数。最大値は1です。", "type": "integer", "format": "int64", "example": 1 }, "folder": { "description": "このポリシーでのフォルダの割り当て数。", "type": "integer", "format": "int64", "example": 1 }, "metadata_template": { "description": "このポリシーでのメタデータテンプレートの割り当て数。", "type": "integer", "format": "int64", "example": 1 } } } } } ], "title": "リテンションポリシー", "x-box-resource-id": "retention_policy", "x-box-tag": "retention_policies", "x-box-variant": "standard" }, "RetentionPolicy--Base": { "description": "リテンションポリシーのBase版の表示。", "type": "object", "properties": { "id": { "description": "リテンションポリシーを表す一意の識別子。", "type": "string", "example": "12345", "nullable": false }, "type": { "description": "値は常に`retention_policy`になります。", "type": "string", "example": "retention_policy", "enum": [ "retention_policy" ], "nullable": false } }, "required": [ "id", "type" ], "title": "リテンションポリシー (Base)", "x-box-resource-id": "retention_policy--base", "x-box-tag": "retention_policies", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard" ] }, "RetentionPolicy--Mini": { "description": "他のリソース内にネストされたときに使用されるリテンションポリシーのMini版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/RetentionPolicy--Base" }, { "properties": { "policy_name": { "description": "リテンションポリシーの名前。", "type": "string", "example": "Some Policy Name" }, "retention_length": { "description": "リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーの`policy_type`が`indefinite`である場合は、`retention_length`も`indefinite`になります。", "type": "string", "format": "int32", "example": "365", "minimum": 1 }, "disposition_action": { "description": "リテンションポリシーの廃棄アクション。このアクションを`permanently_delete`に設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。`remove_retention`に設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。", "type": "string", "example": "permanently_delete", "enum": [ "permanently_delete", "remove_retention" ] } } } ], "title": "リテンションポリシー (Mini)", "x-box-resource-id": "retention_policy--mini", "x-box-variant": "mini" }, "RetentionPolicyAssignment": { "description": "リテンションの割り当ては、リテンションポリシーで保持されるファイルを指定するルールを表します。割り当てにより、フォルダまたはメタデータに基づいてファイルを保持したり、企業内のすべてのファイルを保持したりできます。", "type": "object", "properties": { "id": { "description": "リテンションポリシー割り当ての一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`retention_policy_assignment`になります。", "type": "string", "example": "retention_policy_assignment", "enum": [ "retention_policy_assignment" ] }, "retention_policy": { "allOf": [ { "$ref": "#/components/schemas/RetentionPolicy--Mini" }, { "description": "コンテンツに割り当てられたリテンションポリシーオブジェクトのMini版の表示。" } ] }, "assigned_to": { "description": "リテンションの対象となるコンテンツの`type`と`id`。`type`は、`folder`、`enterprise`、`metadata_template`のいずれかになります。", "type": "object", "properties": { "id": { "description": "ポリシーが割り当てられるフォルダ、企業、またはメタデータテンプレートのID。タイプが企業に設定されている場合は、nullに設定するか省略します。", "type": "string", "example": "a983f69f-e85f-4ph4-9f46-4afdf9c1af65", "nullable": true }, "type": { "description": "ポリシーが割り当てられるリソースのタイプ。", "type": "string", "example": "metadata_template", "enum": [ "folder", "enterprise", "metadata_template" ] } } }, "filter_fields": { "description": "フィールドオブジェクトの配列。値が返されるのは、`assigned_to`のタイプが`metadata_template`の場合のみです。それ以外の場合、配列は空です。", "type": "array", "items": { "type": "object", "nullable": true, "properties": { "field": { "description": "メタデータ属性キーID。", "type": "string", "example": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4", "nullable": true }, "value": { "description": "メタデータ属性フィールドID。値については、列挙型とmultiselect型のみがサポートされています。", "type": "string", "example": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e", "nullable": true } } }, "nullable": true }, "assigned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "リテンションポリシー割り当てを作成したユーザーをMini版のユーザーオブジェクトで表示。" } ] }, "assigned_at": { "description": "リテンションポリシー割り当てオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "start_date_field": { "description": "リテンションポリシー割り当ての開始日。`assigned_to`のタイプが`metadata_template`の場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。", "type": "string", "example": "upload_date" } }, "required": [ "id", "type" ], "title": "リテンションポリシー割り当て", "x-box-resource-id": "retention_policy_assignment", "x-box-tag": "retention_policy_assignments" }, "RetentionPolicyAssignments": { "description": "リテンションポリシー割り当てのリスト。", "type": "object", "allOf": [ { "properties": { "entries": { "description": "リテンションポリシー割り当てのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/RetentionPolicyAssignment" } } } }, { "type": "object", "description": "マーカーベースのページ割りについて説明しているAPIレスポンスの部分。", "properties": { "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "次の検索結果ページの開始場所のマーカー。", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "リテンションポリシー割り当て", "x-box-resource-id": "retention_policy_assignments", "x-box-tag": "retention_policy_assignments" }, "RoleVariable": { "description": "特定のコラボレータの役割がワークフローの結果の影響を受けるかどうかを決定します。", "type": "object", "properties": { "type": { "description": "役割オブジェクトタイプ。", "type": "string", "example": "variable", "enum": [ "variable" ] }, "variable_type": { "description": "オブジェクトで使用される変数タイプ。", "type": "string", "example": "collaborator_role", "enum": [ "collaborator_role" ] }, "variable_value": { "allOf": [ { "type": "string", "description": "付与されるアクセスレベル。", "example": "editor", "enum": [ "editor", "viewer", "previewer", "uploader", "previewer uploader", "viewer uploader", "co-owner" ] }, { "description": "役割パラメータに使用できる変数値。" } ] } }, "required": [ "type", "variable_type", "variable_value" ], "title": "役割変数" }, "SearchResultItem": { "description": "検索結果の項目。ファイル、フォルダ、またはウェブリンクの場合があります。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File--Full" }, { "$ref": "#/components/schemas/Folder--Full" }, { "$ref": "#/components/schemas/WebLink" } ], "title": "検索結果の項目" }, "SearchResultWithSharedLink": { "description": "検索クエリと一致したファイル、フォルダ、ウェブリンクの単一リスト (項目がユーザーと共有されたときに使用された共有リンクに関する追加情報を含む)。\n\nこのレスポンス形式は、`include_recent_shared_links`クエリパラメータが`true`に設定されている場合にのみ返されます。", "type": "object", "properties": { "accessible_via_shared_link": { "description": "ユーザーがこの項目にアクセスする際に使用する共有リンク (省略可)。この値は、ユーザーが最近共有リンクを介してファイルにアクセスした項目のみに返されます。その他すべての項目には、`null`が返されます。", "type": "string", "format": "url", "example": "https://www.box.com/s/vspke7y05sb214wjokpk" }, "item": { "allOf": [ { "$ref": "#/components/schemas/SearchResultWithSharedLinkItem" }, { "description": "検索クエリと一致したファイル、フォルダ、またはウェブリンク。" } ] }, "type": { "description": "結果の種類。値は常に`search_result`になります。", "type": "string", "example": "search_result" } }, "title": "検索結果 (共有リンクを含む)", "x-box-resource-id": "search_result_with_shared_link", "x-box-tag": "search" }, "SearchResultWithSharedLinkItem": { "description": "共有リンク付きの検索結果の項目。ファイル、フォルダ、またはウェブリンクの場合があります。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/File--Full" }, { "$ref": "#/components/schemas/Folder--Full" }, { "$ref": "#/components/schemas/WebLink" } ], "title": "検索結果の項目" }, "SearchResults": { "description": "検索クエリに一致するファイル、フォルダ、およびウェブリンクのリスト。", "type": "object", "allOf": [ { "type": "object", "properties": { "total_count": { "description": "検索結果の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "この検索で使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータを使用した場合と同じになります。", "type": "integer", "format": "int64", "example": 2000 } } }, { "properties": { "type": { "description": "共有リンクを含まない検索結果項目としてレスポンスを指定します。", "type": "string", "example": "search_results_items", "enum": [ "search_results_items" ], "nullable": false }, "entries": { "description": "指定されたクエリの検索結果。", "type": "array", "items": { "$ref": "#/components/schemas/SearchResultItem" } } } } ], "required": [ "type" ], "title": "検索結果", "x-box-resource-id": "search_results", "x-box-tag": "search" }, "SearchResultsResponse": { "description": "コンテンツの検索エンドポイントからの検索結果。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/SearchResults" }, { "$ref": "#/components/schemas/SearchResultsWithSharedLinks" } ], "title": "検索結果のレスポンス" }, "SearchResultsWithSharedLinks": { "description": "検索クエリと一致したファイル、フォルダ、ウェブリンクのリスト (項目がユーザーと共有されたときに使用されたすべての共有リンクに関する追加情報を含む)。\n\nこのレスポンス形式は、`include_recent_shared_links`クエリパラメータが`true`に設定されている場合にのみ返されます。", "type": "object", "allOf": [ { "type": "object", "properties": { "total_count": { "description": "検索結果の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "この検索で使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータを使用した場合と同じになります。", "type": "integer", "format": "int64", "example": 2000 } } }, { "properties": { "type": { "description": "共有リンクを含む検索結果項目としてレスポンスを指定します。", "type": "string", "example": "search_results_with_shared_links", "enum": [ "search_results_with_shared_links" ], "nullable": false }, "entries": { "description": "指定されたクエリの検索結果 (項目がユーザーと共有されたときに使用されたすべての共有リンクに関する追加情報を含む)。", "type": "array", "items": { "$ref": "#/components/schemas/SearchResultWithSharedLink" } } } } ], "required": [ "type" ], "title": "検索結果 (複数の共有リンクを含む)", "x-box-resource-id": "search_results_with_shared_links", "x-box-tag": "search" }, "SessionTerminationMessage": { "description": "終了ジョブステータスについて通知するメッセージ。", "type": "object", "properties": { "message": { "description": "終了ジョブステータスの一意の識別子。", "type": "string", "example": "Request is successful, please check the admin\nevents for the status of the job" } }, "title": "セッション終了メッセージ", "x-box-resource-id": "session_termination", "x-box-tag": "session_termination" }, "ShieldInformationBarrier": { "description": "Shield情報バリアオブジェクトのStandard版の表示。", "type": "object", "properties": { "id": { "description": "Shield情報バリアの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "Shield情報バリアのタイプ。", "type": "string", "example": "shield_information_barrier", "enum": [ "shield_information_barrier" ] }, "enterprise": { "description": "このバリアが配置されている企業の`type`と`id`。", "allOf": [ { "$ref": "#/components/schemas/Enterprise--Base" } ] }, "status": { "description": "Shield情報バリアのステータス。", "type": "string", "example": "draft", "enum": [ "draft", "pending", "disabled", "enabled", "invalid" ] }, "created_at": { "description": "このShield情報バリアオブジェクトが作成された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-06-26T18:44:45.869Z" }, "created_by": { "description": "このShield情報バリアを作成したユーザー。", "allOf": [ { "$ref": "#/components/schemas/User--Base" } ] }, "updated_at": { "description": "このShield情報バリアが更新された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-07-26T18:44:45.869Z" }, "updated_by": { "description": "このShield情報バリアを更新したユーザー。", "allOf": [ { "$ref": "#/components/schemas/User--Base" } ] }, "enabled_at": { "description": "このShield情報バリアが有効化された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-07-26T18:44:45.869Z" }, "enabled_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアを有効化したユーザー。" } ] } }, "title": "Shield情報バリア", "x-box-resource-id": "shield_information_barrier", "x-box-tag": "shield_information_barriers", "x-box-variant": "standard", "x-box-variants": [ "base", "standard" ] }, "ShieldInformationBarrier--Base": { "description": "Shield情報バリアオブジェクトのBase版の表示。", "type": "object", "properties": { "id": { "description": "Shield情報バリアの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "Shield情報バリアのタイプ。", "type": "string", "example": "shield_information_barrier", "enum": [ "shield_information_barrier" ] } }, "title": "Shield情報バリア (Base)", "x-box-resource-id": "shield_information_barrier--base", "x-box-tag": "shield_information_barriers", "x-box-variant": "base", "x-box-variants": [ "base", "standard" ] }, "ShieldInformationBarrierReference": { "description": "リクエストおよびレスポンスのShield情報バリア参照。", "type": "object", "properties": { "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" } }, "title": "Shield情報バリア参照", "x-box-resource-id": "shield_information_barrier_reference", "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierReport": { "description": "Shield情報バリアレポートオブジェクトのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierReport--Base" }, { "properties": { "shield_information_barrier": { "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierReference" } ] }, "status": { "description": "Shield情報バリアレポートのステータス。", "type": "string", "example": "pending", "enum": [ "pending", "error", "done", "cancelled" ] }, "details": { "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierReportDetails" } ] }, "created_at": { "description": "このShield情報バリアレポートオブジェクトが作成された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-06-26T18:44:45.869Z" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアレポートを作成したユーザー。" } ] }, "updated_at": { "description": "このShield情報バリアレポートが更新された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-07-26T18:44:45.869Z" } } } ], "title": "Shield情報バリアレポート", "x-box-resource-id": "shield_information_barrier_report", "x-box-tag": "shield_information_barrier_reports", "x-box-variant": "standard", "x-box-variants": [ "base", "standard" ] }, "ShieldInformationBarrierReport--Base": { "description": "Shield情報バリアレポートオブジェクトのBase版の表示。", "type": "object", "properties": { "id": { "description": "Shield情報バリアレポートの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "Shield情報バリアレポートのタイプ。", "type": "string", "example": "shield_information_barrier_report", "enum": [ "shield_information_barrier_report" ] } }, "title": "Shield情報バリアレポート (Base)", "x-box-resource-id": "shield_information_barrier_report--base", "x-box-tag": "shield_information_barrier_reports", "x-box-variant": "base", "x-box-variants": [ "base", "standard" ] }, "ShieldInformationBarrierReportDetails": { "description": "レポートの生成時に、レポートファイルが配置されているフォルダとエラー (ある場合) を示します。", "type": "object", "properties": { "details": { "type": "object", "properties": { "folder_id": { "description": "このレポートの配置先を表すフォルダID。", "type": "string", "example": "124235" } } } }, "title": "Shield情報バリアレポートの詳細", "x-box-resource-id": "shield_information_barrier_report_details", "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierReports": { "description": "Shieldバリアレポートのリスト。", "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 } } }, { "properties": { "entries": { "description": "Shield情報バリアレポートのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierReport" } } } } ], "title": "Shield情報バリアレポートのリスト", "x-box-resource-id": "shield_information_barrier_reports", "x-box-tag": "shield_information_barrier_reports" }, "ShieldInformationBarrierSegment": { "description": "Shield情報バリアのセグメントオブジェクト。", "type": "object", "properties": { "id": { "description": "Shield情報バリアのセグメントの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "Shield情報バリアのセグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] }, "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "name": { "description": "Shield情報バリアのセグメントの名前。", "type": "string", "example": "Investment Banking" }, "description": { "description": "Shield情報バリアのセグメントの説明。", "type": "string", "example": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'" }, "created_at": { "description": "このShield情報バリアオブジェクトが作成された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-06-26T18:44:45.869Z" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアのセグメントを作成したユーザー。" } ] }, "updated_at": { "description": "このShield情報バリアのセグメントが更新された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-07-26T18:44:45.869Z" }, "updated_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアのセグメントを更新したユーザー。" } ] } }, "title": "Shield情報バリアのセグメント", "x-box-resource-id": "shield_information_barrier_segment", "x-box-tag": "shield_information_barrier_segments" }, "ShieldInformationBarrierSegmentMember": { "description": "Shield情報バリアのセグメントメンバーオブジェクトのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember--Mini" }, { "properties": { "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "shield_information_barrier_segment": { "description": "リクエストされたShield情報バリアのセグメントの`type`と`id`。", "type": "object", "properties": { "id": { "description": "リクエストしているShield情報バリアのセグメントのID参照。", "type": "string", "example": "432554" }, "type": { "description": "Shield情報バリアのセグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] } } }, "user": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "リクエストされたShield情報バリアのセグメントメンバーの`type`と`id`。" } ] }, "created_at": { "description": "このShield情報バリアオブジェクトが作成された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-06-26T18:44:45.869Z" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアのセグメントメンバーを作成したユーザー。" } ] }, "updated_at": { "description": "このShield情報バリアのセグメントメンバーが更新された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-07-26T18:44:45.869Z" }, "updated_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアのセグメントメンバーを更新したユーザー。" } ] } } } ], "title": "Shield情報バリアのセグメントメンバー", "x-box-resource-id": "shield_information_barrier_segment_member", "x-box-tag": "shield_information_barrier_segment_members", "x-box-variant": "standard", "x-box-variants": [ "base", "mini", "standard" ] }, "ShieldInformationBarrierSegmentMember--Base": { "description": "Shield情報バリアのセグメントメンバーオブジェクトのBase版の表示。", "type": "object", "properties": { "id": { "description": "Shield情報バリアのセグメントメンバーの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "Shield情報バリアのセグメントメンバーのタイプ。", "type": "string", "example": "shield_information_barrier_segment_member", "enum": [ "shield_information_barrier_segment_member" ] } }, "title": "Shield情報バリアのセグメントメンバー (Base)", "x-box-resource-id": "shield_information_barrier_segment_member--base", "x-box-tag": "shield_information_barrier_segment_members", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard" ] }, "ShieldInformationBarrierSegmentMember--Mini": { "description": "Shield情報バリアのセグメントメンバーオブジェクトのMini版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember--Base" }, { "properties": { "user": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "リクエストされたShield情報バリアのセグメントメンバーの`type`と`id`。" } ] } } } ], "title": "Shield情報バリアのセグメントメンバー (Mini)", "x-box-resource-id": "shield_information_barrier_segment_member--mini", "x-box-tag": "shield_information_barrier_segment_members", "x-box-variant": "mini", "x-box-variants": [ "base", "mini", "standard" ] }, "ShieldInformationBarrierSegmentMembers": { "description": "Shield情報バリアのメンバーオブジェクトのリスト。", "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 } } }, { "properties": { "entries": { "description": "Shield情報バリアのセグメントメンバーのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentMember" } } } } ], "title": "Shield情報バリアのセグメントメンバーのリスト", "x-box-resource-id": "shield_information_barrier_segment_members", "x-box-tag": "shield_information_barrier_segment_members" }, "ShieldInformationBarrierSegmentRestriction": { "description": "Shield情報バリアオブジェクトのセグメント制限のStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction--Mini" }, { "properties": { "shield_information_barrier": { "$ref": "#/components/schemas/ShieldInformationBarrier--Base" }, "created_at": { "description": "このShield情報バリアのセグメント制限オブジェクトが作成された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-06-26T18:44:45.869Z" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアのセグメント制限を作成したユーザー。" } ] }, "updated_at": { "description": "このShield情報バリアのセグメント制限が更新された日時を示すISO日時文字列。", "type": "string", "format": "date-time", "example": "2020-07-26T18:44:45.869Z" }, "updated_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このShield情報バリアのセグメント制限を更新したユーザー。" } ] } } } ], "required": [ "shield_information_barrier_segment", "restricted_segment" ], "title": "Shield情報バリアのセグメント制限", "x-box-resource-id": "shield_information_barrier_segment_restriction", "x-box-tag": "shield_information_barrier_segment_restrictions", "x-box-variant": "standard", "x-box-variants": [ "base", "mini", "standard" ] }, "ShieldInformationBarrierSegmentRestriction--Base": { "description": "Shield情報バリアのセグメント制限オブジェクトのBase版の表示。", "type": "object", "properties": { "type": { "description": "Shield情報バリアのセグメント制限。", "type": "string", "example": "shield_information_barrier_segment_restriction", "enum": [ "shield_information_barrier_segment_restriction" ] }, "id": { "description": "Shield情報バリアのセグメント制限の一意の識別子。", "type": "string", "example": "11446498" } }, "required": [ "shield_information_barrier_segment", "restricted_segment" ], "title": "Shield情報バリアのセグメント制限 (Base)", "x-box-resource-id": "shield_information_barrier_segment_restriction--base", "x-box-tag": "shield_information_barrier_segment_restrictions", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard" ] }, "ShieldInformationBarrierSegmentRestriction--Mini": { "description": "Shield情報バリアのセグメント制限オブジェクトのMini版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction--Base" }, { "properties": { "shield_information_barrier_segment": { "description": "リクエストされたShield情報バリアのセグメントの`type`と`id`。", "type": "object", "properties": { "id": { "description": "リクエストしているShield情報バリアのセグメントのID参照。", "type": "string", "example": "1910967" }, "type": { "description": "Shield情報バリアのセグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] } } }, "restricted_segment": { "description": "制限されたShield情報バリアのセグメントの`type`と`id`。", "type": "object", "properties": { "id": { "description": "制限されたShield情報バリアのセグメントのID参照。", "type": "string", "example": "1910967" }, "type": { "description": "Shield情報セグメントのタイプ。", "type": "string", "example": "shield_information_barrier_segment", "enum": [ "shield_information_barrier_segment" ] } } } } } ], "required": [ "shield_information_barrier_segment", "restricted_segment" ], "title": "Shield情報バリアのセグメント制限 (Mini)", "x-box-resource-id": "shield_information_barrier_segment_restriction--mini", "x-box-tag": "shield_information_barrier_segment_restrictions", "x-box-variant": "mini", "x-box-variants": [ "base", "mini", "standard" ] }, "ShieldInformationBarrierSegmentRestrictions": { "description": "Shield情報バリアのセグメント制限オブジェクトのリスト。", "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 } } }, { "properties": { "entries": { "description": "Shield情報バリアのセグメント制限オブジェクトのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegmentRestriction" } } } } ], "title": "Shield情報バリアのセグメント制限のリスト", "x-box-resource-id": "shield_information_barrier_segment_restrictions", "x-box-tag": "shield_information_barrier_segment_restrictions" }, "ShieldInformationBarrierSegments": { "description": "Shield情報バリアのセグメントオブジェクトのリスト。", "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 } } }, { "properties": { "entries": { "description": "Shield情報バリアのセグメントのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrierSegment" } } } } ], "title": "Shield情報バリアのセグメントのリスト", "x-box-resource-id": "shield_information_barrier_segments", "x-box-tag": "shield_information_barrier_segments" }, "ShieldInformationBarriers": { "description": "Shield情報バリアオブジェクトのリスト。", "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 } } }, { "properties": { "entries": { "description": "Shield情報バリアオブジェクトのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/ShieldInformationBarrier" } } } } ], "title": "Shield情報バリアのリスト", "x-box-resource-id": "shield_information_barriers", "x-box-tag": "shield_information_barriers" }, "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_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": "最終的な署名済みドキュメントと署名ログの保存先フォルダ。\n\n署名リクエストの作成時にこの値が渡されなかった場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ (そのフォルダへのアップロード権限がある場合) または「My Sign Requests」という名前のフォルダになります。" } ], "nullable": false }, "collaborator_level": { "description": "署名リクエストに対するユーザーのコラボレータレベル。値には「owner」、「editor」、「viewer」を指定できます。", "type": "string", "example": "owner", "nullable": 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", "x-box-variant": "standard", "x-box-variants": [ "standard", "base" ] }, "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 } }, "title": "Box Signリクエスト (Base)", "x-box-resource-id": "sign_request--base", "x-box-tag": "sign_requests", "x-box-variant": "base", "x-box-variants": [ "standard", "base" ] }, "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です。\n\n**注**: 一部の署名者が競合する[セグメント](r://shield-information-barrier-segment-member) (ユーザーグループ) に属している可能性もあります。これは、セキュリティポリシーにより、倫理的な競合につながる可能性のあるやり取りやコミュニケーションを防ぐためにユーザーがセグメントに割り当てられていることを意味します。このような場合、署名リクエストを送信しようとすると、エラーが発生します。\n\nセグメントと情報バリアの詳細については、[こちら](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にすることもできません。\n\n署名リクエストの作成時にこの値が渡されない場合は、デフォルトのフォルダを使用することになります。デフォルトのフォルダは、ペイロードの最初のソースファイルの親フォルダ (そのフォルダへのアップロード権限がある場合) または「My Sign Requests」という名前のフォルダになります。" } ] } } } ], "required": [ "signers" ], "title": "Box Signリクエストを作成する" }, "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 } }, "title": "Box Signリクエストオブジェクトを作成するための署名者フィールド。" }, "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": "署名リクエスト事前入力タグ" }, "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 } } } ], "required": [ "email" ], "title": "Box Signリクエストのレスポンスの署名者フィールド" }, "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 } } } ], "required": [ "page_index" ], "title": "署名リクエストの署名者の入力" }, "SignRequests": { "description": "任意のBox Sign APIエンドポイントからデフォルトで返される署名リクエストのStandard版の表示。", "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 } } }, { "properties": { "entries": { "description": "Box Signリクエストのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/SignRequest" } } } } ], "title": "Box Signリクエスト", "x-box-resource-id": "sign_requests", "x-box-tag": "sign_requests" }, "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": "テンプレートの署名者の配列。\n\n**注**: テンプレートで指定された一部の署名者が競合する[セグメント](r://shield-information-barrier-segment-member) (ユーザーグループ) に属している可能性もあります。これは、セキュリティポリシーにより、倫理的な競合につながる可能性のあるやり取りやコミュニケーションを防ぐためにユーザーがセグメントに割り当てられていることを意味します。このような場合、競合するセグメントに存在する署名者を含むテンプレートに基づいて署名リクエストを送信しようとすると、エラーが発生します。\n\nセグメントと情報バリアの詳細については、[こちら](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/\nready-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\nAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A\n8AAQUBAScY42YAAAAASUVORK5CYII=", "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 } } } } } ], "title": "Box Signテンプレート", "x-box-resource-id": "sign_template", "x-box-tag": "sign_templates" }, "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" }, "SkillCard": { "description": "Box Skillカード。", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/KeywordSkillCard" }, { "$ref": "#/components/schemas/TimelineSkillCard" }, { "$ref": "#/components/schemas/TranscriptSkillCard" }, { "$ref": "#/components/schemas/StatusSkillCard" } ], "title": "Box Skillカード" }, "SkillCardsMetadata": { "description": "Boxスキルの使用に割り当てられたメタデータ。", "type": "object", "properties": { "$canEdit": { "description": "このメタデータをユーザーが編集できるかどうか。", "type": "boolean", "example": true }, "$id": { "description": "メタデータオブジェクトを識別するためのUUID。", "type": "string", "format": "uuid", "example": "01234500-12f1-1234-aa12-b1d234cb567e", "maxLength": 36 }, "$parent": { "description": "親フォルダのID。", "type": "string", "example": "folder_59449484661," }, "$scope": { "description": "このテンプレートが適用されているスコープのID。", "type": "string", "example": "enterprise_27335" }, "$template": { "description": "テンプレートの名前。", "type": "string", "example": "properties" }, "$type": { "description": "このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。", "type": "string", "example": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0" }, "$typeVersion": { "description": "オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。", "type": "integer", "example": 2 }, "$version": { "description": "メタデータオブジェクトのバージョン。0から始まり、ユーザー定義プロパティが変更されるたびに増加します。", "type": "integer", "example": 1 }, "cards": { "description": "このファイルに適用されているBox Skillカードのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/SkillCard" } } }, "title": "Skillsメタデータインスタンス", "x-box-resource-id": "skill_cards_metadata", "x-box-tag": "skills" }, "StatusSkillCard": { "description": "メタデータサイドバーにステータスメッセージを配置するBox Skillメタデータカード。", "type": "object", "properties": { "created_at": { "description": "このカードの作成日時 (省略可)。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00" }, "type": { "description": "値は常に`skill_card`になります。", "type": "string", "example": "skill_card", "enum": [ "skill_card" ] }, "skill_card_type": { "description": "値は常に`status`になります。", "type": "string", "example": "status", "enum": [ "status" ] }, "skill_card_title": { "description": "カードのタイトル。", "type": "object", "properties": { "code": { "description": "タイトルの識別子 (省略可)。", "type": "string", "example": "status" }, "message": { "description": "UI上で表示する実際のタイトル。", "type": "string", "example": "Status" } }, "required": [ "message" ] }, "status": { "description": "スキルのステータスを設定します。これは、スキルがデータを処理している間またはファイルを処理できなかった場合にユーザーにメッセージを表示するのに使用できます。", "type": "object", "properties": { "code": { "description": "このスキル呼び出しのステータスを表すコード。デフォルトでは、各コードには独自のメッセージが伴います。これらのメッセージを調整するには、このオブジェクトの`message`値を設定します。", "type": "string", "example": "success", "enum": [ "invoked", "processing", "success", "transient_failure", "permanent_failure" ] }, "message": { "description": "このステータスで提供できるカスタムメッセージ。ウェブアプリでエンドユーザーに表示されます。", "type": "string", "example": "We're preparing to process your file. Please hold on!" } }, "required": [ "code" ] }, "skill": { "description": "このメタデータを適用したサービス。", "type": "object", "properties": { "type": { "description": "値は常に`service`になります。", "type": "string", "example": "service", "enum": [ "service" ] }, "id": { "description": "このメタデータを適用したサービスを表すカスタム識別子。", "type": "string", "example": "image-recognition-service" } }, "required": [ "type", "id" ] }, "invocation": { "description": "このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。", "type": "object", "properties": { "type": { "description": "値は常に`skill_invocation`になります。", "type": "string", "example": "skill_invocation", "enum": [ "skill_invocation" ] }, "id": { "description": "このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。", "type": "string", "example": "image-recognition-service-123" } }, "required": [ "type", "id" ] } }, "required": [ "type", "skill_card_type", "skill", "invocation", "status" ], "title": "ステータススキルカード", "x-box-resource-id": "status_skill_card", "x-box-tag": "skills" }, "StoragePolicies": { "description": "ストレージポリシーのリスト。", "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/StoragePolicy" } } } } ], "title": "ストレージポリシー", "x-box-resource-id": "storage_policies", "x-box-tag": "storage_policies" }, "StoragePolicy": { "description": "ストレージゾーンを示すストレージポリシーオブジェクト。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/StoragePolicy--Mini" }, { "properties": { "name": { "description": "地域のわかりやすい名前。", "type": "string", "example": "Montreal / Dublin" } } } ], "title": "ストレージポリシー", "x-box-resource-id": "storage_policy", "x-box-variant": "standard" }, "StoragePolicy--Mini": { "description": "ストレージポリシーオブジェクトのMini版の説明。", "type": "object", "properties": { "id": { "description": "このストレージポリシーの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`storage_policy`になります。", "type": "string", "example": "storage_policy", "enum": [ "storage_policy" ] } }, "required": [ "id", "type" ], "title": "ストレージポリシー (Mini)", "x-box-resource-id": "storage_policy--mini", "x-box-tag": "storage_policies", "x-box-variant": "mini", "x-box-variants": [ "standard", "mini" ] }, "StoragePolicyAssignment": { "description": "ユーザーまたは企業へのストレージポリシーの割り当て。", "type": "object", "properties": { "id": { "description": "ストレージポリシー割り当ての一意の識別子。", "type": "string", "example": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw" }, "type": { "description": "値は常に`storage_policy_assignment`になります。", "type": "string", "example": "storage_policy_assignment", "enum": [ "storage_policy_assignment" ] }, "storage_policy": { "allOf": [ { "$ref": "#/components/schemas/StoragePolicy--Mini" }, { "description": "割り当てられたストレージポリシー。" } ] }, "assigned_to": { "allOf": [ { "title": "Reference", "description": "オブジェクトの最も基本的な参照。", "type": "object", "properties": { "id": { "description": "このオブジェクトの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "このオブジェクトのタイプ。", "type": "string", "example": "file" } } }, { "description": "そのポリシーが割り当てられる企業またはユーザー。" } ] } }, "required": [ "id", "type" ], "title": "ストレージポリシー割り当て", "x-box-resource-id": "storage_policy_assignment", "x-box-tag": "storage_policy_assignments" }, "StoragePolicyAssignments": { "description": "ストレージポリシー割り当てのリスト。", "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/StoragePolicyAssignment" } } } } ], "title": "ストレージポリシー割り当て", "x-box-resource-id": "storage_policy_assignments", "x-box-tag": "storage_policy_assignments" }, "Task": { "description": "タスクを使用すると、Boxでファイル中心のワークフローを実現できます。ユーザーはファイルに関連するタスクを作成し、タスクを完了するために他のユーザーに割り当てることができます。", "type": "object", "properties": { "id": { "description": "このタスクの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`task`になります。", "type": "string", "example": "task", "enum": [ "task" ] }, "item": { "allOf": [ { "$ref": "#/components/schemas/File--Mini" }, { "description": "タスクに関連付けられたファイル。" } ] }, "due_at": { "description": "タスクの期限。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "action": { "description": "タスク担当者が実行するように求められるタスクのタイプ。", "type": "string", "example": "review", "enum": [ "review", "complete" ] }, "message": { "description": "タスクに含めるメッセージ。", "type": "string", "example": "Legal review" }, "task_assignment_collection": { "allOf": [ { "$ref": "#/components/schemas/TaskAssignments" }, { "description": "タスクに関連付けられたタスク割り当てオブジェクトのコレクション。" } ] }, "is_completed": { "description": "タスクが完了しているかどうか。", "type": "boolean", "example": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "タスクを作成したユーザー。" } ] }, "created_at": { "description": "タスクオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "completion_rule": { "description": "タスクが完了と見なされる前にそのタスクを完了する必要がある担当者を定義します。\n\n* `all_assignees` - タスクが完了と見なされるには、すべての担当者がそのタスクをレビューまたは承認する必要があります。\n* `any_assignee` - いずれか1人の担当者がタスクをレビューまたは承認すれば、タスクが完了と見なされます。", "type": "string", "example": "all_assignees", "enum": [ "all_assignees", "any_assignee" ] } }, "title": "Task", "x-box-resource-id": "task", "x-box-tag": "tasks" }, "TaskAssignment": { "description": "タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。", "type": "object", "properties": { "id": { "description": "このタスク割り当ての一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`task_assignment`になります。", "type": "string", "example": "task_assignment", "enum": [ "task_assignment" ] }, "item": { "allOf": [ { "$ref": "#/components/schemas/File--Mini" }, { "description": "タスクが割り当てられているファイル。" } ] }, "assigned_to": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "タスクが割り当てられているユーザー。" } ] }, "message": { "description": "タスク割り当てに含められるメッセージ。これは、ウェブおよびモバイルUIで、タスクが割り当てられたユーザーに表示されます。", "type": "string", "example": "Please review" }, "completed_at": { "description": "このタスク割り当てが完了した日。タスクがまだ完了していない場合は`null`になります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "assigned_at": { "description": "このタスクがユーザーに割り当てられた日。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "reminded_at": { "description": "タスクが割り当てられたユーザーに、このタスク割り当てがリマインドされた日。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "resolution_state": { "description": "割り当ての現在の状態。使用可能な状態は、タスクオブジェクトの`action`値によって異なります。", "type": "string", "example": "incomplete", "enum": [ "completed", "incomplete", "approved", "rejected" ] }, "assigned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このタスクを割り当てたユーザー。" } ] } }, "title": "タスク割り当て", "x-box-resource-id": "task_assignment", "x-box-tag": "task_assignments" }, "TaskAssignments": { "description": "タスク割り当てのリスト。", "type": "object", "properties": { "total_count": { "description": "このコレクション内の項目の合計数。", "type": "integer", "format": "int64", "example": 100 }, "entries": { "description": "タスク割り当てのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/TaskAssignment" } } }, "title": "タスク割り当て", "x-box-resource-id": "task_assignments", "x-box-tag": "task_assignments" }, "Tasks": { "description": "タスクのリスト。", "type": "object", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。", "type": "integer", "format": "int64", "example": 5000 }, "entries": { "description": "タスクのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Task" } } }, "title": "Tasks", "x-box-resource-id": "tasks", "x-box-tag": "tasks" }, "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": "テンプレートの署名者フィールド" }, "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 } } } ], "required": [ "page_index" ], "title": "テンプレートの署名者の入力" }, "TermsOfService": { "description": "1つのサービス利用規約に該当するとみなされるルートレベルのレコード。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/TermsOfService--Base" }, { "properties": { "status": { "description": "これらの利用規約が有効になっているかどうか。", "type": "string", "example": "enabled", "enum": [ "enabled", "disabled" ] }, "enterprise": { "allOf": [ { "title": "Enterprise", "type": "object", "description": "Box Enterpriseのレプリゼンテーション。", "properties": { "id": { "description": "この会社の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "name": { "description": "企業の名前。", "type": "string", "example": "Acme Inc." } } }, { "description": "これらの利用規約が適用される企業。" } ] }, "tos_type": { "description": "これらの利用規約を管理対象ユーザーに適用するか、外部ユーザーに適用するか。", "type": "string", "example": "managed", "enum": [ "managed", "external" ] }, "text": { "description": "利用規約のテキスト。`status`が`disabled`に設定されている場合は、このテキストが空になることがあります。", "type": "string", "example": "By using this service, you agree to ..." }, "created_at": { "description": "リーガル項目が作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "リーガル項目が変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } ], "title": "サービス利用規約", "x-box-resource-id": "terms_of_service", "x-box-variant": "standard" }, "TermsOfService--Base": { "description": "1つのサービス利用規約に該当するとみなされるルートレベルのレコード。", "type": "object", "properties": { "id": { "description": "このサービス利用規約の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`terms_of_service`になります。", "type": "string", "example": "terms_of_service", "enum": [ "terms_of_service" ] } }, "required": [ "id", "type" ], "title": "サービス利用規約 (Base)", "x-box-resource-id": "terms_of_service--base", "x-box-tag": "terms_of_services", "x-box-variant": "base", "x-box-variants": [ "base", "standard" ] }, "TermsOfServiceUserStatus": { "description": "サービス利用規約とユーザーの関連付け。", "type": "object", "properties": { "id": { "description": "このサービス利用規約のユーザーステータスの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`terms_of_service_user_status`になります。", "type": "string", "example": "terms_of_service_user_status", "enum": [ "terms_of_service_user_status" ] }, "tos": { "allOf": [ { "$ref": "#/components/schemas/TermsOfService--Base" }, { "description": "サービス利用規約。" } ] }, "user": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "ユーザー。" } ] }, "is_accepted": { "description": "ユーザーがサービス利用規約に同意したかどうか。", "type": "boolean", "example": true }, "created_at": { "description": "リーガル項目が作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "リーガル項目が変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "required": [ "id", "type" ], "title": "サービス利用規約のユーザーステータス", "x-box-resource-id": "terms_of_service_user_status", "x-box-tag": "terms_of_service_user_statuses" }, "TermsOfServiceUserStatuses": { "description": "サービス利用規約のユーザーステータスのリスト。", "type": "object", "properties": { "total_count": { "description": "オブジェクトの合計数。", "type": "integer", "format": "int64", "example": 2 }, "entries": { "description": "サービス利用規約のユーザーステータスのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/TermsOfServiceUserStatus" } } }, "title": "サービス利用規約のユーザーステータス", "x-box-resource-id": "terms_of_services_user_statuses", "x-box-tag": "terms_of_service_user_statuses" }, "TermsOfServices": { "description": "サービス利用規約のリスト。", "type": "object", "properties": { "total_count": { "description": "オブジェクトの合計数。", "type": "integer", "format": "int64", "example": 2 }, "entries": { "description": "サービス利用規約オブジェクトのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/TermsOfService" } } }, "title": "サービス利用規約", "x-box-resource-id": "terms_of_services", "x-box-tag": "terms_of_services" }, "TimelineSkillCard": { "description": "タイムラインに画像のリストを配置するBox Skillメタデータカード。", "type": "object", "properties": { "created_at": { "description": "このカードの作成日時 (省略可)。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00" }, "type": { "description": "値は常に`skill_card`になります。", "type": "string", "example": "skill_card", "enum": [ "skill_card" ] }, "skill_card_type": { "description": "値は常に`timeline`になります。", "type": "string", "example": "timeline", "enum": [ "timeline" ] }, "skill_card_title": { "description": "カードのタイトル。", "type": "object", "properties": { "code": { "description": "タイトルの識別子 (省略可)。", "type": "string", "example": "Faces" }, "message": { "description": "UI上で表示する実際のタイトル。", "type": "string", "example": "Faces" } }, "required": [ "message" ] }, "skill": { "description": "このメタデータを適用したサービス。", "type": "object", "properties": { "type": { "description": "値は常に`service`になります。", "type": "string", "example": "service", "enum": [ "service" ] }, "id": { "description": "このメタデータを適用したサービスを表すカスタム識別子。", "type": "string", "example": "image-recognition-service" } }, "required": [ "type", "id" ] }, "invocation": { "description": "このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。", "type": "object", "properties": { "type": { "description": "値は常に`skill_invocation`になります。", "type": "string", "example": "skill_invocation", "enum": [ "skill_invocation" ] }, "id": { "description": "このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。", "type": "string", "example": "image-recognition-service-123" } }, "required": [ "type", "id" ] }, "duration": { "description": "タイムラインの総持続時間 (秒)。", "type": "integer", "example": 1000 }, "entries": { "description": "タイムライン上のエントリのリスト。", "type": "array", "items": { "type": "object", "description": "タイムライン上の複数の項目に配置される1つの項目。", "properties": { "text": { "description": "エントリのテキスト。これは、たとえば、ビデオで検出された人物の名前など、タイムラインに配置される項目の表示名になります。", "type": "string", "example": "John" }, "appears": { "description": "この項目がタイムラインに表示される日時を表すタイムスタンプのリストを定義します。", "type": "array", "items": { "type": "object", "description": "エントリのタイムスタンプ。", "properties": { "start": { "description": "エントリがタイムライン上に表示され始める時間 (秒)。", "type": "integer", "example": 1 }, "end": { "description": "エントリがタイムラインに表示されなくなる時間 (秒)。", "type": "integer", "example": 20 } } }, "required": [ "start", "end" ] }, "image_url": { "description": "タイムラインに表示されるエントリを示す画像。この画像のURLはすべてのエントリに必要です。\n\nこの画像は項目 (顔など) のリストに表示されます。また、画像をクリックすると、このエントリの期間中にそのエントリが表示される位置がユーザーに示されます。", "type": "string", "example": "https://example.com/image1.jpg" } } } } }, "required": [ "type", "skill_card_type", "skill", "invocation", "entries" ], "title": "タイムラインスキルカード", "x-box-resource-id": "timeline_skill_card", "x-box-tag": "skills" }, "TrackingCode": { "description": "追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。", "type": "object", "properties": { "type": { "description": "値は常に`tracking_code`になります。", "type": "string", "example": "tracking_code", "enum": [ "tracking_code" ] }, "name": { "description": "追跡コードの名前。管理コンソールであらかじめ設定しておく必要があります。", "type": "string", "example": "department" }, "value": { "description": "追跡コードの値。", "type": "string", "example": "Sales" } }, "title": "追跡コード" }, "TranscriptSkillCard": { "description": "ファイルにトランスクリプトを追加するBox Skillメタデータカード。", "type": "object", "properties": { "created_at": { "description": "このカードの作成日時 (省略可)。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00" }, "type": { "description": "値は常に`skill_card`になります。", "type": "string", "example": "skill_card", "enum": [ "skill_card" ] }, "skill_card_type": { "description": "値は常に`transcript`になります。", "type": "string", "example": "transcript", "enum": [ "transcript" ] }, "skill_card_title": { "description": "カードのタイトル。", "type": "object", "properties": { "code": { "description": "タイトルの識別子 (省略可)。", "type": "string", "example": "my_transcripts" }, "message": { "description": "UI上で表示する実際のタイトル。", "type": "string", "example": "My Transcripts" } }, "required": [ "message" ] }, "skill": { "description": "このメタデータを適用したサービス。", "type": "object", "properties": { "type": { "description": "値は常に`service`になります。", "type": "string", "example": "service", "enum": [ "service" ] }, "id": { "description": "このメタデータを適用したサービスを表すカスタム識別子。", "type": "string", "example": "transciption-service" } }, "required": [ "type", "id" ] }, "invocation": { "description": "このサービスの呼び出し。メタデータを適用したサービスのインスタンスを追跡するために使用されます。", "type": "object", "properties": { "type": { "description": "値は常に`skill_invocation`になります。", "type": "string", "example": "skill_invocation", "enum": [ "skill_invocation" ] }, "id": { "description": "このメタデータを適用したサービスのインスタンスを表すカスタム識別子。たとえば、`image-recognition-service`が複数のノードで動作する場合、このフィールドを使用すると、メタデータの適用に使用されたノードのIDを識別できます。", "type": "string", "example": "transciption-service-123" } }, "required": [ "type", "id" ] }, "duration": { "description": "総持続時間 (秒) (省略可)。\n\n`skill_card_type`が`transcript`または`timeline`の場合に使用されます。", "type": "integer", "example": 1000 }, "entries": { "description": "カードのエントリのリスト。これは、書き起こしの個々のエントリを表します。", "type": "array", "items": { "type": "object", "description": "メタデータカードの`entries`属性のエントリ。", "properties": { "text": { "description": "エントリのテキスト。これは、タイムライン上のエントリに割り当てられた書き起こしテキストになります。", "type": "string", "example": "Hi, and welcome to this video..." }, "appears": { "description": "書き起こしテキストが表示される時刻を定義します。これに含まれるのは開始時刻のみで、終了時刻は含まれません。", "type": "array", "items": { "type": "object", "description": "エントリのタイムスタンプ。", "properties": { "start": { "description": "エントリがタイムライン上に表示され始める時間 (秒)。", "type": "integer", "example": 1 } } }, "required": [ "start" ] } } } } }, "required": [ "type", "skill_card_type", "skill", "invocation", "entries" ], "title": "トランスクリプトスキルカード。", "x-box-resource-id": "transcript_skill_card", "x-box-tag": "skills" }, "TrashFile": { "description": "ごみ箱内のファイルを表します。", "type": "object", "properties": { "id": { "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "type": "string", "example": "123456789", "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 }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、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": "ファイルの現在のバージョンに関する情報。" } ] }, "description": { "description": "このファイルの説明 (省略可)。", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 256, "nullable": false }, "size": { "description": "ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。", "type": "integer", "example": 629644, "nullable": false }, "path_collection": { "allOf": [ { "title": "パスのコレクション (ごみ箱)", "description": "ごみ箱内の項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目のパスのコレクションのフォルダの配列。", "type": "array", "items": { "type": "object", "description": "この項目の親フォルダ。", "properties": { "type": { "description": "値は常に`folder`になります。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "フォルダを表す一意の識別子。", "type": "string", "example": "123456789" }, "sequence_id": { "description": "ごみ箱フォルダの場合、このフィールドはnullです。", "type": "string", "example": null, "nullable": true }, "etag": { "description": "ごみ箱フォルダの場合、このフィールドはnullです。", "type": "string", "example": null, "nullable": true }, "name": { "description": "ごみ箱フォルダの名前。", "type": "string", "example": "Trash", "nullable": false } } } } } }, { "description": "ルートフォルダを起点にした、このファイルを含むフォルダツリー。" }, { "nullable": false } ] }, "created_at": { "description": "Box上でこのファイルが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": false }, "modified_at": { "description": "Boxでこのファイルが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": false }, "trashed_at": { "description": "このファイルがごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "purged_at": { "description": "このファイルがごみ箱から削除される予定日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_created_at": { "description": "このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_modified_at": { "description": "このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを作成したユーザー。" } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを最後に変更したユーザー。" }, { "nullable": false } ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを所有するユーザー。" }, { "nullable": false } ] }, "shared_link": { "description": "このファイルの共有リンク。ファイルがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このファイルが配置されているフォルダ。" }, { "nullable": true } ] }, "item_status": { "description": "この項目が削除されたかどうかを定義します。\n\n* `active` - 項目がごみ箱に移動されていない場合。\n* `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。\n* `deleted` - 項目がすでに完全に削除されている場合。", "type": "string", "example": "trashed", "enum": [ "active", "trashed", "deleted" ], "nullable": false } }, "required": [ "id", "type", "sequence_id", "sha1", "description", "size", "path_collection", "created_at", "modified_at", "modified_by", "owned_by", "item_status" ], "title": "ごみ箱内のファイル", "x-box-resource-id": "trash_file", "x-box-tag": "trashed_files" }, "TrashFileRestored": { "description": "ごみ箱から復元されたファイルを表します。", "type": "object", "properties": { "id": { "description": "ファイルを表す一意の識別子。\n\nファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。", "type": "string", "example": "123456789", "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 }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、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": "ファイルの現在のバージョンに関する情報。" } ] }, "description": { "description": "このファイルの説明 (省略可)。", "type": "string", "example": "Contract for Q1 renewal", "maxLength": 256, "nullable": false }, "size": { "description": "ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。", "type": "integer", "example": 629644, "nullable": false }, "path_collection": { "allOf": [ { "title": "パスのコレクション", "description": "項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目の親フォルダ。", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" }, "nullable": false } } }, { "description": "ルートフォルダを起点にした、このファイルを含むフォルダツリー。" }, { "nullable": false } ] }, "created_at": { "description": "Box上でこのファイルが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": false }, "modified_at": { "description": "Boxでこのファイルが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": false }, "trashed_at": { "description": "このファイルがごみ箱に移動された日時。復元後は`null`になります。", "type": "string", "example": null, "nullable": true }, "purged_at": { "description": "このファイルがごみ箱から削除される予定日時。復元後は`null`になります。", "type": "string", "example": null, "nullable": true }, "content_created_at": { "description": "このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_modified_at": { "description": "このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを作成したユーザー。" } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを最後に変更したユーザー。" }, { "nullable": false } ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このファイルを所有するユーザー。" }, { "nullable": false } ] }, "shared_link": { "description": "このファイルの共有リンク。ファイルがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このファイルが配置されているフォルダ。" }, { "nullable": true } ] }, "item_status": { "description": "この項目が削除されたかどうかを定義します。\n\n* `active` - 項目がごみ箱に移動されていない場合。\n* `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。\n* `deleted` - 項目がすでに完全に削除されている場合。", "type": "string", "example": "active", "enum": [ "active", "trashed", "deleted" ], "nullable": false } }, "required": [ "id", "type", "sequence_id", "sha1", "description", "size", "path_collection", "created_at", "modified_at", "modified_by", "owned_by", "item_status" ], "title": "ごみ箱内のファイル (復元済み)", "x-box-resource-id": "trash_file_restored", "x-box-tag": "trashed_files" }, "TrashFolder": { "description": "ごみ箱内のフォルダを表します。", "type": "object", "properties": { "id": { "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。", "type": "string", "example": "123456789", "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 }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。" }, { "nullable": false } ] }, "name": { "description": "フォルダの名前。", "type": "string", "example": "Contracts", "nullable": false }, "created_at": { "description": "このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "modified_at": { "description": "このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "description": { "allOf": [ { "type": "string", "description": "このフォルダの説明 (省略可)。", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false }, { "nullable": false } ] }, "size": { "description": "フォルダサイズ (バイト単位)。\n\nこの整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。", "type": "integer", "format": "int64", "example": 629644, "nullable": false }, "path_collection": { "allOf": [ { "title": "パスのコレクション (ごみ箱)", "description": "ごみ箱内の項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目のパスのコレクションのフォルダの配列。", "type": "array", "items": { "type": "object", "description": "この項目の親フォルダ。", "properties": { "type": { "description": "値は常に`folder`になります。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "フォルダを表す一意の識別子。", "type": "string", "example": "123456789" }, "sequence_id": { "description": "ごみ箱フォルダの場合、このフィールドはnullです。", "type": "string", "example": null, "nullable": true }, "etag": { "description": "ごみ箱フォルダの場合、このフィールドはnullです。", "type": "string", "example": null, "nullable": true }, "name": { "description": "ごみ箱フォルダの名前。", "type": "string", "example": "Trash", "nullable": false } } } } } }, { "description": "ルートフォルダを起点にした、このファイルを含むフォルダツリー。" }, { "nullable": false } ] }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを作成したユーザー。" }, { "nullable": false } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを最後に変更したユーザー。" }, { "nullable": false } ] }, "trashed_at": { "description": "このフォルダがごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "purged_at": { "description": "このフォルダがごみ箱から削除される予定日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_created_at": { "description": "このフォルダが最初に作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_modified_at": { "description": "このフォルダが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを所有するユーザー。" }, { "nullable": false } ] }, "shared_link": { "description": "このフォルダの共有リンク。フォルダがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "folder_upload_email": { "description": "このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、アップロードは動作しなくなるため、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このフォルダが配置されているフォルダ (省略可)\n\nルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。" }, { "nullable": true } ] }, "item_status": { "description": "この項目が削除されたかどうかを定義します。\n\n* `active` - 項目がごみ箱に移動されていない場合。\n* `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。\n* `deleted` - 項目がすでに完全に削除されている場合。", "type": "string", "example": "trashed", "enum": [ "active", "trashed", "deleted" ], "nullable": false } }, "required": [ "id", "type", "name", "description", "size", "path_collection", "created_by", "modified_by", "owned_by", "item_status" ], "title": "ごみ箱内のフォルダ", "x-box-resource-id": "trash_folder", "x-box-tag": "trashed_folders" }, "TrashFolderRestored": { "description": "ごみ箱から復元されたフォルダを表します。", "type": "object", "properties": { "id": { "description": "フォルダを表す一意の識別子。\n\nフォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。", "type": "string", "example": "123456789", "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 }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。" }, { "nullable": false } ] }, "name": { "description": "フォルダの名前。", "type": "string", "example": "Contracts", "nullable": false }, "created_at": { "description": "このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "modified_at": { "description": "このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "description": { "allOf": [ { "type": "string", "description": "このフォルダの説明 (省略可)。", "maxLength": 256, "example": "Legal contracts for the new ACME deal", "nullable": false }, { "nullable": false } ] }, "size": { "description": "フォルダサイズ (バイト単位)。\n\nこの整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。", "type": "integer", "format": "int64", "example": 629644, "nullable": false }, "path_collection": { "allOf": [ { "title": "パスのコレクション", "description": "項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目の親フォルダ。", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" }, "nullable": false } } }, { "description": "ルートフォルダを起点にした、このファイルを含むフォルダツリー。" }, { "nullable": false } ] }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを作成したユーザー。" }, { "nullable": false } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを最後に変更したユーザー。" }, { "nullable": false } ] }, "trashed_at": { "description": "このフォルダがごみ箱に移動された日時。復元後は`null`になります。", "type": "string", "example": null, "nullable": true }, "purged_at": { "description": "このフォルダがごみ箱から削除される予定日時。復元後は`null`になります。", "type": "string", "example": null, "nullable": true }, "content_created_at": { "description": "このフォルダが最初に作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "content_modified_at": { "description": "このフォルダが最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このフォルダを所有するユーザー。" }, { "nullable": false } ] }, "shared_link": { "description": "このファイルの共有リンク。フォルダがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "folder_upload_email": { "description": "このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、元のアップロード用メールアドレスが再度アクティブになっても、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "このフォルダが配置されているフォルダ (省略可)\n\nルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。" }, { "nullable": true } ] }, "item_status": { "description": "この項目が削除されたかどうかを定義します。\n\n* `active` - 項目がごみ箱に移動されていない場合。\n* `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。\n* `deleted` - 項目がすでに完全に削除されている場合。", "type": "string", "example": "active", "enum": [ "active", "trashed", "deleted" ], "nullable": false } }, "title": "ごみ箱内のフォルダ (復元済み)", "x-box-resource-id": "trash_folder_restored", "x-box-tag": "trashed_folders" }, "TrashWebLink": { "description": "ごみ箱内のウェブリンクを表します。", "type": "object", "properties": { "type": { "description": "値は常に`web_link`になります。", "type": "string", "example": "web_link", "enum": [ "web_link" ] }, "id": { "description": "このウェブリンクの一意の識別子。", "type": "string", "example": "11446498" }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。" }, { "nullable": false } ] }, "etag": { "description": "このウェブリンクのエンティティタグ。`If-Match`ヘッダーで使用します。", "type": "string", "example": "1" }, "name": { "description": "ウェブリンクの名前。", "type": "string", "example": "My Bookmark" }, "url": { "description": "このウェブリンクが指すURL。", "type": "string", "example": "https://www.example.com/example/1234" }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "ウェブリンクが属する親オブジェクト。" } ] }, "description": { "description": "ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。", "type": "string", "example": "Example page" }, "path_collection": { "allOf": [ { "title": "パスのコレクション (ごみ箱)", "description": "ごみ箱内の項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目のパスのコレクションのフォルダの配列。", "type": "array", "items": { "type": "object", "description": "この項目の親フォルダ。", "properties": { "type": { "description": "値は常に`folder`になります。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "フォルダを表す一意の識別子。", "type": "string", "example": "123456789" }, "sequence_id": { "description": "ごみ箱フォルダの場合、このフィールドはnullです。", "type": "string", "example": null, "nullable": true }, "etag": { "description": "ごみ箱フォルダの場合、このフィールドはnullです。", "type": "string", "example": null, "nullable": true }, "name": { "description": "ごみ箱フォルダの名前。", "type": "string", "example": "Trash", "nullable": false } } } } } }, { "description": "ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。" }, { "nullable": false } ] }, "created_at": { "description": "このファイルがBoxのサーバー上に作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "このファイルがBoxサーバー上で最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "trashed_at": { "description": "このファイルが最後にごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "purged_at": { "description": "このファイルが完全に削除される日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを作成したユーザー。" } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを最後に変更したユーザー。" } ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを所有するユーザー。" } ] }, "shared_link": { "description": "このブックマークの共有リンク。ブックマークがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "item_status": { "description": "この項目が削除されたかどうか。値には、`active`、`trashed` (ファイルがごみ箱に移動された場合)、`deleted` (ファイルが完全に削除された場合) があります。", "type": "string", "example": "trashed", "enum": [ "active", "trashed", "deleted" ] } }, "title": "ごみ箱内のウェブリンク", "x-box-resource-id": "trash_web_link", "x-box-tag": "trashed_web_links" }, "TrashWebLinkRestored": { "description": "ごみ箱から復元されたウェブリンクを表します。", "type": "object", "properties": { "type": { "description": "値は常に`web_link`になります。", "type": "string", "example": "web_link", "enum": [ "web_link" ] }, "id": { "description": "このウェブリンクの一意の識別子。", "type": "string", "example": "11446498" }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。" }, { "nullable": false } ] }, "etag": { "description": "このウェブリンクのエンティティタグ。`If-Match`ヘッダーで使用します。", "type": "string", "example": "1" }, "name": { "description": "ウェブリンクの名前。", "type": "string", "example": "My Bookmark" }, "url": { "description": "このウェブリンクが指すURL。", "type": "string", "example": "https://www.example.com/example/1234" }, "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "ウェブリンクが属する親オブジェクト。" } ] }, "description": { "description": "ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。", "type": "string", "example": "Example page" }, "path_collection": { "allOf": [ { "title": "パスのコレクション", "description": "項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目の親フォルダ。", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" }, "nullable": false } } }, { "description": "ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。" }, { "nullable": false } ] }, "created_at": { "description": "このファイルがBoxのサーバー上に作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "このファイルがBoxサーバー上で最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "trashed_at": { "description": "このブックマークがごみ箱に移動された日時。復元後は`null`になります。", "type": "string", "example": null, "nullable": true }, "purged_at": { "description": "このブックマークが完全に削除される予定日時。復元後は`null`になります。", "type": "string", "example": null, "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを作成したユーザー。" } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを最後に変更したユーザー。" } ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを所有するユーザー。" } ] }, "shared_link": { "description": "このブックマークの共有リンク。ブックマークがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これは`null`になります。", "type": "string", "example": null, "nullable": true }, "item_status": { "description": "この項目が削除されたかどうか。値には、`active`、`trashed` (ファイルがごみ箱に移動された場合)、`deleted` (ファイルが完全に削除された場合) があります。", "type": "string", "example": "trashed", "enum": [ "active", "trashed", "deleted" ] } }, "required": [ "sequence_id", "path_collection" ], "title": "ごみ箱内のウェブリンク (復元済み)", "x-box-resource-id": "trash_web_link_restored", "x-box-tag": "trashed_web_links" }, "UploadPart": { "description": "アップロードセッションチャンクのレプリゼンテーション。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/UploadPart--Mini" }, { "properties": { "sha1": { "description": "チャンクのSHA1ハッシュ。", "type": "string", "example": "134b65991ed521fcfe4724b7d814ab8ded5185dc" } } } ], "title": "Upload part", "x-box-resource-id": "upload_part", "x-box-variant": "standard" }, "UploadPart--Mini": { "description": "アップロードセッションチャンクのBase版の表示。", "type": "object", "properties": { "part_id": { "description": "チャンクの一意のID。", "type": "string", "example": "6F2D3486" }, "offset": { "description": "ファイル内のチャンクのオフセット (バイト数)。ファイル内のチャンクの位置の下限です。", "type": "integer", "format": "int64", "example": 16777216 }, "size": { "description": "チャンクのサイズ (バイト単位)。", "type": "integer", "format": "int64", "example": 3222784 } }, "title": "パーツのアップロード (Mini)", "x-box-resource-id": "upload_part--mini", "x-box-tag": "chunked_uploads", "x-box-variant": "mini", "x-box-variants": [ "mini", "standard" ] }, "UploadParts": { "description": "アップロードセッションのアップロード済みチャンクのリスト。", "type": "object", "allOf": [ { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "アップロードセッションのアップロード済みチャンクのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/UploadPart" } } } } ], "title": "Upload part", "x-box-resource-id": "upload_parts", "x-box-tag": "chunked_uploads" }, "UploadSession": { "description": "ファイルをアップロードするチャンクのアップロードセッション。", "type": "object", "properties": { "id": { "description": "このセッションの一意の識別子。", "type": "string", "example": "F971964745A5CD0C001BBE4E58196BFD" }, "type": { "description": "値は常に`upload_session`になります。", "type": "string", "example": "upload_session", "enum": [ "upload_session" ] }, "session_expires_at": { "description": "このセッションが期限切れになる日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "part_size": { "description": "アップロードのすべての部分で使用する必要があるサイズ (バイト単位)。\n\n最後の部分のみ、これより小さいサイズを使用できます。", "type": "integer", "format": "int64", "example": 1024 }, "total_parts": { "description": "ファイルのサイズとパーツのサイズで決定される、このアップロードセッションで予想されるパーツの総数。", "type": "integer", "format": "int32", "example": 1000 }, "num_parts_processed": { "description": "アップロードが完了し、サーバーで処理されたパーツの数。値は`0`から始まります。\n\nファイルをコミットするときにこのプロパティを調べることで、すべてのパーツが正しくアップロードされているかどうかを確認できます。", "type": "integer", "format": "int32", "example": 455 }, "session_endpoints": { "allOf": [ { "title": "セッションエンドポイント", "description": "分割アップロードセッションに使用されるエンドポイントのリスト。", "type": "object", "properties": { "upload_part": { "description": "パーツのアップロード先のURL。", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" }, "commit": { "description": "ファイルのコミットに使用されるURL。", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/commit" }, "abort": { "description": "セッションの中止に使用されるURL。", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" }, "list_parts": { "description": "すべてのパーツのリストを取得するためのURL。", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/parts" }, "status": { "description": "アップロードステータスの取得に使用されるURL。", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD" }, "log_event": { "description": "アップロードログの取得に使用されるURL。", "type": "string", "example": "https://{box-upload-server}/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E58196BFD/log" } } }, { "description": "このセッションに使用されるエンドポイントのリスト。" } ] } }, "title": "アップロードセッション", "x-box-resource-id": "upload_session", "x-box-tag": "chunked_uploads" }, "UploadUrl": { "description": "ファイルのアップロードセッションの詳細。", "type": "object", "properties": { "upload_url": { "description": "ファイルのアップロードに使用できるアップロードセッションのURL。", "type": "string", "example": "https://upload-las.app.box.com/api/2.0/files/content?upload_session_id=1234" }, "upload_token": { "description": "ファイルをアップロードするために使用するアクセストークン (省略可)。", "type": "string", "example": "Pc3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQP" } }, "title": "アップロードURL", "x-box-resource-id": "upload_url", "x-box-tag": "uploads" }, "UploadedPart": { "description": "いくつかのエンドポイントで返されるように、アップロードセッションの一部としてアップロードされたファイルのチャンク。", "type": "object", "properties": { "part": { "$ref": "#/components/schemas/UploadPart" } }, "title": "アップロードされたパーツ", "x-box-resource-id": "uploaded_part", "x-box-tag": "chunked_uploads" }, "User": { "description": "任意のユーザーAPIエンドポイントからデフォルトで返されるユーザーのStandard版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "properties": { "created_at": { "description": "ユーザーオブジェクトが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "ユーザーオブジェクトが最後に変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "language": { "description": "修正版の[ISO 639-1](/guides/api-calls/language-codes)形式で表されるユーザーの言語。", "type": "string", "example": "en" }, "timezone": { "description": "ユーザーのタイムゾーン。", "type": "string", "format": "timezone", "example": "Africa/Bujumbura" }, "space_amount": { "description": "ユーザーが利用可能な容量の合計 (バイト数)。", "type": "integer", "format": "int64", "example": 11345156112 }, "space_used": { "description": "ユーザーが現在使用している容量。", "type": "integer", "format": "int64", "example": 1237009912 }, "max_upload_size": { "description": "ユーザーが所有できる個々のファイルの最大サイズ (バイト単位)。", "type": "integer", "format": "int64", "example": 2147483648 }, "status": { "description": "ユーザーのアカウントのステータス。", "type": "string", "example": "active", "enum": [ "active", "inactive", "cannot_delete_edit", "cannot_delete_edit_upload" ] }, "job_title": { "description": "ユーザーの役職。", "type": "string", "example": "CEO", "maxLength": 100 }, "phone": { "description": "ユーザーの電話番号。", "type": "string", "example": "6509241374", "maxLength": 100 }, "address": { "description": "ユーザーの住所。", "type": "string", "example": "900 Jefferson Ave, Redwood City, CA 94063", "maxLength": 255 }, "avatar_url": { "description": "ユーザーのアバター画像のURL。", "type": "string", "example": "https://www.box.com/api/avatar/large/181216415" }, "notification_email": { "description": "通知メールが送信される代替の通知用メールアドレス。確認されると、通知メールはプライマリメールアドレスではなくこのメールアドレスに送信されます。", "type": "object", "nullable": true, "properties": { "email": { "description": "通知を送付するメールアドレス。", "type": "string", "example": "notifications@example.com" }, "is_confirmed": { "description": "このメールアドレスが確認されたかどうかを指定します。", "type": "boolean", "example": true } } } } } ], "title": "User", "x-box-resource-id": "user", "x-box-variant": "standard" }, "User--Base": { "description": "他のリソース内にネストされたときに使用されるユーザーのMini版の表示。", "type": "object", "properties": { "id": { "description": "このユーザーの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`user`になります。", "type": "string", "example": "user", "enum": [ "user" ], "nullable": false } }, "required": [ "type", "id" ], "title": "ユーザー (Base)", "x-box-resource-id": "user--base", "x-box-tag": "users", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard", "full" ] }, "User--Collaborations": { "description": "ユーザーのMini版の表示は、ステータスが`pending`の場合にのみ返すことができます。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "properties": { "name": { "description": "このユーザーの表示名。コラボレーションのステータスが`pending`の場合、空の文字列が返されます。", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { "description": "このユーザーのプライマリメールアドレス。コラボレーションのステータスが`pending`の場合、空の文字列が返されます。", "type": "string", "format": "email", "example": "ceo@example.com", "nullable": false }, "is_active": { "description": "`false`に設定した場合、ユーザーは非アクティブになるか削除されます。", "type": "boolean", "example": true } } } ], "title": "ユーザー (コラボレーション)", "x-box-resource-id": "user_collaborations" }, "User--Full": { "description": "任意のユーザーAPIエンドポイントから返される可能性があるユーザーのFull版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User" }, { "properties": { "role": { "description": "ユーザーの企業でのロール。", "type": "string", "example": "admin", "enum": [ "admin", "coadmin", "user" ] }, "tracking_codes": { "description": "追跡コードを使用すると、管理者は管理コンソールからレポートを生成し、特定のグループのユーザーに属性を割り当てることができます。この設定を使用するには、会社に対して有効にしておく必要があります。", "type": "array", "items": { "$ref": "#/components/schemas/TrackingCode" } }, "can_see_managed_users": { "description": "ユーザーが自身の連絡先リストで企業の他のユーザーを参照できるかどうか。", "type": "boolean", "example": true }, "is_sync_enabled": { "description": "ユーザーがBox Syncを使用できるかどうか。", "type": "boolean", "example": true }, "is_external_collab_restricted": { "description": "ユーザーが社外のユーザーとのコラボレーションを許可されているかどうか。", "type": "boolean", "example": true }, "is_exempt_from_device_limits": { "description": "企業のデバイス制限からユーザーを除外するかどうか。", "type": "boolean", "example": true }, "is_exempt_from_login_verification": { "description": "ユーザーが2要素認証を使用する必要があるかどうか。", "type": "boolean", "example": true }, "enterprise": { "allOf": [ { "title": "Enterprise", "type": "object", "description": "Box Enterpriseのレプリゼンテーション。", "properties": { "id": { "description": "この会社の一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`enterprise`になります。", "type": "string", "example": "enterprise", "enum": [ "enterprise" ] }, "name": { "description": "企業の名前。", "type": "string", "example": "Acme Inc." } } }, { "description": "ユーザーの企業のレプリゼンテーション。" } ] }, "my_tags": { "description": "ユーザーが所有するすべてのファイルとフォルダのタグ。返される値にはリクエスト元によって設定されたタグのみが含まれます。", "type": "array", "items": { "type": "string" }, "example": [ "important" ] }, "hostname": { "description": "ユーザーに対して生成する必要があるリンクのルート (プロトコル、サブドメイン、ドメイン)。", "type": "string", "example": "https://example.app.box.com/" }, "is_platform_access_only": { "description": "ユーザーがApp Userであるかどうか。", "type": "boolean", "example": true }, "external_app_user_id": { "description": "ユーザーの検索に使用できる、App Userの外部識別子。これを使用して、外部IDプロバイダのユーザーIDをBoxユーザーに結び付けることができます。", "type": "string", "example": "my-user-1234" } } } ], "title": "ユーザー (Full)", "x-box-resource-id": "user--full", "x-box-variant": "full" }, "User--Mini": { "description": "他のリソース内にネストされたときに返される可能性があるユーザーのMini版の表示。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "properties": { "name": { "description": "このユーザーの表示名。", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { "description": "このユーザーのプライマリメールアドレス。", "type": "string", "format": "email", "example": "ceo@example.com", "nullable": false } } } ], "title": "ユーザー (Mini)", "x-box-resource-id": "user--mini", "x-box-variant": "mini" }, "UserAvatar": { "description": "BoxアプリケーションにアップロードされたアバターへのURLを保持するリソース。", "type": "object", "properties": { "pic_urls": { "description": "ユーザーのアバターのURLを示すオブジェクトを表します。", "type": "object", "properties": { "small": { "description": "小さいサイズのアバターの場所。", "type": "string", "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks! pac3kv01!7B6R5cZLmurEV_xB-KkycPk8Oi7oENUX2O_qUtIuO4342CG IldyCto9hqiQP7uxqYU5V2w63Ft4ln4UVVLDtDZu903OqzkflY2O-Lq00 ubA29xU-RJ6b_KzJEWRYgUhX1zEl3dzWo12g8eWRE2rStf123DF7AYahNqM 1BmLmviL_nODc7SDQHedTXPAjxURUAra5BvtLe7B05AizbNXdPlCNp-LNh _S-eZ_RjDXcGO-MkRWd_3BOMHnvjf450t5BfKoJ15WhEfiMlfXH1tmouHXrsC 66cT6-pzF9E40Iir_zThqSlrFxzP_xcmXzHapr_k-0E2qr2TXp4iC396TSlEw\n" }, "large": { "description": "大きいサイズのアバターの場所。", "type": "string", "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks\npac3kv01!lipGQlQQOtCTCoB6zCOArUjVWLFJtLr5tn6aOZMCybhRx0NNuFQbVI36nw\njtEk5YjUUz1KVdVuvU2yDhu_ftK_bvxeKP1Ffrx9vKGVvJ-UJc1z32p6n2CmFzzpc\ngSoX4pnPhFgydAL-u9jDspXUGElr-htDG_HPMiE9DZjqDueOxXHy8xe22wbaPAheC\nao1emv8r_fmufaUgSndeMYmyZj-KqOYsLBrBNgdeiK5tZmPOQggAEUmyQPkrd8W92TQ6sSlIp0r" }, "preview": { "description": "アバターのプレビューの場所。", "type": "string", "example": "https://app.box.com/index.php?rm=pic_storage_auth&pic=euks!\npac3kv01!8UcNPweOOAWj2DtHk_dCQB4wJpzyPkl7mT5nHj5ZdjY92ejYCBBZc95--403b29CW\nk-8hSo_uBjh5h9QG42Ihu-cOZ-816sej1kof3SOm5gjn7qjMAx89cHjUaNK-6XasRqSNboenjZ\n04laZuV9vSH12BZGAYycIZvvQ5R66Go8xG5GTMARf2nBU84c4H_SL5iws-HeBS4oQJWOJh6FBl\nsSJDSTI74LGXqeZb3EY_As34VFC95F10uozoTOSubZmPYylPlaKXoKWk2f9wYQso1ZTN7sh-Gc\n9Kp43zMLhArIWhok0Im6FlRAuWOQ03KYgL-k4L5EZp4Gw6B7uqVRwcBbsTwMIorWq1g" } } } }, "title": "ユーザーのアバター", "x-box-resource-id": "user_avatar", "x-box-tag": "avatars" }, "UserIntegrationMappings": { "description": "統合マッピングAPIのためのユーザーのレプリゼンテーション。フィールド名とログインは必要ありません。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "properties": { "name": { "description": "このユーザーの表示名。", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { "description": "このユーザーのプライマリメールアドレス。", "type": "string", "format": "email", "example": "ceo@example.com", "nullable": false } } } ], "title": "ユーザー (統合マッピング)", "x-box-resource-id": "user_integration_mappings_reference", "x-box-tag": "users" }, "Users": { "description": "ユーザーのリスト。", "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 } } }, { "type": "object", "description": "ページ割りについて説明しているAPIレスポンスの部分。", "properties": { "total_count": { "description": "コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 5000 }, "limit": { "description": "これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。", "type": "integer", "format": "int64", "example": 1000 }, "offset": { "description": "このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "integer", "format": "int64", "example": 2000 }, "order": { "description": "項目が返される順序。\n\nこのフィールドは、オフセットベースのページ割りを使用する呼び出しのみで返されます。マーカーベースでページ割りされたAPIでは、このフィールドは省略されます。", "type": "array", "items": { "type": "object", "description": "ページ割りの順序。", "properties": { "by": { "description": "並べ替えに使用するフィールド。", "type": "string", "example": "type" }, "direction": { "description": "並べ替えの方向 (昇順または降順)。", "type": "string", "example": "ASC", "enum": [ "ASC", "DESC" ] } } } } } }, { "properties": { "entries": { "description": "ユーザーのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/User--Full" } } } } ], "title": "Users", "x-box-resource-id": "users", "x-box-tag": "users" }, "Watermark": { "description": "電子すかしとは、埋め込みファイルのプレビューに適用される半透明のオーバーレイです。電子すかしには、ビューアーのメールアドレスまたはユーザーIDと、ファイルのコンテンツのアクセス日時が表示されます。", "type": "object", "properties": { "watermark": { "type": "object", "properties": { "created_at": { "description": "この電子すかしが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "このタスクが変更された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } } } }, "title": "Watermark", "x-box-resource-id": "watermark", "x-box-tag": "file_watermarks" }, "WebLink": { "description": "ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。\n\nウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/WebLink--Mini" }, { "properties": { "parent": { "allOf": [ { "$ref": "#/components/schemas/Folder--Mini" }, { "description": "ウェブリンクが属する親オブジェクト。" } ] }, "description": { "description": "ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。", "type": "string", "example": "Example page" }, "path_collection": { "allOf": [ { "title": "パスのコレクション", "description": "項目の親フォルダのリスト。", "type": "object", "required": [ "total_count", "entries" ], "properties": { "total_count": { "description": "このリスト内のフォルダの数。", "type": "integer", "format": "int64", "example": 1, "nullable": false }, "entries": { "description": "この項目の親フォルダ。", "type": "array", "items": { "$ref": "#/components/schemas/Folder--Mini" }, "nullable": false } } }, { "description": "ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。" }, { "nullable": false } ] }, "created_at": { "description": "このファイルがBoxのサーバー上に作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "このファイルがBoxサーバー上で最後に更新された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "trashed_at": { "description": "このファイルがごみ箱に移動された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "purged_at": { "description": "このファイルが完全に削除される日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを作成したユーザー。" } ] }, "modified_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを最後に変更したユーザー。" } ] }, "owned_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "このウェブリンクを所有するユーザー。" } ] }, "shared_link": { "allOf": [ { "title": "共有リンク", "description": "共有リンクを作成すると、Box上のファイルやフォルダに対する読み取り専用アクセスを直接実行できます。\n\nアクセスレベルがopenに設定されている共有リンクの場合は、URLを知っているすべてのユーザーが項目にアクセスでき、アクセスレベルがcompanyまたはcollaboratorsに設定されている共有リンクの場合は、適切に認証されたBoxユーザーのみが項目にアクセスできます。", "type": "object", "required": [ "url", "accessed", "effective_access", "effective_permission", "is_password_enabled", "download_count", "preview_count" ], "properties": { "url": { "description": "Box上の項目にアクセスするために使用できるURL。\n\nこのURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。\n\nこのURLは、この共有リンクに対してカスタムの`vanity_url`が 設定されている場合でも動作します。", "type": "string", "format": "url", "example": "https://www.box.com/s/vspke7y05sb214wjokpk", "nullable": false }, "download_url": { "description": "ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。\n\nフォルダの場合、このプロパティは`null`になります。", "type": "string", "format": "url", "example": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "nullable": true, "x-box-premium-feature": true }, "vanity_url": { "description": "Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。", "type": "string", "format": "url", "example": "https://acme.app.box.com/v/my_url/", "nullable": true }, "vanity_name": { "description": "`vanity_url`フィールドで使用される、共有リンクのカスタム名。", "type": "string", "example": "my_url", "nullable": true }, "access": { "description": "この共有リンクのアクセスレベル\n\n* `open` - このリンクを知っている全員にこの項目へのアクセスを許可します\n* `company` - 同じ会社のユーザーにのみこの項目へのアクセスを許可します\n* `collaborators` - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します\n\n共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。", "type": "string", "example": "open", "enum": [ "open", "company", "collaborators" ], "nullable": false }, "effective_access": { "description": "共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、`access`フィールドの値よりも低いアクセスレベルになることがあります。", "type": "string", "example": "company", "enum": [ "open", "company", "collaborators" ], "nullable": false }, "effective_permission": { "description": "この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。", "type": "string", "example": "can_download", "enum": [ "can_edit", "can_download", "can_preview", "no_access" ], "nullable": false }, "unshared_at": { "description": "このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。", "type": "string", "format": "date-time", "example": "2018-04-13T13:53:23-07:00", "nullable": true }, "is_password_enabled": { "description": "共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。", "type": "boolean", "example": true, "nullable": false }, "permissions": { "description": "このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。", "type": "object", "properties": { "can_download": { "description": "共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。\n\n実際のアクセスレベルが`collaborators`ではなく、`open`または`company`に設定されている場合は、この値を`true`に設定できます。", "type": "boolean", "example": true, "nullable": false }, "can_preview": { "description": "共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。\n\nこの値は常に`true`です。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。", "type": "boolean", "example": true, "nullable": false }, "can_edit": { "description": "共有リンクからの項目の編集を許可するかどうかを定義します。\n\n`can_download`が`true`で、項目のタイプが`file`の場合のみ、この値も`true`に設定できます。", "type": "boolean", "example": false, "nullable": false } }, "required": [ "can_download", "can_preview", "can_edit" ] }, "download_count": { "description": "この項目がダウンロードされた回数。", "type": "integer", "example": 3, "nullable": false }, "preview_count": { "description": "この項目がプレビューされた回数。", "type": "integer", "example": 3, "nullable": false } } }, { "description": "この項目の共有リンクオブジェクト。共有リンクがまだ作成されていない場合は、`null`になります。" }, { "nullable": true } ] }, "item_status": { "description": "この項目が削除されたかどうか。値には、`active`、`trashed` (ファイルがごみ箱に移動された場合)、`deleted` (ファイルが完全に削除された場合) があります。", "type": "string", "example": "active", "enum": [ "active", "trashed", "deleted" ] } } } ], "title": "ウェブリンク", "x-box-resource-id": "web_link", "x-box-variant": "standard" }, "WebLink--Base": { "description": "ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。\n\nウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。", "type": "object", "properties": { "id": { "description": "このウェブリンクの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`web_link`になります。", "type": "string", "example": "web_link", "enum": [ "web_link" ] }, "etag": { "description": "このウェブリンクのエンティティタグ。`If-Match`ヘッダーで使用します。", "type": "string", "example": "1" } }, "required": [ "id", "type" ], "title": "ウェブリンク (Base)", "x-box-resource-id": "web_link--base", "x-box-tag": "web_links", "x-box-variant": "base", "x-box-variants": [ "base", "mini", "standard" ] }, "WebLink--Mini": { "description": "ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。\n\nウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/WebLink--Base" }, { "properties": { "url": { "description": "このウェブリンクが指すURL。", "type": "string", "example": "https://www.example.com/example/1234" }, "sequence_id": { "allOf": [ { "type": "string", "example": "3", "nullable": true, "description": "この項目に適用された最新のUser Eventを表す数値の識別子。\n\nこれを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。\n\nたとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。" }, { "nullable": false } ] }, "name": { "description": "ウェブリンクの名前。", "type": "string", "example": "My Bookmark" } } } ], "title": "ウェブリンク (Mini)", "x-box-resource-id": "web_link--mini", "x-box-variant": "mini" }, "Webhook": { "description": "設定されたWebhookを表します。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Webhook--Mini" }, { "properties": { "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "Webhookを作成したユーザー。" } ] }, "created_at": { "description": "Webhookが作成された日時を示すタイムスタンプ。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "address": { "description": "このWebhookによって通知されるURL。", "type": "string", "example": "https://example.com/webhooks" }, "triggers": { "description": "このWebhookがトリガーされるイベント名の配列。", "type": "array", "items": { "title": "Webhookトリガー", "example": "FILE.UPLOADED", "type": "string", "description": "このWebhookをトリガーしたイベント名。", "enum": [ "FILE.UPLOADED", "FILE.PREVIEWED", "FILE.DOWNLOADED", "FILE.TRASHED", "FILE.DELETED", "FILE.RESTORED", "FILE.COPIED", "FILE.MOVED", "FILE.LOCKED", "FILE.UNLOCKED", "FILE.RENAMED", "COMMENT.CREATED", "COMMENT.UPDATED", "COMMENT.DELETED", "TASK_ASSIGNMENT.CREATED", "TASK_ASSIGNMENT.UPDATED", "METADATA_INSTANCE.CREATED", "METADATA_INSTANCE.UPDATED", "METADATA_INSTANCE.DELETED", "FOLDER.CREATED", "FOLDER.RENAMED", "FOLDER.DOWNLOADED", "FOLDER.RESTORED", "FOLDER.DELETED", "FOLDER.COPIED", "FOLDER.MOVED", "FOLDER.TRASHED", "WEBHOOK.DELETED", "COLLABORATION.CREATED", "COLLABORATION.ACCEPTED", "COLLABORATION.REJECTED", "COLLABORATION.REMOVED", "COLLABORATION.UPDATED", "SHARED_LINK.DELETED", "SHARED_LINK.CREATED", "SHARED_LINK.UPDATED", "SIGN_REQUEST.COMPLETED", "SIGN_REQUEST.DECLINED", "SIGN_REQUEST.EXPIRED", "SIGN_REQUEST.SIGNER_EMAIL_BOUNCED", "SIGN_REQUEST.SIGN_SIGNER_SIGNED", "SIGN_REQUEST.SIGN_DOCUMENT_CREATED", "SIGN_REQUEST.SIGN_ERROR_FINALIZING" ] }, "example": [ "FILE.UPLOADED" ] } } } ], "title": "Webhook", "x-box-resource-id": "webhook", "x-box-tag": "webhooks", "x-box-variant": "standard" }, "Webhook--Mini": { "description": "設定されたWebhookを表します。", "type": "object", "properties": { "id": { "description": "このWebhookの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`webhook`になります。", "type": "string", "example": "webhook", "enum": [ "webhook" ] }, "target": { "description": "Webhookをトリガーする項目。", "type": "object", "properties": { "id": { "description": "Webhookをトリガーする項目のID。", "type": "string", "example": "1231232" }, "type": { "description": "Webhookをトリガーする項目のタイプ。", "type": "string", "example": "file", "enum": [ "file", "folder" ] } } } }, "title": "Webhook (Mini)", "x-box-resource-id": "webhook--mini", "x-box-tag": "webhooks", "x-box-variant": "mini", "x-box-variants": [ "mini", "standard" ] }, "Webhooks": { "description": "Webhookのリスト。", "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": "Webhookのリスト。", "type": "array", "items": { "$ref": "#/components/schemas/Webhook--Mini" } } } } ], "title": "Webhooks", "x-box-resource-id": "webhooks", "x-box-tag": "webhooks" }, "Workflow": { "description": "Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。\n\nアプリケーションは、このリソースを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Workflow--Mini" }, { "properties": { "flows": { "description": "ワークフローに割り当てられているフローのリスト。", "type": "array", "items": { "type": "object", "description": "Box Relayワークフロー内のステップ。各フローには、`Trigger`のほか、`Trigger`の条件が満たされた場合に実行する結果のコレクションが含まれています。", "properties": { "id": { "description": "フローのID。", "type": "string", "example": "12345" }, "type": { "description": "フローのリソースの種類。", "type": "string", "example": "flow", "enum": [ "flow" ] }, "trigger": { "allOf": [ { "type": "object", "properties": { "type": { "description": "トリガーのリソースの種類。", "type": "string", "example": "trigger", "enum": [ "trigger" ] }, "trigger_type": { "description": "このフローに選択されているトリガーのタイプ。", "type": "string", "example": "WORKFLOW_MANUAL_START", "enum": [ "WORKFLOW_MANUAL_START" ] }, "scope": { "description": "トリガースコープのリスト。", "type": "array", "items": { "type": "object", "description": "トリガーの条件が満たされる場所と方法を説明するオブジェクト。", "properties": { "type": { "description": "トリガースコープのリソースの種類。", "type": "string", "example": "trigger_scope", "enum": [ "trigger_scope" ] }, "ref": { "description": "確認する条件値のパスを示します。", "type": "string", "example": "/event/source/parameters/folder" }, "object": { "description": "`ref`が指すオブジェクト。", "type": "object", "properties": { "type": { "description": "オブジェクトのタイプ。", "type": "string", "example": "folder", "enum": [ "folder" ] }, "id": { "description": "オブジェクトのID。", "type": "string", "example": "12345" } } } } } } } }, { "description": "フローを開始するトリガー。" } ] }, "outcomes": { "allOf": [ { "type": "array", "items": { "type": "object", "description": "トリガーの条件が満たされた場合に実行する結果のリスト。", "properties": { "id": { "description": "結果のID。", "type": "string", "example": "12345" }, "type": { "description": "結果のリソースの種類。", "type": "string", "example": "outcome", "enum": [ "outcome" ] }, "name": { "description": "結果の名前。", "type": "string", "example": "Task Approval Outcome" }, "action_type": { "allOf": [ { "title": "操作の種類", "example": "assign_task", "type": "string", "description": "結果の種類。", "enum": [ "add_metadata", "assign_task", "copy_file", "copy_folder", "create_folder", "delete_file", "delete_folder", "lock_file", "move_file", "move_folder", "remove_watermark_file", "rename_folder", "restore_folder", "share_file", "share_folder", "unlock_file", "upload_file", "wait_for_task", "watermark_file", "go_back_to_step", "apply_file_classification", "apply_folder_classification", "send_notification" ] }, { "description": "結果の種類。" } ] }, "if_rejected": { "description": "`action_type`が`assign_task`の場合にタスクが拒否されると、完了すべき結果のリストが返されます。", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "結果のID。", "type": "string", "example": "12345" }, "type": { "description": "結果のリソースの種類。", "type": "string", "example": "outcome", "enum": [ "outcome" ] }, "name": { "description": "結果の名前。", "type": "string", "example": "Approval Rejection Outcome" }, "action_type": { "allOf": [ { "title": "操作の種類", "example": "assign_task", "type": "string", "description": "結果の種類。", "enum": [ "add_metadata", "assign_task", "copy_file", "copy_folder", "create_folder", "delete_file", "delete_folder", "lock_file", "move_file", "move_folder", "remove_watermark_file", "rename_folder", "restore_folder", "share_file", "share_folder", "unlock_file", "upload_file", "wait_for_task", "watermark_file", "go_back_to_step", "apply_file_classification", "apply_folder_classification", "send_notification" ] }, { "description": "結果の種類。" } ] } } } } } } }, { "description": "フローがトリガーされたら完了する操作。" } ] }, "created_at": { "description": "このフローが作成された日時。", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "このフローを作成したユーザー。" } ] } } } } } } ], "title": "Workflow", "x-box-resource-id": "workflow", "x-box-variant": "standard" }, "Workflow--Mini": { "description": "Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。\n\nアプリケーションは、このリソースを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。", "type": "object", "properties": { "id": { "description": "ワークフローの一意の識別子。", "type": "string", "example": "11446498" }, "type": { "description": "値は常に`workflow`になります。", "type": "string", "example": "workflow", "enum": [ "workflow" ] }, "name": { "description": "ワークフローの名前。", "type": "string", "example": "New Hire Workflow" }, "description": { "description": "ワークフローの説明", "type": "string", "example": "This workflow sets off a new hire approval flow" }, "is_enabled": { "description": "このワークフローが有効かどうかを指定します。", "type": "boolean", "example": true } }, "title": "ワークフロー (Mini)", "x-box-resource-id": "workflow--mini", "x-box-tag": "workflows", "x-box-variant": "mini", "x-box-variants": [ "mini", "standard" ] }, "Workflows": { "description": "ワークフローのリスト。\n\nアプリケーションは、このリソースを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。", "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/Workflow" } } } } ], "title": "ワークフロー (リスト)", "x-box-resource-id": "workflows", "x-box-tag": "workflows" }, "ZipDownload": { "description": "ファイルやフォルダのリストの`zip`アーカイブを作成するリクエストが成功したことを表します。", "type": "object", "properties": { "download_url": { "description": "`zip`アーカイブのダウンロードに使用できるURL。このURLに対する`Get`リクエストにより、リクエストされた項目のストリーミングが開始されます。デフォルトでは、このURLは、ダウンロードが開始されない限り、`expires_at`の時間までの数秒間だけ有効です。ダウンロードが開始されると、ダウンロードしている間は有効です。\n\nこのURLのドメインとパスは、APIコール間で変更される可能性があるため、このURLをそのまま使用することが重要です。", "type": "string", "example": "https://dl.boxcloud.com/2.0/zip_downloads/Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd/content" }, "status_url": { "description": "ダウンロード中の`zip`アーカイブのステータスを取得するために使用できるURL。このURLに対する`Get`リクエストにより、アーカイブ内のファイル数に加え、すでにダウンロードまたはスキップされた項目の数が返されます。デフォルトでは、このURLは、ダウンロードが開始されない限り、`expires_at`の時間までの数秒間だけ有効です。ダウンロードの開始後、このURLは12時間有効です。\n\nこのURLのドメインとパスは、APIコール間で変更される可能性があるため、このURLをそのまま使用することが重要です。", "type": "string", "example": "https://api.box.com/2.0/zip_downloads/Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd/status" }, "expires_at": { "description": "このアーカイブの有効期限が切れる日時。この日時を経過すると、`status_url`と`download_url`によってエラーが返されます。\n\nデフォルトでは、このURLは、ダウンロードが開始されない限り、`download_url`の時間までの数秒間だけ有効です。ダウンロードが開始されると、ダウンロードしている間は有効です。また、`status_url`の有効期間は、ダウンロードを開始してから12時間です。", "type": "string", "format": "date-time", "example": "2019-08-29T23:59:00-07:00" }, "name_conflicts": { "description": "アーカイブを作成しようとしたときに発生した競合のリスト。これは、複数の項目が同じ名前でリクエストされたときに発生します。\n\nこれらの競合を解決するために、APIでは、自動的に項目の名前を変更し、項目の元の名前と新しい名前の間のマッピングを返します。\n\n競合ごとに、両方のファイル名が変更されるため、このリストは常に2の倍数になります。", "type": "array", "items": { "type": "array", "description": "アーカイブを作成しようとしたときに発生した個々の競合。これには、2個のオブジェクトからなる配列が含まれています。各オブジェクトには、名前が競合したファイルまたはフォルダの元の名前と変更後のファイル名が格納されています。", "items": { "type": "object", "description": "競合が発生したファイルまたはフォルダ。このオブジェクトにより、元の項目のタイプと識別子に加えて、項目の元の名前とアーカイブで表示される新しい名前の間のマッピングが提供されます。", "properties": { "id": { "description": "項目の識別子。", "type": "string", "example": "12345" }, "type": { "description": "この項目のタイプ。", "type": "string", "example": "file", "enum": [ "file", "folder" ] }, "original_name": { "description": "Box Developerドキュメント。", "type": "string", "example": "Report.pdf" }, "download_name": { "description": "ダウンロードされた`zip`アーカイブで表示される項目の新しい名前。", "type": "string", "example": "3aa6a7.pdf" } } } } } }, "example": { "download_url": "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content", "status_url": "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status", "expires_at": "2020-07-22T11:26:08Z", "name_conflicts": [ [ { "id": "12345", "type": "file", "original_name": "Report.pdf", "download_name": "3aa6a7.pdf" }, { "id": "34325", "type": "file", "original_name": "Report.pdf", "download_name": "5d53f2.pdf" } ] ] }, "title": "zipダウンロード", "x-box-reference-category": "zip_downloads", "x-box-resource-id": "zip_download", "x-box-tag": "zip_downloads" }, "ZipDownloadRequest": { "description": "ダウンロードする`zip`アーカイブを作成するリクエスト。", "type": "object", "properties": { "items": { "description": "`zip`アーカイブに追加する項目のリスト。項目にはファイルまたはフォルダを指定できます。", "type": "array", "items": { "type": "object", "description": "`zip`アーカイブに追加する項目。項目にはファイルまたはフォルダを指定できます。", "required": [ "type", "id" ], "properties": { "type": { "description": "アーカイブに追加する項目の種類。", "type": "string", "example": "file", "enum": [ "file", "folder" ] }, "id": { "description": "アーカイブに追加する項目の識別子。この項目がフォルダの場合、IDが`0`のルートフォルダを指定することはできません。", "type": "string", "example": "12345" } } } }, "download_file_name": { "description": "`zip`アーカイブの名前 (省略可)。この名前には、`January Financials.zip`のように、`.zip`というファイル拡張子が付加されます。", "type": "string", "example": "January Financials" } }, "required": [ "items" ], "title": "`zip`アーカイブの作成" }, "ZipDownloadStatus": { "description": "ダウンロード中の`zip`アーカイブのステータス。", "type": "object", "properties": { "total_file_count": { "description": "このアーカイブ内のファイルの合計数。", "type": "integer", "example": 20, "maximum": 10000, "minimum": 0 }, "downloaded_file_count": { "description": "すでにダウンロードされているファイルの数。", "type": "integer", "example": 10, "minimum": 0 }, "skipped_file_count": { "description": "ダウンロードできなかったためスキップされたファイルの数。多くの場合、この原因は、アーカイブに対するリクエストの作成と、ダウンロードされるアーカイブとの間に発生した権限に関する問題です。", "type": "integer", "example": 5, "minimum": 0 }, "skipped_folder_count": { "description": "ダウンロードできなかったためスキップされたフォルダの数。多くの場合、この原因は、アーカイブに対するリクエストの作成と、ダウンロードされるアーカイブとの間に発生した権限に関する問題です。", "type": "integer", "example": 5, "minimum": 0 }, "state": { "description": "ダウンロード中のアーカイブの状態。", "type": "string", "example": "succeeded", "default": "in_progress", "enum": [ "in_progress", "failed", "succeeded" ] } }, "title": "zipダウンロードのステータス", "x-box-reference-category": "zip_downloads", "x-box-resource-id": "zip_download_status", "x-box-tag": "zip_downloads" } }, "securitySchemes": { "OAuth2Security": { "type": "oauth2", "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": "リーガルホールドの管理" } } } } } }, "security": [ { "OAuth2Security": [] } ], "tags": [ { "name": "AI", "description": "A set of endpoints used to\ninteract with supported LLMs.", "x-box-tag": "ai" }, { "name": "AI Studio", "description": "A set of endpoints used to\ninteract with AI Studio.", "x-box-tag": "ai_studio" }, { "name": "アプリ項目の関連付け", "x-box-tag": "app_item_associations" }, { "name": "承認", "description": "A set of endpoints used to\nmanage user authorization process.", "x-box-tag": "authorization", "x-box-priority": true }, { "name": "Box Signリクエスト", "description": "Box Sign requests are used\nto submit a file for\nsignature.", "x-box-tag": "sign_requests" }, { "name": "Classifications", "description": "Classification labels are\nused for content that is\nsensitive or under security\nrestrictions.", "x-box-tag": "classifications" }, { "name": "ファイルの分類", "description": "Classification labels are\nused for files that are\nsensitive or under security\nrestrictions.", "x-box-tag": "file_classifications" }, { "name": "フォルダの分類", "description": "Classification labels are\nused for folders that are\nsensitive or under security\nrestrictions.", "x-box-tag": "folder_classifications" }, { "name": "Collaborations", "description": "Collaborations define access permissions\nfor users and groups to files and folders,\nsimilar to access control lists.", "x-box-tag": "user_collaborations" }, { "name": "コラボレーション (リスト)", "description": "A set of endpoints used to\nretrieve file, folder,\npending, and group collaborations.", "x-box-tag": "list_collaborations" }, { "name": "Collections", "description": "Collections are a way to group files,\nfolders, and web links without putting them\nall into a folder.", "x-box-tag": "collections" }, { "name": "Comments", "description": "Comments are messages generated users on files,\nallowing users to collaborate on a file,\ndiscussing any feedback they might\nhave on the content.", "x-box-tag": "comments" }, { "name": "Device Pinners", "description": "Device pinners allow enterprises to\ncontrol what devices can use\nnative Box applications.", "x-box-tag": "device_pinners" }, { "name": "ドメインの制限 (ユーザーの除外)", "description": "A set of endpoints that allow exempting users\nfrom restrictions imposed by the list of\nallowed collaboration domains for a specific enterprise.", "x-box-tag": "collaboration_allowlist_exempt_targets" }, { "name": "コラボレーションに対するドメインを制限", "description": "A set of endpoints that manage domains for which users\ncan collaborate with files and folders in an enterprise.", "x-box-tag": "collaboration_allowlist_entries" }, { "name": "ダウンロード", "description": "Downloads allow saving files to the application's server,\nor directly by the end user in a browser.", "x-box-tag": "downloads" }, { "name": "メールエイリアス", "description": "Email aliases provide a list of emails additional\nto the user's primary login email.", "x-box-tag": "email_aliases" }, { "name": "Events", "description": "Events provide a way for an\napplication to subscribe to\nany actions performed by\nany user, users, or service in an enterprise.", "x-box-tag": "events" }, { "name": "ファイルリクエスト", "description": "File Requests provide a fast and\nsecure way to request files and associated metadata\nfrom anyone.\nUsers can create new file requests\nbased on an existing file request,\nupdate file request settings, activate, deactivate, and delete\nfile requests programmatically.", "x-box-tag": "file_requests" }, { "name": "ファイルバージョンリーガルホールド", "description": "A legal hold is a process that an enterprise\ncan use to preserve all forms of potentially relevant\ninformation when\nlitigation is pending or reasonably anticipated.\nA File Version Legal Hold represents all the policies that\nare assigned to a specific file version.", "x-box-tag": "file_version_legal_holds" }, { "name": "ファイルバージョンリテンション", "description": "A retention policy blocks permanent\ndeletion of content for a specified amount of time.\nA file version retention is a record for a retained file.", "x-box-tag": "file_version_retentions" }, { "name": "ファイルバージョン", "description": "A set of endpoints used to manage specific\nversions of a file.", "x-box-tag": "file_versions" }, { "name": "Files", "description": "Files, together with Folders,\nare at the core of the Box API.\nFiles can be uploaded and downloaded,\nas well as hold important metadata\ninformation about the content.", "x-box-tag": "files" }, { "name": "フォルダロック", "description": "Folder locks define access restrictions\nplaced by folder owners to prevent\nspecific folders from being moved or deleted.", "x-box-tag": "folder_locks" }, { "name": "Folders", "description": "Folders, together with Files,\nare at the core of the Box API.\nFolders can be uploaded and downloaded,\nas well as hold important metadata\ninformation about the content.", "x-box-tag": "folders" }, { "name": "統合マッピング", "description": "Integration Mappings allow the users\nto manage where content from partner apps is stored in Box.", "x-box-tag": "integration_mappings" }, { "name": "グループメンバーシップ", "description": "Group memberships signify that\na user is a part of the group.", "x-box-tag": "memberships" }, { "name": "Groups", "description": "Groups created in an enterprise.", "x-box-tag": "groups" }, { "name": "Invites", "description": "Invites are used to invite the user to\nan enterprise.", "x-box-tag": "invites" }, { "name": "リーガルホールドポリシー", "description": "A legal hold is a process that an enterprise\ncan use to preserve all forms of potentially\nrelevant information when litigation is pending or\nreasonably anticipated.", "x-box-tag": "legal_hold_policies" }, { "name": "リーガルホールドポリシー割り当て", "description": "A Legal Hold Policy Assignment\nis a relation between a policy and custodian.\nIn this case, as custodian can be a user, folder,\nfile, or file version.", "x-box-tag": "legal_hold_policy_assignments" }, { "name": "メタデータカスケードポリシー", "description": "A metadata cascade policy describes how metadata\ninstances applied to a folder should be applied\nto any item within that folder.", "x-box-tag": "metadata_cascade_policies" }, { "name": "メタデータインスタンス (ファイル)", "description": "A metadata instance describes\nthe relation between a template and a file,\nincluding the values that are assigned for every field.", "x-box-tag": "file_metadata" }, { "name": "メタデータインスタンス (フォルダ)", "description": "A metadata instance describes the relation between a template and a folder,\nincluding the values that are assigned for every field.", "x-box-tag": "folder_metadata" }, { "name": "メタデータテンプレート", "description": "A metadata template describes a reusable set\nof key/value pairs that can be assigned to a file.", "x-box-tag": "metadata_templates" }, { "name": "最近使用した項目", "description": "Recent items represent items such\nas files or folders that\nthe user accessed recently.", "x-box-tag": "recent_items" }, { "name": "リテンションポリシー", "description": "A retention policy blocks permanent deletion of content\nfor a specified amount of time. Admins can create\nretention policies and then assign them to\nspecific folders or their entire enterprise.", "x-box-tag": "retention_policies" }, { "name": "リテンションポリシー割り当て", "description": "A Retention Policy Assignment is a relation\nbetween a policy and folder or enterprise.\nCreating an assignment puts a retention on\nall the file versions that belong to that folder or enterprise.", "x-box-tag": "retention_policy_assignments" }, { "name": "検索", "description": "The Box API provides a way to find content in Box\nusing full-text search queries.", "x-box-tag": "search" }, { "name": "セッション終了", "description": "Session termination API is used to\nvalidate the roles and permissions of the group,\nand creates asynchronous jobs to terminate the group's sessions.", "x-box-tag": "session_termination" }, { "name": "共有リンク (ファイル)", "description": "Files shared links are URLs that are generated for files stored in Box,\nwhich provide direct, read-only access to the resource.", "x-box-tag": "shared_links_files" }, { "name": "共有リンク (フォルダ)", "description": "Folders shared links are URLs that are generated for folders stored in Box,\nwhich provide direct, read-only access to the resource.", "x-box-tag": "shared_links_folders" }, { "name": "共有リンク (ウェブリンク)", "description": "Web links for files are URLs that are generated\nfor web links in Box,\nwhich provide direct, read-only access to the resource.", "x-box-tag": "shared_links_web_links" }, { "name": "共有リンク (アプリ項目)", "description": "URLs generated for app items stored in Box,\nwhich provide direct, read-only access to the resource.", "x-box-tag": "shared_links_app_items" }, { "name": "Shield情報バリア", "description": "Shield information barrier in Box defines an ethical wall.\nAn ethical wall is a mechanism that prevents exchanges or communication that\ncould lead to conflicts of interest and therefore result in\nbusiness activities ethically or legally questionable.", "x-box-tag": "shield_information_barriers" }, { "name": "Shield情報バリアのセグメント", "description": "Shield information barrier segment represents\na defined group of users. A user can be a member\nof only one segment, which makes segments\ndifferent from groups.", "x-box-tag": "shield_information_barrier_segments" }, { "name": "Shield情報バリアのセグメントメンバー", "description": "Shield information barrier segment member\nrepresents a user that is assigned to a\nspecific segment.", "x-box-tag": "shield_information_barrier_segment_members" }, { "name": "Shield情報バリアレポート", "description": "Shield information barrier reports\ncontain information on what existing collaborations\nwill be removed permanently when the information barrier is enabled.", "x-box-tag": "shield_information_barrier_reports" }, { "name": "Shield情報バリアのセグメント制限", "description": "Shield information barrier segment restriction is\nan access restriction based on the content (file or folder) owner.", "x-box-tag": "shield_information_barrier_segment_restrictions" }, { "name": "Box Signテンプレート", "description": "Sign templates allow you to use a predefined Box Sign\ntemplate when creating a signature request.\nThe template includes placeholders that\nare automatically populated with data when creating the request.", "x-box-tag": "sign_templates" }, { "name": "Skills", "description": "Box Skills are designed to allow custom processing\nof files uploaded to Box, with the\nintent of enhancing the underlying metadata of the file.", "x-box-tag": "skills" }, { "name": "標準およびZonesのストレージポリシー", "description": "Storage policy assignment represents the\nstorage zone for items in a given enterprise.", "x-box-tag": "storage_policies" }, { "name": "標準およびZonesのストレージポリシー割り当て", "description": "Storage policy assignment represents the\nrelation between storage zone and the\nassigned item (for example a file stored\nin a specific zone).", "x-box-tag": "storage_policy_assignments" }, { "name": "タスク割り当て", "description": "A task assignment defines which\ntask is assigned to which user to complete.", "x-box-tag": "task_assignments" }, { "name": "Tasks", "description": "Tasks allow users to request collaborators on a file\nto review a file or complete a piece of work.\nTasks can be used by developers to create file-centric workflows.", "x-box-tag": "tasks" }, { "name": "サービス利用規約", "description": "A set of endpoints used to\nmanage terms of service agreements.", "x-box-tag": "terms_of_services" }, { "name": "サービス利用規約のユーザーステータス", "description": "A set of endpoints used to\nmanage the status of terms of service\nfor a particular user.", "x-box-tag": "terms_of_service_user_statuses" }, { "name": "フォルダの移動", "description": "API designed to move all of the items\n(files, folders and workflows)\nowned by a user into another user's account.", "x-box-tag": "transfer" }, { "name": "ごみ箱内のファイル", "description": "Files that were deleted and\nare in trash.", "x-box-tag": "trashed_files" }, { "name": "ごみ箱内のフォルダ", "description": "Folders that were deleted and\nare in trash.", "x-box-tag": "trashed_folders" }, { "name": "ごみ箱内の項目", "description": "Items that were deleted and\nare in trash.", "x-box-tag": "trashed_items" }, { "name": "ごみ箱内のウェブリンク", "description": "Web links that were deleted and\nare in trash.", "x-box-tag": "trashed_web_links" }, { "name": "アップロード", "description": "The direct file upload API supports files\nup to 50MB in size and sends all\nthe binary data to the Box API in 1 API request.", "x-box-tag": "uploads" }, { "name": "アップロード (分割)", "description": "The chunked upload endpoints support files from\n20MB in size and allow an application\nto upload the file in parts,\nallowing for more control to catch any errors\nand retry parts individually.", "x-box-tag": "chunked_uploads" }, { "name": "ユーザーのアバター", "description": "User avatars are JPG or PNG files\nuploaded to Box to represent the\nuser image. They are then displayed\nin the user account.", "x-box-tag": "avatars" }, { "name": "Users", "description": "Box API supports a variety of users,\nranging from real employees\nlogging in with their Managed User account,\nto applications using App Users to drive powerful\nautomation workflows.", "x-box-tag": "users" }, { "name": "電子すかし (ファイル)", "description": "A watermark is a semi-transparent\noverlay on an embedded file\npreview that displays a viewer's email address\nor user ID and the time of access over\nthe file.", "x-box-tag": "file_watermarks" }, { "name": "電子すかし (フォルダ)", "description": "A watermark is a semi-transparent overlay on an embedded folder\npreview that displays a viewer's email address or user ID\nand the time of access over\nthe folder content.", "x-box-tag": "folder_watermarks" }, { "name": "ウェブリンク", "description": "Web links are objects that point to URLs.\nThese objects are also known as bookmarks\nwithin the Box web application.", "x-box-tag": "web_links" }, { "name": "Webhooks", "description": "Webhooks allow you to monitor Box content for events,\nand receive notifications to a URL of your choice when they occur.\nFor example, a workflow may include waiting\nfor a file to be downloaded to delete a shared link.", "x-box-tag": "webhooks" }, { "name": "ワークフロー (リスト)", "description": "Box Relay Workflows are objects that represent\na named collection of flows.", "x-box-tag": "workflows" }, { "name": "zipダウンロード", "description": "Zip downloads represent a successful request\nto create a ZIP archive with files and folders.", "x-box-tag": "zip_downloads" } ], "externalDocs": { "description": "Box Developerドキュメント。", "url": "https://developer.box.com" } }