Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jarrResp: HCkJsonArray;
respStatusCode: Integer;
json: HCkJsonObject;
v_Type: PWideChar;
v_Url: PWideChar;
Name: PWideChar;
Id: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'ids','');
CkJsonObject_UpdateString(queryParams,'fields','');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jarrResp := CkJsonArray_Create();
CkJsonArray_LoadSb(jarrResp,sbResponseBody);
CkJsonArray_putEmitCompact(jarrResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonArray__emit(jarrResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001..."
// },
// "Name": "Sample Account",
// "Id": "001..."
// }
// ]
// 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 := CkJsonArray_getSize(jarrResp);
while i < count_i do
begin
json := CkJsonArray_ObjectAt(jarrResp,i);
v_Type := CkJsonObject__stringOf(json,'attributes.type');
v_Url := CkJsonObject__stringOf(json,'attributes.url');
Name := CkJsonObject__stringOf(json,'Name');
Id := CkJsonObject__stringOf(json,'Id');
CkJsonObject_Dispose(json);
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
Curl Command
curl -G -d "ids="
-d "fields="
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME
Postman Collection Item JSON
{
"name": "SObject Collections Retrieve",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME?ids=&fields=",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"sobjects",
":SOBJECT_API_NAME"
],
"query": [
{
"key": "ids",
"value": ""
},
{
"key": "fields",
"value": ""
}
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": ""
}
]
},
"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 Retrieve",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME?ids=0012o00003OBzVSAA1&fields=Name",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"sobjects",
":SOBJECT_API_NAME"
],
"query": [
{
"key": "ids",
"value": "0012o00003OBzVSAA1"
},
{
"key": "fields",
"value": "Name"
}
],
"variable": [
{
"key": "SOBJECT_API_NAME",
"value": "Account"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 20 Nov 2023 15:27:03 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 \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001...\"\n },\n \"Name\": \"Sample Account\",\n \"Id\": \"001...\"\n }\n]"
}
]
}
