フォルダ内の項目のページを取得します。これらの項目はファイル、 フォルダ、ウェブリンクのいずれかになります。
フォルダ自体の詳細情報(サイズなど)をリクエストするには、 代わりにフォルダを取得エンドポイントを使用してください。
0
フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123
の場合、folder_id
は123
です。
Boxアカウントのルートフォルダは常にID 0
で表されます。
ASC
結果を並べ替える方向。アルファベットの昇順(ASC
)または降順(DESC
)のいずれかを指定できます。
次の値のいずれか1つ: ASC
,DESC
id,type,name
応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
1000
1000
返す項目の1ページあたりの最大数。
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarker
をtrue
に設定する必要があります。
1000
0
応答が開始される項目のオフセット。
id
項目並べ替えの2番目の基準として使用される属性を定義します。
項目は必ず最初にtype
を基準にして並べ替えられ、
フォルダはファイルよりも前に、
ファイルはウェブリンクよりも前にリストされます。
ルートフォルダ(ID 0
のフォルダ)の場合、このパラメータを使用したマーカーに基づくページ割りはサポートされません。
次の値のいずれか1つ: id
,name
,date
,size
true
オフセットベースのページ割り方式ではなく マーカーベースのページ割り方式を使用するかどうかを指定します。同時に使用できるページ割りの方式は 1つのみです。
この値をtrueに設定すると、APIは、応答の次のページを取得するために、
このエンドポイントにパラメータとして渡すことができる
marker
フィールドを返します。
フォルダに含まれるファイル、フォルダ、およびウェブリンクのコレクションを返します。
Authorization
ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
フォルダが見つからない場合、またはユーザーにフォルダへの アクセス権限が与えられていない場合に返されます。
folder_id
が認識されていない形式で指定されている場合に返されます。
予期しないクライアントエラー。
curl -X GET https://api.box.com/2.0/folders/0/items \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
BoxCollection<BoxItem> folderItems = await client.FoldersManager.GetFolderItemsAsync("11111", 100);
BoxFolder folder = new BoxFolder(api, "id");
for (BoxItem.Info itemInfo : folder) {
if (itemInfo instanceof BoxFile.Info) {
BoxFile.Info fileInfo = (BoxFile.Info) itemInfo;
// Do something with the file.
} else if (itemInfo instanceof BoxFolder.Info) {
BoxFolder.Info folderInfo = (BoxFolder.Info) itemInfo;
// Do something with the folder.
}
}
items = client.folder(folder_id='22222').get_items()
for item in items:
print('{0} {1} is named "{2}"'.format(item.type.capitalize(), item.id, item.name))
client.folders.getItems(
'12345',
{
usemarker: 'false',
fields: 'name',
offset: 0,
limit: 25
})
.then(items => {
/* items -> {
total_count: 2,
entries:
[ { type: 'folder',
id: '11111',
sequence_id: '1',
etag: '1',
name: 'Personal Documents' },
{ type: 'file',
id: '22222',
sequence_id: '0',
etag: '0',
name: 'Q2 Strategy.pptx' } ],
offset: 0,
limit: 25,
order:
[ { by: 'type', direction: 'ASC' },
{ by: 'name', direction: 'ASC' } ] }
*/
});
let folderItems = client.folders.listItems(folderId: "22222", sort: .name, direction: .ascending) { results in
switch results {
case let .success(iterator):
for i in 1 ... 10 {
iterator.next { result in
switch result {
case let .success(item):
switch item {
case let .file(file):
print("File \(file.name) (ID: \(file.id)) is in the folder")
case let .folder(folder):
print("Subfolder \(folder.name) (ID: \(folder.id)) is in the folder")
case let .webLink(webLink):
print("Web link \(webLink.name) (ID: \(webLink.id)) is in the folder")
}
case let .failure(error):
print(error)
}
}
}
case let .failure(error):
print(error)
}
}