---
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


---

# Ereignisbenachrichtigungsmanagement -- API-Entwicklerleitfaden öffnen

# Ereignisbenachrichtigungsmanagement -- 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 Ereignisbenachrichtigungsmanagement Offen API zum Erstellen, Aktualisieren und Löschen von Ereignisdatensätzen in der Tabelle „Ereignisse" \[em_event\].

Dieser Entwicklerleitfaden enthält Informationen zur Erweiterung von Ereignisbenachrichtigungsmanagement Offen API zum Vornehmen verschiedener Anpassungen.

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

Sie können die Funktionalität von erweitern und ändern Ereignisbenachrichtigungsmanagement Offen API durch Bearbeiten der zugehörigen Skripteinbindungsdateien.  
Im Folgenden finden Sie die Skripteinbindungen, die das enthält Ereignisbenachrichtigungsmanagement Offen API verwendet, um Ereignisbenachrichtigungsanforderungen zu verarbeiten, die an die API übergeben werden:

* AlarmAPIProcessorOOB : Enthält Hilfsfunktionen, die Funktionen in unterstützen TMFThemenEventAPIUtil Skripteinbindung. Für zusätzliche Informationen zu AlarmAPIProcessorOOB Skripteinbindung, siehe [Alarmmanagement -- API-Entwicklerleitfaden öffnen](https://servicenow-prod.fluidtopics.net/dZYyvwejx4dyjIGEWX5Eew#alarm-mgmt_dev-guide "Verwenden Sie Alarmmanagement – API öffnen Dient zum Erstellen und Aktualisieren von Daten in der Tabelle „Ereignisse“ [em_event].").
* AlarmAPIProzessor : Eine leere Skripteinbindungsdatei. Aktualisieren Sie diese Datei, um alle Funktionen zu definieren, die Sie in überschreiben möchten AlarmAPIProcessorOOB Skripteinbindung.
* JSONSchemavalidierung : Enthält Funktionen zur Verarbeitung der Validierung von Schemas für die in definierte Nutzlast TMFAlarmAPIKonstanten Skripteinbindung. Diese Skripteinbindung befindet sich unter dem Plugin „tmt_Core".
* TMFAlarmAPIKonstanten : Enthält Konstanten und erforderliche Parameterinformationen. Enthält auch die Schemas für die in übergebenen Nutzlasten Ereignisbenachrichtigungsmanagement Offen Endpunkt.
* [TMFThemenEventAPIUtilOB](https://servicenow-prod.fluidtopics.net/wclWD9NDUDBSAk_hnxlBZw#tmftopiceventapiutiloobScopedAPI "Die TMFThemenEventAPIUtilOB Skripteinbindung enthält zu behandelnde Funktionen Ereignisbenachrichtigungsmanagement Offen API-Anforderungen, die durch externe Auslöserdefinitionen zum Erstellen, Aktualisieren und Löschen von Ereignissen in der Ereignistabelle [em_event] ausgelöst werden."): Enthält Funktionen zur Verarbeitung von API-Anforderungen, die durch ausgelöst werden [Externe Auslöserdefinitions-Flows](https://www.servicenow.com/docs/access?context=set-up-flow-ihub&version=yokohama&pubname=yokohama-integrate-applications&ft:locale=en-US)Die die Aktionen haben `Alarmerstellungsbenachrichtigung `, `AlarmChangeNotification `, `Alarmlöschbenachrichtigung `Die Ereignisse erstellen, aktualisieren und löschen.
* TMFThemenEventAPIUtil : Eine leere Skripteinbindungsdatei. Aktualisieren Sie diese Datei, um alle Funktionen zu definieren, die Sie in überschreiben möchten TMFThemenEventAPIUtilOB Skripteinbindung.

Die folgenden Abschnitte enthalten Beispiele für einige der Anpassungen, die Sie an vornehmen können Ereignisbenachrichtigungsmanagement Offen API-Verarbeitung durch Erweiterung/Änderung dieser Skripteinbindungsdateien.

### Erforderliche Parameter

Die Verwaltung Von Ereignisbenachrichtigungen Die API verwendet JSON-Schemas, um erforderliche Parameter zu definieren. Diese JSON-Schemas sind in definiert TMFAlarmAPIKonstanten Skripteinbindung. Diese Schemas werden verwendet, um zu validieren, ob Anforderungsnutzlasten gültig sind. Diese Schemas werden in den Skripteinbindungen nicht direkt referenziert, sondern von den folgenden Funktionen in zurückgegeben TMFThemenEventAPIUtilOB Skripteinbindung:

* GetAlarmCreateEventSchema() : Gibt das Validierungsschema zum Erstellen eines Ereignisses zurück.
* GetAlarmDeleteEventSchema() : Gibt das Validierungsschema zum Löschen eines Ereignisalarms zurück.
* GetAlarmChangeEventSchema() : Gibt das Validierungsschema für das Ändern von Feldern in einem Ereignis zurück.

Um die vorhandenen Schemas zu überschreiben, definieren Sie neue Schemas in TMFThemenEventAPIUtilOB Skripteinbindung und überschreiben TMFThemenEventAPIUtil Skripteinbindungsfunktionen.

Zum Beispiel:

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

    // New schema
    TMFTopicEventAPIUtil.CUSTOMIZED_SCHEMA = "{
      \"title\":\"AlarmCreateEvent\",
      \"type\":\"object\",
      \"properties\":{
        \"event\":{
          \"type\":\"object\",
          \"properties\":{
            \"alarm\":{
              \"type\":\"object\",
              \"properties\":{
                \"id\":{
                  \"type\":\"string\"
                },
                \"href\":{
                  \"type\":\"string\"
                },
                \"externalAlarmId\":{
                  \"type\":\"string\"
                },
                \"alarmType\":{
                  \"type\":\"string\"
                },
                \"perceivedSeverity\":{
                  \"type\":\"string\"
                },
                \"probableCause\":{
                  \"type\":\"string\"
                },
                \"alarmedObject\":{
                  \"type\":\"object\",
                  \"properties\":{
                    \"id\":{
                      \"type\":\"string\"
                    },
                    \"href\":{
                      \"type\":\"string\"
                    }
                  },
                  \"required\":[
                    \"id\"
                  ]
                },
                \"crossedThresholdInformation\":{
                  \"type\":\"object\",
                  \"properties\":{
                    \"thresholdId\":{
                      \"type\":\"string\"
                    }
                  },
                  \"required\":[
                    \"thresholdId\"
                  ]
                },
                \"affectedService\":{
                  \"type\":\"array\",
                  \"properties\":{
                    \"id\":{
                      \"type\":\"string\"
                    },
                    \"href\":{
                      \"type\":\"string\"
                    }
                  },
                  \"items\":{
                    \"type\":\"object\",
                    \"required\":[
                      \"id\"
                    ]
                  }
                },
                \"sourceSystemId\":{
                  \"type\":\"string\"
                },
                \"specificProblem\":{
                  \"type\":\"string\"
                }
              },
              \"required\":[
                \"externalAlarmId\",\"alarmType\",\"perceivedSeverity\",\"probableCause\",\"sourceSystemId\",\"alarmedObject\"
              ]
            }
          },
          \"required\":[
            \"alarm\"
          ]
        }
      },
      \"required\":[
        \"event\"
      ]
    }";

