Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Integer iStatusCode
Integer iTotalSize
Boolean iDone
Integer j
Integer iCount_j
Integer iIntVal
Boolean iHasErrors
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateBool Of hoJson "haltOnError" True To iSuccess
Get ComUpdateString Of hoJson "batchRequests[0].method" "GET" To iSuccess
Get ComUpdateString Of hoJson "batchRequests[0].url" "v{{version}}/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2" To iSuccess
Get ComUpdateString Of hoJson "batchRequests[1].method" "GET" To iSuccess
Get ComUpdateString Of hoJson "batchRequests[1].url" "v{{version}}/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/services/data/v{{version}}/composite/batch" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComBoolOf Of hoJResp "hasErrors" To iHasErrors
Move 0 To i
Get ComSizeOfArray Of hoJResp "results" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComIntOf Of hoJResp "results[i].statusCode" To iStatusCode
Get ComIntOf Of hoJResp "results[i].result.totalSize" To iTotalSize
Get ComBoolOf Of hoJResp "results[i].result.done" To iDone
Move 0 To j
Get ComSizeOfArray Of hoJResp "results[i].result.records" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComIntOf Of hoJResp "results[i].result.records[j]" To iIntVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
