SOQL クエリを実行する
Query リソースを使用して、すべての結果を 1 つの応答で返す SOQL クエリを実行するか、必要に応じて結果の一部と、ロケーターを返す SOQL クエリを実行します。そのロケーターを使えば残りの結果も取得できます。
次のクエリは、すべての Account レコードを対象に name 項目の値を要求します。
- クエリを実行する場合の使用例
-
curl https://MyDomainName.my.salesforce.com/services/data/v60.0/query/?q=SELECT+name+from+Account -H "Authorization: Bearer token"
- クエリを実行する場合のリクエストボディの例
- 不要
- クエリを実行する場合のレスポンスボディの例
-
{ "done" : true, "totalSize" : 14, "records" : [ { "attributes" : { "type" : "Account", "url" : "/services/data/v60.0/sobjects/Account/001D000000IRFmaIAH" }, "Name" : "Test 1" }, { "attributes" : { "type" : "Account", "url" : "/services/data/v60.0/sobjects/Account/001D000000IomazIAB" }, "Name" : "Test 2" }, ... ] }
SOQL クエリの残りの結果の取得
最初のクエリで結果の一部のみを返す場合、応答の最後に、次の nextRecordsUrl という項目が含まれます。
"nextRecordsUrl" : "/services/data/v60.0/query/01gD0000002HU6KIAW-2000"
この場合、レコードの次のバッチを要求し、すべてのレコードが取得されるまでこの操作を繰り返します。これらの要求は nextRecordsUrl を使用し、パラメーターを含みません。
- クエリの残りの結果を取得する場合の使用例
-
curl https://MyDomainName.my.salesforce.com/services/data/v60.0/query/01gD0000002HU6KIAW-2000 -H "Authorization: Bearer token"
- クエリの残りの結果を取得する場合のリクエストボディの例
- 不要
- クエリの残りの結果を取得する場合のレスポンスボディの例
-
{ "done" : true, "totalSize" : 3214, "records" : [...] }