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

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

file_id

string

必須

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

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

scope

enum<string>

必須

メタデータテンプレートのスコープ。

利用可能なオプション:

global,

enterprise

template_key

string

必須

メタデータテンプレートの名前。

クエリパラメータ

view

string

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.

レスポンス

ユーザーまたはアプリケーションによって定義された追加の「キー/値」ペアを含むメタデータテンプレートのインスタンス。

ファイルまたはフォルダに適用された、メタデータテンプレートのインスタンス。

$parent

string

このメタデータインスタンスが追加されている項目の識別子。これは、親のtypeとidを{type}_{id}という形式で組み合わせたものです。

例:

"folder_59449484661,"

$template

string

テンプレートの名前。

例:

"marketingCollateral"

$scope

string

このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合はenterprise_{enterprise_id}、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合はglobalになります。

例:

"enterprise_27335"

$version

integer

メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。

例:

1

$canEdit

boolean

このメタデータインスタンスをユーザーが編集できるかどうか。

例:

true

$id

string<uuid>

メタデータインスタンスを識別するためのUUID。

Maximum string length: 36

例:

"01234500-12f1-1234-aa12-b1d234cb567e"

$type

string

このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。

例:

"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0"

$typeVersion

integer

オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。

例:

2

{key}

any

メタデータテンプレートに存在する各フィールドの値。global.propertiesテンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。

例:

"Aaron Levie"