Box Developerドキュメント
最新バージョン

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

get
https://api.box.com/2.0
/files/:file_id/metadata

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

指定したファイルのすべてのメタデータを取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ファイルを表す一意の識別子。

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

クエリパラメータ

stringクエリ内省略可能
hydrated

Taxonomy field values are returned in API view by default, meaning the value is represented with a taxonomy node identifier. To retrieve the Hydrated view, where taxonomy values are represented with the full taxonomy node information, set this parameter to hydrated. This is the only supported value for this parameter.

レスポンス

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

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

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

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

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

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

リクエストの例

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


cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/metadata" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.fileMetadata.getFileMetadata(file.id);
Python v10
client.file_metadata.get_file_metadata(file.id)
.NET v10
await client.FileMetadata.GetFileMetadataAsync(fileId: file.Id);
Swift v10
try await client.fileMetadata.getFileMetadata(fileId: file.id)
Java v10
client.getFileMetadata().getFileMetadata(file.getId())
.NET v6
await client.FileMetadata.GetFileMetadataAsync(fileId: file.Id);
Node v4
await client.fileMetadata.getFileMetadata(file.id);

レスポンスの例

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