メタデータインスタンス (Full)

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

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

$canEdit boolean

例true

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

$id string (uuid)

例01234500-12f1-1234-aa12-b1d234cb567e

最大長36

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

$parent string

例folder_59449484661,

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

$scope string

例enterprise_27335

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

$template string

例marketingCollateral

テンプレートの名前

$type string

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

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

$typeVersion integer

例2

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

$version integer

例1

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

レスポンスの例

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