Query

SOQL クエリが実行された場合、同期要求で一度に最大 2,000 個のレコードが返されます。結果数がこの制限を超える場合、応答には、最初の 2,000 件の結果セットとクエリロケータが含まれ、done は false 値になります。クエリロケータは、後続のレコードセットを取得するために「Query More Results」のリソースで使用できます。

URI

/services/data/vXX.X/query?q=SOQL_query

形式

JSON、XML

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

パラメータ	説明
q	SOQL クエリ。有効な URI を作成するには、クエリ文字列でスペースをプラス記号 + または %20 に置き換えます。たとえば、SELECT+Name+FROM+MyObject のようになります。SOQL クエリ文字列が無効な場合、MALFORMED_QUERY 応答が返されます。

レスポンスボディ

応答には、QueryAll 要求で返されたレコードの総数 (totalSize)、これ以上結果がないことを示す Boolean 値 (done)、後続のレコードの URI (nextRecordsUrl)、クエリ結果レコードの配列 (records) が含まれます。

レスポンスボディの例

1{
2  "totalSize": 3222,
3  "done": false,
4  "nextRecordsUrl": "/services/data/v57.0/query/01gRO0000016PIAYA2-500",
5  "records": [
6    {
7      "attributes": {
8        "type": "Contact",
9        "url": "/services/data/v57.0/sobjects/Contact/003RO0000035WQgYAM"
10      },
11      "Id": "003RO0000035WQgYAM",
12      "Name": "John Smith"
13    },
14    ...
15  ]
16}