Chilkat Online Tools

autoit / Salesforce Platform APIs / Get channel member

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sV_Type = $oJResp.StringOf("attributes.type")
Local $sV_Url = $oJResp.StringOf("attributes.url")
Local $sId = $oJResp.StringOf("Id")
Local $bIsDeleted = $oJResp.BoolOf("IsDeleted")
Local $sDeveloperName = $oJResp.StringOf("DeveloperName")
Local $sLanguage = $oJResp.StringOf("Language")
Local $sMasterLabel = $oJResp.StringOf("MasterLabel")
Local $sNamespacePrefix = $oJResp.StringOf("NamespacePrefix")
Local $sManageableState = $oJResp.StringOf("ManageableState")
Local $sCreatedDate = $oJResp.StringOf("CreatedDate")
Local $sCreatedById = $oJResp.StringOf("CreatedById")
Local $sLastModifiedDate = $oJResp.StringOf("LastModifiedDate")
Local $sLastModifiedById = $oJResp.StringOf("LastModifiedById")
Local $sSystemModstamp = $oJResp.StringOf("SystemModstamp")
Local $sFullName = $oJResp.StringOf("FullName")
Local $sEventChannel = $oJResp.StringOf("Metadata.eventChannel")
Local $sFilterExpression = $oJResp.StringOf("Metadata.filterExpression")
Local $sSelectedEntity = $oJResp.StringOf("Metadata.selectedEntity")
Local $sUrls = $oJResp.StringOf("Metadata.urls")
$sEventChannel = $oJResp.StringOf("EventChannel")
$sSelectedEntity = $oJResp.StringOf("SelectedEntity")
$sFilterExpression = $oJResp.StringOf("FilterExpression")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("Metadata.enrichedFields")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend

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