フォルダ情報を取得
フォルダ内の最初の100エントリを含むフォルダの詳細を取得します。
クエリでsort、direction、offset、およびlimitパラメータを渡すと、返されるフォルダ項目のリストを管理できます。
フォルダ内の項目をさらに多く取得するには、フォルダ内の項目を取得エンドポイントを使用します。
リクエスト
パスパラメータ
"12345"フォルダを表す一意の識別子。
フォルダ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レスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
また、このフィールドを使用すると、ファイルに適用されている任意のメタデータに対してクエリを実行できます。その際、metadataフィールドのほか、取得するテンプレートのスコープとキー (例: ?field=metadata.enterprise_12345.contractTemplate) も指定します。
10001000返す項目の1ページあたりの最大数。
10000レスポンスが開始される項目のオフセット。
オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。
"id"項目並べ替えの2番目の基準として使用される属性を定義します。
フォルダの種類は、項目の並べ替え方法に影響します。
-
標準フォルダ: 項目は必ず最初に
typeを基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。 -
ルートフォルダ: ルートフォルダ
(
idが0のフォルダ) の場合、マーカーベースのページ割りでこのパラメータはサポートされません。 -
関連付けられたフォルダの親パスがコラボレータに表示される共有フォルダ: 項目は必ず最初に
typeを基準にして並べ替えられ、フォルダはファイルよりも前に、ファイルはウェブリンクよりも前にリストされます。
次の値のいずれか1つ: id,name,date,size
リクエストヘッダー
"shared_link=[link]&shared_link_password=[password]"この項目の共有リンクのURLと省略可能なパスワード。
このヘッダーを使用すると、ユーザーと明示的に共有されていない項目にアクセスできます。
shared_link=[link]形式を使用するか、パスワードが必要な場合はshared_link=[link]&shared_link_password=[password]を使用します。
このヘッダーは、共有されているファイルまたはフォルダのほか、その項目内にネストされているすべてのファイルやフォルダで使用できます。
"1"項目が変更されている場合にのみ、その項目を返します。
その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは304 Not Modifiedを返して失敗します。
レスポンス
フォルダ内の最初の100エントリを含め、フォルダを返します。sort、direction、offset、limitのようなクエリパラメータを使用した場合、_フォルダ項目のリスト_は状況に応じて影響を受けます。
フォルダ内の項目をさらに多く取得するには、フォルダ内の項目を取得エンドポイントを使用します。
使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、fieldsクエリパラメータを使用します。
If-None-Matchヘッダーがフォルダの現在のetag値と一致する場合は、空のレスポンスを返します。これは、フォルダが前回リクエストされたときから変更されていないことを示します。
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。
folder_idが認識されていない形式で指定されている場合に返されます。
予期しないクライアントエラー。
リクエストの例
curl -i -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(f'Folder "{folder.name}" has {folder.item_collection["total_count"]} items in it')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)")
}レスポンスの例
{
"id": "12345",
"type": "folder",
"allowed_invitee_roles": [
"editor"
],
"allowed_shared_link_access_levels": [
"open"
],
"can_non_owners_invite": true,
"can_non_owners_view_collaborators": true,
"classification": {
"color": "#FF0000",
"definition": "Content that should not be shared outside the company.",
"name": "Top Secret"
},
"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": {
"access": "open",
"email": "upload.Contracts.asd7asd@u.box.com"
},
"has_collaborations": true,
"is_accessible_via_shared_link": true,
"is_collaboration_restricted_to_enterprise": true,
"is_externally_owned": true,
"item_collection": {
"entries": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
],
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"total_count": 5000
},
"item_status": "active",
"metadata": {
"enterprise_27335": {
"marketingCollateral": {
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661",
"$scope": "enterprise_27335",
"$template": "marketingCollateral",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}
}
},
"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": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"name": "Contracts",
"sequence_id": "3"
}
],
"total_count": 1
},
"permissions": {
"can_delete": true,
"can_download": true,
"can_invite_collaborator": true,
"can_rename": true,
"can_set_share_access": true,
"can_share": true,
"can_upload": true
},
"purged_at": "2012-12-12T10:53:43-08:00",
"sequence_id": "3",
"shared_link": {
"access": "open",
"download_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_edit": false,
"can_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_name": "my_url",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"size": 629644,
"sync_state": "synced",
"tags": [
"approved"
],
"trashed_at": "2012-12-12T10:53:43-08:00",
"watermark_info": {
"is_watermarked": true
}
}