REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Query Options Header
Specifies options used in a query, such as the query results batch
size. Use this request header with the Query resource.
Header Field Name and Values
- Field name: Sforce-Query-Options
-
Field values:
-
batchSize—A numeric value that specifies the number
of records returned for a query request. Child objects count toward the number of records
for the batch size. For example, in relationship queries, multiple child objects are
returned per parent row returned.
The default is 2,000; the minimum is 200, and the maximum is 2,000. There is no guarantee that the requested batch size is the actual batch size. Changes are made as necessary to maximize performance.
-
batchSize—A numeric value that specifies the number
of records returned for a query request. Child objects count toward the number of records
for the batch size. For example, in relationship queries, multiple child objects are
returned per parent row returned.
- Example: Sforce-Query-Options: batchSize=1000