Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
#include <C_CkJsonArray.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonArray jarrResp;
int respStatusCode;
HCkJsonObject json;
const char *id;
BOOL success;
BOOL created;
int j;
int count_j;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "allOrNone": false,
// "records": [
// {
// "attributes": {
// "type": "Account"
// },
// "Name": "Test Upsert",
// "Id": "0012o00003OBzVSAA1"
// }
// ]
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateBool(json,"allOrNone",FALSE);
CkJsonObject_UpdateString(json,"records[0].attributes.type","Account");
CkJsonObject_UpdateString(json,"records[0].Name","Test Upsert");
CkJsonObject_UpdateString(json,"records[0].Id","0012o00003OBzVSAA1");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PATCH","https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jarrResp = CkJsonArray_Create();
CkJsonArray_LoadSb(jarrResp,sbResponseBody);
CkJsonArray_putEmitCompact(jarrResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonArray_emit(jarrResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": "001...",
// "success": true,
// "errors": [
// ],
// "created": false
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonArray_getSize(jarrResp);
while (i < count_i) {
json = CkJsonArray_ObjectAt(jarrResp,i);
id = CkJsonObject_stringOf(json,"id");
success = CkJsonObject_BoolOf(json,"success");
created = CkJsonObject_BoolOf(json,"created");
j = 0;
count_j = CkJsonObject_SizeOfArray(json,"errors");
while (j < count_j) {
CkJsonObject_putJ(json,j);
j = j + 1;
}
CkJsonObject_Dispose(json);
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
}
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"allOrNone" : false,
"records" : [{
"attributes" : {"type" : "Account"},
"Name" : "Test Upsert",
"Id" : "0012o00003OBzVSAA1"
}]
}'
https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME
Postman Collection Item JSON
{
"name": "SObject Collections Upsert",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"allOrNone\" : false,\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Account\"},\n \"Name\" : \"Test Upsert\",\n \"Id\" : \"0012o00003OBzVSAA1\"\n }]\n}\n\n\n"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"sobjects",
":SOBJECT_API_NAME",
":FIELD_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
},
{
"key": "FIELD_NAME",
"value": "Id"
}
]
},
"description": "Use a PATCH request with sObject Collections to either create or update (upsert) up to 200 records based on an external ID field. This method returns a list of UpsertResult objects. You can choose whether to roll back the entire request when an error occurs. This request is available in API version 46 and later.\n\n[https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections_upsert.htm)"
},
"response": [
{
"name": "Successful SObject Collections Upsert",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"allOrNone\" : false,\n \"records\" : [{\n \"attributes\" : {\"type\" : \"Account\"},\n \"Name\" : \"Test Upsert\",\n \"Id\" : \"0012o00003OBzVSAA1\"\n }]\n}\n\n\n"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"sobjects",
":SOBJECT_API_NAME",
":FIELD_NAME"
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
},
{
"key": "FIELD_NAME",
"value": "Id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:29:54 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=48/15000"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "[\n {\n \"id\": \"001...\",\n \"success\": true,\n \"errors\": [],\n \"created\": false\n }\n]"
}
]
}