Chilkat Online Tools

Ruby / Salesforce Platform APIs / SObject Collections Create

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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": "example.com",
#       "BillingCity": "San Francisco"
#     },
#     {
#       "attributes": {
#         "type": "Contact"
#       },
#       "LastName": "Johnson",
#       "FirstName": "Erica"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateBool("allOrNone",false)
json.UpdateString("records[0].attributes.type","Account")
json.UpdateString("records[0].Name","example.com")
json.UpdateString("records[0].BillingCity","San Francisco")
json.UpdateString("records[1].attributes.type","Contact")
json.UpdateString("records[1].LastName","Johnson")
json.UpdateString("records[1].FirstName","Erica")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/composite/sobjects","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jarrResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# [
#   {
#     "id": "001...",
#     "success": true,
#     "errors": [
#     ]
#   },
#   {
#     "id": "003...",
#     "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
count_i = jarrResp.get_Size()
while i < count_i
    # json is a CkJsonObject
    json = jarrResp.ObjectAt(i)
    id = json.stringOf("id")
    success = json.BoolOf("success")
    j = 0
    count_j = json.SizeOfArray("errors")
    while j < count_j
        json.put_J(j)
        j = j + 1
    end

    i = i + 1
end

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
   "allOrNone" : false,
   "records" : [{
      "attributes" : {"type" : "Account"},
      "Name" : "example.com",
      "BillingCity" : "San Francisco"
   }, {
      "attributes" : {"type" : "Contact"},
      "LastName" : "Johnson",
      "FirstName" : "Erica"
   }]
}'
https://domain.com/services/data/v{{version}}/composite/sobjects

Postman Collection Item JSON

{
  "name": "SObject Collections Create",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"allOrNone\" : false,\n   \"records\" : [{\n      \"attributes\" : {\"type\" : \"Account\"},\n      \"Name\" : \"example.com\",\n      \"BillingCity\" : \"San Francisco\"\n   }, {\n      \"attributes\" : {\"type\" : \"Contact\"},\n      \"LastName\" : \"Johnson\",\n      \"FirstName\" : \"Erica\"\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": "Successful SObject Collections Create",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"allOrNone\" : false,\n   \"records\" : [{\n      \"attributes\" : {\"type\" : \"Account\"},\n      \"Name\" : \"example.com\",\n      \"BillingCity\" : \"San Francisco\"\n   }, {\n      \"attributes\" : {\"type\" : \"Contact\"},\n      \"LastName\" : \"Johnson\",\n      \"FirstName\" : \"Erica\"\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:25:46 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=44/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"id\": \"001...\",\n        \"success\": true,\n        \"errors\": []\n    },\n    {\n        \"id\": \"003...\",\n        \"success\": true,\n        \"errors\": []\n    }\n]"
    }
  ]
}