フォルダ情報の取得
フォルダ内の最初の100エントリを含むフォルダの詳細を取得します。
フォルダ内の項目をさらに多く取得するには、フォルダ内の項目を取得エンドポイントを使用してください。
リクエスト
パスパラメータ
0フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。
Boxアカウントのルートフォルダは常にID 0で表されます。
クエリパラメータ
id,type,name応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
リクエストヘッダー
shared_link=[link]&shared_link_password=[password]この項目の共有リンクのURLと省略可能なパスワード。
このヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。
shared_link=[link]形式を使用するか、パスワードが必要な場合はshared_link=[link]&shared_link_password=[password]を使用します。
このヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。
1項目が変更されている場合にのみ、その項目を返します。
その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは304 Not Modifiedを返して失敗します。
レスポンス
フォルダ内の最初の100エントリを含め、フォルダを返します。
フォルダ内の項目をさらに多く取得するには、Get items in a folderエンドポイントを使用してください。
使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、fieldsクエリパラメータを使用します。
If-None-Matchヘッダーがフォルダの現在のetag値と一致する場合は、空の応答を返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
フォルダが見つからない場合、またはユーザーにフォルダへの アクセス権限が与えられていない場合に返されます。
folder_idが認識されていない形式で指定されている場合に返されます。
予期しないクライアントエラー。
リクエストの例
curl -X GET https://api.box.com/2.0/folders/4353455 \
-H 'Authorization: Bearer <ACCESS_TOKEN>'BoxFolder folder = await client.FoldersManager.GetInformationAsync("11111");BoxFolder folder = new BoxFolder(api, "id");
BoxFolder.Info info = folder.getInfo();folder = client.folder(folder_id='22222').get()
print('Folder "{0}" has {1} items in it'.format(
folder.name,
folder.item_collection.['total_count'],
))client.folders.get('11111')
.then(folder => {
/* folder -> {
type: 'folder',
id: '11111',
sequence_id: '1',
etag: '1',
name: 'Pictures',
created_at: '2012-12-12T10:53:43-08:00',
modified_at: '2012-12-12T11:15:04-08:00',
description: 'Some pictures I took',
size: 629644,
path_collection:
{ total_count: 1,
entries:
[ { type: 'folder',
id: '0',
sequence_id: null,
etag: null,
name: 'All Files' } ] },
created_by:
{ type: 'user',
id: '22222',
name: 'Example User'
login: 'user@example.com' },
modified_by:
{ type: 'user',
id: '22222',
name: 'Example User',
login: 'user@example.com' },
owned_by:
{ type: 'user',
id: '22222',
name: 'Example User',
login: 'user@example.com' },
shared_link: null,
parent:
{ type: 'folder',
id: '0',
sequence_id: null,
etag: null,
name: 'All Files' },
item_status: 'active',
item_collection:
{ total_count: 1,
entries:
[ { type: 'file',
id: '33333',
sequence_id: '3',
etag: '3',
sha1: '134b65991ed521fcfe4724b7d814ab8ded5185dc',
name: 'tigers.jpeg' } ],
offset: 0,
limit: 100 } }
*/
});client.folders.get(
folderId: "22222",
fields: ["name", "created_at"]
) { (result: Result<Folder, BoxSDKError>) in
guard case let .success(folder) = result else {
print("Error getting folder information")
return
}
print("Folder \(folder.name) was created at \(folder.createdAt)")
}レスポンスの例
{}