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
String sReferenceId
String sId
Boolean iHasErrors
Integer i
Integer iCount_i
String sTemp1
// 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.
// {
// "records": [
// {
// "attributes": {
// "type": "Account",
// "referenceId": "ref1"
// },
// "name": "SampleAccount1",
// "phone": "1234567890",
// "website": "www.salesforce.com",
// "numberOfEmployees": "100",
// "industry": "Banking",
// "Contacts": {
// "records": [
// {
// "attributes": {
// "type": "Contact",
// "referenceId": "ref2"
// },
// "lastname": "Smith",
// "Title": "President",
// "email": "sample@salesforce.com"
// },
// {
// "attributes": {
// "type": "Contact",
// "referenceId": "ref3"
// },
// "lastname": "Evans",
// "title": "Vice President",
// "email": "sample@salesforce.com"
// }
// ]
// }
// },
// {
// "attributes": {
// "type": "Account",
// "referenceId": "ref4"
// },
// "name": "SampleAccount2",
// "phone": "1234567890",
// "website": "www.salesforce.com",
// "numberOfEmployees": "52000",
// "industry": "Banking",
// "childAccounts": {
// "records": [
// {
// "attributes": {
// "type": "Account",
// "referenceId": "ref5"
// },
// "name": "SampleChildAccount1",
// "phone": "1234567890",
// "website": "www.salesforce.com",
// "numberOfEmployees": "100",
// "industry": "Banking"
// }
// ]
// },
// "Contacts": {
// "records": [
// {
// "attributes": {
// "type": "Contact",
// "referenceId": "ref6"
// },
// "lastname": "Jones",
// "title": "President",
// "email": "sample@salesforce.com"
// }
// ]
// }
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "records[0].attributes.type" "Account" To iSuccess
Get ComUpdateString Of hoJson "records[0].attributes.referenceId" "ref1" To iSuccess
Get ComUpdateString Of hoJson "records[0].name" "SampleAccount1" To iSuccess
Get ComUpdateString Of hoJson "records[0].phone" "1234567890" To iSuccess
Get ComUpdateString Of hoJson "records[0].website" "www.salesforce.com" To iSuccess
Get ComUpdateString Of hoJson "records[0].numberOfEmployees" "100" To iSuccess
Get ComUpdateString Of hoJson "records[0].industry" "Banking" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[0].attributes.type" "Contact" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[0].attributes.referenceId" "ref2" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[0].lastname" "Smith" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[0].Title" "President" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[0].email" "sample@salesforce.com" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[1].attributes.type" "Contact" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[1].attributes.referenceId" "ref3" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[1].lastname" "Evans" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[1].title" "Vice President" To iSuccess
Get ComUpdateString Of hoJson "records[0].Contacts.records[1].email" "sample@salesforce.com" To iSuccess
Get ComUpdateString Of hoJson "records[1].attributes.type" "Account" To iSuccess
Get ComUpdateString Of hoJson "records[1].attributes.referenceId" "ref4" To iSuccess
Get ComUpdateString Of hoJson "records[1].name" "SampleAccount2" To iSuccess
Get ComUpdateString Of hoJson "records[1].phone" "1234567890" To iSuccess
Get ComUpdateString Of hoJson "records[1].website" "www.salesforce.com" To iSuccess
Get ComUpdateString Of hoJson "records[1].numberOfEmployees" "52000" To iSuccess
Get ComUpdateString Of hoJson "records[1].industry" "Banking" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].attributes.type" "Account" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].attributes.referenceId" "ref5" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].name" "SampleChildAccount1" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].phone" "1234567890" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].website" "www.salesforce.com" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].numberOfEmployees" "100" To iSuccess
Get ComUpdateString Of hoJson "records[1].childAccounts.records[0].industry" "Banking" To iSuccess
Get ComUpdateString Of hoJson "records[1].Contacts.records[0].attributes.type" "Contact" To iSuccess
Get ComUpdateString Of hoJson "records[1].Contacts.records[0].attributes.referenceId" "ref6" To iSuccess
Get ComUpdateString Of hoJson "records[1].Contacts.records[0].lastname" "Jones" To iSuccess
Get ComUpdateString Of hoJson "records[1].Contacts.records[0].title" "President" To iSuccess
Get ComUpdateString Of hoJson "records[1].Contacts.records[0].email" "sample@salesforce.com" 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 Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoJson to vJson
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "https://domain.com/services/data/v{{version}}/composite/tree/:SOBJECT_API_NAME" vJson "application/json" vResp To iSuccess
If (iSuccess = 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."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "hasErrors": false,
// "results": [
// {
// "referenceId": "ref1",
// "id": "001..."
// },
// {
// "referenceId": "ref4",
// "id": "001..."
// },
// {
// "referenceId": "ref2",
// "id": "003.."
// },
// {
// "referenceId": "ref3",
// "id": "003..."
// },
// {
// "referenceId": "ref5",
// "id": "001..."
// },
// {
// "referenceId": "ref6",
// "id": "003..."
// }
// ]
// }
// 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 ComStringOf Of hoJResp "results[i].referenceId" To sReferenceId
Get ComStringOf Of hoJResp "results[i].id" To sId
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"records" :[{
"attributes" : {"type" : "Account", "referenceId" : "ref1"},
"name" : "SampleAccount1",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "100",
"industry" : "Banking",
"Contacts" : {
"records" : [{
"attributes" : {"type" : "Contact", "referenceId" : "ref2"},
"lastname" : "Smith",
"Title" : "President",
"email" : "sample@salesforce.com"
},{
"attributes" : {"type" : "Contact", "referenceId" : "ref3"},
"lastname" : "Evans",
"title" : "Vice President",
"email" : "sample@salesforce.com"
}]
}
},{
"attributes" : {"type" : "Account", "referenceId" : "ref4"},
"name" : "SampleAccount2",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "52000",
"industry" : "Banking",
"childAccounts" : {
"records" : [{
"attributes" : {"type" : "Account", "referenceId" : "ref5"},
"name" : "SampleChildAccount1",
"phone" : "1234567890",
"website" : "www.salesforce.com",
"numberOfEmployees" : "100",
"industry" : "Banking"
}]
},
"Contacts" : {
"records" : [{
"attributes" : {"type" : "Contact", "referenceId" : "ref6"},
"lastname" : "Jones",
"title" : "President",
"email" : "sample@salesforce.com"
}]
}
}]
}'
https://domain.com/services/data/v{{version}}/composite/tree/:SOBJECT_API_NAME
Postman Collection Item JSON
{
"name": "SObject Tree",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\"records\" :[{\n \"attributes\" : {\"type\" : \"Account\", \"referenceId\" : \"ref1\"},\n \"name\" : \"SampleAccount1\",\n \"phone\" : \"1234567890\",\n \"website\" : \"www.salesforce.com\",\n \"numberOfEmployees\" : \"100\",\n \"industry\" : \"Banking\",\n \"Contacts\" : {\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Contact\", \"referenceId\" : \"ref2\"},\n \"lastname\" : \"Smith\",\n \"Title\" : \"President\",\n \"email\" : \"sample@salesforce.com\"\n },{\n \"attributes\" : {\"type\" : \"Contact\", \"referenceId\" : \"ref3\"},\n \"lastname\" : \"Evans\",\n \"title\" : \"Vice President\",\n \"email\" : \"sample@salesforce.com\"\n }]\n }\n },{\n \"attributes\" : {\"type\" : \"Account\", \"referenceId\" : \"ref4\"},\n \"name\" : \"SampleAccount2\",\n \"phone\" : \"1234567890\",\n \"website\" : \"www.salesforce.com\",\n \"numberOfEmployees\" : \"52000\",\n \"industry\" : \"Banking\",\n \"childAccounts\" : {\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Account\", \"referenceId\" : \"ref5\"},\n \"name\" : \"SampleChildAccount1\",\n \"phone\" : \"1234567890\",\n \"website\" : \"www.salesforce.com\",\n \"numberOfEmployees\" : \"100\",\n \"industry\" : \"Banking\"\n }]\n },\n \"Contacts\" : {\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Contact\", \"referenceId\" : \"ref6\"},\n \"lastname\" : \"Jones\",\n \"title\" : \"President\",\n \"email\" : \"sample@salesforce.com\"\n }]\n }\n }]\n}"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/tree/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"tree",
":SOBJECT_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
}
]
},
"description": "Creates one or more sObject trees with root records of the specified type. An sObject tree is a collection of nested, parent-child records with a single root record.\nIn the request data, you supply the record hierarchies, required and optional field values, each record’s type, and a reference ID for each record. Upon success, the response contains the IDs of the created records. If an error occurs while creating a record, the entire request fails. In this case, the response contains only the reference ID of the record that caused the error and the error information.\n\nThe request can contain the following:\nUp to a total of 200 records across all trees\nUp to five records of different types\nSObject trees up to five levels deep\nBecause an sObject tree can contain a single record, you can use this resource to create up to 200 unrelated records of the same type.\n\nWhen the request is processed and records are created, triggers, processes, and workflow rules fire separately for each of the following groups of records.\nRoot records across all sObject trees in the request\nAll second-level records of the same type—for example, second-level Contacts across all sObject trees in the request\nAll third-level records of the same type\nAll fourth-level records of the same type\nAll fifth-level records of the same type\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobject_tree.htm"
},
"response": [
{
"name": "Successful SObject Tree",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\"records\" :[{\n \"attributes\" : {\"type\" : \"Account\", \"referenceId\" : \"ref1\"},\n \"name\" : \"SampleAccount1\",\n \"phone\" : \"1234567890\",\n \"website\" : \"www.salesforce.com\",\n \"numberOfEmployees\" : \"100\",\n \"industry\" : \"Banking\",\n \"Contacts\" : {\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Contact\", \"referenceId\" : \"ref2\"},\n \"lastname\" : \"Smith\",\n \"Title\" : \"President\",\n \"email\" : \"sample@salesforce.com\"\n },{\n \"attributes\" : {\"type\" : \"Contact\", \"referenceId\" : \"ref3\"},\n \"lastname\" : \"Evans\",\n \"title\" : \"Vice President\",\n \"email\" : \"sample@salesforce.com\"\n }]\n }\n },{\n \"attributes\" : {\"type\" : \"Account\", \"referenceId\" : \"ref4\"},\n \"name\" : \"SampleAccount2\",\n \"phone\" : \"1234567890\",\n \"website\" : \"www.salesforce.com\",\n \"numberOfEmployees\" : \"52000\",\n \"industry\" : \"Banking\",\n \"childAccounts\" : {\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Account\", \"referenceId\" : \"ref5\"},\n \"name\" : \"SampleChildAccount1\",\n \"phone\" : \"1234567890\",\n \"website\" : \"www.salesforce.com\",\n \"numberOfEmployees\" : \"100\",\n \"industry\" : \"Banking\"\n }]\n },\n \"Contacts\" : {\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Contact\", \"referenceId\" : \"ref6\"},\n \"lastname\" : \"Jones\",\n \"title\" : \"President\",\n \"email\" : \"sample@salesforce.com\"\n }]\n }\n }]\n}"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/tree/:SOBJECT_API_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"tree",
":SOBJECT_API_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:23:41 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=41/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 \"referenceId\": \"ref1\",\n \"id\": \"001...\"\n },\n {\n \"referenceId\": \"ref4\",\n \"id\": \"001...\"\n },\n {\n \"referenceId\": \"ref2\",\n \"id\": \"003..\"\n },\n {\n \"referenceId\": \"ref3\",\n \"id\": \"003...\"\n },\n {\n \"referenceId\": \"ref5\",\n \"id\": \"001...\"\n },\n {\n \"referenceId\": \"ref6\",\n \"id\": \"003...\"\n }\n ]\n}"
}
]
}
