Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "compositeRequest": [
; {
; "method": "POST",
; "url": "/services/data/v{{version}}/sobjects/Account",
; "referenceId": "refAccount",
; "body": {
; "Name": "Sample Account"
; }
; },
; {
; "method": "POST",
; "url": "/services/data/v{{version}}/sobjects/Contact",
; "referenceId": "refContact",
; "body": {
; "LastName": "Sample Contact",
; "AccountId": "@{refAccount.id}"
; }
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"compositeRequest[0].method","POST")
CkJsonObject::ckUpdateString(json,"compositeRequest[0].url","/services/data/v{{version}}/sobjects/Account")
CkJsonObject::ckUpdateString(json,"compositeRequest[0].referenceId","refAccount")
CkJsonObject::ckUpdateString(json,"compositeRequest[0].body.Name","Sample Account")
CkJsonObject::ckUpdateString(json,"compositeRequest[1].method","POST")
CkJsonObject::ckUpdateString(json,"compositeRequest[1].url","/services/data/v{{version}}/sobjects/Contact")
CkJsonObject::ckUpdateString(json,"compositeRequest[1].referenceId","refContact")
CkJsonObject::ckUpdateString(json,"compositeRequest[1].body.LastName","Sample Contact")
CkJsonObject::ckUpdateString(json,"compositeRequest[1].body.AccountId","@{refAccount.id}")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpJson(http,"POST","https://domain.com/services/data/v{{version}}/composite/",json,"application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "compositeResponse": [
; {
; "body": {
; "id": "001...",
; "success": true,
; "errors": [
; ]
; },
; "httpHeaders": {
; "Location": "/services/data/v53.0/sobjects/Account/001..."
; },
; "httpStatusCode": 201,
; "referenceId": "refAccount"
; },
; {
; "body": {
; "id": "0032o00003WauzJAAR",
; "success": true,
; "errors": [
; ]
; },
; "httpHeaders": {
; "Location": "/services/data/v53.0/sobjects/Contact/003..."
; },
; "httpStatusCode": 201,
; "referenceId": "refContact"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id.s
Success.i
Location.s
httpStatusCode.i
referenceId.s
j.i
count_j.i
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"compositeResponse")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Id = CkJsonObject::ckStringOf(jResp,"compositeResponse[i].body.id")
Success = CkJsonObject::ckBoolOf(jResp,"compositeResponse[i].body.success")
Location = CkJsonObject::ckStringOf(jResp,"compositeResponse[i].httpHeaders.Location")
httpStatusCode = CkJsonObject::ckIntOf(jResp,"compositeResponse[i].httpStatusCode")
referenceId = CkJsonObject::ckStringOf(jResp,"compositeResponse[i].referenceId")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"compositeResponse[i].body.errors")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"compositeRequest": [
{
"method": "POST",
"url": "/services/data/v{{version}}/sobjects/Account",
"referenceId": "refAccount",
"body": {
"Name": "Sample Account"
}
},
{
"method": "POST",
"url": "/services/data/v{{version}}/sobjects/Contact",
"referenceId": "refContact",
"body": {
"LastName": "Sample Contact",
"AccountId": "@{refAccount.id}"
}
}
]
}'
https://domain.com/services/data/v{{version}}/composite/
Postman Collection Item JSON
{
"name": "Composite",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compositeRequest\": [\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v{{version}}/sobjects/Account\",\n \"referenceId\": \"refAccount\",\n \"body\": {\n \"Name\": \"Sample Account\"\n }\n },\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v{{version}}/sobjects/Contact\",\n \"referenceId\": \"refContact\",\n \"body\": {\n \"LastName\": \"Sample Contact\",\n \"AccountId\": \"@{refAccount.id}\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
""
]
},
"description": "Executes a series of REST API requests in a single call. You can use the output of one request as the input to a subsequent request. The response bodies and HTTP statuses of the requests are returned in a single response body. The entire request counts as a single call toward your API limits.\nThe requests in a composite call are called subrequests. All subrequests are executed in the context of the same user. In a subrequest’s body, you specify a reference ID that maps to the subrequest’s response. You can then refer to the ID in the url or body fields of later subrequests by using a JavaScript-like reference notation.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm"
},
"response": [
{
"name": "Successful Composite",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compositeRequest\": [\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v53.0/sobjects/Account\",\n \"referenceId\": \"refAccount\",\n \"body\": {\n \"Name\": \"Sample Account\"\n }\n },\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v53.0/sobjects/Contact\",\n \"referenceId\": \"refContact\",\n \"body\": {\n \"LastName\": \"Sample Contact\",\n \"AccountId\": \"@{refAccount.id}\"\n }\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
""
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:18:26 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=33/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 \"compositeResponse\": [\n {\n \"body\": {\n \"id\": \"001...\",\n \"success\": true,\n \"errors\": []\n },\n \"httpHeaders\": {\n \"Location\": \"/services/data/v53.0/sobjects/Account/001...\"\n },\n \"httpStatusCode\": 201,\n \"referenceId\": \"refAccount\"\n },\n {\n \"body\": {\n \"id\": \"0032o00003WauzJAAR\",\n \"success\": true,\n \"errors\": []\n },\n \"httpHeaders\": {\n \"Location\": \"/services/data/v53.0/sobjects/Contact/003...\"\n },\n \"httpStatusCode\": 201,\n \"referenceId\": \"refContact\"\n }\n ]\n}"
}
]
}
