Box Developerドキュメント

Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。

最新バージョン

フォルダのメタデータインスタンスのリストを取得

get
https://api.box.com/2.0
/folders/:folder_id/metadata

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

指定したフォルダのすべてのメタデータを取得します。これは、IDが0のルートフォルダでは使用できません。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_id123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

レスポンス

フォルダに関連付けられたすべてのメタデータを返します。

このAPIはページネーションをサポートしていないため、常にフォルダに関連付けられたすべてのメタデータを返します。

リクエストパラメータが無効な場合に返されます。

  • forbidden - この操作はルートフォルダで許可されていません。

ユーザーがフォルダにアクセスできない場合に返されます。

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

get
フォルダのメタデータインスタンスのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X GET "https://api.box.com/2.0/folders/4353455/metadata" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.folderMetadata.getFolderMetadata(folder.id);
Python v10
client.folder_metadata.get_folder_metadata(folder.id)
.NET v10
await client.FolderMetadata.GetFolderMetadataAsync(folderId: folder.Id);
Swift v10
try await client.folderMetadata.getFolderMetadata(folderId: folder.id)
Java v10
client.getFolderMetadata().getFolderMetadata(folder.getId())
.NET v6
await client.FolderMetadata.GetFolderMetadataAsync(folderId: folder.Id);
Node v4
await client.folderMetadata.getFolderMetadata(folder.id);

レスポンスの例

{
  "entries": [
    {
      "$parent": "folder_59449484661,",
      "$scope": "enterprise_27335",
      "$template": "marketingCollateral",
      "$version": 1
    }
  ],
  "limit": 100
}