Chilkat Online Tools

Node.js / Salesforce Platform APIs / SObject Collections Update

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var 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"
    //       },
    //       "id": "<account-id>",
    //       "NumberOfEmployees": 27000
    //     }
    //   ]
    // }

    var json = new chilkat.JsonObject();
    json.UpdateBool("allOrNone",false);
    json.UpdateString("records[0].attributes.type","Account");
    json.UpdateString("records[0].id","<account-id>");
    json.UpdateInt("records[0].NumberOfEmployees",27000);

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

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/composite/sobjects",sbRequestBody,"utf-8","application/json",false,false);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jarrResp = new chilkat.JsonArray();
    jarrResp.LoadSb(sbResponseBody);
    jarrResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jarrResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // [
    //   {
    //     "id": "001...",
    //     "success": true,
    //     "errors": [
    //     ]
    //   }
    // ]

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // json: JsonObject
    var json;
    var id;
    var success;
    var j;
    var count_j;

    var i = 0;
    var count_i = jarrResp.Size;
    while (i < count_i) {
        json = jarrResp.ObjectAt(i);
        id = json.StringOf("id");
        success = json.BoolOf("success");
        j = 0;
        count_j = json.SizeOfArray("errors");
        while (j < count_j) {
            json.J = j;
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
   "allOrNone" : false,
   "records" : [{
      "attributes" : {"type" : "Account"},
      "id" : "<account-id>",
      "NumberOfEmployees" : 27000
   }]
}'
https://domain.com/services/data/v{{version}}/composite/sobjects

Postman Collection Item JSON

{
  "name": "SObject Collections Update",
  "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      \"id\" : \"<account-id>\",\n      \"NumberOfEmployees\" : 27000\n   }]\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "composite",
        "sobjects"
      ]
    },
    "description": "Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm"
  },
  "response": [
    {
      "name": "SObject Collections Update",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"allOrNone\" : false,\n   \"records\" : [{\n      \"attributes\" : {\"type\" : \"Account\"},\n      \"id\" : \"0012o00003OBzVSAA1\",\n      \"NumberOfEmployees\" : 27000\n   }]\n}"
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "composite",
            "sobjects"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:28:31 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=46/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    }\n]"
    }
  ]
}