REST API 開発者ガイド
jQuery More Results
クエリロケーターを使用することにより、SOQL クエリから結果の次のバッチを返します。
SOQL クエリから返される結果数が、要求されたレコードの数または制限を超える場合、応答に含まれるのは、結果のバッチ、false 値の done、およびクエリロケーターになります。レコードの次のバッチを取得するには、次の要求でクエリロケーターを使用します。まだ返されていないレコードがある場合は、応答に新しいクエリロケーターが含まれ、done は false となります。結果の取得は、最初のクエリから done が true になるまで、つまり全結果が返されたことを示すまで、続けることができます。
応答には、QueryAll 要求で返されたレコードの総数 (totalSize)、これ以上結果がないことを示す Boolean 値 (done)、後続のレコードの URI (nextRecordsUrl)、クエリ結果レコードの配列 (records) が含まれます。
構文
- URI
- /services/data/vXX.X/query/queryLocator
- 形式
- JSON、XML
- HTTP のメソッド
- GET
- 認証
- Authorization: Bearer token
- パラメーター
-
パラメーター 説明 queryLocator 後続のクエリ結果を取得するために使用する文字列。まだ未取得の結果がある場合、前のクエリ結果の nextRecordsUrl 項目にクエリロケーターが含まれます。
例
- レスポンスボディの例
-
1{ 2 "totalSize": 3222, 3 "done": false, 4 "nextRecordsUrl": "/services/data/v60.0/query/01gRO0000016PIAYA2-500", 5 "records": [ 6 { 7 "attributes": { 8 "type": "Contact", 9 "url": "/services/data/v60.0/sobjects/Contact/003RO0000035WQgYAM" 10 }, 11 "Id": "003RO0000035WQgYAM", 12 "Name": "John Smith" 13 }, 14 ... 15 ] 16}
SOQL クエリ実行のリソース
- クエリロケーターの使用方法については、「SOQL クエリを実行する」を参照してください。
- バッチサイズを変更する別のオプションについては、「Query Options ヘッダー」を参照してください。
-
SOQL 全般についての詳細は、『SOQL および SOSL リファレンス』を参照してください。