Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *v_Type;
const wchar_t *v_Url;
const wchar_t *Id;
const wchar_t *DeveloperName;
const wchar_t *MasterLabel;
const wchar_t *ChannelType;
int size;
int totalSize;
BOOL done;
const wchar_t *queryLocator;
const wchar_t *entityTypeName;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"q",L"SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://domain.com/services/data/v{{version}}/tooling/query/",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "size": 2,
// "totalSize": 2,
// "done": true,
// "queryLocator": null,
// "entityTypeName": "PlatformEventChannel",
// "records": [
// {
// "attributes": {
// "type": "PlatformEventChannel",
// "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE"
// },
// "Id": "0YL4H0000004C93WAE",
// "DeveloperName": "HREvents",
// "MasterLabel": "Custom Channel for the HR App",
// "ChannelType": "data"
// },
// {
// "attributes": {
// "type": "PlatformEventChannel",
// "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C98WAE"
// },
// "Id": "0YL4H0000004C98WAE",
// "DeveloperName": "AdvocateEvents",
// "MasterLabel": "Custom Channel for the HR App",
// "ChannelType": "data"
// }
// ]
// }
// 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.
size = CkJsonObjectW_IntOf(jResp,L"size");
totalSize = CkJsonObjectW_IntOf(jResp,L"totalSize");
done = CkJsonObjectW_BoolOf(jResp,L"done");
queryLocator = CkJsonObjectW_stringOf(jResp,L"queryLocator");
entityTypeName = CkJsonObjectW_stringOf(jResp,L"entityTypeName");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"records");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
v_Type = CkJsonObjectW_stringOf(jResp,L"records[i].attributes.type");
v_Url = CkJsonObjectW_stringOf(jResp,L"records[i].attributes.url");
Id = CkJsonObjectW_stringOf(jResp,L"records[i].Id");
DeveloperName = CkJsonObjectW_stringOf(jResp,L"records[i].DeveloperName");
MasterLabel = CkJsonObjectW_stringOf(jResp,L"records[i].MasterLabel");
ChannelType = CkJsonObjectW_stringOf(jResp,L"records[i].ChannelType");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -G -d "q=SELECT%20Id,%20DeveloperName,%20MasterLabel,%20ChannelType%20FROM%20PlatformEventChannel"
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "List event channels",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel"
}
]
}
},
"response": [
{
"name": "List event channels",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 03 Jul 2023 13:15:17 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"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=7/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 \"size\": 2,\n \"totalSize\": 2,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"PlatformEventChannel\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"PlatformEventChannel\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE\"\n },\n \"Id\": \"0YL4H0000004C93WAE\",\n \"DeveloperName\": \"HREvents\",\n \"MasterLabel\": \"Custom Channel for the HR App\",\n \"ChannelType\": \"data\"\n },\n {\n \"attributes\": {\n \"type\": \"PlatformEventChannel\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C98WAE\"\n },\n \"Id\": \"0YL4H0000004C98WAE\",\n \"DeveloperName\": \"AdvocateEvents\",\n \"MasterLabel\": \"Custom Channel for the HR App\",\n \"ChannelType\": \"data\"\n }\n ]\n}"
}
]
}
