ごみ箱内のフォルダを取得
ごみ箱に移動されたフォルダを取得します。
そのフォルダ自体がごみ箱に移動されている場合のみ、この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_idは123です。
Boxアカウントのルートフォルダは常にID 0で表されます。
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
レスポンス
application/jsonごみ箱内のフォルダ
ごみ箱に移動された日時の情報を含め、ごみ箱内にあるフォルダを返します。
application/jsonクライアントエラー
フォルダがごみ箱で直接見つからない場合にエラーを返します。
そのフォルダの親フォルダのいずれかがごみ箱に移動されている場合も、HTTP 404が返されることに注意してください。
その場合、GET /folders/:id/trash APIを使用して調べることができるのは、その親フォルダのみです。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/folders/4353455/trash" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.trashedFolders.getTrashedFolderById(folder.id);Python Gen
client.trashed_folders.get_trashed_folder_by_id(folder.id).NET Gen
await client.TrashedFolders.GetTrashedFolderByIdAsync(folderId: folder.Id);Python
folder = client.folder(folder_id='22222')
folder_from_trash = client.trash().get_item(folder)
print(f'Folder ID is {folder_from_trash.id} and name is {folder_from_trash.name}').NET
BoxFolder trashedFolder = await client.FoldersManager.GetTrashedFolderAsync("22222");Node
client.folders.getTrashedFolder('22222')
.then(trashedFolder => {
/* trashedFolder -> {
type: 'folder',
id: '22222',
sequence_id: '1',
etag: '1',
name: 'Old Files',
created_at: '2013-05-06T22:37:30-07:00',
modified_at: '2013-05-06T22:39:08-07:00',
description: '',
size: 18482,
path_collection:
{ total_count: 1,
entries:
[ { type: 'folder',
id: '1',
sequence_id: null,
etag: null,
name: 'Trash' } ] },
created_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
modified_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
trashed_at: '2013-05-29T09:37:13-07:00',
purged_at: null,
content_created_at: '2013-05-06T22:37:30-07:00',
content_modified_at: '2013-05-06T22:39:08-07:00',
owned_by:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' },
shared_link: null,
folder_upload_email: null,
parent:
{ type: 'folder',
id: '0',
sequence_id: null,
etag: null,
name: 'All Files' },
item_status: 'trashed' }
*/
});レスポンスの例
{
"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": [
{
"type": "folder",
"id": "123456789",
"sequence_id": "null",
"etag": "null",
"name": "Trash"
}
],
"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"
}