メタデータインスタンス (詳細)

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

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

boolean
true

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

string / uuid
01234500-12f1-1234-aa12-b1d234cb567e36

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

string
folder_59449484661,

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

string
enterprise_27335

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

string
marketingCollateral

テンプレートの名前

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

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

integer
2

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

integer
1

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

Response Example

{
  "$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
}