> ## Documentation Index > Fetch the complete documentation index at: https://developer.box.com/llms.txt > Use this file to discover all available pages before exploring further. # Folders リソース フォルダは、ファイルとともに、Box APIの中核を成します。フォルダはアップロードおよびダウンロードが可能で、コンテンツに関する重要なメタデータ情報を保持できます。 ## Folder 任意のフォルダAPIエンドポイントからデフォルトで返されるフォルダのStandard版の表示。 | プロパティ | 型 | 必須 | 説明 | | --------------------- | -------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | はい | フォルダを表す一意の識別子。 フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。 | | `etag` | `string` | いいえ | このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。 | | `type` | `enum` | はい | 値は常に`folder`になります。 使用可能なオプション: `folder`. | | `sequence_id` | `string` | いいえ | この項目に適用された最新のUser Eventを表す数値の識別子。 これを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。 たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。 `null` を指定できます。 | | `name` | `string` | いいえ | フォルダの名前。 | | `created_at` | `string` | いいえ | このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。 `null` を指定できます。 | | `modified_at` | `string` | いいえ | このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。 `null` を指定できます。 | | `description` | `string` | いいえ | このフォルダの説明 (省略可)。 | | `size` | `integer` | いいえ | フォルダサイズ (バイト単位)。 この整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。 | | `path_collection` | `object` | いいえ | 項目の親フォルダのリスト。 | | `created_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このフォルダを作成したユーザー。 | | `modified_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このフォルダを最後に変更したユーザー。 | | `trashed_at` | `string` | いいえ | このフォルダがごみ箱に移動された日時。 `null` を指定できます。 | | `purged_at` | `string` | いいえ | このフォルダがごみ箱から削除される予定日時。 `null` を指定できます。 | | `content_created_at` | `string` | いいえ | このフォルダが最初に作成された日時。 `null` を指定できます。 | | `content_modified_at` | `string` | いいえ | このフォルダが最後に更新された日時。 `null` を指定できます。 | | `owned_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このフォルダを所有するユーザー。 | | `shared_link` | `object` | いいえ | 共有リンクを作成すると、Box上のファイルやフォルダに対する読み取り専用アクセスを直接実行できます。 アクセスレベルがopenに設定されている共有リンクの場合は、URLを知っているすべてのユーザーが項目にアクセスでき、アクセスレベルがcompanyまたはcollaboratorsに設定されている共有リンクの場合は、適切に認証されたBoxユーザーのみが項目にアクセスできます。 `null` を指定できます。 | | `folder_upload_email` | `object` | いいえ | 以下のオプションのいずれかが**true**の場合、`folder_upload_email`パラメータは`null`ではありません。 - \[**このフォルダへのメールによるアップロードを許可する**] および \[**このフォルダのコラボレータにのみメールによるアップロードを許可する**] が[管理コンソールで1フォルダに対して有効](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email)になっていて、ユーザーには少なくとも**アップロード**権限が付与されています。 - \[**このフォルダへのメールによるアップロードを許可する**] の設定が管理コンソールで1フォルダに対して有効になっていて、\[**このフォルダのコラボレータにのみメールによるアップロードを許可する**] の設定が無効 (オフ) になっています。 条件が満たされていない場合、パラメータには次の値が設定されます: `folder_upload_email: null`。 `null` を指定できます。 | | `parent` | [フォルダ (Mini)](#-mini) | いいえ | このフォルダが配置されているフォルダ (省略可) ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。 `null` を指定できます。 | | `item_status` | `enum` | いいえ | この項目が削除されたかどうかを定義します。 - `active` - 項目がごみ箱に移動されていない場合。 - `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。 - `deleted` - 項目がすでに完全に削除されている場合。 使用可能なオプション: `active`, `trashed`, `deleted`. | | `item_collection` | [Items](#items) | いいえ | フォルダ内の項目のページ。 このフィールドをリクエストできるのは、フォルダの情報をクエリで照会するときのみで、フォルダの項目をクエリで照会するときにはリクエストできません。 | ```json 例 theme={null} { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts", "created_at": "2012-12-12T10:53:43-08:00", "modified_at": "2012-12-12T10:53:43-08:00", "description": "Legal contracts for the new ACME deal", "size": 629644, "path_collection": { "total_count": 1, "entries": [ { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ] }, "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "modified_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "trashed_at": "2012-12-12T10:53:43-08:00", "purged_at": "2012-12-12T10:53:43-08:00", "content_created_at": "2012-12-12T10:53:43-08:00", "content_modified_at": "2012-12-12T10:53:43-08:00", "owned_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "shared_link": { "url": "https://www.box.com/s/vspke7y05sb214wjokpk", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "vanity_url": "https://acme.app.box.com/v/my_url/", "vanity_name": "my_url", "access": "open", "effective_access": "company", "effective_permission": "can_download", "unshared_at": "2018-04-13T13:53:23-07:00", "is_password_enabled": true, "permissions": { "can_download": true, "can_preview": true, "can_edit": false }, "download_count": 3, "preview_count": 3 }, "folder_upload_email": { "access": "open", "email": "upload.Contracts.asd7asd@u.box.com" }, "parent": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" }, "item_status": "active", "item_collection": { "limit": 1000, "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "total_count": 5000, "offset": 2000, "order": [ { "by": "type", "direction": "ASC" } ], "entries": [ { "id": "12345", "etag": "1", "type": "file", "sequence_id": "3", "name": "Contract.pdf", "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37", "file_version": { "id": "12345", "type": "file_version", "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc" }, "description": "Contract for Q1 renewal", "size": 629644, "path_collection": { "total_count": 1, "entries": [ { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ] }, "created_at": "2012-12-12T10:53:43-08:00", "modified_at": "2012-12-12T10:53:43-08:00", "trashed_at": "2012-12-12T10:53:43-08:00", "purged_at": "2012-12-12T10:53:43-08:00", "content_created_at": "2012-12-12T10:53:43-08:00", "content_modified_at": "2012-12-12T10:53:43-08:00", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "modified_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "owned_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "shared_link": { "url": "https://www.box.com/s/vspke7y05sb214wjokpk", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "vanity_url": "https://acme.app.box.com/v/my_url/", "vanity_name": "my_url", "access": "open", "effective_access": "company", "effective_permission": "can_download", "unshared_at": "2018-04-13T13:53:23-07:00", "is_password_enabled": true, "permissions": { "can_download": true, "can_preview": true, "can_edit": false }, "download_count": 3, "preview_count": 3 }, "parent": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" }, "item_status": "active", "version_number": "1", "comment_count": 10, "permissions": { "can_delete": true, "can_download": true, "can_invite_collaborator": true, "can_rename": true, "can_set_share_access": true, "can_share": true, "can_annotate": true, "can_comment": true, "can_preview": true, "can_upload": true, "can_view_annotations_all": true, "can_view_annotations_self": true, "can_apply_watermark": true }, "tags": [ "approved" ], "lock": { "id": "11446498", "type": "lock", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "created_at": "2012-12-12T10:53:43-08:00", "expired_at": "2012-12-12T10:53:43-08:00", "is_download_prevented": true, "app_type": "office_wopiplus" }, "extension": "pdf", "is_package": true, "expiring_embed_link": { "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ", "expires_in": 3600, "token_type": "bearer", "restricted_to": [ { "scope": "item_download", "object": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } } ], "url": "https://cloud.app.box.com/preview/expiring_embed/..." }, "watermark_info": { "is_watermarked": true, "is_watermark_inherited": false, "is_watermarked_by_access_policy": false }, "is_accessible_via_shared_link": true, "allowed_invitee_roles": [ "editor" ], "is_externally_owned": true, "has_collaborations": true, "metadata": { "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 } } }, "expires_at": "2012-12-12T10:53:43-08:00", "representations": { "entries": [ { "content": { "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567" }, "info": { "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048" }, "properties": { "dimensions": "2048x2048", "paged": "true", "thumb": "true" }, "representation": "png", "status": { "state": "success" } } ] }, "classification": { "name": "Top Secret", "definition": "Content that should not be shared outside the company.", "color": "#FF0000" }, "uploader_display_name": "Ellis Wiggins", "disposition_at": "2012-12-12T10:53:43-08:00", "shared_link_permission_options": [ "can_preview" ], "is_associated_with_app_item": true, "collections": [ { "id": "11446498", "type": "collection", "name": "Favorites", "collection_type": "favorites" } ], "is_download_available": true, "download_url": "https://dl.boxcloud.com/d/1/example_token/download", "authenticated_download_url": "https://api.box.com/2.0/files/12345/content", "allowed_shared_link_access_levels": [ "open" ] } ] } } ``` ## Items Mini版の表示に含まれるファイル、フォルダ、ウェブリンクのリスト。 | プロパティ | 型 | 必須 | 説明 | | ------------- | ----------------- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | | `next_marker` | `string` | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | | `prev_marker` | `string` | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。 | | `total_count` | `integer` | いいえ | コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 | | `offset` | `integer` | いいえ | このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 | | `order` | array of `object` | いいえ | 項目が返される順序。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 | | `entries` | array of `項目` | いいえ | このコレクション内の項目。 | ```json 例 theme={null} { "limit": 1000, "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "total_count": 5000, "offset": 2000, "order": [ { "by": "type", "direction": "ASC" } ], "entries": [ { "id": "12345", "etag": "1", "type": "file", "sequence_id": "3", "name": "Contract.pdf", "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37", "file_version": { "id": "12345", "type": "file_version", "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc" }, "description": "Contract for Q1 renewal", "size": 629644, "path_collection": { "total_count": 1, "entries": [ { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ] }, "created_at": "2012-12-12T10:53:43-08:00", "modified_at": "2012-12-12T10:53:43-08:00", "trashed_at": "2012-12-12T10:53:43-08:00", "purged_at": "2012-12-12T10:53:43-08:00", "content_created_at": "2012-12-12T10:53:43-08:00", "content_modified_at": "2012-12-12T10:53:43-08:00", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "modified_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "owned_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "shared_link": { "url": "https://www.box.com/s/vspke7y05sb214wjokpk", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "vanity_url": "https://acme.app.box.com/v/my_url/", "vanity_name": "my_url", "access": "open", "effective_access": "company", "effective_permission": "can_download", "unshared_at": "2018-04-13T13:53:23-07:00", "is_password_enabled": true, "permissions": { "can_download": true, "can_preview": true, "can_edit": false }, "download_count": 3, "preview_count": 3 }, "parent": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" }, "item_status": "active", "version_number": "1", "comment_count": 10, "permissions": { "can_delete": true, "can_download": true, "can_invite_collaborator": true, "can_rename": true, "can_set_share_access": true, "can_share": true, "can_annotate": true, "can_comment": true, "can_preview": true, "can_upload": true, "can_view_annotations_all": true, "can_view_annotations_self": true, "can_apply_watermark": true }, "tags": [ "approved" ], "lock": { "id": "11446498", "type": "lock", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "created_at": "2012-12-12T10:53:43-08:00", "expired_at": "2012-12-12T10:53:43-08:00", "is_download_prevented": true, "app_type": "office_wopiplus" }, "extension": "pdf", "is_package": true, "expiring_embed_link": { "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ", "expires_in": 3600, "token_type": "bearer", "restricted_to": [ { "scope": "item_download", "object": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } } ], "url": "https://cloud.app.box.com/preview/expiring_embed/..." }, "watermark_info": { "is_watermarked": true, "is_watermark_inherited": false, "is_watermarked_by_access_policy": false }, "is_accessible_via_shared_link": true, "allowed_invitee_roles": [ "editor" ], "is_externally_owned": true, "has_collaborations": true, "metadata": { "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 } } }, "expires_at": "2012-12-12T10:53:43-08:00", "representations": { "entries": [ { "content": { "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567" }, "info": { "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048" }, "properties": { "dimensions": "2048x2048", "paged": "true", "thumb": "true" }, "representation": "png", "status": { "state": "success" } } ] }, "classification": { "name": "Top Secret", "definition": "Content that should not be shared outside the company.", "color": "#FF0000" }, "uploader_display_name": "Ellis Wiggins", "disposition_at": "2012-12-12T10:53:43-08:00", "shared_link_permission_options": [ "can_preview" ], "is_associated_with_app_item": true, "collections": [ { "id": "11446498", "type": "collection", "name": "Favorites", "collection_type": "favorites" } ], "is_download_available": true, "download_url": "https://dl.boxcloud.com/d/1/example_token/download", "authenticated_download_url": "https://api.box.com/2.0/files/12345/content", "allowed_shared_link_access_levels": [ "open" ] } ] } ``` ## Items Mini版の表示に含まれるファイル、フォルダ、ウェブリンクのリスト。 | プロパティ | 型 | 必須 | 説明 | | ------------- | ----------------- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `total_count` | `integer` | いいえ | コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 | | `limit` | `integer` | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 | | `offset` | `integer` | いいえ | このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 | | `order` | array of `object` | いいえ | 項目が返される順序。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 | | `entries` | array of `項目` | いいえ | このコレクション内の項目。 | ```json 例 theme={null} { "total_count": 5000, "limit": 1000, "offset": 2000, "order": [ { "by": "type", "direction": "ASC" } ], "entries": [ { "id": "12345", "etag": "1", "type": "file", "sequence_id": "3", "name": "Contract.pdf", "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37", "file_version": { "id": "12345", "type": "file_version", "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc" }, "description": "Contract for Q1 renewal", "size": 629644, "path_collection": { "total_count": 1, "entries": [ { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ] }, "created_at": "2012-12-12T10:53:43-08:00", "modified_at": "2012-12-12T10:53:43-08:00", "trashed_at": "2012-12-12T10:53:43-08:00", "purged_at": "2012-12-12T10:53:43-08:00", "content_created_at": "2012-12-12T10:53:43-08:00", "content_modified_at": "2012-12-12T10:53:43-08:00", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "modified_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "owned_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "shared_link": { "url": "https://www.box.com/s/vspke7y05sb214wjokpk", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "vanity_url": "https://acme.app.box.com/v/my_url/", "vanity_name": "my_url", "access": "open", "effective_access": "company", "effective_permission": "can_download", "unshared_at": "2018-04-13T13:53:23-07:00", "is_password_enabled": true, "permissions": { "can_download": true, "can_preview": true, "can_edit": false }, "download_count": 3, "preview_count": 3 }, "parent": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" }, "item_status": "active", "version_number": "1", "comment_count": 10, "permissions": { "can_delete": true, "can_download": true, "can_invite_collaborator": true, "can_rename": true, "can_set_share_access": true, "can_share": true, "can_annotate": true, "can_comment": true, "can_preview": true, "can_upload": true, "can_view_annotations_all": true, "can_view_annotations_self": true, "can_apply_watermark": true }, "tags": [ "approved" ], "lock": { "id": "11446498", "type": "lock", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "created_at": "2012-12-12T10:53:43-08:00", "expired_at": "2012-12-12T10:53:43-08:00", "is_download_prevented": true, "app_type": "office_wopiplus" }, "extension": "pdf", "is_package": true, "expiring_embed_link": { "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ", "expires_in": 3600, "token_type": "bearer", "restricted_to": [ { "scope": "item_download", "object": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } } ], "url": "https://cloud.app.box.com/preview/expiring_embed/..." }, "watermark_info": { "is_watermarked": true, "is_watermark_inherited": false, "is_watermarked_by_access_policy": false }, "is_accessible_via_shared_link": true, "allowed_invitee_roles": [ "editor" ], "is_externally_owned": true, "has_collaborations": true, "metadata": { "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 } } }, "expires_at": "2012-12-12T10:53:43-08:00", "representations": { "entries": [ { "content": { "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567" }, "info": { "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048" }, "properties": { "dimensions": "2048x2048", "paged": "true", "thumb": "true" }, "representation": "png", "status": { "state": "success" } } ] }, "classification": { "name": "Top Secret", "definition": "Content that should not be shared outside the company.", "color": "#FF0000" }, "uploader_display_name": "Ellis Wiggins", "disposition_at": "2012-12-12T10:53:43-08:00", "shared_link_permission_options": [ "can_preview" ], "is_associated_with_app_item": true, "collections": [ { "id": "11446498", "type": "collection", "name": "Favorites", "collection_type": "favorites" } ], "is_download_available": true, "download_url": "https://dl.boxcloud.com/d/1/example_token/download", "authenticated_download_url": "https://api.box.com/2.0/files/12345/content", "allowed_shared_link_access_levels": [ "open" ] } ] } ``` ## フォルダ (Base) 最も基本的なフォルダのBase版の表示。`fields`クエリパラメータを使用すると、最小限の数のフィールドが返されます。 | プロパティ | 型 | 必須 | 説明 | | ------ | -------------- | --- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | はい | フォルダを表す一意の識別子。 フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。 | | `etag` | `string` | いいえ | このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。 | | `type` | `enum` | はい | 値は常に`folder`になります。 使用可能なオプション: `folder`. | ```json 例 theme={null} { "id": "12345", "etag": "1", "type": "folder" } ``` ## フォルダ (Full) 任意のフォルダAPIエンドポイントからデフォルトで返される可能性があるフォルダのFull版の表示。 | プロパティ | 型 | 必須 | 説明 | | ------------------------------------------- | --------------------------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | はい | フォルダを表す一意の識別子。 フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。 | | `etag` | `string` | いいえ | このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。 | | `type` | `enum` | はい | 値は常に`folder`になります。 使用可能なオプション: `folder`. | | `sequence_id` | `string` | いいえ | この項目に適用された最新のUser Eventを表す数値の識別子。 これを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。 たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。 `null` を指定できます。 | | `name` | `string` | いいえ | フォルダの名前。 | | `created_at` | `string` | いいえ | このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。 `null` を指定できます。 | | `modified_at` | `string` | いいえ | このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になる場合があります。 `null` を指定できます。 | | `description` | `string` | いいえ | このフォルダの説明 (省略可)。 | | `size` | `integer` | いいえ | フォルダサイズ (バイト単位)。 この整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。 | | `path_collection` | `object` | いいえ | 項目の親フォルダのリスト。 | | `created_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このフォルダを作成したユーザー。 | | `modified_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このフォルダを最後に変更したユーザー。 | | `trashed_at` | `string` | いいえ | このフォルダがごみ箱に移動された日時。 `null` を指定できます。 | | `purged_at` | `string` | いいえ | このフォルダがごみ箱から削除される予定日時。 `null` を指定できます。 | | `content_created_at` | `string` | いいえ | このフォルダが最初に作成された日時。 `null` を指定できます。 | | `content_modified_at` | `string` | いいえ | このフォルダが最後に更新された日時。 `null` を指定できます。 | | `owned_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このフォルダを所有するユーザー。 | | `shared_link` | `object` | いいえ | 共有リンクを作成すると、Box上のファイルやフォルダに対する読み取り専用アクセスを直接実行できます。 アクセスレベルがopenに設定されている共有リンクの場合は、URLを知っているすべてのユーザーが項目にアクセスでき、アクセスレベルがcompanyまたはcollaboratorsに設定されている共有リンクの場合は、適切に認証されたBoxユーザーのみが項目にアクセスできます。 `null` を指定できます。 | | `folder_upload_email` | `object` | いいえ | 以下のオプションのいずれかが**true**の場合、`folder_upload_email`パラメータは`null`ではありません。 - \[**このフォルダへのメールによるアップロードを許可する**] および \[**このフォルダのコラボレータにのみメールによるアップロードを許可する**] が[管理コンソールで1フォルダに対して有効](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email)になっていて、ユーザーには少なくとも**アップロード**権限が付与されています。 - \[**このフォルダへのメールによるアップロードを許可する**] の設定が管理コンソールで1フォルダに対して有効になっていて、\[**このフォルダのコラボレータにのみメールによるアップロードを許可する**] の設定が無効 (オフ) になっています。 条件が満たされていない場合、パラメータには次の値が設定されます: `folder_upload_email: null`。 `null` を指定できます。 | | `parent` | [フォルダ (Mini)](#-mini) | いいえ | このフォルダが配置されているフォルダ (省略可) ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。 `null` を指定できます。 | | `item_status` | `enum` | いいえ | この項目が削除されたかどうかを定義します。 - `active` - 項目がごみ箱に移動されていない場合。 - `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。 - `deleted` - 項目がすでに完全に削除されている場合。 使用可能なオプション: `active`, `trashed`, `deleted`. | | `item_collection` | [Items](#items) | いいえ | フォルダ内の項目のページ。 このフィールドをリクエストできるのは、フォルダの情報をクエリで照会するときのみで、フォルダの項目をクエリで照会するときにはリクエストできません。 | | `sync_state` | `enum` | いいえ | フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。これはBox Sync (廃止済み) で使用され、Box Driveでは 使用されません。 使用可能なオプション: `synced`, `not_synced`, `partially_synced`. | | `has_collaborations` | `boolean` | いいえ | このフォルダに他のコラボレータが存在するかどうかを指定します。 | | `permissions` | `object` | いいえ | フォルダに対して認証済みユーザーが持っている権限。 | | `tags` | array of `string` | いいえ | この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。 タグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。 タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。 | | `can_non_owners_invite` | `boolean` | いいえ | フォルダの所有者ではないユーザーがそのフォルダに新しいコラボレータを招待できるかどうかを指定します。 | | `is_externally_owned` | `boolean` | いいえ | このフォルダが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。 | | `metadata` | `object` | いいえ | `scope`および`templateKey`のキー/値ペア内にネストされている、メタデータインスタンスのリスト。 ファイルまたはフォルダのメタデータにアクセスするには、最初にメタデータエンドポイントを使用して、会社で使用できるメタデータテンプレートを特定します。 その後、`fields`クエリパラメータを指定して`GET /files/:id`または`GET /folder/:id`エンドポイントを使用すると、IDを指定してメタデータを取得できます。 特定の`scope`および`templateKey`のメタデータインスタンスをリクエストするには、`fields`パラメータに`metadata..`の形式を使用してください。 たとえば、`?fields=metadata.enterprise_27335.marketingCollateral`のようになります。 | | `is_collaboration_restricted_to_enterprise` | `boolean` | いいえ | このフォルダへの招待を社内のユーザーのみに限定するかどうかを指定します。既存のコラボレーションには影響しません。 | | `allowed_shared_link_access_levels` | array of `enum` | いいえ | The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this folder. The list depends on item policy and user authorization. For some folders, like the root folder, this is always empty as sharing is not allowed at that level. | | `allowed_invitee_roles` | array of `enum` | いいえ | このフォルダを共有するときに招待できるユーザーの役割タイプのリスト。 | | `watermark_info` | `object` | いいえ | この項目に適用された電子すかしに関する詳細。 | | `is_accessible_via_shared_link` | `boolean` | いいえ | 直接共有リンクまたは親フォルダへの共有リンクを使用してフォルダにアクセスできるかどうかを指定します。 | | `can_non_owners_view_collaborators` | `boolean` | いいえ | このフォルダの所有者ではないコラボレータがこのフォルダの他のコラボレータを表示できないように制限するかどうかを指定します。 この制限を有効にした場合は、所有者ではないユーザーが新しいコラボレータを招待することも制限されます。 | | `classification` | `object` | いいえ | 項目に適用される分類。 `null` を指定できます。 | | `is_associated_with_app_item` | `boolean` | いいえ | フォルダまたはフォルダの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのフォルダに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。 | | `collections` | array of [Collection](/ja/reference/collections-resources#collection) | いいえ | The collections that this folder belongs to. For more information, see the [collections guide](/guides/collections). | ```json 例 theme={null} { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts", "created_at": "2012-12-12T10:53:43-08:00", "modified_at": "2012-12-12T10:53:43-08:00", "description": "Legal contracts for the new ACME deal", "size": 629644, "path_collection": { "total_count": 1, "entries": [ { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ] }, "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "modified_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "trashed_at": "2012-12-12T10:53:43-08:00", "purged_at": "2012-12-12T10:53:43-08:00", "content_created_at": "2012-12-12T10:53:43-08:00", "content_modified_at": "2012-12-12T10:53:43-08:00", "owned_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "shared_link": { "url": "https://www.box.com/s/vspke7y05sb214wjokpk", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "vanity_url": "https://acme.app.box.com/v/my_url/", "vanity_name": "my_url", "access": "open", "effective_access": "company", "effective_permission": "can_download", "unshared_at": "2018-04-13T13:53:23-07:00", "is_password_enabled": true, "permissions": { "can_download": true, "can_preview": true, "can_edit": false }, "download_count": 3, "preview_count": 3 }, "folder_upload_email": { "access": "open", "email": "upload.Contracts.asd7asd@u.box.com" }, "parent": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" }, "item_status": "active", "item_collection": { "limit": 1000, "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "total_count": 5000, "offset": 2000, "order": [ { "by": "type", "direction": "ASC" } ], "entries": [ { "id": "12345", "etag": "1", "type": "file", "sequence_id": "3", "name": "Contract.pdf", "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37", "file_version": { "id": "12345", "type": "file_version", "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc" }, "description": "Contract for Q1 renewal", "size": 629644, "path_collection": { "total_count": 1, "entries": [ { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ] }, "created_at": "2012-12-12T10:53:43-08:00", "modified_at": "2012-12-12T10:53:43-08:00", "trashed_at": "2012-12-12T10:53:43-08:00", "purged_at": "2012-12-12T10:53:43-08:00", "content_created_at": "2012-12-12T10:53:43-08:00", "content_modified_at": "2012-12-12T10:53:43-08:00", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "modified_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "owned_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "shared_link": { "url": "https://www.box.com/s/vspke7y05sb214wjokpk", "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", "vanity_url": "https://acme.app.box.com/v/my_url/", "vanity_name": "my_url", "access": "open", "effective_access": "company", "effective_permission": "can_download", "unshared_at": "2018-04-13T13:53:23-07:00", "is_password_enabled": true, "permissions": { "can_download": true, "can_preview": true, "can_edit": false }, "download_count": 3, "preview_count": 3 }, "parent": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" }, "item_status": "active", "version_number": "1", "comment_count": 10, "permissions": { "can_delete": true, "can_download": true, "can_invite_collaborator": true, "can_rename": true, "can_set_share_access": true, "can_share": true, "can_annotate": true, "can_comment": true, "can_preview": true, "can_upload": true, "can_view_annotations_all": true, "can_view_annotations_self": true, "can_apply_watermark": true }, "tags": [ "approved" ], "lock": { "id": "11446498", "type": "lock", "created_by": { "id": "11446498", "type": "user", "name": "Aaron Levie", "login": "ceo@example.com" }, "created_at": "2012-12-12T10:53:43-08:00", "expired_at": "2012-12-12T10:53:43-08:00", "is_download_prevented": true, "app_type": "office_wopiplus" }, "extension": "pdf", "is_package": true, "expiring_embed_link": { "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ", "expires_in": 3600, "token_type": "bearer", "restricted_to": [ { "scope": "item_download", "object": { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } } ], "url": "https://cloud.app.box.com/preview/expiring_embed/..." }, "watermark_info": { "is_watermarked": true, "is_watermark_inherited": false, "is_watermarked_by_access_policy": false }, "is_accessible_via_shared_link": true, "allowed_invitee_roles": [ "editor" ], "is_externally_owned": true, "has_collaborations": true, "metadata": { "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 } } }, "expires_at": "2012-12-12T10:53:43-08:00", "representations": { "entries": [ { "content": { "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567" }, "info": { "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048" }, "properties": { "dimensions": "2048x2048", "paged": "true", "thumb": "true" }, "representation": "png", "status": { "state": "success" } } ] }, "classification": { "name": "Top Secret", "definition": "Content that should not be shared outside the company.", "color": "#FF0000" }, "uploader_display_name": "Ellis Wiggins", "disposition_at": "2012-12-12T10:53:43-08:00", "shared_link_permission_options": [ "can_preview" ], "is_associated_with_app_item": true, "collections": [ { "id": "11446498", "type": "collection", "name": "Favorites", "collection_type": "favorites" } ], "is_download_available": true, "download_url": "https://dl.boxcloud.com/d/1/example_token/download", "authenticated_download_url": "https://api.box.com/2.0/files/12345/content", "allowed_shared_link_access_levels": [ "open" ] } ] }, "sync_state": "synced", "has_collaborations": true, "permissions": { "can_delete": true, "can_download": true, "can_invite_collaborator": true, "can_rename": true, "can_set_share_access": true, "can_share": true, "can_upload": true, "can_apply_watermark": true }, "tags": [ "approved" ], "can_non_owners_invite": true, "is_externally_owned": true, "metadata": { "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 } } }, "is_collaboration_restricted_to_enterprise": true, "allowed_shared_link_access_levels": [ "open" ], "allowed_invitee_roles": [ "editor" ], "watermark_info": { "is_watermarked": true, "is_watermark_inherited": false, "is_watermarked_by_access_policy": false }, "is_accessible_via_shared_link": true, "can_non_owners_view_collaborators": true, "classification": { "name": "Top Secret", "definition": "Content that should not be shared outside the company.", "color": "#FF0000" }, "is_associated_with_app_item": true, "collections": [ { "id": "11446498", "type": "collection", "name": "Favorites", "collection_type": "favorites" } ] } ``` ## フォルダ (Mini) 他のリソースの下にネストされたときに使用されるファイルバージョンのMini版の表示。 | プロパティ | 型 | 必須 | 説明 | | ------------- | -------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | はい | フォルダを表す一意の識別子。 フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/folders/123`の場合、`folder_id`は`123`です。 | | `etag` | `string` | いいえ | このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。 | | `type` | `enum` | はい | 値は常に`folder`になります。 使用可能なオプション: `folder`. | | `sequence_id` | `string` | いいえ | この項目に適用された最新のUser Eventを表す数値の識別子。 これを`GET /events`エンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。 たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventの`sequence_id`が最初に取得されたリソースの`sequence_id`よりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。 `null` を指定できます。 | | `name` | `string` | いいえ | フォルダの名前。 | ```json 例 theme={null} { "id": "12345", "etag": "1", "type": "folder", "sequence_id": "3", "name": "Contracts" } ```