QueryAll
この API リソースでは、指定された SOQL クエリが実行されます。Query リソースとは異なり、QueryAll は merge または delete によって削除されるレコードを返します。また、QueryAll はアーカイブ済みの ToDo と行動のレコードの情報を返します。QueryAll は、API バージョン 29.0 以降で使用できます。
SOQL クエリが実行された場合、同期要求で一度に最大 2,000 個のレコードが返されます。結果数がこの制限を超える場合、応答には、最初の結果セットと応答の nextRecordsUrl 項目に含まれるクエリ識別子が含まれます。識別子は、次のバッチを取得するために別の要求で使用できます。 nextRecordsUrl の URL に query が指定されている場合でも、最初の QueryAll 要求の残りの結果が提供されます。残りの結果には、最初のクエリに一致した削除されたレコードが含まれます。
- URI
- /services/data/vXX.X/queryAll/?q=SOQL クエリ
- 最初のレコード数がデフォルトの制限を超える場合は、クエリ識別子を使用して、追加のクエリ結果を取得します。
- /services/data/vXX.X/queryAll/クエリ識別子
- 形式
- JSON、XML
- HTTP メソッド
- GET
- 認証
- Authorization: Bearer token
- パラメータ
-
パラメータ 説明 q SOQL クエリ。有効な URI を作成するには、クエリ文字列ではスペースをプラス記号 + に置き換えます。たとえば、SELECT+Name+FROM+MyObject のようになります。
SOQL クエリ実行のリソース
- 削除された項目を含むクエリを実行するには、「削除された項目を含む SOQL クエリを実行する」を参照してください。
- 最初に返された結果数を超えるクエリ結果を追加で取得するには、「削除された項目を含む SOQL クエリを実行する」の「SOQL クエリの残りの結果の取得」を参照してください。
- クエリ結果のバッチサイズを大きくするには、「SOQL クエリを実行する」で説明されているクエリ識別子を使用するか、Query Options ヘッダーを使用します。
- SOQL 全般についての詳細は、『SOQL および SOSL リファレンス』を参照してください。