Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sV_Type
String sV_Url
String sId
Boolean iIsDeleted
String sDeveloperName
String sLanguage
String sMasterLabel
String sNamespacePrefix
String sManageableState
String sCreatedDate
String sCreatedById
String sLastModifiedDate
String sLastModifiedById
String sSystemModstamp
String sChannelType
String sFullName
String sMetadataChannelType
String sLabel
String sUrls
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_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
Get ComStringOf Of hoJResp "attributes.type" To sV_Type
Get ComStringOf Of hoJResp "attributes.url" To sV_Url
Get ComStringOf Of hoJResp "Id" To sId
Get ComBoolOf Of hoJResp "IsDeleted" To iIsDeleted
Get ComStringOf Of hoJResp "DeveloperName" To sDeveloperName
Get ComStringOf Of hoJResp "Language" To sLanguage
Get ComStringOf Of hoJResp "MasterLabel" To sMasterLabel
Get ComStringOf Of hoJResp "NamespacePrefix" To sNamespacePrefix
Get ComStringOf Of hoJResp "ManageableState" To sManageableState
Get ComStringOf Of hoJResp "CreatedDate" To sCreatedDate
Get ComStringOf Of hoJResp "CreatedById" To sCreatedById
Get ComStringOf Of hoJResp "LastModifiedDate" To sLastModifiedDate
Get ComStringOf Of hoJResp "LastModifiedById" To sLastModifiedById
Get ComStringOf Of hoJResp "SystemModstamp" To sSystemModstamp
Get ComStringOf Of hoJResp "ChannelType" To sChannelType
Get ComStringOf Of hoJResp "FullName" To sFullName
Get ComStringOf Of hoJResp "Metadata.channelType" To sMetadataChannelType
Get ComStringOf Of hoJResp "Metadata.label" To sLabel
Get ComStringOf Of hoJResp "Metadata.urls" To sUrls
End_Procedure
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}"
}
]
}
