ごみ箱内の項目のリストを取得

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

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

fieldsパラメータを使用して完全版のファイルオブジェクトまたはフォルダオブジェクト内の任意の属性を渡すと、デフォルトでは返されない特定の属性を取得できます。

このエンドポイントはデフォルトでオフセットベースのページ割りを使用しますが、markerパラメータを使用したマーカーベースのページ割りもサポートしています。

リクエスト

application/json

クエリパラメータ

stringクエリ内省略可能
ASC

結果を並べ替える方向。アルファベットの昇順(ASC)または降順(DESC)のいずれかを指定できます。

次の値のいずれか1つ: ASC,DESC

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

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

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

integer / int64クエリ内省略可能
10001000

返す項目の1ページあたりの最大数。

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkertrueに設定する必要があります。

integer / int64クエリ内省略可能
10000

応答が開始される項目のオフセット。

stringクエリ内省略可能
id

項目並べ替えの2番目の基準として使用される属性を定義します。

項目は必ず最初にtypeを基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。

マーカーベースのページ割りを使用している場合、このパラメータはサポートされません。

次の値のいずれか1つ: id,name,date,size

booleanクエリ内省略可能
true

オフセットベースのページ割り方式ではなく マーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は 1つのみです。

この値をtrueに設定すると、APIは、応答の次のページを取得するために、 このエンドポイントにパラメータとして渡すことができる markerフィールドを返します。

レスポンス

application/jsonItems

削除された項目のリストを返します

一部のパラメータが指定されていないか無効な場合はエラーを返します。

  • invalid_parameterは、マーカーベースのページ割りの使用時にsortdirection、またはoffsetパラメータを指定した場合か、markerパラメータが指定されているのにusemarkerfalseまたはnullに設定されている場合に返されることがあります。

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

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

リクエストの例

cURL
curl -X GET https://api.box.com/2.0/folders/trash/items \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
.NET
BoxCollection<BoxItem> trashedItems = await client.FoldersManager.GetTrashItemsAsync(limit: 100);
Python
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))
Node
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 }
		*/
	});