> ## 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.
# ごみ箱内のファイル リソース
削除されて現在ごみ箱にあるファイル。
## ごみ箱内のファイル
ごみ箱内のファイルを表します。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | ---------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `string` | はい | ファイルを表す一意の識別子。 ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。 |
| `etag` | `string` | いいえ | このファイルのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にファイルに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。 |
| `type` | `enum` | はい | 値は常に`file`になります。 使用可能なオプション: `file`. |
| `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` | いいえ | ファイルの名前。 |
| `sha1` | `string` | はい | ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。 |
| `file_version` | `ファイルバージョン (Mini)` | いいえ | ファイルの現在のバージョンに関する情報。 |
| `description` | `string` | はい | このファイルの説明 (省略可)。 |
| `size` | `integer` | はい | ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。 |
| `path_collection` | `object` | はい | ごみ箱内の項目の親フォルダのリスト。 |
| `created_at` | `string` | はい | Box上でこのファイルが作成された日時。 |
| `modified_at` | `string` | はい | Boxでこのファイルが最後に更新された日時。 |
| `trashed_at` | `string` | いいえ | このファイルがごみ箱に移動された日時。 `null` を指定できます。 |
| `purged_at` | `string` | いいえ | このファイルがごみ箱から削除される予定日時。 `null` を指定できます。 |
| `content_created_at` | `string` | いいえ | このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。 `null` を指定できます。 |
| `content_modified_at` | `string` | いいえ | このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。 `null` を指定できます。 |
| `created_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このファイルを作成したユーザー。 |
| `modified_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | はい | このファイルを最後に変更したユーザー。 |
| `owned_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | はい | このファイルを所有するユーザー。 |
| `shared_link` | `string` | いいえ | このファイルの共有リンク。ファイルがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これは`null`になります。 `null` を指定できます。 |
| `parent` | [フォルダ (Mini)](/ja/reference/folders-resources#-mini) | いいえ | このファイルが配置されているフォルダ。 `null` を指定できます。 |
| `item_status` | `enum` | はい | この項目が削除されたかどうかを定義します。 - `active` - 項目がごみ箱に移動されていない場合。 - `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。 - `deleted` - 項目がすでに完全に削除されている場合。 使用可能なオプション: `active`, `trashed`, `deleted`. |
```json 例 theme={null}
{
"id": "123456789",
"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": [
{
"type": "folder",
"id": "123456789",
"sequence_id": null,
"etag": null,
"name": "Trash"
}
]
},
"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": null,
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"item_status": "trashed"
}
```
## ごみ箱内のファイル (復元済み)
ごみ箱から復元されたファイルを表します。
| プロパティ | 型 | 必須 | 説明 |
| --------------------- | ---------------------------------------------------- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `string` | はい | ファイルを表す一意の識別子。 ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLが`https://*.app.box.com/files/123`の場合、`file_id`は`123`です。 |
| `etag` | `string` | いいえ | このファイルのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にファイルに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。 |
| `type` | `enum` | はい | 値は常に`file`になります。 使用可能なオプション: `file`. |
| `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` | いいえ | ファイルの名前。 |
| `sha1` | `string` | はい | ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。 |
| `file_version` | `ファイルバージョン (Mini)` | いいえ | ファイルの現在のバージョンに関する情報。 |
| `description` | `string` | はい | このファイルの説明 (省略可)。 |
| `size` | `integer` | はい | ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。 |
| `path_collection` | `object` | はい | 項目の親フォルダのリスト。 |
| `created_at` | `string` | はい | Box上でこのファイルが作成された日時。 |
| `modified_at` | `string` | はい | Boxでこのファイルが最後に更新された日時。 |
| `trashed_at` | `string` | いいえ | このファイルがごみ箱に移動された日時。復元後は`null`になります。 `null` を指定できます。 |
| `purged_at` | `string` | いいえ | このファイルがごみ箱から削除される予定日時。復元後は`null`になります。 `null` を指定できます。 |
| `content_created_at` | `string` | いいえ | このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。 `null` を指定できます。 |
| `content_modified_at` | `string` | いいえ | このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。 `null` を指定できます。 |
| `created_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | いいえ | このファイルを作成したユーザー。 |
| `modified_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | はい | このファイルを最後に変更したユーザー。 |
| `owned_by` | [ユーザー (Mini)](/ja/reference/users-resources#-mini) | はい | このファイルを所有するユーザー。 |
| `shared_link` | `string` | いいえ | このファイルの共有リンク。ファイルがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これは`null`になります。 `null` を指定できます。 |
| `parent` | [フォルダ (Mini)](/ja/reference/folders-resources#-mini) | いいえ | このファイルが配置されているフォルダ。 `null` を指定できます。 |
| `item_status` | `enum` | はい | この項目が削除されたかどうかを定義します。 - `active` - 項目がごみ箱に移動されていない場合。 - `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。 - `deleted` - 項目がすでに完全に削除されている場合。 使用可能なオプション: `active`, `trashed`, `deleted`. |
```json 例 theme={null}
{
"id": "123456789",
"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": null,
"purged_at": null,
"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": null,
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"item_status": "active"
}
```