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
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sV_Type
Local $sName
Local $sNamespace
Local $iJ
Local $iCount_j
Local $sTypeType
Local $sTypeName
Local $sDoc
Local $iK
Local $iCount_k
Local $sDoc
Local $sDefault
Local $oJson1
Local $i1
Local $iCount_i1
Local $strVal
Local $sName = $oJResp.StringOf("name")
Local $sNamespace = $oJResp.StringOf("namespace")
Local $sV_type = $oJResp.StringOf("type")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("fields")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("fields[i].name")
$sV_Type = $oJResp.StringOf("fields[i].type.type")
$sName = $oJResp.StringOf("fields[i].type.name")
$sNamespace = $oJResp.StringOf("fields[i].type.namespace")
$sV_type = $oJResp.StringOf("fields[i].type")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("fields[i].type.fields")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sName = $oJResp.StringOf("fields[i].type.fields[j].name")
$sV_type = $oJResp.StringOf("fields[i].type.fields[j].type")
$sTypeType = $oJResp.StringOf("fields[i].type.fields[j].type.type")
$sTypeName = $oJResp.StringOf("fields[i].type.fields[j].type.name")
$sDoc = $oJResp.StringOf("fields[i].type.fields[j].type.doc")
$iK = 0
$iCount_k = $oJResp.SizeOfArray("fields[i].type.fields[j].type.fields")
While $iK < $iCount_k
$oJResp.K = $iK
$sName = $oJResp.StringOf("fields[i].type.fields[j].type.fields[k].name")
$sV_type = $oJResp.StringOf("fields[i].type.fields[j].type.fields[k].type")
$sDoc = $oJResp.StringOf("fields[i].type.fields[j].type.fields[k].doc")
$sDefault = $oJResp.StringOf("fields[i].type.fields[j].type.fields[k].default")
$oJson1 = $oJResp.ObjectOf("fields[i].type.fields[j].type.fields[k]")
$i1 = 0
$iCount_i1 = $oJson1.SizeOfArray("type")
While $i1 < $iCount_i1
$oJson1.I = $i1
$strVal = $oJson1.StringOf("type[i]")
$i1 = $i1 + 1
Wend
$iK = $iK + 1
Wend
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
