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 *Id;
const char *DeveloperName;
const char *MasterLabel;
const char *ChannelType;
int size;
int totalSize;
BOOL done;
const char *queryLocator;
const char *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 = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"q","SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/services/data/v{{version}}/tooling/query/",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)
// {
// "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 = CkJsonObject_IntOf(jResp,"size");
totalSize = CkJsonObject_IntOf(jResp,"totalSize");
done = CkJsonObject_BoolOf(jResp,"done");
queryLocator = CkJsonObject_stringOf(jResp,"queryLocator");
entityTypeName = CkJsonObject_stringOf(jResp,"entityTypeName");
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");
Id = CkJsonObject_stringOf(jResp,"records[i].Id");
DeveloperName = CkJsonObject_stringOf(jResp,"records[i].DeveloperName");
MasterLabel = CkJsonObject_stringOf(jResp,"records[i].MasterLabel");
ChannelType = CkJsonObject_stringOf(jResp,"records[i].ChannelType");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_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}"
}
]
}
