Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Get channel member

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcV_Url
LOCAL lcId
LOCAL lnIsDeleted
LOCAL lcDeveloperName
LOCAL lcLanguage
LOCAL lcMasterLabel
LOCAL lcNamespacePrefix
LOCAL lcManageableState
LOCAL lcCreatedDate
LOCAL lcCreatedById
LOCAL lcLastModifiedDate
LOCAL lcLastModifiedById
LOCAL lcSystemModstamp
LOCAL lcFullName
LOCAL lcEventChannel
LOCAL lcFilterExpression
LOCAL lcSelectedEntity
LOCAL lcUrls
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
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

lcV_Type = loJResp.StringOf("attributes.type")
lcV_Url = loJResp.StringOf("attributes.url")
lcId = loJResp.StringOf("Id")
lnIsDeleted = 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")
lcFullName = loJResp.StringOf("FullName")
lcEventChannel = loJResp.StringOf("Metadata.eventChannel")
lcFilterExpression = loJResp.StringOf("Metadata.filterExpression")
lcSelectedEntity = loJResp.StringOf("Metadata.selectedEntity")
lcUrls = loJResp.StringOf("Metadata.urls")
lcEventChannel = loJResp.StringOf("EventChannel")
lcSelectedEntity = loJResp.StringOf("SelectedEntity")
lcFilterExpression = loJResp.StringOf("FilterExpression")
i = 0
lnCount_i = loJResp.SizeOfArray("Metadata.enrichedFields")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO

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