REST API 開発者ガイド
jスキーマ ID によるプラットフォームイベントスキーマ
構文
例
この URI は、スキーマ ID が dffQ2QLzDNHqwB8_sHMxdA のプラットフォームイベントのスキーマを取得します。このスキーマ ID が例の ID です。これをイベントの有効なスキーマ ID に置き換えます。
1/services/data/v42.0/event/eventSchema/5E5OtZj5_Gm6Vax9XMXH9AAPI バージョン 42.0 では、返される応答は次のようになります。
1{
2 "name" : "Low_Ink__e",
3 "namespace" : "com.sforce.eventbus",
4 "doc" : "42.0",
5 "type" : "record",
6 "fields" : [ {
7 "name" : "CreatedDate",
8 "type" : "long",
9 "doc" : "CreatedDate:DateTime"
10 }, {
11 "name" : "CreatedById",
12 "type" : "string",
13 "doc" : "CreatedBy:EntityId"
14 }, {
15 "name" : "Printer_Model__c",
16 "type" : [ "null", "string" ],
17 "doc" : "Data:Text",
18 "default" : null
19 }, {
20 "name" : "Serial_Number__c",
21 "type" : [ "null", "string" ],
22 "doc" : "Data:Text",
23 "default" : null
24 }, {
25 "name" : "Ink_Percentage__c",
26 "type" : [ "null", "double" ],
27 "doc" : "Data:Double",
28 "default" : null
29 } ],
30 "uuid" : "5E5OtZj5_Gm6Vax9XMXH9A"
31}返される応答の項目は、レコード複合型のオープンソース Apache Avro 仕様に準拠しています (Apache Avro 仕様の「Avro レコード」を参照してください)。次の点に注意してください。
- name はプラットフォームイベントの名前です。
- namespace はイベント名を修飾し、com.salesforce.event.{orgId} という形式になります。
- type は Avro 複合型です。
- fields はプラットフォームイベントの項目が含まれる JSON 配列です。項目ごとに、type は、その項目が null であるか、指定された型の値があるかを示します。また、default は、項目が存在しない場合の項目のデフォルト値です。
応答にはさらにもう 1 つの項目、uuid が含まれ、この項目には要求 URI に追加したスキーマ ID が含まれています。
ReplayId 標準項目は、イベントの公開後にシステムによって生成されるため、スキーマでは返されません。
スキーマ ID がない場合は、プラットフォームイベント名を入力するとスキーマを取得できます。/vXX.X/sobjects/Platform_Event_Name__e/eventSchema に対して GET 要求を行います。「イベント名によるプラットフォームイベントスキーマ」を参照してください。