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

インスタンスIDでメタデータテンプレートを検索

get
https://api.box.com/2.0
/metadata_templates

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

テンプレートのインスタンスのIDを検索することにより、メタデータテンプレートを見つけます。

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

integer (int64)クエリ内省略可能
1000
1000

返す項目の1ページあたりの最大数。

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkerをtrueに設定する必要があります。

string (uuid)クエリ内必須
01234500-12f1-1234-aa12-b1d234cb567e

検索するメタデータテンプレートのインスタンスのID。

レスポンス

application/jsonメタデータテンプレート

インスタンスIDと一致する1つのメタデータテンプレートを含むリストを返します。

application/jsonクライアントエラー

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

application/jsonクライアントエラー

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

get
インスタンスIDでメタデータテンプレートを検索
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.metadataTemplates.getMetadataTemplatesByInstanceId({
  metadataInstanceId: createdMetadataInstance.id!,
} satisfies GetMetadataTemplatesByInstanceIdQueryParams);
Python Gen
client.metadata_templates.get_metadata_templates_by_instance_id(
    created_metadata_instance.id
)
.NET Gen
await client.MetadataTemplates.GetMetadataTemplatesByInstanceIdAsync(queryParams: new GetMetadataTemplatesByInstanceIdQueryParams(metadataInstanceId: NullableUtils.Unwrap(createdMetadataInstance.Id)));

レスポンスの例

{
  "entries": [
    {
      "copyInstanceOnItemCopy": true,
      "displayName": "Product Info",
      "fields": [
        {
          "description": "The category",
          "displayName": "Category",
          "hidden": true,
          "key": "category",
          "options": [
            {
              "key": "Category 1",
              "id": "45dc2849-a4a7-40a9-a751-4a699a589190"
            }
          ],
          "type": "string",
          "id": "822227e0-47a5-921b-88a8-494760b2e6d2"
        }
      ],
      "hidden": true,
      "id": "58063d82-4128-7b43-bba9-92f706befcdf",
      "scope": "enterprise_123456",
      "templateKey": "productInfo",
      "type": "metadata_template"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}