Chilkat Online Tools

autoit / Salesforce Platform APIs / List channel members

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

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("q","SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember")

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

Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/query/",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

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

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

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "size": 4,
;   "totalSize": 4,
;   "done": true,
;   "queryLocator": null,
;   "entityTypeName": "PlatformEventChannelMember",
;   "records": [
;     {
;       "attributes": {
;         "type": "PlatformEventChannelMember",
;         "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000PAvIQAW"
;       },
;       "Id": "0v84H000000PAvIQAW",
;       "DeveloperName": "ChangeEvents_ContactChangeEvent",
;       "EventChannel": "ChangeEvents",
;       "FilterExpression": null,
;       "SelectedEntity": "ContactChangeEvent"
;     },
;     {
;       "attributes": {
;         "type": "PlatformEventChannelMember",
;         "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000XZCjQAO"
;       },
;       "Id": "0v84H000000XZCjQAO",
;       "DeveloperName": "ChangeEvents_AccountChangeEvent",
;       "EventChannel": "ChangeEvents",
;       "FilterExpression": null,
;       "SelectedEntity": "AccountChangeEvent"
;     },
;     {
;       "attributes": {
;         "type": "PlatformEventChannelMember",
;         "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSfQAI"
;       },
;       "Id": "0v84H000000fxSfQAI",
;       "DeveloperName": "HREvents_Employee_ChangeEvent",
;       "EventChannel": "0YL4H0000004C93WAE",
;       "FilterExpression": null,
;       "SelectedEntity": "Meeting_Note__ChangeEvent"
;     },
;     {
;       "attributes": {
;         "type": "PlatformEventChannelMember",
;         "url": "/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSkQAI"
;       },
;       "Id": "0v84H000000fxSkQAI",
;       "DeveloperName": "AdvocateEvents_Employee_ChangeEvent",
;       "EventChannel": "0YL4H0000004C98WAE",
;       "FilterExpression": null,
;       "SelectedEntity": "Meeting_Note__ChangeEvent"
;     }
;   ]
; }

; 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
Local $sV_Url
Local $sId
Local $sDeveloperName
Local $sEventChannel
Local $sFilterExpression
Local $sSelectedEntity

Local $iSize = $oJResp.IntOf("size")
Local $iTotalSize = $oJResp.IntOf("totalSize")
Local $bDone = $oJResp.BoolOf("done")
Local $sQueryLocator = $oJResp.StringOf("queryLocator")
Local $sEntityTypeName = $oJResp.StringOf("entityTypeName")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("records")
While $i < $iCount_i
    $oJResp.I = $i
    $sV_Type = $oJResp.StringOf("records[i].attributes.type")
    $sV_Url = $oJResp.StringOf("records[i].attributes.url")
    $sId = $oJResp.StringOf("records[i].Id")
    $sDeveloperName = $oJResp.StringOf("records[i].DeveloperName")
    $sEventChannel = $oJResp.StringOf("records[i].EventChannel")
    $sFilterExpression = $oJResp.StringOf("records[i].FilterExpression")
    $sSelectedEntity = $oJResp.StringOf("records[i].SelectedEntity")
    $i = $i + 1
Wend

Curl Command

curl -G -d "q=SELECT%20Id,%20DeveloperName,%20EventChannel,%20FilterExpression,%20SelectedEntity%20FROM%20PlatformEventChannelMember"
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/query/

Postman Collection Item JSON

{
  "name": "List channel members",
  "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/query/?q=SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "query",
        ""
      ],
      "query": [
        {
          "key": "q",
          "value": "SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember"
        }
      ]
    }
  },
  "response": [
    {
      "name": "List channel members",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/query/?q=SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "query",
            ""
          ],
          "query": [
            {
              "key": "q",
              "value": "SELECT Id, DeveloperName, EventChannel, FilterExpression, SelectedEntity FROM PlatformEventChannelMember"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:16:35 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": "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    \"size\": 4,\n    \"totalSize\": 4,\n    \"done\": true,\n    \"queryLocator\": null,\n    \"entityTypeName\": \"PlatformEventChannelMember\",\n    \"records\": [\n        {\n            \"attributes\": {\n                \"type\": \"PlatformEventChannelMember\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000PAvIQAW\"\n            },\n            \"Id\": \"0v84H000000PAvIQAW\",\n            \"DeveloperName\": \"ChangeEvents_ContactChangeEvent\",\n            \"EventChannel\": \"ChangeEvents\",\n            \"FilterExpression\": null,\n            \"SelectedEntity\": \"ContactChangeEvent\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"PlatformEventChannelMember\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000XZCjQAO\"\n            },\n            \"Id\": \"0v84H000000XZCjQAO\",\n            \"DeveloperName\": \"ChangeEvents_AccountChangeEvent\",\n            \"EventChannel\": \"ChangeEvents\",\n            \"FilterExpression\": null,\n            \"SelectedEntity\": \"AccountChangeEvent\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"PlatformEventChannelMember\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSfQAI\"\n            },\n            \"Id\": \"0v84H000000fxSfQAI\",\n            \"DeveloperName\": \"HREvents_Employee_ChangeEvent\",\n            \"EventChannel\": \"0YL4H0000004C93WAE\",\n            \"FilterExpression\": null,\n            \"SelectedEntity\": \"Meeting_Note__ChangeEvent\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"PlatformEventChannelMember\",\n                \"url\": \"/services/data/v58.0/tooling/sobjects/PlatformEventChannelMember/0v84H000000fxSkQAI\"\n            },\n            \"Id\": \"0v84H000000fxSkQAI\",\n            \"DeveloperName\": \"AdvocateEvents_Employee_ChangeEvent\",\n            \"EventChannel\": \"0YL4H0000004C98WAE\",\n            \"FilterExpression\": null,\n            \"SelectedEntity\": \"Meeting_Note__ChangeEvent\"\n        }\n    ]\n}"
    }
  ]
}