Chilkat Online Tools

Android / Salesforce Platform APIs / Composite Batch

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "haltOnError": true,
    //   "batchRequests": [
    //     {
    //       "method": "GET",
    //       "url": "v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2"
    //     },
    //     {
    //       "method": "GET",
    //       "url": "v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2"
    //     }
    //   ]
    // }

    CkJsonObject json = new CkJsonObject();
    json.UpdateBool("haltOnError",true);
    json.UpdateString("batchRequests[0].method","GET");
    json.UpdateString("batchRequests[0].url","v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2");
    json.UpdateString("batchRequests[1].method","GET");
    json.UpdateString("batchRequests[1].url","v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("Content-Type","application/json");

    CkHttpResponse resp = http.PostJson3("https://domain.com/services/data/v{{version}}/composite/batch","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    CkStringBuilder sbResponseBody = new CkStringBuilder();
    resp.GetBodySb(sbResponseBody);

    CkJsonObject jResp = new CkJsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    Log.i(TAG, "Response Body:");
    Log.i(TAG, jResp.emit());

    int respStatusCode = resp.get_StatusCode();
    Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
    if (respStatusCode >= 400) {
        Log.i(TAG, "Response Header:");
        Log.i(TAG, resp.header());
        Log.i(TAG, "Failed.");

        return;
        }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "hasErrors": false,
    //   "results": [
    //     {
    //       "statusCode": 200,
    //       "result": {
    //         "totalSize": 2,
    //         "done": true,
    //         "records": [
    //           {
    //             "attributes": {
    //               "type": "Account",
    //               "url": "/services/data/v58.0/sobjects/Account/001..."
    //             },
    //             "Id": "001...",
    //             "Name": "Sample Account"
    //           },
    //           ...
    //         ]
    //       }
    //     },
    //     {
    //       "statusCode": 200,
    //       "result": {
    //         "totalSize": 2,
    //         "done": true,
    //         "records": [
    //           {
    //             "attributes": {
    //               "type": "Opportunity",
    //               "url": "/services/data/v58.0/sobjects/Opportunity/006..."
    //             },
    //             "Id": "006...",
    //             "Name": "Edge Emergency Generator"
    //           },
    //           ...
    //         ]
    //       }
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    int statusCode;
    int TotalSize;
    boolean Done;
    int j;
    int count_j;
    int intVal;

    boolean hasErrors = jResp.BoolOf("hasErrors");
    int i = 0;
    int count_i = jResp.SizeOfArray("results");
    while (i < count_i) {
        jResp.put_I(i);
        statusCode = jResp.IntOf("results[i].statusCode");
        TotalSize = jResp.IntOf("results[i].result.totalSize");
        Done = jResp.BoolOf("results[i].result.done");
        j = 0;
        count_j = jResp.SizeOfArray("results[i].result.records");
        while (j < count_j) {
            jResp.put_J(j);
            intVal = jResp.IntOf("results[i].result.records[j]");
            j = j + 1;
            }

        i = i + 1;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "haltOnError": true,
    "batchRequests": [
        {
            "method": "GET",
            "url": "v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2"
        },
        {
            "method": "GET",
            "url": "v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2"
        }
    ]
}'
https://domain.com/services/data/v{{version}}/composite/batch

Postman Collection Item JSON

{
  "name": "Composite Batch",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"haltOnError\": true,\n    \"batchRequests\": [\n        {\n            \"method\": \"GET\",\n            \"url\": \"v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2\"\n        },\n        {\n            \"method\": \"GET\",\n            \"url\": \"v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2\"\n        }\n    ]\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/composite/batch",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "composite",
        "batch"
      ]
    },
    "description": "Executes up to 25 subrequests in a single request. The response bodies and HTTP statuses of the subrequests in the batch are returned in a single response body. Each subrequest counts against rate limits.\nThe requests in a batch are called subrequests. All subrequests are executed in the context of the same user. Subrequests are independent, and you can’t pass information between them. Subrequests execute serially in their order in the request body. When a subrequest executes successfully, it commits its data. Commits are reflected in the output of later subrequests. If a subrequest fails, commits made by previous subrequests are not rolled back. If a batch request doesn’t complete within 10 minutes, the batch times out and the remaining subrequests aren’t executed.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_batch.htm"
  },
  "response": [
    {
      "name": "Successful Composite Batch",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"haltOnError\": true,\n    \"batchRequests\": [\n        {\n            \"method\": \"GET\",\n            \"url\": \"v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2\"\n        },\n        {\n            \"method\": \"GET\",\n            \"url\": \"v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2\"\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/composite/batch",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "composite",
            "batch"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:19:46 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=34/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"hasErrors\": false,\n    \"results\": [\n        {\n            \"statusCode\": 200,\n            \"result\": {\n                \"totalSize\": 2,\n                \"done\": true,\n                \"records\": [\n                    {\n                        \"attributes\": {\n                            \"type\": \"Account\",\n                            \"url\": \"/services/data/v58.0/sobjects/Account/001...\"\n                        },\n                        \"Id\": \"001...\",\n                        \"Name\": \"Sample Account\"\n                    },\n                    ...\n                ]\n            }\n        },\n        {\n            \"statusCode\": 200,\n            \"result\": {\n                \"totalSize\": 2,\n                \"done\": true,\n                \"records\": [\n                    {\n                        \"attributes\": {\n                            \"type\": \"Opportunity\",\n                            \"url\": \"/services/data/v58.0/sobjects/Opportunity/006...\"\n                        },\n                        \"Id\": \"006...\",\n                        \"Name\": \"Edge Emergency Generator\"\n                    },\n                    ...\n                ]\n            }\n        }\n    ]\n}"
    }
  ]
}