> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# メタデータ階層ノードのリストを取得
> 指定したパラメータに基づいてメタデータ階層ノードを取得する場合に使用します。`query`パラメータを渡さない限り、結果は辞書式順序に並べ替えられます。`query`パラメータを指定すると、結果は関連度順で並べ替えられます。
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 [**Box APIのバージョン管理**](/ja/guides/api-calls/api-versioning-strategy/)を参照してください。
「[Box SDKのバージョニング戦略](/ja/guides/tooling/sdks/sdk-versioning/)について詳しく学ぶ。」
## OpenAPI
````yaml box-openapi-jp.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box
Platform](https://developer.box.com)では、[Box](https://box.com)内に保存されているコンテンツへのアクセス権限を付与する機能が提供されています。また、ファイルとフォルダの基本操作、会社内のユーザーの管理、リーガルホールドやリテンションポリシーなどの複雑なトピックのためのエンドポイントも提供されています。
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 056413ec44
servers:
- url: https://api.box.com/2.0
description: Box Platform APIサーバー。
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: アプリ項目の関連付け
x-box-tag: app_item_associations
- name: 承認
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Signリクエスト
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: ファイルの分類
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: フォルダの分類
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: コラボレーション (リスト)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device Pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: ドメインの制限 (ユーザーの除外)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: コラボレーションに対するドメインを制限
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: ダウンロード
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: メールエイリアス
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: ファイルリクエスト
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: ファイルバージョンリーガルホールド
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: ファイルバージョンリテンション
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: ファイルバージョン
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: フォルダロック
description: フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: 統合マッピング
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: グループメンバーシップ
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: リーガルホールドポリシー
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: リーガルホールドポリシー割り当て
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: メタデータカスケードポリシー
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: メタデータインスタンス (ファイル)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: メタデータインスタンス (フォルダ)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: メタデータ階層
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: メタデータテンプレート
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: 最近使用した項目
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: リテンションポリシー
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: リテンションポリシー割り当て
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: 検索
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: セッション終了
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: 共有リンク (ファイル)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: 共有リンク (フォルダ)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: 共有リンク (ウェブリンク)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: 共有リンク (アプリ項目)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield情報バリア
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield情報バリアのセグメント
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield情報バリアのセグメントメンバー
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield情報バリアレポート
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield情報バリアのセグメント制限
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Signテンプレート
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: 標準およびZonesのストレージポリシー
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: 標準およびZonesのストレージポリシー割り当て
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: タスク割り当て
description: タスク割り当てでは、完了するためにどのタスクをどのユーザーに割り当てるかを定義します。
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: サービス利用規約
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: サービス利用規約のユーザーステータス
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: フォルダの移動
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: ごみ箱内のファイル
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: ごみ箱内のフォルダ
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: ごみ箱内の項目
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: ごみ箱内のウェブリンク
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: アップロード
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: アップロード (分割)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: ユーザーのアバター
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: 電子すかし (ファイル)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: 電子すかし (フォルダ)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: ウェブリンク
description: ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: ワークフロー (リスト)
description: Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
x-box-tag: workflows
- name: zipダウンロード
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developerドキュメント。
url: https://developer.box.com
paths:
/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes:
get:
tags:
- メタデータ階層
summary: メタデータ階層ノードのリストを取得
description: >-
指定したパラメータに基づいてメタデータ階層ノードを取得する場合に使用します。`query`パラメータを渡さない限り、結果は辞書式順序に並べ替えられます。`query`パラメータを指定すると、結果は関連度順で並べ替えられます。
operationId: get_metadata_taxonomies_id_id_nodes
parameters:
- name: namespace
in: path
description: メタデータ階層の名前空間。
required: true
schema:
type: string
example: enterprise_123456
- name: taxonomy_key
in: path
description: メタデータ階層のキー。
required: true
schema:
type: string
example: geography
- name: level
in: query
description: >-
指定したメタデータ階層レベルのみに結果を絞り込みます。複数の値を指定できます。結果には、指定した値のいずれかに一致するノードが含まれます。
required: false
schema:
type: array
items:
type: integer
example:
- 1
- name: parent
in: query
description: すぐ上の親ノードのノード識別子。複数の値を指定できます。結果には、指定した値のいずれかに一致するノードが含まれます。
required: false
schema:
type: array
items:
type: string
example:
- c73a9bf3-f377-4210-9159-3df06a481905
- name: ancestor
in: query
description: 任意の先祖ノードのノード識別子。複数の値を指定できます。結果には、指定した値のいずれかに一致するノードが含まれます。
required: false
schema:
type: array
items:
type: string
example:
- c73a9bf3-f377-4210-9159-3df06a481905
- bf8b8213-be1f-4011-bd45-533c0713fa0a
- name: query
in: query
description: メタデータ階層ノードを検索するためのクエリテキスト。
required: false
schema:
type: string
example: France
- name: include-total-result-count
in: query
description: >-
`true`に設定すると、クエリに一致するノードの総数が示されます。レスポンスでは最大10,000個まで要素数が計算されます。デフォルトでは`false`です。
required: false
schema:
type: boolean
example: true
- name: marker
in: query
description: |-
結果が返される開始位置のマーカー。マーカーベースのページネーションを使用している場合に使用されます。
これを使用するには、`usemarker`を`true`に設定する必要があります。
required: false
schema:
type: string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
- name: limit
in: query
description: 返す項目の1ページあたりの最大数。
required: false
schema:
type: integer
format: int64
maximum: 1000
example: 1000
responses:
'200':
description: 指定されたパラメータに一致するメタデータ階層ノードのリストが返されます。
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataTaxonomyNodes'
'400':
description: リクエストパラメータが無効な場合に返されます。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: 予期しないクライアントエラー。
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: メタデータ階層ノードのリストを取得
source: >-
curl -i -X GET
"https://api.box.com/2.0/metadata_taxonomies/enterprise_123456/geography/nodes"
\
-H "authorization: Bearer "
- lang: dotnet
label: メタデータ階層ノードのリストを取得
source: >-
await
client.MetadataTaxonomies.GetMetadataTaxonomyNodesAsync(namespaceParam:
namespaceParam, taxonomyKey: taxonomyKey);
- lang: swift
label: メタデータ階層ノードのリストを取得
source: >-
try await
client.metadataTaxonomies.getMetadataTaxonomyNodes(namespace:
namespace, taxonomyKey: taxonomyKey)
- lang: java
label: メタデータ階層ノードのリストを取得
source: >-
client.getMetadataTaxonomies().getMetadataTaxonomyNodes(namespace,
taxonomyKey)
- lang: node
label: メタデータ階層ノードのリストを取得
source: |-
await client.metadataTaxonomies.getMetadataTaxonomyNodes(
namespace,
taxonomyKey,
);
- lang: python
label: メタデータ階層ノードのリストを取得
source: >-
client.metadata_taxonomies.get_metadata_taxonomy_nodes(namespace,
taxonomy_key)
components:
schemas:
MetadataTaxonomyNodes:
description: メタデータ階層ノードのリスト。
type: object
allOf:
- type: object
description: マーカーベースのページネーションについて説明しているAPIレスポンスの部分。
properties:
limit:
description: >-
これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
type: integer
format: int64
example: 1000
next_marker:
description: 次の検索結果ページの開始場所のマーカー。
type: string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
nullable: true
prev_marker:
description: 前の検索結果ページの開始場所のマーカー。
type: string
example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
nullable: true
- properties:
entries:
description: メタデータ階層ノードのリスト。
type: array
items:
$ref: '#/components/schemas/MetadataTaxonomyNode'
title: メタデータ階層ノード
x-box-resource-id: metadata_taxonomy_nodes
x-box-tag: metadata_taxonomies
ClientError:
description: 一般的なエラー。
type: object
properties:
type:
description: 値は常に`error`になります。
type: string
example: error
enum:
- error
nullable: false
status:
description: レスポンスのHTTPステータス。
type: integer
format: int32
example: 400
nullable: false
code:
description: Box固有のエラーコード。
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: エラーについての短い説明メッセージ。
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
このエラーに関する追加コンテキストを含む自由形式のオブジェクト。使用できるフィールドは、エンドポイントごとに定義されています。`message`は唯一の例です。
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: このエラーの原因に関する詳細情報にリンクされたURL。
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: Boxサポートに連絡するときに使用できる、このレスポンスの一意の識別子。
type: string
example: abcdef123456
nullable: false
title: クライアントエラー
x-box-resource-id: client_error
MetadataTaxonomyNode:
description: メタデータテンプレートで使用可能なメタデータ階層のノードオブジェクト。
type: object
properties:
id:
description: メタデータ階層ノードの一意の識別子。
type: string
example: 14d3d433-c77f-49c5-b146-9dea370f6e32
displayName:
description: メタデータ階層ノードの表示名。
type: string
example: France
level:
description: ノードが属するレベルのインデックス。
type: integer
example: 2
parentId:
description: 親ノードの識別子。
type: string
example: 99df4513-7102-4896-8228-94635ee9d330
nodePath:
description: |-
すべての先祖ノードの識別子の配列。\
ルートレベルのノードの場合は返されません。
type: array
items:
type: string
example:
- 99df4513-7102-4896-8228-94635ee9d330
ancestors:
description: |-
すべての先祖ノードのオブジェクトの配列。\
ルートレベルのノードの場合は返されません。
type: array
items:
$ref: '#/components/schemas/MetadataTaxonomyAncestor'
required:
- id
- displayName
- level
title: メタデータ階層ノード
x-box-resource-id: metadata_taxonomy_node
x-box-tag: metadata_taxonomies
MetadataTaxonomyAncestor:
description: 先祖を表すメタデータ階層のノードオブジェクト。
type: object
properties:
id:
description: メタデータ階層ノードの一意の識別子。
type: string
example: 14d3d433-c77f-49c5-b146-9dea370f6e32
displayName:
description: メタデータ階層ノードの表示名。
type: string
example: France
level:
description: ノードが属するレベルのインデックス。
type: integer
example: 2
title: 先祖メタデータ階層
securitySchemes:
OAuth2Security:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Boxに格納されているすべてのファイルとフォルダの読み取り
root_readwrite: Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み
manage_app_users: App Userのプロビジョニングと管理
manage_managed_users: 管理対象ユーザーのプロビジョニングと管理
manage_groups: 企業のグループの管理
manage_webhook: APIを使用したプログラムによるWebhookの作成
manage_enterprise_properties: Enterpriseのプロパティを管理
manage_data_retention: データリテンションポリシーの管理
manage_legal_hold: リーガルホールドの管理
````