Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// 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"
// }
// ]
// }
loJson = createobject("CkJsonObject")
loJson.UpdateBool("haltOnError",.T.)
loJson.UpdateString("batchRequests[0].method","GET")
loJson.UpdateString("batchRequests[0].url","v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2")
loJson.UpdateString("batchRequests[1].method","GET")
loJson.UpdateString("batchRequests[1].url","v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/composite/batch","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
llHasErrors = loJResp.BoolOf("hasErrors")
i = 0
lnCount_i = loJResp.SizeOfArray("results")
do while i < lnCount_i
loJResp.I = i
lnStatusCode = loJResp.IntOf("results[i].statusCode")
lnTotalSize = loJResp.IntOf("results[i].result.totalSize")
llDone = loJResp.BoolOf("results[i].result.done")
j = 0
lnCount_j = loJResp.SizeOfArray("results[i].result.records")
do while j < lnCount_j
loJResp.J = j
lnIntVal = loJResp.IntOf("results[i].result.records[j]")
j = j + 1
enddo
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
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}"
}
]
}
