Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_Type: WideString;
v_Url: WideString;
Id: WideString;
DeveloperName: WideString;
MasterLabel: WideString;
ChannelType: WideString;
size: Integer;
totalSize: Integer;
done: Integer;
queryLocator: WideString;
entityTypeName: WideString;
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 := TChilkatHttp.Create(Self);
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('q','SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel');
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
resp := http.QuickRequestParams('GET','https://domain.com/services/data/v{{version}}/tooling/query/',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
size := jResp.IntOf('size');
totalSize := jResp.IntOf('totalSize');
done := jResp.BoolOf('done');
queryLocator := jResp.StringOf('queryLocator');
entityTypeName := jResp.StringOf('entityTypeName');
i := 0;
count_i := jResp.SizeOfArray('records');
while i < count_i do
begin
jResp.I := i;
v_Type := jResp.StringOf('records[i].attributes.type');
v_Url := jResp.StringOf('records[i].attributes.url');
Id := jResp.StringOf('records[i].Id');
DeveloperName := jResp.StringOf('records[i].DeveloperName');
MasterLabel := jResp.StringOf('records[i].MasterLabel');
ChannelType := jResp.StringOf('records[i].ChannelType');
i := i + 1;
end;
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}"
}
]
}
