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()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "name": "Sample__e",
# "namespace": "com.sforce.eventbus",
# "type": "expanded-record",
# "fields": [
# {
# "name": "data",
# "type": {
# "type": "record",
# "name": "Data",
# "namespace": "",
# "fields": [
# {
# "name": "schema",
# "type": "string"
# },
# {
# "name": "payload",
# "type": {
# "type": "record",
# "name": "Payload",
# "doc": "",
# "fields": [
# {
# "name": "CreatedDate",
# "type": "string",
# "doc": "CreatedDate:DateTime"
# },
# {
# "name": "CreatedById",
# "type": "string",
# "doc": "CreatedBy:EntityId"
# },
# {
# "name": "Message__c",
# "type": [
# "null",
# "string"
# ],
# "doc": "Data:Text:00N4H00000Ecs0G",
# "default": null
# }
# ]
# }
# },
# {
# "name": "event",
# "type": {
# "type": "record",
# "name": "Event",
# "fields": [
# {
# "name": "replayId",
# "type": "long"
# }
# ]
# }
# }
# ]
# }
# },
# {
# "name": "channel",
# "type": "string"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
name = jResp.stringOf("name")
namespace = jResp.stringOf("namespace")
v_type = jResp.stringOf("type")
i = 0
count_i = jResp.SizeOfArray("fields")
while i < count_i
jResp.put_I(i)
name = jResp.stringOf("fields[i].name")
v_Type = jResp.stringOf("fields[i].type.type")
Name = jResp.stringOf("fields[i].type.name")
Namespace = jResp.stringOf("fields[i].type.namespace")
v_type = jResp.stringOf("fields[i].type")
j = 0
count_j = jResp.SizeOfArray("fields[i].type.fields")
while j < count_j
jResp.put_J(j)
name = jResp.stringOf("fields[i].type.fields[j].name")
v_type = jResp.stringOf("fields[i].type.fields[j].type")
typeType = jResp.stringOf("fields[i].type.fields[j].type.type")
typeName = jResp.stringOf("fields[i].type.fields[j].type.name")
Doc = jResp.stringOf("fields[i].type.fields[j].type.doc")
k = 0
count_k = jResp.SizeOfArray("fields[i].type.fields[j].type.fields")
while k < count_k
jResp.put_K(k)
name = jResp.stringOf("fields[i].type.fields[j].type.fields[k].name")
v_type = jResp.stringOf("fields[i].type.fields[j].type.fields[k].type")
doc = jResp.stringOf("fields[i].type.fields[j].type.fields[k].doc")
default = jResp.stringOf("fields[i].type.fields[j].type.fields[k].default")
# json1 is a CkJsonObject
json1 = jResp.ObjectOf("fields[i].type.fields[j].type.fields[k]")
i1 = 0
count_i1 = json1.SizeOfArray("type")
while i1 < count_i1
json1.put_I(i1)
strVal = json1.stringOf("type[i]")
i1 = i1 + 1
end
k = k + 1
end
j = j + 1
end
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://domain.com/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema
Postman Collection Item JSON
{
"name": "Platform Event Schema by Event Name",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"sobjects",
":EVENT_NAME",
"eventSchema"
],
"query": [
{
"key": "payloadFormat",
"value": "",
"description": "(Optional query parameter. Available in API version 43.0 and later.) The format of the returned event schema. This parameter can take one of the following values.\nEXPANDED—The JSON representation of the event schema, which is the default format when payloadFormat is not specified in API version 43.0 and later.\nCOMPACT—A format that adheres to the open-source Apache Avro specification for the record complex type (see Apache Avro Format). Subscribers use the compact schema format to deserialize compact events received in binary form.",
"disabled": true
}
],
"variable": [
{
"key": "EVENT_NAME",
"value": "",
"description": "API Name of the event"
}
]
},
"description": "Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later."
},
"response": [
{
"name": "Platform Event Schema by Event Name",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"sobjects",
":EVENT_NAME",
"eventSchema"
],
"query": [
{
"key": "payloadFormat",
"value": "",
"description": "(Optional query parameter. Available in API version 43.0 and later.) The format of the returned event schema. This parameter can take one of the following values.\nEXPANDED—The JSON representation of the event schema, which is the default format when payloadFormat is not specified in API version 43.0 and later.\nCOMPACT—A format that adheres to the open-source Apache Avro specification for the record complex type (see Apache Avro Format). Subscribers use the compact schema format to deserialize compact events received in binary form.",
"disabled": true
}
],
"variable": [
{
"key": "EVENT_NAME",
"value": "Sample__e",
"description": "API Name of the event"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 03 Jul 2023 13:06:08 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=2/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 \"name\": \"Sample__e\",\n \"namespace\": \"com.sforce.eventbus\",\n \"type\": \"expanded-record\",\n \"fields\": [\n {\n \"name\": \"data\",\n \"type\": {\n \"type\": \"record\",\n \"name\": \"Data\",\n \"namespace\": \"\",\n \"fields\": [\n {\n \"name\": \"schema\",\n \"type\": \"string\"\n },\n {\n \"name\": \"payload\",\n \"type\": {\n \"type\": \"record\",\n \"name\": \"Payload\",\n \"doc\": \"\",\n \"fields\": [\n {\n \"name\": \"CreatedDate\",\n \"type\": \"string\",\n \"doc\": \"CreatedDate:DateTime\"\n },\n {\n \"name\": \"CreatedById\",\n \"type\": \"string\",\n \"doc\": \"CreatedBy:EntityId\"\n },\n {\n \"name\": \"Message__c\",\n \"type\": [\n \"null\",\n \"string\"\n ],\n \"doc\": \"Data:Text:00N4H00000Ecs0G\",\n \"default\": null\n }\n ]\n }\n },\n {\n \"name\": \"event\",\n \"type\": {\n \"type\": \"record\",\n \"name\": \"Event\",\n \"fields\": [\n {\n \"name\": \"replayId\",\n \"type\": \"long\"\n }\n ]\n }\n }\n ]\n }\n },\n {\n \"name\": \"channel\",\n \"type\": \"string\"\n }\n ]\n}"
}
]
}
