Box Developerドキュメント
最新バージョン

ごみ箱内のフォルダを取得

get
https://api.box.com/2.0
/folders/:folder_id/trash

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ごみ箱に移動されたフォルダを取得します。

そのフォルダ自体がごみ箱に移動されている場合のみ、このAPIコールを使用して取得できることに注意してください。そうではなく、その親フォルダのいずれかがごみ箱に移動された場合、GET /folders/:id/trash APIを使用して調べることができるのは、そのフォルダのみです。

ごみ箱に移動されたすべての項目のリストを取得するには、GET /folders/trash/items APIを使用します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_id123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

レスポンス

ごみ箱に移動された日時の情報を含め、ごみ箱内にあるフォルダを返します。

フォルダがごみ箱で直接見つからない場合にエラーを返します。

そのフォルダの親フォルダのいずれかがごみ箱に移動されている場合も、HTTP 404が返されることに注意してください。

その場合、GET /folders/:id/trash APIを使用して調べることができるのは、その親フォルダのみです。

予期しないクライアントエラー。

get
ごみ箱内のフォルダを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/folders/4353455/trash" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

レスポンスの例

{
  "id": "123456789",
  "type": "folder",
  "content_created_at": "2012-12-12T10:53:43-08:00",
  "content_modified_at": "2012-12-12T10:53:43-08:00",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Legal contracts for the new ACME deal",
  "etag": "1",
  "folder_upload_email": "null",
  "item_status": "trashed",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "Contracts",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "null",
        "id": "123456789",
        "name": "Trash",
        "sequence_id": "null",
        "type": "folder"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": "null",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00"
}