Chilkat Online Tools

TCL / Salesforce Platform APIs / SObject Collections Delete

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "DELETE" "https://domain.com/services/data/v{{version}}/composite/sobjects?ids=0012o00003OBzVSAA1&allOrNone=true"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jarrResp [new_CkJsonArray]

CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0

puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonArray $jarrResp
    exit
}

delete_CkHttpResponse $resp

# 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 is a CkJsonObject

set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
    set json [CkJsonArray_ObjectAt $jarrResp $i]
    set id [CkJsonObject_stringOf $json "id"]
    set success [CkJsonObject_BoolOf $json "success"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $json "errors"]
    while {$j < $count_j} {
        CkJsonObject_put_J $json $j
        set j [expr $j + 1]
    }
    delete_CkJsonObject $json

    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/composite/sobjects?ids=0012o00003OBzVSAA1&allOrNone=true

Postman Collection Item JSON

{
  "name": "SObject Collections Delete",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": ""
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects?ids=0012o00003OBzVSAA1&allOrNone=true",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "composite",
        "sobjects"
      ],
      "query": [
        {
          "key": "ids",
          "value": "0012o00003OBzVSAA1"
        },
        {
          "key": "allOrNone",
          "value": "true"
        }
      ]
    },
    "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 Delete",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": ""
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects?ids=0012o00003OBzVSAA1&allOrNone=true",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "composite",
            "sobjects"
          ],
          "query": [
            {
              "key": "ids",
              "value": "0012o00003OBzVSAA1"
            },
            {
              "key": "allOrNone",
              "value": "true"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:31:21 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=49/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]"
    }
  ]
}