Chilkat Online Tools

TCL / Salesforce Platform APIs / List event channels

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "q" "SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpParams $http "GET" "https://domain.com/services/data/v{{version}}/tooling/query/" $queryParams $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set size [CkJsonObject_IntOf $jResp "size"]
set totalSize [CkJsonObject_IntOf $jResp "totalSize"]
set done [CkJsonObject_BoolOf $jResp "done"]
set queryLocator [CkJsonObject_stringOf $jResp "queryLocator"]
set entityTypeName [CkJsonObject_stringOf $jResp "entityTypeName"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "records"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set v_Type [CkJsonObject_stringOf $jResp "records[i].attributes.type"]
    set v_Url [CkJsonObject_stringOf $jResp "records[i].attributes.url"]
    set Id [CkJsonObject_stringOf $jResp "records[i].Id"]
    set DeveloperName [CkJsonObject_stringOf $jResp "records[i].DeveloperName"]
    set MasterLabel [CkJsonObject_stringOf $jResp "records[i].MasterLabel"]
    set ChannelType [CkJsonObject_stringOf $jResp "records[i].ChannelType"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
    }
  ]
}