L’API Gestion des alarmes utilise des schémas JSON pour conserver les informations sur les paramètres requis. Ces schémas JSON sont définis dans l’include de script TMFAlarmAPIConstants . Ces schémas sont utilisés pour valider si les charges utiles de la demande sont valides. Ces schémas ne sont pas référencés directement dans les includes de script et sont retournés par les méthodes suivantes dans l’include de script AlarmAPIProcessorOOB :

• getCreateEventSchema : renvoie le schéma de validation pour la création d’un événement.
• getClearEventSchema : renvoie le schéma de validation pour effacer une alarme d’événement.
• getPatchEventSchema : renvoie le schéma de validation pour l’application de correctif d’un événement.

Pour remplacer les schémas existants, définissez de nouveaux schémas dans l’include de script AlarmAPIProcessor et remplacez les méthodes d’include de script AlarmAPIProcessorOOB.

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\"]}";

Pour effectuer une validation supplémentaire sur le corps de la demande, remplacez les fonctions suivantes dans l’include de script AlarmAPIProcessorOOB . Ces fonctions sont appelées par les fonctions spécifiées dans le script include TMFAlarmAPIUtil .

• verifyCreateEventPayload() : appelé par processCreateEvent().
• verifyClearEventPayload() : appelé par processClearEvent().
• verifyPatchEventPayload() : appelé par processPatchEvent().

Toutes ces fonctions renvoient true par defalut. Si une fonction d’assistance renvoie la valeur faux , elle arrête l’opération d’API.

Dans cet exemple, une fonction d’un include de script AlarmAPIProcessor personnalisé remplace une fonction par défaut dans AlarmAPIProcessorOOB pour effectuer une validation sur l’attribut nom.

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'
});

L’include de script AlarmAPIProcessorOOB contient les fonctions suivantes pour mapper le corps d’une demande PATCH ou POST à un enregistrement de la table d’événements [em_event].

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

Il contient également les fonctions suivantes pour mapper un événement GlideRecord à un objet de réponse JSON pour les demandes GET, PATCH ou POST.

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

Vous pouvez utiliserles mappages de champs pour ajouter et récupérer des données pour des champs supplémentaires de la table d’événements [em_event] ou modifier les mappages de champs par défaut. Pour utiliser des mappages, créez des fonctions avec des noms et des paramètres identiques dans AlarmAPIProcessor pour remplacer les fonctions de mappage AlarmAPIProcessorOOB . TMFAlarmAPIUtil utilise ces fonctions AlarmAPIProcessor pour remplacer les fonctions de mappage AlarmAPIProcessorOOB par défaut.

Dans l’exemple suivant, deux fonctions AlarmAPIProcessor remplacent les fonctions par défaut dans AlarmAPIProcessorOOB pour modifier le mappage de type field et ajouter un mappage pour le champ Gravité .

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'
});