Chilkat Online Tools

Python / Salesforce Platform APIs / SObject Collections Upsert

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

# 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 = chilkat2.JsonObject()
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.AuthToken = "<access_token>"
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)

# resp is a 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.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jarrResp = chilkat2.JsonArray()
jarrResp.LoadSb(sbResponseBody)
jarrResp.EmitCompact = False

print("Response Body:")
print(jarrResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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

i = 0
count_i = jarrResp.Size
while i < count_i :
    # json is a CkJsonObject
    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.J = j
        j = j + 1

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