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/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_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": "PlatformEventChannelMember",
-- "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000PAvIQAW"
-- },
-- "Id": "0v84H000000PAvIQAW",
-- "IsDeleted": false,
-- "DeveloperName": "ChangeEvents_ContactChangeEvent",
-- "Language": "en_US",
-- "MasterLabel": "ContactChangeEvent",
-- "NamespacePrefix": null,
-- "ManageableState": "unmanaged",
-- "CreatedDate": "2022-12-30T15:10:39.000+0000",
-- "CreatedById": "00558000000yFyDAAU",
-- "LastModifiedDate": "2022-12-30T15:10:39.000+0000",
-- "LastModifiedById": "00558000000yFyDAAU",
-- "SystemModstamp": "2022-12-30T15:10:39.000+0000",
-- "FullName": "ChangeEvents_ContactChangeEvent",
-- "Metadata": {
-- "enrichedFields": [
-- ],
-- "eventChannel": "ChangeEvents",
-- "filterExpression": null,
-- "selectedEntity": "ContactChangeEvent",
-- "urls": null
-- },
-- "EventChannel": "ChangeEvents",
-- "SelectedEntity": "ContactChangeEvent",
-- "FilterExpression": 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 @FullName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FullName OUT, 'FullName'
DECLARE @EventChannel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @EventChannel OUT, 'Metadata.eventChannel'
DECLARE @FilterExpression nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FilterExpression OUT, 'Metadata.filterExpression'
DECLARE @SelectedEntity nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @SelectedEntity OUT, 'Metadata.selectedEntity'
DECLARE @Urls nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Urls OUT, 'Metadata.urls'
EXEC sp_OAMethod @jResp, 'StringOf', @EventChannel OUT, 'EventChannel'
EXEC sp_OAMethod @jResp, 'StringOf', @SelectedEntity OUT, 'SelectedEntity'
EXEC sp_OAMethod @jResp, 'StringOf', @FilterExpression OUT, 'FilterExpression'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'Metadata.enrichedFields'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
SELECT @i = @i + 1
END
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/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID
Postman Collection Item JSON
{
"name": "Get channel member",
"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/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"PlatformEventChannelMember",
":PLATFORM_EVENT_CHANNEL_MEMBER_ID"
],
"variable": [
{
"key": "PLATFORM_EVENT_CHANNEL_MEMBER_ID",
"value": ""
}
]
}
},
"response": [
{
"name": "Get channel member",
"originalRequest": {
"method": "GET",
"header": [
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"tooling",
"sobjects",
"PlatformEventChannelMember",
":PLATFORM_EVENT_CHANNEL_MEMBER_ID"
],
"variable": [
{
"key": "PLATFORM_EVENT_CHANNEL_MEMBER_ID",
"value": "0v84H000000PAvIQAW"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 03 Jul 2023 13:17:20 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": "Last-Modified",
"value": "Fri, 30 Dec 2022 15:10:39 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\": \"PlatformEventChannelMember\",\n \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000PAvIQAW\"\n },\n \"Id\": \"0v84H000000PAvIQAW\",\n \"IsDeleted\": false,\n \"DeveloperName\": \"ChangeEvents_ContactChangeEvent\",\n \"Language\": \"en_US\",\n \"MasterLabel\": \"ContactChangeEvent\",\n \"NamespacePrefix\": null,\n \"ManageableState\": \"unmanaged\",\n \"CreatedDate\": \"2022-12-30T15:10:39.000+0000\",\n \"CreatedById\": \"00558000000yFyDAAU\",\n \"LastModifiedDate\": \"2022-12-30T15:10:39.000+0000\",\n \"LastModifiedById\": \"00558000000yFyDAAU\",\n \"SystemModstamp\": \"2022-12-30T15:10:39.000+0000\",\n \"FullName\": \"ChangeEvents_ContactChangeEvent\",\n \"Metadata\": {\n \"enrichedFields\": [],\n \"eventChannel\": \"ChangeEvents\",\n \"filterExpression\": null,\n \"selectedEntity\": \"ContactChangeEvent\",\n \"urls\": null\n },\n \"EventChannel\": \"ChangeEvents\",\n \"SelectedEntity\": \"ContactChangeEvent\",\n \"FilterExpression\": null\n}"
}
]
}
