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

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

    get
    https://api.box.com/2.0
    /metadata_templates/:scope/:template_key/schema

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

    scopetemplateKeyの値でメタデータテンプレートを取得します。

    テンプレートのscopetemplateKeyを調べるには、会社のすべてのテンプレートまたはグローバルテンプレートのリストを取得するか、ファイルまたはフォルダに適用されているすべてのテンプレートのリストを取得します。

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    パスパラメータ

    stringパス内必須
    global

    メタデータテンプレートのスコープ

    次の値のいずれか1つ: global,enterprise

    stringパス内必須
    properties

    メタデータテンプレートの名前

    レスポンス

    scopeおよびtemplateの名前と一致するメタデータテンプレートを返します。

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

    • bad_request: テンプレートのスコープが認識されていない場合によく返されます。scopeの値として必ずenterpriseまたはglobalを使用してください。

    指定されたscopeおよびtemplate_keyを持つテンプレートが見つからない場合に返されます。

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

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

    リクエストの例

    cURL
    curl -i -X GET "https://api.box.com/2.0/metadata_templates/enterprise/blueprintTemplate/schema" \
         -H "authorization: Bearer <ACCESS_TOKEN>"

    レスポンスの例

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