client.query.create_query_v2026_r0(
CreateQueryV2026R0Query(
predicate=predicate,
params={"name": "John", "age": 50},
ancestors=[QueryAncestorReferenceV2026R0(id="0", type="folder")],
),
limit=10,
fields=["box:item:name", search_from],
)await client.query.createQueryV2026R0({
query: {
predicate: predicate,
params: { ['name']: 'John', ['age']: 50 },
ancestors: [
{ id: '0', type: 'folder' } satisfies QueryAncestorReferenceV2026R0,
],
} satisfies QueryRequestBodyV2026R0QueryField,
limit: 10,
fields: ['box:item:name', searchFrom],
} satisfies QueryRequestBodyV2026R0);try await client.query.createQueryV2026R0(requestBody: QueryRequestBodyV2026R0(query: QueryRequestBodyV2026R0QueryField(predicate: predicate, params: ["name": "John", "age": 50], ancestors: [QueryAncestorReferenceV2026R0(id: "0", type: "folder")]), limit: 10, fields: ["box:item:name", searchFrom]))client.getQuery().createQueryV2026R0(new QueryRequestBodyV2026R0.Builder(new QueryRequestBodyV2026R0QueryField.Builder(predicate).params(mapOf(entryOf("name", "John"), entryOf("age", 50))).ancestors(Arrays.asList(new QueryAncestorReferenceV2026R0("0", "folder"))).build()).limit(10).fields(Arrays.asList("box:item:name", searchFrom)).build())await client.Query.CreateQueryV2026R0Async(requestBody: new QueryRequestBodyV2026R0(query: new QueryRequestBodyV2026R0QueryField(predicate: predicate) { Parameters = new Dictionary<string, object>() { { "name", "John" }, { "age", 50 } }, Ancestors = Array.AsReadOnly(new [] {new QueryAncestorReferenceV2026R0(id: "0", type: "folder")}) }) { Limit = 10, Fields = Array.AsReadOnly(new [] {"box:item:name",searchFrom}) });{
"entries": [
{
"id": "12345",
"type": "file",
"box": {
"item": {
"name": "My Form"
}
},
"enterprise_12345678": {
"book": {
"$parent": "file_12345",
"$scope": "enterprise_12345678",
"$template": "book",
"$version": 4,
"isbn": "1871263670",
"purchasePrice": 234.57,
"publicationYear": "1937"
}
}
}
],
"next_marker": "xppy0jjG1kBRSc7NBBSgQmBz1Gk6VaQdg5Vyb+Ob0iA=",
"limit": 1
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}Boxの項目に対するクエリ
項目フィールドとメタデータテンプレートに対してフィルタをかけられる論理述語を使用して、Boxの項目を検出するクエリを実行します。結果は並べ替えたり、ページ割りしたりできるほか、追加の項目フィールドやメタデータフィールドを含む形式にすることができます。
client.query.create_query_v2026_r0(
CreateQueryV2026R0Query(
predicate=predicate,
params={"name": "John", "age": 50},
ancestors=[QueryAncestorReferenceV2026R0(id="0", type="folder")],
),
limit=10,
fields=["box:item:name", search_from],
)await client.query.createQueryV2026R0({
query: {
predicate: predicate,
params: { ['name']: 'John', ['age']: 50 },
ancestors: [
{ id: '0', type: 'folder' } satisfies QueryAncestorReferenceV2026R0,
],
} satisfies QueryRequestBodyV2026R0QueryField,
limit: 10,
fields: ['box:item:name', searchFrom],
} satisfies QueryRequestBodyV2026R0);try await client.query.createQueryV2026R0(requestBody: QueryRequestBodyV2026R0(query: QueryRequestBodyV2026R0QueryField(predicate: predicate, params: ["name": "John", "age": 50], ancestors: [QueryAncestorReferenceV2026R0(id: "0", type: "folder")]), limit: 10, fields: ["box:item:name", searchFrom]))client.getQuery().createQueryV2026R0(new QueryRequestBodyV2026R0.Builder(new QueryRequestBodyV2026R0QueryField.Builder(predicate).params(mapOf(entryOf("name", "John"), entryOf("age", 50))).ancestors(Arrays.asList(new QueryAncestorReferenceV2026R0("0", "folder"))).build()).limit(10).fields(Arrays.asList("box:item:name", searchFrom)).build())await client.Query.CreateQueryV2026R0Async(requestBody: new QueryRequestBodyV2026R0(query: new QueryRequestBodyV2026R0QueryField(predicate: predicate) { Parameters = new Dictionary<string, object>() { { "name", "John" }, { "age", 50 } }, Ancestors = Array.AsReadOnly(new [] {new QueryAncestorReferenceV2026R0(id: "0", type: "folder")}) }) { Limit = 10, Fields = Array.AsReadOnly(new [] {"box:item:name",searchFrom}) });{
"entries": [
{
"id": "12345",
"type": "file",
"box": {
"item": {
"name": "My Form"
}
},
"enterprise_12345678": {
"book": {
"$parent": "file_12345",
"$scope": "enterprise_12345678",
"$template": "book",
"$version": 4,
"isbn": "1871263670",
"purchasePrice": 234.57,
"publicationYear": "1937"
}
}
}
],
"next_marker": "xppy0jjG1kBRSc7NBBSgQmBz1Gk6VaQdg5Vyb+Ob0iA=",
"limit": 1
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}承認
The access token received from the authorization server in the OAuth 2.0 flow.
ヘッダー
Version header.
2026.0 ボディ
実行するクエリを記述するリクエスト本文。フィルタ処理の述語、並べ替え (省略可)、ページネーション、各結果で返されるフィールドが含まれます。
クエリの定義。フィルタ処理の述語、そのパラメータ (省略可能)、先祖の制限が含まれます。
Show child attributes
Show child attributes
結果セットの並べ替え基準。エントリが順次適用され、複数レベルの並べ替えが定義されます。
Show child attributes
Show child attributes
返される結果の最大数。指定されていない場合はデフォルトで50に設定されます。
0 <= x <= 1001
各結果エントリに含まれる追加のフィールドを制御します。各値は、項目フィールドの完全修飾キー (例: box:item:name)、テンプレート全体をハイドレートするメタデータテンプレートキー (例: enterprise_12345678:project)、またはテンプレートから単一のフィールドをハイドレートするメタデータテンプレートの特定のフィールドキー (例: enterprise_12345678:project:name) のいずれかである必要があります。省略した場合、エントリには項目の種類と識別子のみが含まれます。
["box:item:name", "enterprise_12345678:book"]
前回のレスポンスから返された不明瞭なトークンで、取得を継続するために使用されます。指定されている場合、他のすべてのリクエストパラメータは、元のリクエストのものと厳密に一致している必要があります。
"xppy0jjG1kBRSc7NBBSgQmBz1Gk6VaQdg5Vyb+Ob0iA="
レスポンス
クエリに一致する項目のページ割りされたリストが返されます。
マイルストーンベースのマーカーページネーションを使用した、クエリに一致する項目のページ割りされたリスト。
このページは役に立ちましたか?
