この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

スキーマ ID によるプラットフォームイベントスキーマ

特定のスキーマ名のプラットフォームイベントの定義を JSON 形式で取得します。

構文

URI: /vXX.X/event/eventSchema/Schema_ID
適用開始バージョン: 40.0
形式: JSON
HTTP メソッド: GET
認証: Authorization: Bearer token

例

この URI は、スキーマ ID が dffQ2QLzDNHqwB8_sHMxdA のプラットフォームイベントのスキーマを取得します。このスキーマ ID が例の ID です。これをイベントの有効なスキーマ ID に置き換えます。

1/services/data/v42.0/event/eventSchema/dffQ2QLzDNHqwB8_sHMxdA

返される応答は次のようになります。

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 複合型です。
fields はプラットフォームイベントの項目が含まれる JSON 配列です。項目ごとに、type は、その項目が null であるか、指定された型の値があるかを示します。また、default は、項目が存在しない場合の項目のデフォルト値です。

応答にはさらにもう 1 つの項目、uuid が含まれ、この項目には要求 URI に追加したスキーマ ID が含まれています。

ReplayId 標準項目は、イベントの公開後にシステムによって生成されるため、スキーマでは返されません。

プラットフォームイベントの定義を変更すると、このプラットフォームイベントのスキーマ ID も変更されます。

メモ

スキーマ ID がない場合は、プラットフォームイベント名を入力するとスキーマを取得できます。/vXX.X/sobjects/Platform_Event_Name__e/eventSchema に対して GET 要求を行います。「イベント名によるプラットフォームイベントスキーマ」を参照してください。

Force.com REST API 開発者ガイド

スキーマ ID によるプラットフォームイベントスキーマ

構文

例