TMFTopicEventAPIUtilOOB: スコープ指定

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：50分

    • TMFTopicEventAPIUtilOOB スクリプトインクルードには、イベント [em_event] テーブルのイベントを作成、更新、および削除するために外部トリガー定義によってトリガーされるイベント通知管理オープン API 要求を処理する関数が含まれています。

    このスクリプトインクルードには、 イベント通知管理オープン API のデフォルト実装が含まれています。この API のデフォルト機能を変更する場合は、このスクリプトインクルードに含まれる関数を TMFTopicEventAPIUtil スクリプトインクルードで上書きする必要があります。

    このスクリプトインクルードは sn_ind_tmf642 名前空間で実行され、Telecommunications Alarm Management Open API (app-ind-tmfapi-alarm) プラグインを有効にする必要があります。

    これらの関数をオーバーライドする方法の詳細については、 イベント通知管理オープン API 開発者ガイドを参照してください。

    イベント通知管理オープン API の詳細については、「イベント通知管理オープン API」を参照してください。

    TMFTopicEventAPIUtilOOB - getAlarmChangeEventSchema()

    アラーム変更イベント (ALARM_CHANGE_EVENT_SCHEMA) を処理するときに使用されるペイロードスキーマを返します。

    この関数は、 AlarmChangeEvent フローアクション呼び出しプロセスの一部として呼び出されます。この関数の機能を変更するには、 TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能と TMFAlarmAPIConstants スクリプトインクルードのスキーマを上書きします。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし
    表 : 2. 返される内容
    タイプ 説明
    文字列 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA で定義されたスキーマ。 
    // Schema validation
