Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
#include <CkJsonArrayW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
CkJsonObjectW queryParams;
queryParams.UpdateString(L"ids",L"");
queryParams.UpdateString(L"fields",L"");
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken(L"<access_token>");
http.SetRequestHeader(L"Content-Type",L"application/json");
CkHttpResponseW resp;
success = http.HttpParams(L"GET",L"https://domain.com/services/data/v{{version}}/composite/sobjects/:SOBJECT_API_NAME",queryParams,resp);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp.GetBodySb(sbResponseBody);
CkJsonArrayW jarrResp;
jarrResp.LoadSb(sbResponseBody);
jarrResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jarrResp.emit());
int respStatusCode = resp.get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp.header());
wprintf(L"Failed.\n");
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
CkJsonObjectW json;
const wchar_t *v_Type = 0;
const wchar_t *v_Url = 0;
const wchar_t *Name = 0;
const wchar_t *Id = 0;
int i = 0;
int count_i = jarrResp.get_Size();
while (i < count_i) {
jarrResp.ObjectAt2(i,json);
v_Type = json.stringOf(L"attributes.type");
v_Url = json.stringOf(L"attributes.url");
Name = json.stringOf(L"Name");
Id = json.stringOf(L"Id");
i = i + 1;
}
}
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]"
}
]
}
