Chilkat Online Tools

C++ / Salesforce Platform APIs / SObject Collections Upsert

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>
#include <CkJsonArray.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    // 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"
    //     }
    //   ]
    // }

    CkJsonObject json;
    json.UpdateBool("allOrNone",false);
    json.UpdateString("records[0].attributes.type","Account");
    json.UpdateString("records[0].Name","Test Upsert");
    json.UpdateString("records[0].Id","0012o00003OBzVSAA1");

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("Content-Type","application/json");

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME/:FIELD_NAME",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonArray jarrResp;
    jarrResp.LoadSb(sbResponseBody);
    jarrResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jarrResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete 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.

    CkJsonObject *json = 0;
    const char *id = 0;
    bool success;
    bool created;
    int j;
    int count_j;

    int i = 0;
    int count_i = jarrResp.get_Size();
    while (i < count_i) {
        json = jarrResp.ObjectAt(i);
        id = json->stringOf("id");
        success = json->BoolOf("success");
        created = json->BoolOf("created");
        j = 0;
        count_j = json->SizeOfArray("errors");
        while (j < count_j) {
            json->put_J(j);
            j = j + 1;
        }

        delete json;
        i = i + 1;
    }
    }

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]"
    }
  ]
}