Chilkat Online Tools

VB6 / Salesforce Platform APIs / Get event channel

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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

Dim v_Type As String
v_Type = jResp.StringOf("attributes.type")
Dim v_Url As String
v_Url = jResp.StringOf("attributes.url")
Dim Id As String
Id = jResp.StringOf("Id")
Dim IsDeleted As Long
IsDeleted = jResp.BoolOf("IsDeleted")
Dim DeveloperName As String
DeveloperName = jResp.StringOf("DeveloperName")
Dim Language As String
Language = jResp.StringOf("Language")
Dim MasterLabel As String
MasterLabel = jResp.StringOf("MasterLabel")
Dim NamespacePrefix As String
NamespacePrefix = jResp.StringOf("NamespacePrefix")
Dim ManageableState As String
ManageableState = jResp.StringOf("ManageableState")
Dim CreatedDate As String
CreatedDate = jResp.StringOf("CreatedDate")
Dim CreatedById As String
CreatedById = jResp.StringOf("CreatedById")
Dim LastModifiedDate As String
LastModifiedDate = jResp.StringOf("LastModifiedDate")
Dim LastModifiedById As String
LastModifiedById = jResp.StringOf("LastModifiedById")
Dim SystemModstamp As String
SystemModstamp = jResp.StringOf("SystemModstamp")
Dim ChannelType As String
ChannelType = jResp.StringOf("ChannelType")
Dim FullName As String
FullName = jResp.StringOf("FullName")
Dim MetadataChannelType As String
MetadataChannelType = jResp.StringOf("Metadata.channelType")
Dim Label As String
Label = jResp.StringOf("Metadata.label")
Dim Urls As String
Urls = jResp.StringOf("Metadata.urls")

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}"
    }
  ]
}