Python

client.metadata_taxonomies.get_metadata_template_field_options(
    namespace, metadata_template_key, "taxonomy"
)

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
      "displayName": "France",
      "level": 2,
      "parentId": "99df4513-7102-4896-8228-94635ee9d330",
      "nodePath": [
        "99df4513-7102-4896-8228-94635ee9d330"
      ],
      "ancestors": [
        {
          "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
          "displayName": "France",
          "level": 2
        }
      ]
    }
  ]
}

エンドポイント

メタデータテンプレートのメタデータ階層フィールドオプションのリストを取得

メタデータ階層フィールドの構成および指定したパラメータに基づいて、そのフィールドで使用可能なメタデータ階層ノードを取得する場合に使用します。queryパラメータを渡さない限り、結果は辞書式順序に並べ替えられます。queryパラメータを指定すると、結果は関連度順で並べ替えられます。

GET

metadata_templates

{namespace}

{template_key}

fields

{field_key}

options

Python

client.metadata_taxonomies.get_metadata_template_field_options(
    namespace, metadata_template_key, "taxonomy"
)

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
      "displayName": "France",
      "level": 2,
      "parentId": "99df4513-7102-4896-8228-94635ee9d330",
      "nodePath": [
        "99df4513-7102-4896-8228-94635ee9d330"
      ],
      "ancestors": [
        {
          "id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
          "displayName": "France",
          "level": 2
        }
      ]
    }
  ]
}

このリソースは、バージョン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

必須

メタデータ階層の名前空間。

template_key

string

必須

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

field_key

string

必須

テンプレート内のメタデータ階層フィールドのキー。

クエリパラメータ

level

integer[]

指定したメタデータ階層レベルのみに結果を絞り込みます。複数の値を指定できます。結果には、指定した値のいずれかに一致するノードが含まれます。

parent

string[]

すぐ上の親ノードのノード識別子。複数の値を指定できます。結果には、指定した値のいずれかに一致するノードが含まれます。

ancestor

string[]

任意の先祖ノードのノード識別子。複数の値を指定できます。結果には、指定した値のいずれかに一致するノードが含まれます。

query

string

メタデータ階層ノードを検索するためのクエリテキスト。

include-total-result-count

boolean

trueに設定すると、クエリに一致するノードの総数が示されます。レスポンスでは最大10,000個まで要素数が計算されます。デフォルトではfalseです。

only-selectable-options

boolean

trueに設定すると、指定したテンプレートのメタデータ階層フィールドに選択できる有効なオプションだけが返されます。それ以外の場合は、選択可能かどうかにかかわらず、すべてのメタデータ階層ノードが返されます。デフォルトではtrueです。

marker

string

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

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

limit

integer<int64>

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

必須範囲: x <= 1000

レスポンス

指定されたパラメータに一致するメタデータ階層ノードのリストが返されます。

メタデータ階層ノードのリスト。

limit

integer<int64>

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

例:

1000

next_marker

string | null

次の検索結果ページの開始場所のマーカー。

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

prev_marker

string | null

前の検索結果ページの開始場所のマーカー。

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

entries

メタデータ階層ノード · object[]

メタデータ階層ノードのリスト。

表示子属性

IDを指定してメタデータ階層ノードを取得

メタデータ階層キーを指定してメタデータ階層を取得

⌘I