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

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

get
https://api.box.com/2.0
/metadata_templates/:namespace/:template_key/fields/:field_key/options

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

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
geography

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

stringパス内必須
enterprise_123456

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

stringパス内必須
properties

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

クエリパラメータ

string arrayクエリ内省略可能
["c73a9bf3-f377-4210-9159-3df06a481905","bf8b8213-be1f-4011-bd45-533c0713fa0a"]

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

booleanクエリ内省略可能
true

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

integer arrayクエリ内省略可能
[1]

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

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

booleanクエリ内省略可能
true

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

string arrayクエリ内省略可能
["c73a9bf3-f377-4210-9159-3df06a481905"]

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

stringクエリ内省略可能
France

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

レスポンス

application/jsonメタデータ階層ノード

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

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

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

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

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

get
メタデータテンプレートのメタデータ階層フィールドオプションのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

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


.NET v6
await client.MetadataTaxonomies.GetMetadataTemplateFieldOptionsAsync(namespaceParam: namespaceParam, templateKey: metadataTemplateKey, fieldKey: "taxonomy");
Node v4
await client.metadataTaxonomies.getMetadataTemplateFieldOptions(
  namespace,
  metadataTemplateKey,
  'taxonomy',
);

レスポンスの例

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