Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Content-Type","application/json"
Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema",sbResponseBody)
If (success = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print http.LastHeader
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim v_Type As String
Dim Name As String
Dim Namespace As String
Dim j As Long
Dim count_j As Long
Dim typeType As String
Dim typeName As String
Dim Doc As String
Dim k As Long
Dim count_k As Long
Dim doc As String
Dim default As String
Dim json1 As ChilkatJsonObject
Dim i1 As Long
Dim count_i1 As Long
Dim strVal As String
Dim name As String
name = jResp.StringOf("name")
Dim namespace As String
namespace = jResp.StringOf("namespace")
Dim v_type As String
v_type = jResp.StringOf("type")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("fields")
Do While i < count_i
jResp.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")
Do While j < count_j
jResp.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")
Do While k < count_k
jResp.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")
Set json1 = jResp.ObjectOf("fields[i].type.fields[j].type.fields[k]")
i1 = 0
count_i1 = json1.SizeOfArray("type")
Do While i1 < count_i1
json1.I = i1
strVal = json1.StringOf("type[i]")
i1 = i1 + 1
Loop
k = k + 1
Loop
j = j + 1
Loop
i = i + 1
Loop
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}"
}
]
}
