> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

# メタデータインスタンス (ファイル) リソース

メタデータインスタンスには、テンプレートとファイル間の関係が記載されています。これには、各フィールドに割り当てられている値が含まれます。

## メタデータインスタンス

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

<Accordion title="属性と例">
  | プロパティ       | 型         | 必須  | 説明                                                                                                                                   |
  | ----------- | --------- | --- | ------------------------------------------------------------------------------------------------------------------------------------ |
  | `$parent`   | `string`  | いいえ | このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。                                                         |
  | `$template` | `string`  | いいえ | テンプレートの名前。                                                                                                                           |
  | `$scope`    | `string`  | いいえ | このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合は`enterprise_{enterprise_id}`、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合は`global`になります。 |
  | `$version`  | `integer` | いいえ | メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。                                                                          |

  ```json 例 theme={null}
  {
    "$parent": "folder_59449484661,",
    "$template": "marketingCollateral",
    "$scope": "enterprise_27335",
    "$version": 1
  }
  ```
</Accordion>

## メタデータインスタンス

ファイルまたはフォルダに適用されているメタデータインスタンスのリスト。

<Accordion title="属性と例">
  | プロパティ     | 型                         | 必須  | 説明                                  |
  | --------- | ------------------------- | --- | ----------------------------------- |
  | `entries` | array of [メタデータインスタンス](#) | いいえ | このファイルまたはフォルダに適用されるメタデータインスタンスのリスト。 |
  | `limit`   | `integer`                 | いいえ | 結果の現在のページに使用された制限。                  |

  ```json 例 theme={null}
  {
    "entries": [
      {
        "$parent": "folder_59449484661,",
        "$template": "marketingCollateral",
        "$scope": "enterprise_27335",
        "$version": 1
      }
    ],
    "limit": 100
  }
  ```
</Accordion>

## メタデータインスタンス (Base)

メタデータインスタンスのBase版の表示。

<Accordion title="属性と例">
  | プロパティ       | 型         | 必須  | 説明                                                                                                                                   |
  | ----------- | --------- | --- | ------------------------------------------------------------------------------------------------------------------------------------ |
  | `$parent`   | `string`  | いいえ | このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。                                                         |
  | `$template` | `string`  | いいえ | テンプレートの名前。                                                                                                                           |
  | `$scope`    | `string`  | いいえ | このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合は`enterprise_{enterprise_id}`、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合は`global`になります。 |
  | `$version`  | `integer` | いいえ | メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。                                                                          |

  ```json 例 theme={null}
  {
    "$parent": "folder_59449484661,",
    "$template": "marketingCollateral",
    "$scope": "enterprise_27335",
    "$version": 1
  }
  ```
</Accordion>

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

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

<Accordion title="属性と例">
  | プロパティ          | 型         | 必須  | 説明                                                                                                                                   |
  | -------------- | --------- | --- | ------------------------------------------------------------------------------------------------------------------------------------ |
  | `$parent`      | `string`  | いいえ | このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。                                                         |
  | `$template`    | `string`  | いいえ | テンプレートの名前。                                                                                                                           |
  | `$scope`       | `string`  | いいえ | このテンプレートが適用されているスコープのID。これは、この会社で使用するために定義されたテンプレートの場合は`enterprise_{enterprise_id}`、Boxを使用するすべての会社が利用できる一般的なテンプレートの場合は`global`になります。 |
  | `$version`     | `integer` | いいえ | メタデータインスタンスのバージョン。このバージョンは0から始まり、ユーザー定義プロパティが変更されるたびに増加します。                                                                          |
  | `$canEdit`     | `boolean` | いいえ | このメタデータインスタンスをユーザーが編集できるかどうか。                                                                                                        |
  | `$id`          | `string`  | いいえ | メタデータインスタンスを識別するためのUUID。                                                                                                             |
  | `$type`        | `string`  | いいえ | このインスタンスの「タイプ」に対応する一意の識別子。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。                                                            |
  | `$typeVersion` | `integer` | いいえ | オブジェクトテンプレートの既知の最新バージョン。これは内部システムプロパティであるため、クライアントアプリケーションでは使用しないでください。                                                              |

  ```json 例 theme={null}
  {
    "$parent": "folder_59449484661,",
    "$template": "marketingCollateral",
    "$scope": "enterprise_27335",
    "$version": 1,
    "$canEdit": true,
    "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
    "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
    "$typeVersion": 2
  }
  ```
</Accordion>
