Chilkat Online Tools

lianja / Salesforce Platform APIs / SObject Collections Update

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loJson = createobject("CkJsonObject")
loJson.UpdateBool("allOrNone",.F.)
loJson.UpdateString("records[0].attributes.type","Account")
loJson.UpdateString("records[0].id","<account-id>")
loJson.UpdateInt("records[0].NumberOfEmployees",27000)

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

loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/composite/sobjects",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    release loSbRequestBody
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJarrResp = createobject("CkJsonArray")
loJarrResp.LoadSb(loSbResponseBody)
loJarrResp.EmitCompact = .F.

? "Response Body:"
? loJarrResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbRequestBody
    release loSbResponseBody
    release loJarrResp
    return
endif

release loResp

// 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

i = 0
lnCount_i = loJarrResp.Size
do while i < lnCount_i
    loJson = loJarrResp.ObjectAt(i)
    lcId = loJson.StringOf("id")
    llSuccess = loJson.BoolOf("success")
    j = 0
    lnCount_j = loJson.SizeOfArray("errors")
    do while j < lnCount_j
        loJson.J = j
        j = j + 1
    enddo
    release loJson
    i = i + 1
enddo


release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJarrResp

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