REST API 開発者ガイド
jQueryAll
指定された SOQL クエリを実行します。Query リソースとは異なり、QueryAll は merge または delete によって削除されるレコードを返します。また、QueryAll はアーカイブ済みの ToDo と行動のレコードの情報を返します。このリソースは REST API バージョン 29.0 以降で使用できます。
QueryAll 要求が実行された場合、同期要求で一度に最大 2,000 個のレコードが返されます。ただし、パフォーマンスを最適化するために、返されるバッチには、照会されたレコードのサイズと複雑さに基づいて、制限値またはリクエストで設定された値よりも少ない数のレコードを含めることができます。結果の合計数が、この制限または結果の要求数を超える場合、応答に含まれるのは、結果のバッチ、false 値の done、およびクエリロケーターになります。クエリロケーターは、後続のレコードのバッチを取得するために「QueryAll More Results」のリソースで使用できます。
nextRecordsUrl の URL に query が指定されている場合でも、最初の QueryAll 要求の残りの結果が提供されます。残りの結果には、最初のクエリに一致した削除されたレコードが含まれます。
応答には、QueryAll 要求で返されたレコードの総数 (totalSize)、これ以上結果がないことを示す Boolean 値 (done)、後続のレコードの URI (nextRecordsUrl)、クエリ結果レコードの配列 (records) が含まれます。
構文
- URI
- /services/data/vXX.X/queryAll?q=query
- 形式
- JSON、XML
- HTTP メソッド
- GET
- 認証
- Authorization: Bearer token
- パラメーター
-
パラメーター 説明 q SOQL クエリ。有効な URI を作成するには、クエリ文字列ではスペースをプラス記号 + に置き換えます。たとえば、SELECT+Name+FROM+MyObject のようになります。
例
- レスポンスボディの例
-
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 クエリを実行する」を参照してください。
- クエリ結果のバッチサイズを大きくするには、「SOQL クエリを実行する」で説明されているクエリ識別子を使用するか、Query Options ヘッダーを使用します。
- SOQL 全般についての詳細は、『SOQL および SOSL リファレンス』を参照してください。