Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("compositeRequest[0].method","POST")
json.UpdateString("compositeRequest[0].url","/services/data/v{{version}}/sobjects/Account")
json.UpdateString("compositeRequest[0].referenceId","refAccount")
json.UpdateString("compositeRequest[0].body.Name","Sample Account")
json.UpdateString("compositeRequest[1].method","POST")
json.UpdateString("compositeRequest[1].url","/services/data/v{{version}}/sobjects/Contact")
json.UpdateString("compositeRequest[1].referenceId","refContact")
json.UpdateString("compositeRequest[1].body.LastName","Sample Contact")
json.UpdateString("compositeRequest[1].body.AccountId","@{refAccount.id}")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/composite/","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
i = 0
count_i = jResp.SizeOfArray("compositeResponse")
while i < count_i
jResp.put_I(i)
Id = jResp.stringOf("compositeResponse[i].body.id")
Success = jResp.BoolOf("compositeResponse[i].body.success")
Location = jResp.stringOf("compositeResponse[i].httpHeaders.Location")
httpStatusCode = jResp.IntOf("compositeResponse[i].httpStatusCode")
referenceId = jResp.stringOf("compositeResponse[i].referenceId")
j = 0
count_j = jResp.SizeOfArray("compositeResponse[i].body.errors")
while j < count_j
jResp.put_J(j)
j = j + 1
end
i = i + 1
end
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}"
}
]
}
