Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *v_Type;
const char *v_Url;
const char *Name;
int totalSize;
BOOL done;
int i;
int count_i;
// 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,"q","SELECT name from Account");
// 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}}/queryAll/",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "totalSize": 12,
// "done": true,
// "records": [
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF"
// },
// "Name": "Edge Communications"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF"
// },
// "Name": "Burlington Textiles Corp of America"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2xIAF"
// },
// "Name": "Pyramid Construction Inc."
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF"
// },
// "Name": "Dickenson plc"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ2zIAF"
// },
// "Name": "Grand Hotels & Resorts Ltd"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ30IAF"
// },
// "Name": "United Oil & Gas Corp."
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF"
// },
// "Name": "Express Logistics and Transport"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ32IAF"
// },
// "Name": "University of Arizona"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ33IAF"
// },
// "Name": "United Oil & Gas, UK"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ34IAF"
// },
// "Name": "United Oil & Gas, Singapore"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF"
// },
// "Name": "GenePoint"
// },
// {
// "attributes": {
// "type": "Account",
// "url": "/services/data/v58.0/sobjects/Account/001B000000UnQ36IAF"
// },
// "Name": "sForce"
// }
// ]
// }
// 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.
totalSize = CkJsonObject_IntOf(jResp,"totalSize");
done = CkJsonObject_BoolOf(jResp,"done");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"records");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
v_Type = CkJsonObject_stringOf(jResp,"records[i].attributes.type");
v_Url = CkJsonObject_stringOf(jResp,"records[i].attributes.url");
Name = CkJsonObject_stringOf(jResp,"records[i].Name");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "q=SELECT%20name%20from%20Account"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/queryAll/
Postman Collection Item JSON
{
"name": "QueryAll",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/queryAll/?q=SELECT+name+from+Account",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"queryAll",
""
],
"query": [
{
"key": "q",
"value": "SELECT+name+from+Account"
},
{
"key": "explain",
"value": "",
"description": "A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query string to get feedback on how Salesforce will process your report or list view.",
"disabled": true
}
]
},
"description": "Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.\n\nIf the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch. Note that even though nextRecordsUrl has query in the URL, it will still provide remaining results from the initial QueryAll request. The remaining results will include deleted records that matched the initial query.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm"
},
"response": [
{
"name": "QueryAll",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/queryAll/?q=SELECT+name+from+Account",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"queryAll",
""
],
"query": [
{
"key": "q",
"value": "SELECT+name+from+Account"
},
{
"key": "explain",
"value": "",
"description": "A SOQL query to get performance feedback on. Use explain instead of q to get a response that details how Salesforce will process your query. You can use this feedback to further optimize your queries. You can also use a report or list view ID in place of the query string to get feedback on how Salesforce will process your report or list view.",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 27 Sep 2023 15:27: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=2/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 \"totalSize\": 12,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2vIAF\"\n },\n \"Name\": \"Edge Communications\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2wIAF\"\n },\n \"Name\": \"Burlington Textiles Corp of America\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2xIAF\"\n },\n \"Name\": \"Pyramid Construction Inc.\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2yIAF\"\n },\n \"Name\": \"Dickenson plc\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ2zIAF\"\n },\n \"Name\": \"Grand Hotels & Resorts Ltd\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ30IAF\"\n },\n \"Name\": \"United Oil & Gas Corp.\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ31IAF\"\n },\n \"Name\": \"Express Logistics and Transport\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ32IAF\"\n },\n \"Name\": \"University of Arizona\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ33IAF\"\n },\n \"Name\": \"United Oil & Gas, UK\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ34IAF\"\n },\n \"Name\": \"United Oil & Gas, Singapore\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ35IAF\"\n },\n \"Name\": \"GenePoint\"\n },\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001B000000UnQ36IAF\"\n },\n \"Name\": \"sForce\"\n }\n ]\n}"
}
]
}
