ごみ箱内のフォルダリソース

削除されて現在ごみ箱にあるフォルダ。

ごみ箱内のフォルダ

ごみ箱内のフォルダを表します。

属性と例

プロパティ	型	必須	説明
`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<string>`	はい	値は常に`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)	はい	このフォルダを作成したユーザー。
`modified_by`	ユーザー (Mini)	はい	このフォルダを最後に変更したユーザー。
`trashed_at`	`string`	いいえ	このフォルダがごみ箱に移動された日時。 `null` を指定できます。
`purged_at`	`string`	いいえ	このフォルダがごみ箱から削除される予定日時。 `null` を指定できます。
`content_created_at`	`string`	いいえ	このフォルダが最初に作成された日時。 `null` を指定できます。
`content_modified_at`	`string`	いいえ	このフォルダが最後に更新された日時。 `null` を指定できます。
`owned_by`	ユーザー (Mini)	はい	このフォルダを所有するユーザー。
`shared_link`	`string`	いいえ	このフォルダの共有リンク。フォルダがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これは`null`になります。 `null` を指定できます。
`folder_upload_email`	`string`	いいえ	このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、アップロードは動作しなくなるため、これは`null`になります。 `null` を指定できます。
`parent`	フォルダ (Mini)	いいえ	このフォルダが配置されているフォルダ (省略可) ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。 `null` を指定できます。
`item_status`	`enum<string>`	はい	この項目が削除されたかどうかを定義します。 - `active` - 項目がごみ箱に移動されていない場合。 - `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。 - `deleted` - 項目がすでに完全に削除されている場合。使用可能なオプション: `active`, `trashed`, `deleted`.

例

{
  "id": "123456789",
  "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": [
      {
        "type": "folder",
        "id": "123456789",
        "sequence_id": null,
        "etag": null,
        "name": "Trash"
      }
    ]
  },
  "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": null,
  "folder_upload_email": 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/folders/123`の場合、`folder_id`は`123`です。
`etag`	`string`	いいえ	このフォルダのHTTP `etag`。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、`If-Match`および`If-None-Match`ヘッダー内の一部のAPIエンドポイントで使用できます。 `null` を指定できます。
`type`	`enum<string>`	いいえ	値は常に`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)	いいえ	このフォルダを作成したユーザー。
`modified_by`	ユーザー (Mini)	いいえ	このフォルダを最後に変更したユーザー。
`trashed_at`	`string`	いいえ	このフォルダがごみ箱に移動された日時。復元後は`null`になります。 `null` を指定できます。
`purged_at`	`string`	いいえ	このフォルダがごみ箱から削除される予定日時。復元後は`null`になります。 `null` を指定できます。
`content_created_at`	`string`	いいえ	このフォルダが最初に作成された日時。 `null` を指定できます。
`content_modified_at`	`string`	いいえ	このフォルダが最後に更新された日時。 `null` を指定できます。
`owned_by`	ユーザー (Mini)	いいえ	このフォルダを所有するユーザー。
`shared_link`	`string`	いいえ	このファイルの共有リンク。フォルダがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これは`null`になります。 `null` を指定できます。
`folder_upload_email`	`string`	いいえ	このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、元のアップロード用メールアドレスが再度アクティブになっても、これは`null`になります。 `null` を指定できます。
`parent`	フォルダ (Mini)	いいえ	このフォルダが配置されているフォルダ (省略可) ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は`null`になることがあります。 `null` を指定できます。
`item_status`	`enum<string>`	いいえ	この項目が削除されたかどうかを定義します。 - `active` - 項目がごみ箱に移動されていない場合。 - `trashed` - 項目がごみ箱に移動されているが、まだ削除されていない場合。 - `deleted` - 項目がすでに完全に削除されている場合。使用可能なオプション: `active`, `trashed`, `deleted`.

例

{
  "id": "123456789",
  "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": null,
  "purged_at": null,
  "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": null,
  "folder_upload_email": null,
  "parent": {
    "id": "12345",
    "etag": "1",
    "type": "folder",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "item_status": "active"
}

​ごみ箱内のフォルダ

​ごみ箱内のフォルダ (復元済み)

ごみ箱内のフォルダ

ごみ箱内のフォルダ (復元済み)