Box Developerドキュメント

Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。

最新バージョン

IDを指定してメタデータテンプレートを取得

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

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

IDを指定してメタデータテンプレートを取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
f7a9891f

テンプレートのID。

レスポンス

IDと一致するメタデータテンプレートを返します。

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

  • bad_request: テンプレートのIDが認識されていない場合によくメッセージとともに返されます。

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

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

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X GET "https://api.box.com/2.0/metadata_templates/d9671692-3df6-11ea-b77f-2e728ce88125" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.metadataTemplates.getMetadataTemplateById(template.id);
Python v10
client.metadata_templates.get_metadata_template_by_id(template.id)
.NET v10
await client.MetadataTemplates.GetMetadataTemplateByIdAsync(templateId: template.Id);
Swift v10
try await client.metadataTemplates.getMetadataTemplateById(templateId: template.id)
Java v10
client.getMetadataTemplates().getMetadataTemplateById(template.getId())
.NET v6
await client.MetadataTemplates.GetMetadataTemplateByIdAsync(templateId: template.Id);
Node v4
await client.metadataTemplates.getMetadataTemplateById(template.id);

レスポンスの例

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "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,
  "scope": "enterprise_123456",
  "templateKey": "productInfo"
}