Force.com REST API 開発者ガイド
jスキーマ ID によるプラットフォームイベントスキーマ
構文
例
この URL は、スキーマ ID が dffQ2QLzDNHqwB8_sHMxdA のプラットフォームイベントのスキーマを取得します。このスキーマ ID が例の ID です。これをイベントの有効なスキーマ ID に置き換えます。
返される応答は次のようになります。
返される応答の項目は、レコード複合型のオープンソース Apache Avro 仕様に準拠しています (Apache Avro 仕様の「Avro レコード」を参照してください)。次の点に注意してください。
- name はプラットフォームイベントの名前です。
- namespace はイベント名を修飾し、com.salesforce.event.{orgId} という形式になります。
- type は Avro 複合型です。
- name はプラットフォームイベントの項目が含まれる JSON 配列です。項目ごとに、type は、その項目が null であるか、指定された型の値があるかを示します。また、default は、項目が存在しない場合の項目のデフォルト値です。
応答にはさらにもう 1 つの項目、uuid が含まれ、この項目には要求 URI に追加したスキーマ ID が含まれています。
ReplayId 標準項目は、イベントの公開後にシステムによって生成されるため、スキーマでは返されません。
スキーマ ID がない場合は、プラットフォームイベント名を入力するとスキーマを取得できます。/vXX.X/sobjects/Platform_Event_Name__e/eventSchema に対して GET 要求を行います。「イベント名によるプラットフォームイベントスキーマ」を参照してください。