イベント管理トピックのオープン API 機能を上書きする
イベント管理トピックオープン API を使用すると、トピックペイロードを検証した後、トピックレコードをトピック [sn_api_notif_mgmt_topic] テーブルに保存できます。
トピックレコードの処理を上書きするには、TopicAPIUtils API の TopicAPIUtilsOOB API のメソッドを更新します。
この API 内で使用可能なメソッドと、それらが提供するデフォルトの機能のリストを以下に示します。
- TopicAPIUtilsOOB:createTopicHelper(オブジェクト、topicObject、アレイの警告): イベント管理トピックオープン API - POST /sn_api_notif_mgmt/topic エンドポイントで渡されたペイロードをトピック [sn_api_notif_mgmt_topic] テーブルに挿入します。
- TopicAPIUtilsOOB:getCreateTopicSchema(): イベント管理トピックオープン API - POST /sn_api_notif_mgmt/topic エンドポイントを使用してトピックペイロードを検証するために使用する、ペイロードの定義済みスキーマを返します。デフォルトのペイロードスキーマである Constants.SCHEMA は、 sn_api_notif_mgmtにあります。定数 スクリプトインクルード。
- TopicAPIUtilsOOB:isValidCreateTopicPayload(オブジェクト、topicObject、文字列スキーマ、アレイの警告): イベント管理トピックオープン API - POST /sn_api_notif_mgmt/topic エンドポイントに渡されたペイロードを検証します。この検証は、要求本文とスキーマに対して実行されます。
- TopicAPIUtilsOOB - prepareCreateTopicResponse (オブジェクト topicObject, 文字列 topicSysId, アレイの警告): イベント管理トピックオープン API - POST /sn_api_notif_mgmt/topic エンドポイント呼び出しへの応答を生成して返します。
- TopicAPIUtilsOOB:processTopicCreation(オブジェクト、topicObject): イベント管理トピックオープン API エンドポイントによって行われた要求を処理します。このメソッドは、データの挿入、スキーマの検証、要求本文の検証、および応答オーケストレーションに必要なヘルパーメソッドを呼び出します。イベント管理トピックオープン:POST /sn_api_notif_mgmt/topic要求の基本的な処理をカスタマイズする必要がある場合は、このメソッドを上書きします。それ以外の場合は、個々のヘルパーメソッドを上書きします。
- TopicAPIUtilsOOB:transformCreateTopicResponse(オブジェクト、topicObject、文字列、topicSysId): イベント管理トピックオープン API - POST /sn_api_notif_mgmt/topic エンドポイントに返された応答オブジェクトにカスタムデータを追加する機能を提供します。
- TopicAPIUtilsOOB:validateTopicAttributes(オブジェクト、topicObject、アレイの詳細): イベント管理トピックオープン API エンドポイントペイロードで渡されたトピック名、ヘッダークエリ、コンテンツクエリ、および名前空間の組み合わせが一意であるかどうかを検証します。エンドポイントは、この属性の組み合わせを使用して、トピックが現在トピック [sn_api_notif_mgmt_topic] テーブルに存在するかどうかを判断します。デフォルトの実装では、デフォルトのトピックペイロードスキーマで必須として定義されている name 属性が、渡されたペイロードに含まれているかどうかもチェックされます。
- TopicAPIUtilsOOB:validateTopicExternalId(オブジェクト、topicObject、アレイの詳細): イベント管理トピックオープン API エンドポイントの要求本文で渡されたトピック外部 ID を検証します。基本実装では、これは外部 ID が空でないことを確認するだけです。