---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# TMFTopicEventAPIUtilOOB: スコープ指定

# TMFTopicEventAPIUtilOOB: スコープ指定 {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：50分

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

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

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

これらの関数をオーバーライドする方法の詳細については、 [イベント通知管理オープン API 開発者ガイド](https://servicenow-prod.fluidtopics.net/SygM5G0eOYCUQMRWzIICBg#event-mgmt-notif_dev-guide "イベント通知管理オープン API を使用して、イベント [em_event] テーブルのイベントレコードを作成、更新、および削除します。")を参照してください。

イベント通知管理オープン API の詳細については、「[イベント通知管理オープン API](https://servicenow-prod.fluidtopics.net/JIvDyhLqOgFJtfFHeZjgIQ#event_open-api "イベント通知管理オープン API は、イベント [em_event] テーブルからイベントを作成、更新、および削除するためのエンドポイントを提供します。")」を参照してください。

## TMFTopicEventAPIUtilOOB - getAlarmChangeEventSchema() {#ariaid-title2}

アラーム変更イベント (ALARM_CHANGE_EVENT_SCHEMA) を処理するときに使用されるペイロードスキーマを返します。
この関数は、 `AlarmChangeEvent` フローアクション呼び出しプロセスの一部として呼び出されます。この関数の機能を変更するには、 TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能と TMFAlarmAPIConstants スクリプトインクルードのスキーマを上書きします。
{#TMFEvtOOB-getAlrmChngEvtSchem__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#TMFEvtOOB-getAlrmChngEvtSchem__table_tnr_qxs_zyb} {#TMFEvtOOB-getAlrmChngEvtSchem__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | `TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA` で定義されたスキーマ。 |
[表 : 2. 返される内容]

{#TMFEvtOOB-getAlrmChngEvtSchem__table_unr_qxs_zyb}  

    // 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() {#ariaid-title3}

アラーム作成イベント (ALARM_CREATE_EVENT_SCHEMA) を処理するときに使用されるペイロードスキーマを返します。
この関数は、 `AlarmCreateEvent` フローアクションコールプロセスの一部として呼び出されます。この関数の機能を変更するには、 TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能と TMFAlarmAPIConstants スクリプトインクルードのスキーマを上書きします。
{#TMFEvtOOB-getAlrmCreatEvtSchem__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 3. パラメーター]

{#TMFEvtOOB-getAlrmCreatEvtSchem__table_tnr_qxs_zyb} {#TMFEvtOOB-getAlrmCreatEvtSchem__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | `TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA` で定義されたスキーマ |
[表 : 4. 返される内容]

{#TMFEvtOOB-getAlrmCreatEvtSchem__table_unr_qxs_zyb}  

    // 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() {#ariaid-title4}

アラーム削除イベント (ALARM_DELETE_EVENT_SCHEMA) を処理するときに使用されるペイロードスキーマを返します。
この関数は、 `AlarmDeleteEvent` フローアクション呼び出しプロセスの一部として呼び出されます。この関数の機能を変更するには、 TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能と TMFAlarmAPIConstants スクリプトインクルードのスキーマを上書きします。
{#TMFEvtOOB-getAlrmDelEvtSchem__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 5. パラメーター]

{#TMFEvtOOB-getAlrmDelEvtSchem__table_tnr_qxs_zyb} {#TMFEvtOOB-getAlrmDelEvtSchem__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | `TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA` で定義されたスキーマ。 |
[表 : 6. 返される内容]

{#TMFEvtOOB-getAlrmDelEvtSchem__table_unr_qxs_zyb}  

    // 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) {#ariaid-title5}

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

この関数は、 transformAndPersistChangeEvent() 関数の一部として呼び出されます。
{#TMFEvtOOB-mapChngObjToEvt_O_GR__table_tnr_qxs_zyb__entry__3}

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

{#TMFEvtOOB-mapChngObjToEvt_O_GR__table_tnr_qxs_zyb} {#TMFEvtOOB-mapChngObjToEvt_O_GR__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 8. 返される内容]

{#TMFEvtOOB-mapChngObjToEvt_O_GR__table_unr_qxs_zyb}  

    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

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

## TMFTopicEventAPIUtilOOB - mapCreateAlarmObjectToEvent(オブジェクト alarmObject, GlideRecord eventGr) {#ariaid-title6}

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

この関数は、 transformAndPersistAlarmCreateEvent() 関数の一部として呼び出されます。
{#TMFEvtOOB-mapCreatObjToEvt_O_GR__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| アラームオブジェクト | オブジェクト | ペイロードは、 `TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA` で定義されたスキーマで定義されているものと一致する必要があります。 |
| eventGr | GlideRecord | イベント \[em_event\] テーブルのレコードの GlideRecord。 |
[表 : 9. パラメーター]

{#TMFEvtOOB-mapCreatObjToEvt_O_GR__table_tnr_qxs_zyb} {#TMFEvtOOB-mapCreatObjToEvt_O_GR__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 10. 返される内容]

{#TMFEvtOOB-mapCreatObjToEvt_O_GR__table_unr_qxs_zyb}  

    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
    var id = eventGr.insert();
    return gs.nil(id) ? id : msgKey;

## TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(オブジェクト additionalInfoObj, GlideRecord newEventGr) {#ariaid-title7}

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

この関数は、 transformAndPersistDeleteEvent() 関数の一部として呼び出されます。
{#TMFEvtOOB-mapDelObjToEvt_O_GR__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| アラームオブジェクト | オブジェクト | ペイロードは、 `TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA` で定義されたスキーマで定義されているものと一致する必要があります。 |
| newEventGr | GlideRecord | ペイロードのフィールドをイベント \[em_event\] テーブルのフィールドにマッピングするために使用するレコードの GlideRecord。 |
[表 : 11. パラメーター]

{#TMFEvtOOB-mapDelObjToEvt_O_GR__table_tnr_qxs_zyb} {#TMFEvtOOB-mapDelObjToEvt_O_GR__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 12. 返される内容]

{#TMFEvtOOB-mapDelObjToEvt_O_GR__table_unr_qxs_zyb}  

    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
    var id = newEventGr.insert();
    return gs.nil(id) ? id : newEventGr.message_key;

## TMFTopicEventAPIUtilOOB - prepareEventAlarmRecordResponse(文字列、msgKey、オブジェクト、alarmObject、オブジェクト、responseObject) {#ariaid-title8}

イベントの作成または更新 (イベントのクリアを含む) 後に応答オブジェクトを生成します。
この関数は、processAlarmCreateEvent()、processChangeAlarm()、および processDeleteAlarmEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-prepEvtRecResp_S_O_O__table_tnr_qxs_zyb__entry__3}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject-TMFEvtOOO-entry}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject_responseError-TMFEvtOOO-entry}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject_responseError_details-TMFEvtOOO-entry}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject_responseError_errorMessage-TMFEvtOOO-entry}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject_responseError_errorReason-TMFEvtOOO-entry}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject_status-TMFEvtOOO-entry}{#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject_successResponse-TMFEvtOOO-entry}

| 名前 | タイプ | 説明 |
|-|-|-|
| msgKey | 文字列 | メッセージキー。このキーは、イベントが作成されると生成されます。イベント \[em_event\] テーブルの Message key フィールドにあります。 |
| アラームオブジェクト | オブジェクト | 処理するイベントペイロード。このペイロードの形式は、処理中のイベントタイプに関連付けられている必要があります。これらのペイロードのスキーマは、 TMFAlarmAPIConstants スクリプトインクルードで定義されます。 |
| responseObject | オブジェクト | 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。 データタイプ: オブジェクト "responseObject": { "responseError": {Object}, "status": "String", "successResponse": {Object} } {#TMFEvtOOB-prepEvtRecResp_S_O_O__responseObject-TMFEvtOOO-codeblock} |
| 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です。成功応答 | オブジェクト | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 13. パラメーター]

{#TMFEvtOOB-prepEvtRecResp_S_O_O__table_tnr_qxs_zyb} {#TMFEvtOOB-prepEvtRecResp_S_O_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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 スクリプトインクルードで定義されています。 |
[表 : 14. 返される内容]

{#TMFEvtOOB-prepEvtRecResp_S_O_O__table_unr_qxs_zyb}  

    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) {#ariaid-title9}

eventTypeが `AlarmChangeNotification` に設定されている場合、イベント \[em_event\] テーブルのレコードを更新するプロセスを開始します。
この関数は、 `AlarmChangeEvent` フローアクションによって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-procAlarmChngEvt_O__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| changeAlarmPayload | オブジェクト | 処理するイベント変更ペイロード。ペイロードは、 `TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
[表 : 15. パラメーター]

{#TMFEvtOOB-procAlarmChngEvt_O__table_tnr_qxs_zyb} {#TMFEvtOOB-procAlarmChngEvt_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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です。成功応答 | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 16. 返される内容]

{#TMFEvtOOB-procAlarmChngEvt_O__table_unr_qxs_zyb}  

    Called by the `AlarmChangeEvent` flow action

## TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(オブジェクト eventAlarmObject) {#ariaid-title10}

eventTypeが `AlarmCreateNotification` に設定されている場合、イベント \[em_event\] テーブルにレコードを作成するプロセスを開始します。
この関数は、 `AlarmCreateEvent` フローアクションによって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-procAlarmCreatEvt_O__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| eventAlarmObject | オブジェクト | 処理するイベント作成ペイロード。ペイロードは、 `TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
[表 : 17. パラメーター]

{#TMFEvtOOB-procAlarmCreatEvt_O__table_tnr_qxs_zyb} {#TMFEvtOOB-procAlarmCreatEvt_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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です。成功応答 | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 18. 返される内容]

{#TMFEvtOOB-procAlarmCreatEvt_O__table_unr_qxs_zyb}  

    Called by `AlarmCreateEvent` flow action.

## TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent(オブジェクト deleteAlarmPayload) {#ariaid-title11}

eventTypeが `AlarmDeleteNotification` に設定されている場合、イベント \[em_event\] テーブルのアラームイベントをクリアするプロセスを開始します。
この関数は、状態フィールドをクリアし、イベントアラームを閉じます。また、渡されたペイロードのパラメーターも更新されます。

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

| 名前 | タイプ | 説明 |
|-|-|-|
| deleteAlarmPayload | オブジェクト | 処理するイベント削除ペイロード。ペイロードは、 `TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
[表 : 19. パラメーター]

{#TMFEvtOOB-procAlarmDelEvt_O__table_tnr_qxs_zyb} {#TMFEvtOOB-procAlarmDelEvt_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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です。成功応答 | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 20. 返される内容]

{#TMFEvtOOB-procAlarmDelEvt_O__table_unr_qxs_zyb}  

    Called by `AlarmDeleteEvent` flow action.

## TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(オブジェクト alarmObject) {#ariaid-title12}

関連付けられたイベントマッピングの作成値を使用して、渡されたイベント作成ペイロードを変換し、情報をイベント \[em_event\] テーブルに保存します。
この関数は、フローアクションの一部として [processAlarmCreateEvent()](https://servicenow-prod.fluidtopics.net/phcy6oZZF3n70ooCOAO5qw#TMFEvtOOB-procAlarmCreatEvt_O "eventTypeが AlarmCreateNotification に設定されている場合、イベント [em_event] テーブルにレコードを作成するプロセスを開始します。") 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-transPersCreatEvt_O__table_tnr_qxs_zyb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| アラームオブジェクト | オブジェクト | イベント \[em_event\] テーブルにレコードを作成するために使用するペイロード。ペイロードは、 `TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
[表 : 21. パラメーター]

{#TMFEvtOOB-transPersCreatEvt_O__table_tnr_qxs_zyb} {#TMFEvtOOB-transPersCreatEvt_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | イベントの一意の ID (メッセージキー)。 |
[表 : 22. 返される内容]

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

## TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(オブジェクト additionalInfoObj, GlideRecord existingGr) {#ariaid-title13}

関連する変更イベントマッピング値を使用して、渡された変更イベントペイロードを変換し、イベント \[em_event\] テーブル内の渡された GlideRecord に更新された情報を保存します。
この関数は、フローアクションの一部として [processAlarmChangeEvent()](https://servicenow-prod.fluidtopics.net/phcy6oZZF3n70ooCOAO5qw#TMFEvtOOB-procAlarmChngEvt_O "eventTypeが AlarmChangeNotification に設定されている場合、イベント [em_event] テーブルのレコードを更新するプロセスを開始します。") 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-transPersChngEvt_O_GR__table_tnr_qxs_zyb__entry__3}

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

{#TMFEvtOOB-transPersChngEvt_O_GR__table_tnr_qxs_zyb} {#TMFEvtOOB-transPersChngEvt_O_GR__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | イベントの一意の ID (メッセージキー)。 |
[表 : 24. 返される内容]

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

## TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(オブジェクト、additionalInfoObj、GlideRecord、existingGr) {#ariaid-title14}

関連付けられた削除イベントマッピング値を使用して、渡された削除 (クリア) イベントペイロードを変換し、イベント \[em_event\] テーブル内の渡された GlideRecord に更新された情報を保存します。
この関数は、フローアクションの一部として [\>processAlarmDeleteEvent()](https://servicenow-prod.fluidtopics.net/phcy6oZZF3n70ooCOAO5qw#TMFEvtOOB-procAlarmDelEvt_O "eventTypeが AlarmDeleteNotification に設定されている場合、イベント [em_event] テーブルのアラームイベントをクリアするプロセスを開始します。") 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-transPersDelEvt_O__table_tnr_qxs_zyb__entry__3}

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

{#TMFEvtOOB-transPersDelEvt_O__table_tnr_qxs_zyb} {#TMFEvtOOB-transPersDelEvt_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | イベントの一意の ID (メッセージキー)。 |
[表 : 26. 返される内容]

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

## TMFTopicEventAPIUtilOOB - validateSubscription(オブジェクト eventAlarmObject, オブジェクト responseObject) {#ariaid-title15}

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

この関数は、processAlarmCreateEvent()、processChangeAlarm()、および processDeleteAlarmEvent() 関数によって呼び出されます。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を変更できます。
{#TMFEvtOOB-validateSub_O_O__table_tnr_qxs_zyb__entry__3}{#TMFEvtOOB-validateSub_O_O__responseObject-TMFEvtOOO-entry}{#TMFEvtOOB-validateSub_O_O__responseObject_status-TMFEvtOOO-entry}{#TMFEvtOOB-validateSub_O_O__responseObject_successResponse-TMFEvtOOO-entry}{#TMFEvtOOB-validateSub_O_O__responseObject_responseError-TMFEvtOOO-entry}{#TMFEvtOOB-validateSub_O_O__responseObject_responseError_details-TMFEvtOOO-entry}{#TMFEvtOOB-validateSub_O_O__responseObject_responseError_errorMessage-TMFEvtOOO-entry}{#TMFEvtOOB-validateSub_O_O__responseObject_responseError_errorReason-TMFEvtOOO-entry}

| 名前 | タイプ | 説明 |
|-|-|-|
| eventAlarmObject | オブジェクト | 検証するイベントペイロード。このペイロードの形式は、処理中のイベントタイプに関連付けられている必要があります。これらのペイロードのスキーマは、 TMFAlarmAPIConstants スクリプトインクルードで定義されます。 |
| responseObject | オブジェクト | 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。 データタイプ: オブジェクト "responseObject": { "responseError": {Object}, "status": "String", "successResponse": {Object} } {#TMFEvtOOB-validateSub_O_O__responseObject-TMFEvtOOO-codeblock} |
| 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 スクリプトインクルードで定義されています。 |
[表 : 27. パラメーター]

{#TMFEvtOOB-validateSub_O_O__table_tnr_qxs_zyb} {#TMFEvtOOB-validateSub_O_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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です。成功応答 | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 28. 返される内容]

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

## TMFTopicEventAPIUtilOOB - verifyAlarmChangeEventPayload(オブジェクト changeAlarmPayload, オブジェクト responseObject ) {#ariaid-title16}

渡された変更イベントペイロードの追加の検証を定義する機能を提供します。
この関数は、フローアクションの一部として [processAlarmChangeEvent()](https://servicenow-prod.fluidtopics.net/phcy6oZZF3n70ooCOAO5qw#TMFEvtOOB-procAlarmChngEvt_O "eventTypeが AlarmChangeNotification に設定されている場合、イベント [em_event] テーブルのレコードを更新するプロセスを開始します。") 関数によって呼び出されます。現在、変更ペイロードに提供される追加のペイロード検証はありません。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を追加できます。
{#TMFEvtOOB-verAlrmChngEvtPay_O_O__table_tnr_qxs_zyb__entry__3}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject_responseError-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject_responseError_details-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject_responseError_errorMessage-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject_responseError_errorReason-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject_status-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject_successResponse-TMFEvtOOO-entry}

| 名前 | タイプ | 説明 |
|-|-|-|
| changeAlarmPayload | オブジェクト | 検証するペイロード。ペイロードは `、TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
| responseObject | オブジェクト | 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。 データタイプ: オブジェクト "responseObject": { "responseError": {Object}, "status": "String", "successResponse": {Object} } {#TMFEvtOOB-verAlrmChngEvtPay_O_O__responseObject-TMFEvtOOO-codeblock} |
| 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です。成功応答 | オブジェクト | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 29. パラメーター]

{#TMFEvtOOB-verAlrmChngEvtPay_O_O__table_tnr_qxs_zyb} {#TMFEvtOOB-verAlrmChngEvtPay_O_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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. 返される内容]

{#TMFEvtOOB-verAlrmChngEvtPay_O_O__table_unr_qxs_zyb}  

     // 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) {#ariaid-title17}

イベントペイロードの作成で渡される追加の検証を定義する機能を提供します。
この関数は、フローアクションの一部として [processAlarmCreateEvent()](https://servicenow-prod.fluidtopics.net/phcy6oZZF3n70ooCOAO5qw#TMFEvtOOB-procAlarmCreatEvt_O "eventTypeが AlarmCreateNotification に設定されている場合、イベント [em_event] テーブルにレコードを作成するプロセスを開始します。") 関数によって呼び出されます。現在、作成ペイロードに提供される追加のペイロード検証はありません。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を追加できます。
{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__table_tnr_qxs_zyb__entry__3}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject_status-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject_successResponse-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject_responseError-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject_responseError_details-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject_responseError_errorMessage-TMFEvtOOO-entry}{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject_responseError_errorReason-TMFEvtOOO-entry}

| 名前 | タイプ | 説明 |
|-|-|-|
| アラームペイロード | オブジェクト | 検証するペイロード。ペイロードは `、TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
| responseObject | オブジェクト | 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。 データタイプ: オブジェクト "responseObject": { "responseError": {Object}, "status": "String", "successResponse": {Object} } {#TMFEvtOOB-verAlrmCreatEvtPay_O_O__responseObject-TMFEvtOOO-codeblock} |
| 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 スクリプトインクルードで定義されています。 |
[表 : 31. パラメーター]

{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__table_tnr_qxs_zyb} {#TMFEvtOOB-verAlrmCreatEvtPay_O_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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です。成功応答 | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 32. 返される内容]

{#TMFEvtOOB-verAlrmCreatEvtPay_O_O__table_unr_qxs_zyb}  

    // 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) {#ariaid-title18}

渡された削除イベントペイロードの追加検証を定義する機能を提供します。
この関数は、フローアクションの一部として [processDeleteAlarmEvent()](https://servicenow-prod.fluidtopics.net/phcy6oZZF3n70ooCOAO5qw#TMFEvtOOB-procAlarmDelEvt_O "eventTypeが AlarmDeleteNotification に設定されている場合、イベント [em_event] テーブルのアラームイベントをクリアするプロセスを開始します。") 関数によって呼び出されます。現在、削除ペイロードに提供される追加のペイロード検証はありません。TMFTopicEventAPIUtil スクリプトインクルードのデフォルト機能を上書きすることで、この関数の機能を追加できます。
{#TMFEvtOOB-verDelEvtPay_O_O__table_tnr_qxs_zyb__entry__3}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject-TMFEvtOOO-entry}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject_status-TMFEvtOOO-entry}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject_successResponse-TMFEvtOOO-entry}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject_responseError-TMFEvtOOO-entry}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject_responseError_details-TMFEvtOOO-entry}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject_responseError_errorMessage-TMFEvtOOO-entry}{#TMFEvtOOB-verDelEvtPay_O_O__responseObject_responseError_errorReason-TMFEvtOOO-entry}

| 名前 | タイプ | 説明 |
|-|-|-|
| deleteAlarmPayload | オブジェクト | 検証するペイロード。ペイロードは `、TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA`で定義されたスキーマと一致する必要があります。 |
| responseObject | オブジェクト | 空の応答オブジェクト。このオブジェクトを使用して、ペイロードスキーマの検証に関する問題を記録します。 データタイプ: オブジェクト "responseObject": { "responseError": {Object}, "status": "String", "successResponse": {Object} } {#TMFEvtOOB-verDelEvtPay_O_O__responseObject-TMFEvtOOO-codeblock} |
| 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 スクリプトインクルードで定義されています。 |
[表 : 33. パラメーター]

{#TMFEvtOOB-verDelEvtPay_O_O__table_tnr_qxs_zyb} {#TMFEvtOOB-verDelEvtPay_O_O__table_unr_qxs_zyb__entry__2}

| タイプ | 説明 |
|-|-|
| 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です。成功応答 | 関数呼び出しからの正常な応答。たとえば、この値にペイロードオブジェクトを格納できます。 |
[表 : 34. 返される内容]

{#TMFEvtOOB-verDelEvtPay_O_O__table_unr_qxs_zyb}  

    // Apply customized validations if applicable, defaults to no error
    var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
    if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
      return deletePayloadResponse;