Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"q","SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/services/data/v{{version}}/tooling/query/",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "size": 4,
; "totalSize": 4,
; "done": true,
; "queryLocator": null,
; "entityTypeName": "PlatformEventChannelMember",
; "records": [
; {
; "attributes": {
; "type": "PlatformEventChannelMember",
; "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000PAvIQAW"
; },
; "Id": "0v84H000000PAvIQAW",
; "DeveloperName": "ChangeEvents_ContactChangeEvent",
; "EventChannel": "ChangeEvents",
; "FilterExpression": null,
; "SelectedEntity": "ContactChangeEvent"
; },
; {
; "attributes": {
; "type": "PlatformEventChannelMember",
; "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000XZCjQAO"
; },
; "Id": "0v84H000000XZCjQAO",
; "DeveloperName": "ChangeEvents_AccountChangeEvent",
; "EventChannel": "ChangeEvents",
; "FilterExpression": null,
; "SelectedEntity": "AccountChangeEvent"
; },
; {
; "attributes": {
; "type": "PlatformEventChannelMember",
; "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSfQAI"
; },
; "Id": "0v84H000000fxSfQAI",
; "DeveloperName": "HREvents_Employee_ChangeEvent",
; "EventChannel": "0YL4H0000004C93WAE",
; "FilterExpression": null,
; "SelectedEntity": "Meeting_Note__ChangeEvent"
; },
; {
; "attributes": {
; "type": "PlatformEventChannelMember",
; "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSkQAI"
; },
; "Id": "0v84H000000fxSkQAI",
; "DeveloperName": "AdvocateEvents_Employee_ChangeEvent",
; "EventChannel": "0YL4H0000004C98WAE",
; "FilterExpression": null,
; "SelectedEntity": "Meeting_Note__ChangeEvent"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
v_Type.s
v_Url.s
Id.s
DeveloperName.s
EventChannel.s
FilterExpression.s
SelectedEntity.s
size.i = CkJsonObject::ckIntOf(jResp,"size")
totalSize.i = CkJsonObject::ckIntOf(jResp,"totalSize")
done.i = CkJsonObject::ckBoolOf(jResp,"done")
queryLocator.s = CkJsonObject::ckStringOf(jResp,"queryLocator")
entityTypeName.s = CkJsonObject::ckStringOf(jResp,"entityTypeName")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"records")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_Type = CkJsonObject::ckStringOf(jResp,"records[i].attributes.type")
v_Url = CkJsonObject::ckStringOf(jResp,"records[i].attributes.url")
Id = CkJsonObject::ckStringOf(jResp,"records[i].Id")
DeveloperName = CkJsonObject::ckStringOf(jResp,"records[i].DeveloperName")
EventChannel = CkJsonObject::ckStringOf(jResp,"records[i].EventChannel")
FilterExpression = CkJsonObject::ckStringOf(jResp,"records[i].FilterExpression")
SelectedEntity = CkJsonObject::ckStringOf(jResp,"records[i].SelectedEntity")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "q=SELECT%20Id,%20DeveloperName,%20EventChannel,%20FilterExpression,%20SelectedEntity%20FROM%20PlatformEventChannelMember"
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/
Postman Collection Item JSON
{
"name": "List channel members",
"protocolProfileBehavior": {
"strictSSL": false,
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember"
}
]
}
},
"response": [
{
"name": "List channel members",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"query",
""
],
"query": [
{
"key": "q",
"value": "SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 03 Jul 2023 13:16:35 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=9/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\": 4,\n \"totalSize\": 4,\n \"done\": true,\n \"queryLocator\": null,\n \"entityTypeName\": \"PlatformEventChannelMember\",\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"PlatformEventChannelMember\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000PAvIQAW\"\n },\n \"Id\": \"0v84H000000PAvIQAW\",\n \"DeveloperName\": \"ChangeEvents_ContactChangeEvent\",\n \"EventChannel\": \"ChangeEvents\",\n \"FilterExpression\": null,\n \"SelectedEntity\": \"ContactChangeEvent\"\n },\n {\n \"attributes\": {\n \"type\": \"PlatformEventChannelMember\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000XZCjQAO\"\n },\n \"Id\": \"0v84H000000XZCjQAO\",\n \"DeveloperName\": \"ChangeEvents_AccountChangeEvent\",\n \"EventChannel\": \"ChangeEvents\",\n \"FilterExpression\": null,\n \"SelectedEntity\": \"AccountChangeEvent\"\n },\n {\n \"attributes\": {\n \"type\": \"PlatformEventChannelMember\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSfQAI\"\n },\n \"Id\": \"0v84H000000fxSfQAI\",\n \"DeveloperName\": \"HREvents_Employee_ChangeEvent\",\n \"EventChannel\": \"0YL4H0000004C93WAE\",\n \"FilterExpression\": null,\n \"SelectedEntity\": \"Meeting_Note__ChangeEvent\"\n },\n {\n \"attributes\": {\n \"type\": \"PlatformEventChannelMember\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSkQAI\"\n },\n \"Id\": \"0v84H000000fxSkQAI\",\n \"DeveloperName\": \"AdvocateEvents_Employee_ChangeEvent\",\n \"EventChannel\": \"0YL4H0000004C98WAE\",\n \"FilterExpression\": null,\n \"SelectedEntity\": \"Meeting_Note__ChangeEvent\"\n }\n ]\n}"
}
]
}
