Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("q","SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sV_Type
Local $sV_Url
Local $sId
Local $sDeveloperName
Local $sMasterLabel
Local $sChannelType
Local $iSize = $oJResp.IntOf("size")
Local $iTotalSize = $oJResp.IntOf("totalSize")
Local $bDone = $oJResp.BoolOf("done")
Local $sQueryLocator = $oJResp.StringOf("queryLocator")
Local $sEntityTypeName = $oJResp.StringOf("entityTypeName")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("records")
While $i < $iCount_i
$oJResp.I = $i
$sV_Type = $oJResp.StringOf("records[i].attributes.type")
$sV_Url = $oJResp.StringOf("records[i].attributes.url")
$sId = $oJResp.StringOf("records[i].Id")
$sDeveloperName = $oJResp.StringOf("records[i].DeveloperName")
$sMasterLabel = $oJResp.StringOf("records[i].MasterLabel")
$sChannelType = $oJResp.StringOf("records[i].ChannelType")
$i = $i + 1
Wend
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}"
}
]
}