### Validierung des Anforderungstexts {#extend-event-mgmt-notif-api__section_ikk_tkt_prb}

Um eine zusätzliche Validierung für den Anforderungstext durchzuführen, überschreiben Sie die folgenden Funktionen in TMFThemenEventAPIUtilOB Skripteinbindung. Diese Funktionen werden von den angegebenen Funktionen in derselben Skripteinbindung aufgerufen.

* VerifyAlarmCreateEventPayload() : Aufgerufen von ProcessAlarmCreateEvent() .
* VerifyAlarmDeleteEventPayload() : Aufgerufen von ProcessAlarmDeleteEvent() .
* VerifyAlarmChangeEventPayload() : Aufgerufen von ProcessAlarmChangeEvent() .

Alle diese Funktionen geben standardmäßig Erfolg zurück. Wenn eine Hilfsfunktion einen Fehler zurückgibt, wird der API-Vorgang gestoppt.

Um anwenderdefinierte Validierungen anzuwenden, überschreiben Sie die Hilfsfunktionen in TMFThemenEventAPIUtilOB Skripteinbindung mit identischen Funktionsnamen und Parametern in TMFThemenEventAPIUtil Skripteinbindung.

In diesem Beispiel eine Funktion in einer anwenderdefinierten TMFThemenEventAPIUtil Die Skripteinbindung überschreibt die Standardfunktion in TMFThemenEventAPIUtilOB Skripteinbindung zum Durchführen der Validierung des Namensattributs.  

    var TMFTopicEventAPIUtil = Class.create();
    TMFTopicEventAPIUtil.prototype = Object.extendsObject(TMFTopicEventAPIUtilOOB, {

        // Define overriding functions here
        verifyAlarmCreateEventPayload: function(eventPayload,responseObject){

            // Returning error status terminates the POST request
            // Make sure to assign error message and reason
            if (eventPayload.type != "unique") {
                responseObject.setMessage("Failed");
                responseObject.setReason("No reason needed");
                return responseObject.status = "error";
            }
        },
    	
        type: 'TMFTopicEventAPIUtil'
    });

### Abonnementvalidierung des Textkörpers anfordern

Um die Abonnementvalidierung des Anforderungstexts für die API zu ändern, müssen Sie überschreiben ValidateAbonnement() Funktion in TMFThemenEventAPIUtilOB Skripteinbindung. Diese Funktion validiert, ob die callbackURL, die Sie zum Erstellen der Ereignisbenachrichtigung verwenden, registriert ist, und bestimmt, ob eventTypeIst für den ausgelösten Rückruf registriert. Diese Funktion wird von aufgerufen ProcessAlarmCreateEvent() , ProcessAlarmDeleteEvent() , Und ProcessAlarmChangeEvent() Funktionen, die sich auch in befinden TMFThemenEventAPIUtilOB Skripteinbindung.

### Feldzuordnung

Beim Erstellen oder Aktualisieren von Datensätzen wird Ereignisbenachrichtigungsmanagement Offen API ordnet Anforderungstext-Parameter Ereignisdatensatzfeldern zu. Beim Abrufen von Datensätzen ordnet die API Ereignisdatensatzfelder Antwortobjektattributen zu.

Die TMFThemenEventAPIUtilOB Die Skripteinbindung enthält die folgenden Funktionen, die Change-, Erstellungs- und Löschanforderungen basierend auf dem Wert in zuordnen eventTypeParameter, zu einem Datensatz in der Ereignistabelle \[em_event\].

* MapAlarmChangeObjectToEvent()
* MapCreateAlarmObjectToEvent()
* MapDeleteAlarmObjectToEvent()

Sie können Feldzuordnungen anpassen, um Daten für zusätzliche Ereignisfelder \[em_event\] hinzuzufügen und abzurufen, oder die Standardfeldzuordnungen ändern. Um mit Zuordnungen zu arbeiten, erstellen Sie Funktionen mit identischen Namen und Parametern in TMFThemenEventAPIUtil Zum Überschreiben TMFThemenEventAPIUtilOB Zuordnungsfunktionen.

