---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Alarmmanagement -- API-Entwicklerleitfaden öffnen

# Alarmmanagement -- API-Entwicklerleitfaden öffnen {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 Minuten Lesedauer

Verwenden Sie Alarmmanagement -- API öffnen Dient zum Erstellen und Aktualisieren von Daten in der Tabelle „Ereignisse" \[em_event\].

Dieser Entwicklerleitfaden enthält Informationen zur Erweiterung von [Alarmmanagement -- API öffnen](https://servicenow-prod.fluidtopics.net/Ckavly8R4p5leonBw8XcMw#alarm-open-api "Die Alarmmanagement Offen Die API stellt Endpunkte zum Erstellen, Aktualisieren und Abrufen von Daten aus den Tabellen „Ereignisse“ [em_event] und „Warnung [em_Alert]“ bereit.")Um verschiedene Anpassungen vorzunehmen.

## Erweiterung der offenen API für Alarmmanagement {#ariaid-title2}

Die Alarmmanagement Offen API Kann erweitert werden Durch Bearbeiten von Skripteinbindungen.  
Diese Skripteinbindungen Sollte nur bearbeitet werden Mit einem Verständnis von Konsequenzen der Changes .

* `TMFAlarmAPIKonstanten `: Enthält Konstanten und erforderliche Parameterinformationen.
* `TMFAlarmAPIUtil `: Enthält Funktionen zur Verarbeitung von API-Anforderungen.
* `AlarmAPIProcessorOOB `: Enthält Hilfsfunktionen, die Funktionen in unterstützen TMFAlarmAPIUtil .
* `AlarmAPIProzessor `: Eine leere Skripteinbindungsdatei. Verwenden Sie dies Datei Zum Definieren von Funktionen, von denen Sie überschreiben möchten AlarmAPIProcessorOOB .
{#extend-alarm-mgmt-api__ul_yyb_qjh_yqb}

Erweitern Sie Alarmmanagement -- API öffnen Um die folgenden Anpassungen vorzunehmen.

### Erforderliche Parameter {#extend-alarm-mgmt-api__section_a22_fkt_prb}

Die Alarmmanagement Die API verwendet JSON-Schemas, um erforderliche Parameterinformationen zu speichern. Diese JSON-Schemas sind in definiert TMFAlarmAPIKonstanten Skripteinbindung. Diese Schemas werden verwendet Dient zum Validieren, ob Anforderungsnutzlasten gültig sind. Diese Schemas werden nicht direkt in Skripteinbindungen referenziert und werden von den folgenden Methoden in zurückgegeben AlarmAPIProcessorOOB Skripteinbindung:

* GetCreateEventSchema : Gibt das Validierungsschema zum Erstellen eines Ereignisses zurück.
* GetClearEventSchema : Gibt das Validierungsschema zum Löschen eines Ereignisalarms zurück.
* GetPatchEventSchema : Gibt das Validierungsschema für das Patchen eines Ereignisses zurück.
{#extend-alarm-mgmt-api__ul_zyb_qjh_yqb}  
Um vorhandene Schemas zu überschreiben, definieren Sie neue Schemas in AlarmAPIProzessor Skripteinbindung und überschreiben AlarmAPIProcessorOOB Skripteinbindung Methoden .

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

### Validierung des Anforderungstexts {#extend-alarm-mgmt-api__section_ikk_tkt_prb}

Überschreiben Sie, um eine zusätzliche Validierung für den Anforderungstext durchzuführen Die folgenden Funktionen in AlarmAPIProcessorOOB Skripteinbindung . Diese Funktionen werden aufgerufen Durch die angegebenen Funktionen In Die TMFAlarmAPIUtil Skripteinbindung .

* `VerifyCreateEventPayload() `-- Angerufen von `ProcessCreateEvent () `.
* `VerifyClearEventPayload() `-- Angerufen von `ProcessClearEvent() `.
* `VerifyPatchEventPayload() `-- Angerufen von `ProcessPatchEvent() `.

{#extend-alarm-mgmt-api__ul_azb_qjh_yqb} Alle diese Funktionen werden zurückgegeben Wahr Per Defalut. Wenn eine Hilfsfunktion zurückgegeben wird Falsch , Stoppt den API-Vorgang.
Um anwenderdefinierte Validierungen anzuwenden, überschreiben Sie AlarmAPIProcessorOOB-Hilfsfunktionen mit identisch benannten Funktionsnamen und Parametern in AlarmAPIProcessor. Die neuen AlarmAPIProcessor-Funktionen werden von TMFAlarmAPIUtil aufgerufen, um die standardmäßigen AlarmAPIProcessorOOB-Hilfsfunktionen zu ersetzen.  
In diesem Beispiel eine Funktion in Ein anwenderdefinierter AlarmAPIProzessor Skripteinbindung Überschreibt eine Standardfunktion in AlarmAPIProcessorOOB, um eine Validierung für das Namensattribut durchzuführen.

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

### Zusätzliche REST-Vorgänge {#extend-alarm-mgmt-api__section_qc3_xkt_prb}

Um zusätzliche Vorgänge zu erstellen, die über die vorhandenen GET-, PATCH- und POST-Vorgänge hinausgehen, [Erstellen Sie zusätzliche geskriptete REST-Ressourcen](https://servicenow-prod.fluidtopics.net/J9poRY8S~x2OKdHpaThv6Q "Erstellen Sie eine geskriptete REST-API-Ressource, um die HTTP-Methode und das Verarbeitungsskript zu definieren und Einstellungen aus dem übergeordneten Service zu überschreiben.") Für Alarmmanagement Offen API. Die Logik der neuen geskripteten REST-Ressourcen Muss sein Entspricht den vorhandenen Vorgängen. Definieren Sie Funktionen für die neuen Vorgänge in TMFAlarmAPIUtil.

### Feldzuordnung {#extend-alarm-mgmt-api__section_hyt_ykt_prb}

Beim Erstellen oder Aktualisieren von Datensätzen Die Alarmmanagement Offen API ordnet Anforderungstext-Parameter zu zu Ereignis Datensatzfelder . Beim Abrufen von Datensätzen ordnet die API Datensatzfelder Antwortobjektattributen zu.  
Die AlarmAPIProcessorOOB Skripteinbindung Enthält die folgenden Funktionen zum Zuordnen eines PATCH- oder POST-Anforderungstexts zu einem Datensatz in der Ereignistabelle \[em_event\].

* `MapCreateAlarmObjectToEvent () `
* `MapClearAlarmObjectToEvent()`
* `MapPatchAlarmObjectToEvent()`
{#extend-alarm-mgmt-api__ul_bzb_qjh_yqb}  
Auch Enthält die folgenden Funktionen zum Zuordnen eines Ereignis-GlideRecord zu einem JSON-Antwortobjekt für GET-, PATCH- oder POST-Anforderungen.

* `ModifyCreateEventResponse()`
* `ModifyClearEventResponse()`
* `ModifyPatchEventResponse()`

{#extend-alarm-mgmt-api__ul_nsy_3xh_yqb} Sie können c Passen Sie Feldzuordnungen an, um Daten für zusätzliche Ereignistabellenfelder \[em_event\] hinzuzufügen und abzurufen, oder ändern Sie die Standardfeldzuordnungen. Um mit Zuordnungen zu arbeiten, erstellen Sie Funktionen mit identischen Namen und Parametern in AlarmAPIProzessor Zum Überschreiben AlarmAPIProcessorOOB Zuordnungsfunktionen. TMFAlarmAPIUtil Verwendet diese AlarmAPIProzessor Funktionen zum Ersetzen des Standards AlarmAPIProcessorOOB Zuordnungsfunktionen.  
Im folgenden Beispiel zwei AlarmAPIProzessor Funktionen überschreiben die Standardfunktionen in AlarmAPIProcessorOOB Zum Ändern von Typ f Leistungszuordnung und fügen Sie eine Zuordnung für hinzu Schweregrad Feld.

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


