Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'q', 'SELECT Id, DeveloperName, MasterLabel, ChannelType FROM PlatformEventChannel'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/services/data/v{{version}}/tooling/query/', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @v_Type nvarchar(4000)
DECLARE @v_Url nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @DeveloperName nvarchar(4000)
DECLARE @MasterLabel nvarchar(4000)
DECLARE @ChannelType nvarchar(4000)
DECLARE @size int
EXEC sp_OAMethod @jResp, 'IntOf', @size OUT, 'size'
DECLARE @totalSize int
EXEC sp_OAMethod @jResp, 'IntOf', @totalSize OUT, 'totalSize'
DECLARE @done int
EXEC sp_OAMethod @jResp, 'BoolOf', @done OUT, 'done'
DECLARE @queryLocator nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @queryLocator OUT, 'queryLocator'
DECLARE @entityTypeName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @entityTypeName OUT, 'entityTypeName'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'records'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'records[i].attributes.type'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'records[i].attributes.url'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'records[i].Id'
EXEC sp_OAMethod @jResp, 'StringOf', @DeveloperName OUT, 'records[i].DeveloperName'
EXEC sp_OAMethod @jResp, 'StringOf', @MasterLabel OUT, 'records[i].MasterLabel'
EXEC sp_OAMethod @jResp, 'StringOf', @ChannelType OUT, 'records[i].ChannelType'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
