Force.com REST API 開発者ガイド
jイベント名によるプラットフォームイベントスキーマ
構文
例
この URL は、プラットフォームイベント名が Low_Ink__e のスキーマを取得します。
1/services/data/v41.0/sobjects/Low_Ink__e/eventSchema返される応答は次のようになります。
1{
2 "name" : "Low_Ink__e",
3 "namespace" : "com.salesforce.event.org00DD00000008Xay",
4 "type" : "record",
5 "fields" : [ {
6 "name" : "CreatedDate",
7 "type" : "string"
8 }, {
9 "name" : "CreatedById",
10 "type" : "string"
11 }, {
12 "name" : "Printer_Model__c",
13 "type" : [ "null", "string" ],
14 "default" : null
15 }, {
16 "name" : "Serial_Number__c",
17 "type" : [ "null", "string" ],
18 "default" : null
19 }, {
20 "name" : "Ink_Percentage__c",
21 "type" : [ "null", "double" ],
22 "default" : null
23 } ],
24 "uuid" : "dffQ2QLzDNHqwB8_sHMxdA"
25}
返される応答の項目は、レコード複合型のオープンソース Apache Avro 仕様に準拠しています (Apache Avro 仕様の「Avro レコード」を参照してください)。次の点に注意してください。
- name はプラットフォームイベントの名前です。
- namespace はイベント名を修飾し、com.salesforce.event.{orgId} という形式になります。
- type は Avro 複合型です。
- name はプラットフォームイベントの項目が含まれる JSON 配列です。項目ごとに、type は、その項目が null であるか、指定された型の値があるかを示します。また、default は、項目が存在しない場合の項目のデフォルト値です。
応答にはさらにもう 1 つの項目、uuid が含まれ、この項目にはこのスキーマの ID が含まれています。この ID は、base-64 URL バリアントとして符号化された、正規化された Avro スキーマの MD5 フィンガープリントです。この ID を /vXX.X/event/eventSchema/ URI に追加してスキーマを取得することができます。