Box Developerドキュメント
ログイン

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

最新バージョン

List metadata template's options for taxonomy field

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

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

Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a query parameter is passed. With a query parameter specified, results are sorted in order of relevance.

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
geography

The key of the metadata taxonomy field in the template.

stringパス内必須
global

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

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

stringパス内必須
properties

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

クエリパラメータ

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

Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.

booleanクエリ内省略可能
true

When set to true this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000 elements. Defaults to false.

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

Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

booleanクエリ内省略可能
true

When set to true, this only returns valid selectable options for this template taxonomy field. Otherwise, it returns all taxonomy nodes, whether or not they are selectable. Defaults to true.

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

Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.

stringクエリ内省略可能
France

Query text to search for the taxonomy nodes.

レスポンス

application/jsonMetadata taxonomy nodes

Returns a list of the taxonomy nodes that match the specified parameters.

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

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

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

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

get
List metadata template's options for taxonomy field
このドキュメント内で一部の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"
}