Chilkat Online Tools

Ruby / Salesforce Platform APIs / Add enriched fields to channel member

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "FullName": "Account_Channel_chn_AccountChangeEvent",
#   "Metadata": {
#     "enrichedFields": [
#       {
#         "name": "External_Account_ID__c"
#       }
#     ],
#     "eventChannel": "Account_Channel__chn",
#     "selectedEntity": "AccountChangeEvent"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("FullName","Account_Channel_chn_AccountChangeEvent")
json.UpdateString("Metadata.enrichedFields[0].name","External_Account_ID__c")
json.UpdateString("Metadata.eventChannel","Account_Channel__chn")
json.UpdateString("Metadata.selectedEntity","AccountChangeEvent")

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-d '{
    "FullName": "Account_Channel_chn_AccountChangeEvent",
    "Metadata": {
        "enrichedFields": [
            {
                "name": "External_Account_ID__c"
            }
        ],
        "eventChannel": "Account_Channel__chn",
        "selectedEntity": "AccountChangeEvent"
    }
}'
https://domain.com/services/data/v{{version}}/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID

Postman Collection Item JSON

{
  "name": "Add enriched fields to channel member",
  "protocolProfileBehavior": {
    "strictSSL": false
  },
  "request": {
    "method": "PATCH",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"FullName\": \"Account_Channel_chn_AccountChangeEvent\",\n    \"Metadata\": {\n        \"enrichedFields\": [\n            {\n                \"name\": \"External_Account_ID__c\"\n            }\n        ],\n        \"eventChannel\": \"Account_Channel__chn\",\n        \"selectedEntity\": \"AccountChangeEvent\"\n    }\n}",
      "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": [
  ]
}