var schema = this.getAlarmChangeEventSchema();
var validationResults = this.schemaValidator.validateJSON(changeAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;

    TMFTopicEventAPIUtilOOB - getAlarmCreateEventSchema()

    アラーム作成イベント (ALARM_CREATE_EVENT_SCHEMA) を処理するときに使用されるペイロードスキーマを返します。

    この関数は、 AlarmCreateEvent フローアクションコールプロセスの一部として呼び出されます。この関数の機能を変更するには、 TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能と TMFAlarmAPIConstants スクリプトインクルードのスキーマを上書きします。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    文字列 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA で定義されたスキーマ 
    // Schema validation
var schema = this.getAlarmCreateEventSchema();
var validationResults = this.schemaValidator.validateJSON(eventAlarmObject, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - getAlarmDeleteEventSchema()

    アラーム削除イベント (ALARM_DELETE_EVENT_SCHEMA) を処理するときに使用されるペイロードスキーマを返します。

    この関数は、 AlarmDeleteEvent フローアクション呼び出しプロセスの一部として呼び出されます。この関数の機能を変更するには、 TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能と TMFAlarmAPIConstants スクリプトインクルードのスキーマを上書きします。

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    文字列 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA で定義されたスキーマ。 
    // Schema validation
var schema = this.getAlarmDeleteEventSchema();
var validationResults = this.schemaValidator.validateJSON(deleteAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - mapAlarmChangeObjectToEvent(alarmObject, GlideRecord newEventGr)

    渡された変更要求ペイロードのパラメーターを、イベント [em_event] テーブルの指定されたレコードのフィールドにマッピングします。

    フィールドマッピングをカスタマイズして、イベント [em_event] テーブルにデータを追加したり、デフォルトのフィールドマッピングを変更したりできます。マッピングを変更するには、 TMFTopicEventAPIUtil スクリプトインクルードで同じ名前とパラメーターを使用して関数を作成し、 TMFTopicEventAPIUtilOOB スクリプトインクルードのマッピングを上書きします。マッピングにフィールドを追加する場合は、これらのフィールドも関連するスキーマ (TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA) に追加する必要があります。

    この関数は、 transformAndPersistChangeEvent() 関数の一部として呼び出されます。

    表 : 7. パラメーター
    名前 タイプ 説明
    アラームオブジェクト オブジェクト ペイロードは、 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAで定義されたスキーマで定義されているものと一致する必要があります。
    newEventGr GlideRecord イベント [em_event] テーブルで更新するレコードの GlideRecord。
    表 : 8. 返される内容
    タイプ 説明
    なし 
    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - mapCreateAlarmObjectToEvent(オブジェクト alarmObject, GlideRecord eventGr)

    渡された作成要求ペイロードのパラメーターを、イベント [em_event] テーブルの指定されたレコードのフィールドにマッピングします。

    フィールドマッピングをカスタマイズして、イベント [em_event] テーブルにデータを追加したり、デフォルトのフィールドマッピングを変更したりできます。マッピングを変更するには、 TMFTopicEventAPIUtil スクリプトインクルードで同じ名前とパラメーターを使用して関数を作成し、 TMFTopicEventAPIUtilOOB スクリプトインクルードのマッピングを上書きします。マッピングにフィールドを追加する場合は、これらのフィールドを関連するスキーマ (TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA) にも追加する必要があります。

    この関数は、 transformAndPersistAlarmCreateEvent() 関数の一部として呼び出されます。

    表 : 9. パラメーター
    名前 タイプ 説明
    アラームオブジェクト オブジェクト ペイロードは、 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA で定義されたスキーマで定義されているものと一致する必要があります。
    eventGr GlideRecord イベント [em_event] テーブルのレコードの GlideRecord。
    表 : 10. 返される内容
    タイプ 説明
    なし 
    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

    TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(オブジェクト additionalInfoObj, GlideRecord newEventGr)

    渡された削除要求ペイロードのパラメーターを、イベント [em_event] テーブルの指定されたレコードのフィールドにマッピングします。

    フィールドマッピングをカスタマイズして、イベント [em_event] テーブルにデータを追加したり、デフォルトのフィールドマッピングを変更したりできます。マッピングを変更するには、 TMFTopicEventAPIUtil スクリプトインクルードで同じ名前とパラメーターを使用して関数を作成し、 TMFTopicEventAPIUtilOOB スクリプトインクルードのマッピングを上書きします。マッピングにフィールドを追加する場合は、これらのフィールドを関連するスキーマ (TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA) にも追加する必要があります。

    この関数は、 transformAndPersistDeleteEvent() 関数の一部として呼び出されます。

    表 : 11. パラメーター
    名前 タイプ 説明
    アラームオブジェクト オブジェクト ペイロードは、 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA で定義されたスキーマで定義されているものと一致する必要があります。
    newEventGr GlideRecord ペイロードのフィールドをイベント [em_event] テーブルのフィールドにマッピングするために使用するレコードの GlideRecord。
    表 : 12. 返される内容
    タイプ 説明
    なし 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - prepareEventAlarmRecordResponse(文字列、msgKey、オブジェクト、alarmObject、オブジェクト、responseObject)

    イベントの作成または更新 (イベントのクリアを含む) 後に応答オブジェクトを生成します。

    この関数は、processAlarmCreateEvent()、processChangeAlarm()、および processDeleteAlarmEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 13. パラメーター
    名前 タイプ 説明
    msgKey 文字列 メッセージキー。このキーは、イベントが作成されると生成されます。イベント [em_event] テーブルの Message key フィールドにあります。
    アラームオブジェクト オブジェクト 処理するイベントペイロード。このペイロードの形式は、処理中のイベントタイプに関連付けられている必要があります。これらのペイロードのスキーマは、 TMFAlarmAPIConstants スクリプトインクルードで定義されます。
    responseObject オブジェクト 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。
    データタイプ: オブジェクト
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー オブジェクト 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 アレイ 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 文字列 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason 文字列 エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 文字列 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 オブジェクト 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。
    表 : 14. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。 
    processDeleteAlarm: function(additionalInfoObj, gr, deleteAlarmPayload, responseObject) {
var msgKey = this.transformAndPersistDeleteEvent(additionalInfoObj, gr);
var responsePayload = this.prepareEventAlarmRecordResponse(msgKey, deleteAlarmPayload, responseObject);
this._logger.logDebug("processDeleteAlarmEvent");
return responsePayload;
},

    TMFTopicEventAPIUtilOOB - processAlarmChangeEvent(オブジェクト changeAlarmPayload)

    eventTypeが AlarmChangeNotification に設定されている場合、イベント [em_event] テーブルのレコードを更新するプロセスを開始します。

    この関数は、 AlarmChangeEvent フローアクションによって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 15. パラメーター
    名前 タイプ 説明
    changeAlarmPayload オブジェクト 処理するイベント変更ペイロード。ペイロードは、 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    表 : 16. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(オブジェクト eventAlarmObject)

    eventTypeが AlarmCreateNotification に設定されている場合、イベント [em_event] テーブルにレコードを作成するプロセスを開始します。

    この関数は、 AlarmCreateEvent フローアクションによって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 17. パラメーター
    名前 タイプ 説明
    eventAlarmObject オブジェクト 処理するイベント作成ペイロード。ペイロードは、 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    表 : 18. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent(オブジェクト deleteAlarmPayload)

    eventTypeが AlarmDeleteNotification に設定されている場合、イベント [em_event] テーブルのアラームイベントをクリアするプロセスを開始します。

    この関数は、状態フィールドをクリアし、イベントアラームを閉じます。また、渡されたペイロードのパラメーターも更新されます。

    この関数は、 AlarmDeleteEvent フローアクションによって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 19. パラメーター
    名前 タイプ 説明
    deleteAlarmPayload オブジェクト 処理するイベント削除ペイロード。ペイロードは、 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    表 : 20. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(オブジェクト alarmObject)

    関連付けられたイベントマッピングの作成値を使用して、渡されたイベント作成ペイロードを変換し、情報をイベント [em_event] テーブルに保存します。

    この関数は、フローアクションの一部として processAlarmCreateEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 21. パラメーター
    名前 タイプ 説明
    アラームオブジェクト オブジェクト イベント [em_event] テーブルにレコードを作成するために使用するペイロード。ペイロードは、 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    表 : 22. 返される内容
    タイプ 説明
    文字列 イベントの一意の ID (メッセージキー)。

    この関数は AlarmCreateEvent フローアクションによってのみ呼び出されるため、コード例は提供されていません。

    TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(オブジェクト additionalInfoObj, GlideRecord existingGr)

    関連する変更イベントマッピング値を使用して、渡された変更イベントペイロードを変換し、イベント [em_event] テーブル内の渡された GlideRecord に更新された情報を保存します。

    この関数は、フローアクションの一部として processAlarmChangeEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 23. パラメーター
    名前 タイプ 説明
    追加情報オブジェクト オブジェクト existingGr パラメーターで指定されたレコードのフィールドを更新するために使用するペイロード。ペイロードは、 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    既存の Gr GlideRecord 更新するイベント [em_event] テーブルのイベントレコードの GlideRecord。
    表 : 24. 返される内容
    タイプ 説明
    文字列 イベントの一意の ID (メッセージキー)。

    この関数は AlarmChangeEvent フローアクションによってのみ呼び出されるため、コード例は提供されていません。

    TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(オブジェクト、additionalInfoObj、GlideRecord、existingGr)

    関連付けられた削除イベントマッピング値を使用して、渡された削除 (クリア) イベントペイロードを変換し、イベント [em_event] テーブル内の渡された GlideRecord に更新された情報を保存します。

    この関数は、フローアクションの一部として >processAlarmDeleteEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 25. パラメーター
    名前 タイプ 説明
    追加情報オブジェクト オブジェクト existingGr パラメーターで指定されたレコードのクリアイベントフィールドを更新するために使用するペイロード。ペイロードは、 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    既存の Gr GlideRecord アラームをクリアするイベント [em_event] テーブル内のイベントレコードの GlideRecord。
    表 : 26. 返される内容
    タイプ 説明
    文字列 イベントの一意の ID (メッセージキー)。

    この関数は AlarmDeleteEvent フローアクションによってのみ呼び出されるため、コード例は提供されていません。

    TMFTopicEventAPIUtilOOB - validateSubscription(オブジェクト eventAlarmObject, オブジェクト responseObject)

    サブスクリプションの検証を実行します。

    この検証には、イベント通知の作成に使用されたコールバック URL とペイロード内の eventType が登録されているかどうかの確認が含まれます。

    この関数は、processAlarmCreateEvent()、processChangeAlarm()、および processDeleteAlarmEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。

    表 : 27. パラメーター
    名前 タイプ 説明
    eventAlarmObject オブジェクト 検証するイベントペイロード。このペイロードの形式は、処理中のイベントタイプに関連付けられている必要があります。これらのペイロードのスキーマは、 TMFAlarmAPIConstants スクリプトインクルードで定義されます。
    responseObject オブジェクト 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。
    データタイプ: オブジェクト
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。地位 文字列 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 オブジェクト 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。
    responseObjectです。応答エラー オブジェクト 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 アレイ 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 文字列 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason 文字列 エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    表 : 28. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。

    この関数は AlarmCHANGEEvent フローアクションによってのみ呼び出されるため、コード例は提供されていません。

    TMFTopicEventAPIUtilOOB - verifyAlarmChangeEventPayload(オブジェクト changeAlarmPayload, オブジェクト responseObject )

    渡された変更イベントペイロードの追加の検証を定義する機能を提供します。

    この関数は、フローアクションの一部として processAlarmChangeEvent() 関数によって呼び出されます。現在、変更ペイロードに提供される追加のペイロード検証はありません。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を追加できます。

    表 : 29. パラメーター
    名前 タイプ 説明
    changeAlarmPayload オブジェクト 検証するペイロード。ペイロードは 、TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    responseObject オブジェクト 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。
    データタイプ: オブジェクト
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー オブジェクト 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 アレイ 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 文字列 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason 文字列 エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 文字列 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 オブジェクト 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。
    表 : 30. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 
     // Apply customized validations if applicable, defaults to no error
var changePayloadResponse = this.verifyAlarmChangeEventPayload(changeAlarmPayload, this.responseObject);
if (!gs.nil(changePayloadResponse.responseError.errorMessage))
  return changePayloadResponse;

    TMFTopicEventAPIUtilOOB - verifyAlarmCreateEventPayload(オブジェクト alarmObject, オブジェクト responseObject)

    イベントペイロードの作成で渡される追加の検証を定義する機能を提供します。

    この関数は、フローアクションの一部として processAlarmCreateEvent() 関数によって呼び出されます。現在、作成ペイロードに提供される追加のペイロード検証はありません。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を追加できます。

    表 : 31. パラメーター
    名前 タイプ 説明
    アラームペイロード オブジェクト 検証するペイロード。ペイロードは 、TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    responseObject オブジェクト 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。
    データタイプ: オブジェクト
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。地位 文字列 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 オブジェクト 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。
    responseObjectです。応答エラー オブジェクト 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 アレイ 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 文字列 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason 文字列 エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    表 : 32. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 
    // Apply customized validations if applicable, defaults to no error
var creatPayloadResponse = this.verifyAlarmCreateEventPayload(eventAlarmObject, this.responseObject);
if (!gs.nil(creatPayloadResponse.responseError.errorMessage))
  return creatPayloadResponse;

    TMFTopicEventAPIUtilOOB - verifyDeleteEventPayload(オブジェクト deleteAlarmPayload, オブジェクト responseObject)

    渡された削除イベントペイロードの追加検証を定義する機能を提供します。

    この関数は、フローアクションの一部として processDeleteAlarmEvent() 関数によって呼び出されます。現在、削除ペイロードに提供される追加のペイロード検証はありません。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を追加できます。

    表 : 33. パラメーター
    名前 タイプ 説明
    deleteAlarmPayload オブジェクト 検証するペイロード。ペイロードは 、TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAで定義されたスキーマと一致する必要があります。
    responseObject オブジェクト 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。
    データタイプ: オブジェクト
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。地位 文字列 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 オブジェクト 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。
    responseObjectです。応答エラー オブジェクト 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 アレイ 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 文字列 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason 文字列 エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    表 : 34. 返される内容
    タイプ 説明
    responseObject 関数呼び出しのステータスに関する詳細。
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObjectです。応答エラー 検証中に発生したエラーに関する詳細。
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObjectです。responseError。細部 呼び出しルーチンに渡す追加情報。
    例：
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObjectです。responseError。エラーメッセージ 発生したエラーを説明するエラーメッセージ。使用可能なエラーメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。responseError。errorReason エンドポイントに障害が発生した理由。使用可能なエラーの理由は、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。地位 関数呼び出しのステータス。使用可能なステータスメッセージは、 TMFAlarmAPIConstants スクリプトインクルードで定義されています。
    responseObjectです。成功応答 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 
    // Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
  return deletePayloadResponse;