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
-- 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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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 @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "attributes": {
-- "type": "PlatformEventChannel",
-- "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE"
-- },
-- "Id": "0YL4H0000004C93WAE",
-- "IsDeleted": false,
-- "DeveloperName": "HREvents",
-- "Language": "en_US",
-- "MasterLabel": "Custom Channel for the HR App",
-- "NamespacePrefix": null,
-- "ManageableState": "unmanaged",
-- "CreatedDate": "2021-01-11T19:33:54.000+0000",
-- "CreatedById": "00558000000yFyDAAU",
-- "LastModifiedDate": "2021-01-11T19:33:54.000+0000",
-- "LastModifiedById": "00558000000yFyDAAU",
-- "SystemModstamp": "2021-01-11T19:33:54.000+0000",
-- "ChannelType": "data",
-- "FullName": "HREvents__chn",
-- "Metadata": {
-- "channelType": "data",
-- "label": "Custom Channel for the HR App",
-- "urls": null
-- }
-- }
-- 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)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'attributes.type'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'attributes.url'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'Id'
DECLARE @IsDeleted int
EXEC sp_OAMethod @jResp, 'BoolOf', @IsDeleted OUT, 'IsDeleted'
DECLARE @DeveloperName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @DeveloperName OUT, 'DeveloperName'
DECLARE @Language nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Language OUT, 'Language'
DECLARE @MasterLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MasterLabel OUT, 'MasterLabel'
DECLARE @NamespacePrefix nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @NamespacePrefix OUT, 'NamespacePrefix'
DECLARE @ManageableState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ManageableState OUT, 'ManageableState'
DECLARE @CreatedDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedDate OUT, 'CreatedDate'
DECLARE @CreatedById nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CreatedById OUT, 'CreatedById'
DECLARE @LastModifiedDate nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastModifiedDate OUT, 'LastModifiedDate'
DECLARE @LastModifiedById nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @LastModifiedById OUT, 'LastModifiedById'
DECLARE @SystemModstamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SystemModstamp OUT, 'SystemModstamp'
DECLARE @ChannelType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ChannelType OUT, 'ChannelType'
DECLARE @FullName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FullName OUT, 'FullName'
DECLARE @MetadataChannelType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @MetadataChannelType OUT, 'Metadata.channelType'
DECLARE @Label nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Label OUT, 'Metadata.label'
DECLARE @Urls nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Urls OUT, 'Metadata.urls'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID
Postman Collection Item JSON
{
"name": "Get event channel",
"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/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"PlatformEventChannel",
":PLATFORM_EVENT_CHANNEL_ID"
],
"variable": [
{
"key": "PLATFORM_EVENT_CHANNEL_ID",
"value": "0YL4H0000004C93WAE"
}
]
}
},
"response": [
{
"name": "Get event channel",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"PlatformEventChannel",
":PLATFORM_EVENT_CHANNEL_ID"
],
"variable": [
{
"key": "PLATFORM_EVENT_CHANNEL_ID",
"value": "0YL4H0000004C93WAE"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 03 Jul 2023 13:15:59 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": "Last-Modified",
"value": "Mon, 11 Jan 2021 19:33:54 GMT"
},
{
"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 \"attributes\": {\n \"type\": \"PlatformEventChannel\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannel/0YL4H0000004C93WAE\"\n },\n \"Id\": \"0YL4H0000004C93WAE\",\n \"IsDeleted\": false,\n \"DeveloperName\": \"HREvents\",\n \"Language\": \"en_US\",\n \"MasterLabel\": \"Custom Channel for the HR App\",\n \"NamespacePrefix\": null,\n \"ManageableState\": \"unmanaged\",\n \"CreatedDate\": \"2021-01-11T19:33:54.000+0000\",\n \"CreatedById\": \"00558000000yFyDAAU\",\n \"LastModifiedDate\": \"2021-01-11T19:33:54.000+0000\",\n \"LastModifiedById\": \"00558000000yFyDAAU\",\n \"SystemModstamp\": \"2021-01-11T19:33:54.000+0000\",\n \"ChannelType\": \"data\",\n \"FullName\": \"HREvents__chn\",\n \"Metadata\": {\n \"channelType\": \"data\",\n \"label\": \"Custom Channel for the HR App\",\n \"urls\": null\n }\n}"
}
]
}
