PowerBuilder / Salesforce Platform APIs / Platform Event Schema by Event Name
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_V_Type
string ls_Name
string ls_Namespace
integer j
integer li_Count_j
string ls_TypeType
string ls_TypeName
string ls_Doc
integer k
integer li_Count_k
string ls_Doc
string ls_Default
oleobject loo_Json1
integer li_I1
integer li_Count_i1
string ls_StrVal
string ls_Name
string ls_Namespace
string ls_V_type
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://domain.com/services/data/v{{version}}/sobjects/:EVENT_NAME/eventSchema",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
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
ls_Name = loo_JResp.StringOf("name")
ls_Namespace = loo_JResp.StringOf("namespace")
ls_V_type = loo_JResp.StringOf("type")
i = 0
li_Count_i = loo_JResp.SizeOfArray("fields")
do while i < li_Count_i
loo_JResp.I = i
ls_Name = loo_JResp.StringOf("fields[i].name")
ls_V_Type = loo_JResp.StringOf("fields[i].type.type")
ls_Name = loo_JResp.StringOf("fields[i].type.name")
ls_Namespace = loo_JResp.StringOf("fields[i].type.namespace")
ls_V_type = loo_JResp.StringOf("fields[i].type")
j = 0
li_Count_j = loo_JResp.SizeOfArray("fields[i].type.fields")
do while j < li_Count_j
loo_JResp.J = j
ls_Name = loo_JResp.StringOf("fields[i].type.fields[j].name")
ls_V_type = loo_JResp.StringOf("fields[i].type.fields[j].type")
ls_TypeType = loo_JResp.StringOf("fields[i].type.fields[j].type.type")
ls_TypeName = loo_JResp.StringOf("fields[i].type.fields[j].type.name")
ls_Doc = loo_JResp.StringOf("fields[i].type.fields[j].type.doc")
k = 0
li_Count_k = loo_JResp.SizeOfArray("fields[i].type.fields[j].type.fields")
do while k < li_Count_k
loo_JResp.K = k
ls_Name = loo_JResp.StringOf("fields[i].type.fields[j].type.fields[k].name")
ls_V_type = loo_JResp.StringOf("fields[i].type.fields[j].type.fields[k].type")
ls_Doc = loo_JResp.StringOf("fields[i].type.fields[j].type.fields[k].doc")
ls_Default = loo_JResp.StringOf("fields[i].type.fields[j].type.fields[k].default")
loo_Json1 = loo_JResp.ObjectOf("fields[i].type.fields[j].type.fields[k]")
li_I1 = 0
li_Count_i1 = loo_Json1.SizeOfArray("type")
do while li_I1 < li_Count_i1
loo_Json1.I = li_I1
ls_StrVal = loo_Json1.StringOf("type[i]")
li_I1 = li_I1 + 1
loop
destroy loo_Json1
k = k + 1
loop
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
