REST API 開発者ガイド
jPlatform Event Schema by Event Name
| 400 Bad Request | 説明 |
|---|---|
| API バージョン 43.0 以降 | 要求の形式が正しくありません — URI の payloadFormat パラメータで無効な値が渡されました。 |
| API バージョン 42.0 以前 | 要求の形式が正しくありません — URI で payloadFormat パラメータが渡されましたが、この API バージョンではこのパラメータはサポートされていません。 |
構文
- URI
- /services/data/vXX.X/sobjects/eventName/eventSchema
- 形式
- JSON
- HTTP のメソッド
- GET
- 認証
- Authorization: Bearer token
- パラメータ
-
パラメータ 説明 payloadFormat (省略可能なクエリパラメータ。API バージョン 43.0 以降で使用可能)。返されるイベントスキーマの形式。このパラメータは、次のいずれかの値を取ります。 - EXPANDED — イベントスキーマの JSON 表現。これは、API バージョン 43.0 以降で payloadFormat を指定しない場合のデフォルトの形式です。拡張されたイベントスキーマは、オープンソースの Apache Avro 形式ですが、レコード複合型に厳密には準拠していません。スキーマ項目の詳細は、「Apache Avro 形式」を参照してください。
- COMPACT — レコード複合型のオープンソース Apache Avro 仕様に準拠する、イベントスキーマの JSON 表現。スキーマ項目の詳細は、「Apache Avro 形式」を参照してください。登録者は、コンパクトスキーマ形式を使用して、バイナリ形式で受信したコンパクトイベントを並列化します。
API バージョン 43.0 以降の例
この URI は、プラットフォームイベント名が Low_Ink__e のスキーマを取得します。API バージョン 43.0 以降では、応答形式がイベントスキーマの JSON 表現となっています。
または
API バージョン 59.0 では、拡張された形式について返される応答は次のようになります。
コンパクト (Apache Avro) 形式を取得するには、次の URI を使用します。
API バージョン 59.0 では、コンパクト形式について返される応答は次のようになります。
API バージョン 42.0 以前の例
API バージョン 42.0 以前では、応答形式はレコード複合型のオープンソース Apache Avro 仕様に準拠しています。
API バージョン 42.0 では、返される応答は次のようになります。
Apache Avro 形式
返される応答の項目は、レコード複合型のオープンソース Apache Avro 仕様に準拠しています (Apache Avro 仕様の「Avro レコード」を参照してください)。次の点に注意してください。
- name はプラットフォームイベントの名前です。
- namespace は com.sforce.eventbus に対応します。
- type は Avro 複合型です。
-
fields はプラットフォームイベントの項目が含まれる JSON 配列です。各項目は、次のようになっています。
- type は、その項目が null であるか、指定された型の値があるかを示します。項目が存在しない場合、値は default です。
- doc は、項目のデータ型の説明と、カスタム項目の項目 ID を含んでいます。この項目は、組織内で使用することを目的としています��たとえば、Salesforce では、このデータ型情報を使用して、DateTime 項目が long から DateTime に変換されます。この項目の値は、将来変更される可能性があるため、依存しないことをお勧めします。
応答には uuid 項目も含まれ、この項目にはこのスキーマの ID が含まれています。この ID は、base-64 URL バリアントとして符号化された、正規化された Avro スキーマの MD5 フィンガープリントです。この ID を /vXX.X/event/eventSchema/ URI に追加してスキーマを取得することができます。