メインコンテンツへスキップ
GET
/
metadata_templates
/
{scope}
/
{template_key}
/
fields
/
{field_key}
/
options
List metadata template's options for taxonomy field
curl --request GET \
  --url https://api.box.com/2.0/metadata_templates/{scope}/{template_key}/fields/{field_key}/options \
  --header 'Authorization: Bearer <token>'
{
  "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
        }
      ]
    }
  ]
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

認証

​
Authorization
string
header
必須

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

パスパラメータ

​
scope
enum<string>
必須

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

利用可能なオプション:
global,
enterprise
​
template_key
string
必須

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

​
field_key
string
必須

The key of the metadata taxonomy field in the template.

クエリパラメータ

​
level
integer[]

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

​
parent
string[]

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

​
ancestor
string[]

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

​
query
string

Query text to search for the taxonomy nodes.

​
include-total-result-count
boolean

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.

​
only-selectable-options
boolean

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.

​
marker
string

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

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

​
limit
integer<int64>

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

必須範囲: x <= 1000

レスポンス

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

A list of metadata taxonomy nodes.

​
limit
integer<int64>

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

例:

1000

​
next_marker
string | null

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

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

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

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
entries
Metadata taxonomy node · object[]

A list of metadata taxonomy nodes.