Get metadata taxonomy by taxonomy key

Used to retrieve a metadata taxonomy by taxonomy key.

GET /metadata_taxonomies/{namespace}/{taxonomy_key}

cURL

cURL

curl --request GET \
  --url https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
  "displayName": "Geography",
  "namespace": "enterprise_123456",
  "key": "geography",
  "levels": [
    {
      "displayName": "Continent",
      "description": "Continent",
      "level": 1
    }
  ]
}

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。

「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization · string · header · 必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

namespace · string · 必須

The namespace of the metadata taxonomy.

taxonomy_key · string · 必須

The key of the metadata taxonomy.

レスポンス

200

application/json

Returns the metadata taxonomy identified by the taxonomy key.

A taxonomy object for metadata that can be used in metadata templates.

id · string · 必須

A unique identifier of the metadata taxonomy.

例:

"822227e0-47a5-921b-88a8-494760b2e6d2"

displayName · string · 必須

The display name of the metadata taxonomy. This can be seen in the Box web app.

Maximum string length: 4096

例:

"Geography"

namespace · string · 必須

A namespace that the metadata taxonomy is associated with.

Maximum string length: 4096

例:

"enterprise_123456"

key · string

A unique identifier of the metadata taxonomy. The identifier must be unique within the namespace to which it belongs.

Maximum string length: 256

例:

"geography"

levels · Metadata taxonomy level · object[]

Levels of the metadata taxonomy.

表示 子属性