ごみ箱内の項目のリストを取得
ごみ箱に移動されたファイルとフォルダを取得します。
fieldsパラメータを使用して完全版のファイルオブジェクトまたはフォルダオブジェクト内の任意の属性を渡すと、デフォルトでは返されない特定の属性を取得できます。
このエンドポイントはデフォルトでオフセットベースのページ割りを使用しますが、markerパラメータを使用したマーカーベースのページ割りもサポートしています。
リクエスト
クエリパラメータ
ASC結果を並べ替える方向。アルファベットの昇順(ASC)または降順(DESC)のいずれかを指定できます。
次の値のいずれか1つ: ASC,DESC
id,type,name応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
10001000返す項目の1ページあたりの最大数。
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
10000応答が開始される項目のオフセット。
id項目並べ替えの2番目の基準として使用される属性を定義します。
項目は必ず最初にtypeを基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。
マーカーベースのページ割りを使用している場合、このパラメータはサポートされません。
次の値のいずれか1つ: id,name,date,size
trueオフセットベースのページ割り方式ではなく マーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は 1つのみです。
この値をtrueに設定すると、APIは、応答の次のページを取得するために、
このエンドポイントにパラメータとして渡すことができる
markerフィールドを返します。
リクエストの例
curl -X GET https://api.box.com/2.0/folders/trash/items \
-H 'Authorization: Bearer <ACCESS_TOKEN>'BoxCollection<BoxItem> trashedItems = await client.FoldersManager.GetTrashItemsAsync(limit: 100);trashed_items = client.trash().get_items()
for trashed_item in trashed_items:
print('The item ID is {0} and the item name is {1}'.format(trashed_item.id, trashed_item.name))client.trash.get()
.then(trashedItems => {
/* trashedItems -> {
total_count: 2,
entries:
[ { type: 'file',
id: '11111',
sequence_id: '1',
etag: '1',
sha1: '9d976863fc849f6061ecf9736710bd9c2bce488c',
name: 'file Tue Jul 24 145436 2012KWPX5S.csv' },
{ type: 'file',
id: '22222',
sequence_id: '1',
etag: '1',
sha1: '09b0e2e9760caf7448c702db34ea001f356f1197',
name: 'file Tue Jul 24 010055 20129Z6GS3.csv' } ],
offset: 0,
limit: 100 }
*/
});レスポンスの例
{
"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/",
"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
},
"download_count": 3,
"preview_count": 3
},
"parent": {
"id": 12345,
"etag": 1,
"type": "folder",
"sequence_id": 3,
"name": "Contracts"
},
"item_status": "active",
"allowed_invitee_roles": [
"editor"
],
"is_externally_owned": true,
"has_collaborations": true
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
}