アラーム管理 API は、JSON スキーマを使用して必須パラメーター情報を保持します。これらの JSON スキーマは、 TMFAlarmAPIConstants スクリプトインクルードで定義されます。これらのスキーマは 要求ペイロードが有効かどうかを検証するために使用されます。これらのスキーマはスクリプトインクルードでは直接参照されず、 AlarmAPIProcessorOOB スクリプトインクルードの次のメソッドによって返されます。

• getCreateEventSchema:イベントを作成するための検証スキーマを返します。
• getClearEventSchema:イベントアラームをクリアするための検証スキーマを返します。
• getPatchEventSchema:イベントにパッチを適用するための検証スキーマを返します。

既存のスキーマを上書きするには、 AlarmAPIProcessor スクリプトインクルードで新しいスキーマを定義し、 AlarmAPIProcessorOOB スクリプトインクルード methods を上書きします。

var AlarmAPIProcessor = Class.create();
AlarmAPIProcessor.prototype = Object.extendsObject(AlarmAPIProcessorOOB, {
	// Define overriding functions here
	
	// Define getCreateEventSchema here to override OOTB method in AlarmAPIProcessorOOB
	getCreateEventSchema: function() {
		return JSON.parse(AlarmAPIProcessor.CUSTOMIZED_SCHEMA);
	},
    type: 'AlarmAPIProcessor'
});

// Define a new schema
AlarmAPIProcessor.CUSTOMIZED_SCHEMA = "{\"title\":\"CreateAlarm\",\"type\":\"object\",
\"properties\":{\"externalAlarmId\":{\"type\":\"string\"},\"alarmType\":{\"type\":\"string\"},
\"perceivedSeverity\":{\"type\":\"string\"},\"probableCause\":{\"type\":\"string\"},
\"alarmedObject\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},
\"href\":{\"type\":\"string\"}},\"required\":[\"id\"]},\"sourceSystemId\":{\"type\":\"string\"}},
\"required\":[\"externalAlarmId\",\"alarmType\",\"perceivedSeverity\",\"probableCause\",
\"alarmedObject\",\"sourceSystemId\"]}";

要求本文で追加の検証を実行するには、AlarmAPIProcessorOOB スクリプトインクルードの次の関数 を上書きします。これらの関数は TMFAlarmAPIUtil スクリプトインクルードで指定された関数によって呼び出されます。

• verifyCreateEventPayload() - processCreateEvent() によって呼び出されます。
• verifyClearEventPayload() - processClearEvent() によって呼び出されます。
• verifyPatchEventPayload() - processPatchEvent() によって呼び出されます。

これらの関数はすべて、デフォルトで true を返します。ヘルパー関数が false を返すと、API 操作が停止されます。

この例では カスタム AlarmAPIProcessor スクリプトインクルードの関数が AlarmAPIProcessorOOB のデフォルト関数を オーバーライドして、name 属性の検証を実行します。

var AlarmAPIProcessor = Class.create();
AlarmAPIProcessor.prototype = Object.extendsObject(AlarmAPIProcessorOOB, {
	// Define overriding functions here
	
    verifyCreateEventPayload: function(eventPayload, apiResponseProcessor){
        // Returning false terminates the POST request
        // Make sure to assign error message and reason
        if (eventPayload.type != "unique") {
            apiResponseProcessor.setMessage("Failed");
            apiResponseProcessor.setReason("No reason needed");
            return false;
        }
    },
	
    type: 'AlarmAPIProcessor'
});

AlarmAPIProcessorOOB スクリプトインクルードには、PATCH または POST 要求本文をイベント [em_event] テーブルのレコードにマップするための次の関数が含まれています。

• mapCreateAlarmObjectToEvent()
• mapClearAlarmObjectToEvent()
• mapPatchAlarmObjectToEvent()

また イベント GlideRecord を GET、PATCH、または POST 要求の JSON 応答オブジェクトにマッピングするための次の関数も含まれています。

• modifyCreateEventResponse()
• modifyClearEventResponse()
• modifyPatchEventResponse()

フィールドマッピングをカスタマイズして、追加のイベント [em_event] テーブルフィールドのデータを追加および取得したり、デフォルトのフィールドマッピングを変更したりすることができます。マッピングを操作するには、 AlarmAPIProcessor に同じ名前とパラメーターを持つ関数を作成し、 AlarmAPIProcessorOOB マッピング関数を上書きします。TMFAlarmAPIUtil は、これらの AlarmAPIProcessor 関数を使用して、デフォルトの AlarmAPIProcessorOOB マッピング関数を置き換えます。

次の例では、2 つの AlarmAPIProcessor 関数が AlarmAPIProcessorOOB のデフォルト関数を上書きして、 タイプ field マッピングを変更し、[ 重大度 ] フィールドのマッピングを追加します。

var AlarmAPIProcessor = Class.create();
AlarmAPIProcessor.prototype = Object.extendsObject(AlarmAPIProcessorOOB, {
	// Define overriding functions here
	
    // Function name and parameters must be identical to the function it overrides
    mapCreateAlarmObjectToEvent: function(eventGr, eventObject){
        // Override default mapping for the severity field
        eventGr.severity = "High";
    },

    modifyCreateEventResponse: function(eventGr, eventObject){
        // Override default mapping for the type field
        eventGr.type = "Customized Event"; 
    },
	
    type: 'AlarmAPIProcessor'
});