[SalesForce] How to specify BatchSize in Rest API SOQL call

How to specify BatchSize in Rest API SOQL call, I tried it as per salesforce documentation and its not working ?

Note – I know you can do this using offset, but I wanted to explore if its possible using BatchSize.

Sample Code (I added this code in visualforce page) –

jQuery(document).ready(function($) {
  // Pull 10 Accounts via the REST API
  $.ajax('/services/data/v28.0/query?q=SELECT+Name+FROM+Account+LIMIT+10',
    {
      beforeSend: function(xhr) {
        // Set the OAuth header from the session ID
        xhr.setRequestHeader('Authorization', 'Bearer {!$Api.Session_ID}');
        xhr.setRequestHeader('batchSize', '5');            
      },
      success: function(response) {
        // We got 'em - append our records to the HTML list
        $.each(response.records, function(index, record) {
          $('#accountList').append('<li>'+record.Name+'</li>');
        });
      },
      error: function(jqXHR, textStatus, errorThrown) {
        // Oops - what went wrong?
        alert(jqXHR.status + ': ' + errorThrown);
      }
    }
  );
});

This code still gives me 10 accounts instead of 5 accounts.

Best Answer

The header is called Sforce-Query-Options, specified like this:
```
Sforce-Query-Options: batchSize=1000
```
You can't specify a batch size of less than 200, or greater than 2000. Also, it is only a "hint" and may be adjusted/ignored at the server's discretion.

Related Solutions

[SalesForce] Issue with using OAuth token in REST API

http://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm&language=en_US

reading this awesome article from sfdc its very clearly mentioned that " full does not return a refresh token. You must explicitly request the refresh_token scope to get a refresh token".

hence a refresh_token access is also needed .

[SalesForce] how to call rest API from Html or javascript

First of all, ensure that your Class is global and method is webservice like below -

global class MyClass
{
    webservice static void myMethod() // you can pass parameters
    { 
         // Do something
    }
}

Next if you are calling from Button Click then ensure that Button behaviour is as below-

Behaviour : Execute Javascript
Content source : On-Click Javascript

Ensure that you include appropriate JS files in the Script-

{!REQUIRESCRIPT("/soap/ajax/30.0/connection.js")}
{!REQUIRESCRIPT("/soap/ajax/30.0/apex.js")}

Method can be called as below -

sforce.apex.execute("MyClass","myMethod",{}"});

If method accepts a parameter, the same can be passed in the third argument comma seperated as below -

   sforce.apex.execute("MyClass","myMethod",{requestString:"Sample Request",endpoint:"www.a.com/b"}"});

Now if you are calling from a VF page then the code remains same but ensure that you have added scripts to the top as below:

<apex:includeScript value="/soap/ajax/30.0/connection.js"/>
<apex:includeScript value="/soap/ajax/30.0/apex.js"/>

If you are calling from Outside Salesforce then I would suggest -

Setting OAUTH in salesforce by creating a connected App. (App Setup>Create>Apps)
Change the URL mapping to the top to display appropriate URL. ( This will be endpoint)
then you can use either Curl or SOAP UI tool or hurl.it to check if your class gives proper response.

The process is bit lengthy to explain, and I found a good link that sums it all - http://www.oyecode.com/2014/08/start-building-your-own-rest-api-in.html

Best Answer

Related Solutions

[SalesForce] Issue with using OAuth token in REST API

[SalesForce] how to call rest API from Html or javascript

Related Topic