Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// 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
lcV_Type = loJResp.StringOf("attributes.type")
lcV_Url = loJResp.StringOf("attributes.url")
lcId = loJResp.StringOf("Id")
llIsDeleted = loJResp.BoolOf("IsDeleted")
lcDeveloperName = loJResp.StringOf("DeveloperName")
lcLanguage = loJResp.StringOf("Language")
lcMasterLabel = loJResp.StringOf("MasterLabel")
lcNamespacePrefix = loJResp.StringOf("NamespacePrefix")
lcManageableState = loJResp.StringOf("ManageableState")
lcCreatedDate = loJResp.StringOf("CreatedDate")
lcCreatedById = loJResp.StringOf("CreatedById")
lcLastModifiedDate = loJResp.StringOf("LastModifiedDate")
lcLastModifiedById = loJResp.StringOf("LastModifiedById")
lcSystemModstamp = loJResp.StringOf("SystemModstamp")
lcChannelType = loJResp.StringOf("ChannelType")
lcFullName = loJResp.StringOf("FullName")
lcMetadataChannelType = loJResp.StringOf("Metadata.channelType")
lcLabel = loJResp.StringOf("Metadata.label")
lcUrls = loJResp.StringOf("Metadata.urls")
release loHttp
release loSbResponseBody
release loJResp
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}"
}
]
}
