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

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

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

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.
Die Telekommunikation Alarmmanagement Offen API (sn_ind_tmf642) ist ein ServiceNow®Implementierung der Spezifikation der offenen API des TM-Forums. Diese API basiert auf [TMF642 -- Alarmmanagement-API -- REST-Spezifikation, Release 20](https://www.tmforum.org/resources/specification/tmf642-alarm-management-api-user-guide-v4-0/), April 2020.

Der aufrufende Anwender muss auf zugreifen `sn_ind_tmf642.alarm_mgmt_integration `Endpunkt.

Diese API wird in bereitgestellt `sn_ind_tmf642 `Namespace.

Die Spezifikation der offenen API des TM-Forums erfordert eine synchrone Antwort für jede eingehende Anforderung, die sie empfängt. Wenden Sie Korrelation und Deduplizierung im Operational Support-Quellsystem (OSS) an, bevor Sie Nutzlasten an das System weiterleiten.

Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts, zusätzliche REST-Vorgänge und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie unterDie [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].").

Die Alarmmanagement Offen API ist vom TM-Forum zertifiziert.

## Alarmmanagement -- API öffnen -- GET /sn_ind_tmf642/Alarm_mgmt/Alarm {#ariaid-title2}

Ruft eine Liste aller Alarmdatensätze aus den Tabellen „Ereignisse" \[em_event\] und „Warnung \[em_Alert\]" ab.

### URL-Format

Standard-URL: /api/sn_ind_tmf642/Alarm_mgmt/Alarm

### Unterstützte Anforderungsparameter

{#alarm-GET-alarm__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 1. Pfad-Parameter]

{#alarm-GET-alarm__table_qcn_fkm_qtb__entry__2}

| Name | Beschreibung |
|-|-|
| AlarmRaisedTime | Datum, an dem der Alarm ausgelöst wurde. Nur Alarme mit einem Datum, das dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: * AlarmedObject * AlarmRaisedTime * Alarmtyp * CrossedThresholdInformationen * ExternalAlarmId * ID * WahrgenommenSchweregrad * ProbableCause * Quelle * SourceSystemId * Staat * Typ {#alarm-GET-alarm__ul_n1h_htz_54b} Standard: Alle Felder Datentyp: Zeichenfolge |
| ID | Alarm-ID. Nur Alarme mit einer ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel in der Tabelle Ereignisse \[em_event\]. |
| limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Standard: 1000 Maximum: 2000 Datentyp: Zahl |
| Offset | Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Datentyp: Zahl Standard: 0 |
| ProbableCause | Wahrscheinliche Ursache des Alarms. Nur Alarme mit einer wahrscheinlichen Ursache, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
| Staat | Alarmstatus. Nur Alarme mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
| SourceSystemId | Quellsystem-ID des Alarms. Nur Alarme mit einer Quellsystem-ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge |
[Tabelle : 2. Abfrageparameter]

{#alarm-GET-alarm__table_qcn_fkm_qtb} {#alarm-GET-alarm__entry__24}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-GET-alarm__table_rgh_drm_qtb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 4. Anforderungskopfzeilen.]

{#alarm-GET-alarm__table_rgh_drm_qtb} {#alarm-GET-alarm__table_c2r_4gm_lsb__entry__2}{#alarm-GET-alarm__content-range-row}{#alarm-GET-alarm__content-type-row}{#alarm-GET-alarm__links-pagination-row}{#alarm-GET-alarm__x-total-count-descr}

| Header | Beschreibung |
|-|-|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2 `Und `Grenzwert = 3 `, Der Wert von Content-RangeHeader ist `Elemente 3-5 `. |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfen | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. * zuerst * letzte * Weiter * previous {#alarm-GET-alarm__ul_zzk_sdm_lsb} |
| X-Gesamtzahl | Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
[Tabelle : 5. Antwort-Header]

{#alarm-GET-alarm__table_c2r_4gm_lsb}

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-GET-alarm__table_qbg_4cm_lsb__entry__2}{#alarm-GET-alarm__tmf-get-status-200-p}{#alarm-GET-alarm__tmf-get-status-206-entry}{#alarm-GET-alarm__tmf-get-status-400-entry}{#alarm-GET-alarm__tmf-get-status-404-entry}

| Statuscode | Beschreibung |
|-|-|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource in Antwort zurückgegeben (keine Paginierung). |
| 206 | In Antwort zurückgegebene Teilressource (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe: * Ungültiger Pfadparameter * Ungültiger URI {#alarm-GET-alarm__ul_rys_1gy_fsb} |
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
[Tabelle : 6. Statuscodes]

{#alarm-GET-alarm__table_qbg_4cm_lsb}

### Antworttext-Parameter (JSON)

{#alarm-GET-alarm__table_zjc_fbg_qtb__entry__2}{#alarm-GET-alarm__alm-mgmt-affectedService-entry}{#alarm-GET-alarm__alm-mgmt-affectedServiceHREF-entry}{#alarm-GET-alarm__alm-mgmt-create-alarmobj-href-entry}{#alarm-GET-alarm__alm-mgmt-specificProb-ph}

| Name | Beschreibung |
|-|-|
| Betroffener Service | Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten "affectedService":[ { "href": "String", "id": "String" }, ] |
| AffectedService.href | URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge |
| affectedService.id | Bezeichner des vom Alarm betroffenen Service. Dieser Wert ist dem betroffenen Konfigurationselement (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge |
| Alarmdetails | Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge |
| AlarmedObject | Details des Alarmobjekts. "alarmedObject": { "href": "String", "id": "String" } Datentyp: Objekt |
| alarmedObject.id | Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge |
| AlarmedObject.href | URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge |
| AlarmedObjectType | Typ oder Klasse des Objekts, das dem Ereignis zugeordnet ist. Datentyp: Zeichenfolge |
| AlarmRaisedTime | Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge |
| Alarmmeldezeit | Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: * Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). * Die alarmReportingTimeIst die Speicherzeit für den Alarmbericht in der EMS-Alarmliste. {#alarm-GET-alarm__ul_mbt_1rf_ynb} Datentyp: Zeichenfolge |
| Alarmtyp | Alarmkategorie. Datentyp: Zeichenfolge |
| CrossedThresholdInformationen | Details zum überschrittenen Schwellenwert. Datentyp: Objekt "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } |
| CrossedSchwellenwert Informationen.Richtung | Richtung des Schwellenwertüberschreitens. Gültige Werte: * AUSGEFALLEN * AKTIV {#alarm-GET-alarm__ul_fsb_jlg_ynb} Datentyp: Zeichenfolge |
| crossedThresholdInformation.granularity | Granularität, mit der der Indikator für die Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN `. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorName | Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorUnit | Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.observedWert | Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-CrossingDescription | Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-Id | Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.Schwellenwertref | URL des Schwellenwertobjekts. Datentyp: Zeichenfolge |
| ExternalAlarmId | Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge |
| href | URL von Ressource . Datentyp: Zeichenfolge |
| ID | Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Daten Typ: Zeichenfolge |
| WahrgenommenSchweregrad | Alarmschweregrad. Gültige Werte: * LÖSCHEN * CRITICAL * SCHWERWIEGEND * GERING * WARNUNG {#alarm-GET-alarm__ul_vcp_c4f_ynb} Datentyp: Zeichenfolge |
| PlannedAusfallindikation | Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Beispiel: Geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge |
| ProbableCause | Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge |
| ProposedReparaturaktionen | Stellt, falls für das System verfügbar, eine Reparaturaktion zur Behebung des Problems bereit, das den Alarm auslöst. Datentyp: Zeichenfolge |
| Servicerelevant | Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: * Wahr: Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. * Falsch: Alarm wirkt sich nicht auf den Service aus. {#alarm-GET-alarm__ul_omz_dnf_ynb} Standard: Falsch Datentyp: Boolescher Wert |
| SourceSystemId | Instanz-ID des Quellalarms. Datentyp: Zeichenfolge |
| Spezifisches Problem | Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter o qualifizieren den Alarm. Datentyp: Zeichenfolge |
| Staat | Alarmstatus. Gültige Werte: * Fehler * Ignoriert * Bereit * Verarbeitet {#alarm-GET-alarm__ul_ilh_3jt_xnb}Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit `. Wenn der Status ist `Bereit `, Eine Warnung wird in der Tabelle Warnung \[em_Alert\] erstellt, und der Status wird dann zu `Verarbeitet `. Wenn der Status ist `Verarbeitet `, `Ignoriert `, Oder `Fehler `Es wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge |
[ ]

{#alarm-GET-alarm__table_zjc_fbg_qtb}  

### Curl-Anforderung

Dieses Beispiel ruft alle Alarme ab.

    curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

Antworttext.

    [
       {
          "externalAlarmId": "2212331",
          "alarmType": "QualityOfServiceAlarm23",
          "perceivedSeverity": "MAJOR",
          "probableCause": "ProbB",
          "sourceSystemId": "checkSB",
          "alarmedObject": {
             "id": "vManage_000000",
             "href": " http://api/alarmedobject/000000"
          },
          "crossedThresholdInformation": {
             "direction": "111",
             "granularity": "1234",
             "indicatorName": "sdfgds",
             "indicatorUnit": "asdfdsaf",
             "observedValue": "adsfds",
             "thresholdId": "12fasdfasdfasd",
             "thresholdCrossingDescription": "S23rtring",
             "thresholdRef": "asdfasf"
          },
          "type": "QualityOfServiceAlarm",
          "ackState": "acknowledged",
          "specificProblem": "Inbound Traffic threshold crossed",
          "alarmedObjectType": "ROUTER",
          "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
          "state": "processed",
          "alarmChangedTime": "2017-08-15T07:04:15.666Z",
          "proposedRepairActions": "Switch in standby equipment",
          "alarmReportingTime": "2017-06-15T07:04:15.666Z",
          "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
          "plannedOutageIndication": "IN_SERVICE",
          "serviceAffecting": true,
          "affectedService": [
             {
                "id": "SD WAN Enterprise Solutions",
                "href": "http://api/service/vlan_dot0_dot0"
             },
             {
                "id": "Santa Clara SD WAN Application Service",
                "href": "http://api/service/vlan_dot0_dot0"
             }
          ],
          "source": "Alarm Management Open API",
          "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
          "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
       },
       {
          "externalAlarmId": "2212331",
          "alarmType": "QualityOfServiceAlarm23",
          "perceivedSeverity": "MAJOR",
          "probableCause": "ProbB",
          "sourceSystemId": "checkSB",
          "alarmedObject": {
             "id": "vManage_000000",
             "href": " http://api/alarmedobject/000000"
          },
          "crossedThresholdInformation": {
             "direction": "111",
             "granularity": "1234",
             "indicatorName": "sdfgds",
             "indicatorUnit": "asdfdsaf",
             "observedValue": "adsfds",
             "thresholdId": "12fasdfasdfasd",
             "thresholdCrossingDescription": "S23rtring",
             "thresholdRef": "asdfasf"
          },
          "type": "QualityOfServiceAlarm",
          "ackState": "acknowledged",
          "specificProblem": "Inbound Traffic threshold crossed",
          "alarmedObjectType": "ROUTER",
          "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
          "state": "processed",
          "alarmChangedTime": "2017-08-15T07:04:15.666Z",
          "proposedRepairActions": "Switch in standby equipment",
          "alarmReportingTime": "2017-06-15T07:04:15.666Z",
          "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
          "plannedOutageIndication": "IN_SERVICE",
          "serviceAffecting": true,
          "affectedService": [
             {
                "id": "SD WAN Enterprise Solutions",
                "href": "http://api/service/vlan_dot0_dot0"
             },
             {
                "id": "Santa Clara SD WAN Application Service",
                "href": "http://api/service/vlan_dot0_dot0"
             }
          ],
          "source": "Alarm Management Open API",
          "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001c84aa29078d10f87759e2f69e4cfa_2212331",
          "id": "001c84aa29078d10f87759e2f69e4cfa_2212331"
       }
    ]

## Alarmmanagement -- API öffnen -- GET /sn_ind_tmf642/Alarm_mgmt/Alarm/{ID} {#ariaid-title3}

Ruft einen angegebenen Alarmdatensatz aus der Tabelle „Ereignisse" \[em_event\] oder „Warnung \[em_Alert\]" ab.

### URL-Format

Standard-URL: /api/sn_ind_tmf642/Alarm_mgmt/Alarm/{ID}

### Unterstützte Anforderungsparameter

{#alarm-GET-alarm-id__entry__2}

| Name | Beschreibung |
|-|-|
| ID | Eindeutiger Bezeichner des abzurufenden Datensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel der Tabelle Ereignisse \[em_event\]. |
[Tabelle : 7. Pfad-Parameter]

{#alarm-GET-alarm-id__entry__6}

| Name | Beschreibung |
|-|-|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: * AlarmedObject * AlarmRaisedTime * Alarmtyp * CrossedThresholdInformationen * ExternalAlarmId * ID * WahrgenommenSchweregrad * ProbableCause * Quelle * SourceSystemId * Staat * Typ {#alarm-GET-alarm-id__ul_n1h_htz_54b} Standardwert: Alle Felder Datentyp: Zeichenfolge |
[Tabelle : 8. Abfrageparameter]

{#alarm-GET-alarm-id__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-GET-alarm-id__entry__14}{#alarm-GET-alarm-id__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 10. Anforderungskopfzeilen.]

{#alarm-GET-alarm-id__entry__18}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-GET-alarm-id__entry__22}{#alarm-GET-alarm-id__entry-200-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt. * Ungültiger Pfadparameter. * Ungültiger URI. {#alarm-GET-alarm-id__ul_rjf_fqw_rpb} |
| 404 | Datensatz nicht gefunden Ein Datensatz, der der angegebenen ID zugeordnet ist, wurde in der Tabelle „Ereignis" \[em_event\] oder „Warnung \[em_Alert\]" nicht gefunden. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON)

{#alarm-GET-alarm-id__table_gtd_dbg_qtb__entry__2}{#alarm-GET-alarm-id__alm-mgmt-affectedService-entry}{#alarm-GET-alarm-id__alm-mgmt-affectedServiceHREF-entry}{#alarm-GET-alarm-id__alm-mgmt-create-alarmobj-href-entry}{#alarm-GET-alarm-id__alm-mgmt-specificProb-ph}

| Name | Beschreibung |
|-|-|
| Betroffener Service | Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten "affectedService":[ { "href": "String", "id": "String" }, ] |
| AffectedService.href | URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge |
| affectedService.id | Bezeichner des vom Alarm betroffenen Service. Dieser Wert ist dem betroffenen Konfigurationselement (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge |
| Alarmdetails | Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge |
| AlarmedObject | Details des Alarmobjekts. Datentyp: Objekt "alarmedObject": { "href": "String", "id": "String" } |
| alarmedObject.id | Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge |
| AlarmedObject.href | URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge |
| AlarmedObjectType | Typ oder Klasse des Objekts, das dem Ereignis zugeordnet ist. Datentyp: Zeichenfolge |
| AlarmRaisedTime | Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge |
| Alarmmeldezeit | Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: * Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). * Die alarmReportingTimeIst die Speicherzeit für den Alarmbericht in der EMS-Alarmliste. {#alarm-GET-alarm-id__ul_mbt_1rf_ynb} Datentyp: Zeichenfolge |
| Alarmtyp | Alarmkategorie. Datentyp: Zeichenfolge |
| CrossedThresholdInformationen | Details zum überschrittenen Schwellenwert. Datentyp: Objekt "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } |
| CrossedSchwellenwert Informationen.Richtung | Richtung des Schwellenwertüberschreitens. Gültige Werte: * AUSGEFALLEN * AKTIV {#alarm-GET-alarm-id__ul_fsb_jlg_ynb} Datentyp: Zeichenfolge |
| crossedThresholdInformation.granularity | Granularität, mit der der Indikator für die Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN `. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorName | Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorUnit | Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.observedWert | Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-CrossingDescription | Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-Id | Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.Schwellenwertref | URL des Schwellenwertobjekts. Datentyp: Zeichenfolge |
| ExternalAlarmId | Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge |
| href | URL von Die Ressource . Datentyp: Zeichenfolge |
| ID | Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Datentyp: Zeichenfolge |
| WahrgenommenSchweregrad | Alarmschweregrad. Gültige Werte: * LÖSCHEN * CRITICAL * SCHWERWIEGEND * GERING * WARNUNG {#alarm-GET-alarm-id__ul_vcp_c4f_ynb} Datentyp: Zeichenfolge |
| PlannedAusfallindikation | Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Beispiel: Geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge |
| ProbableCause | Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge |
| ProposedReparaturaktionen | Stellt, falls für das System verfügbar, eine Reparaturaktion zur Behebung des Problems bereit, das den Alarm auslöst. Datentyp: Zeichenfolge |
| Servicerelevant | Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: * Wahr: Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. * Falsch: Alarm wirkt sich nicht auf den Service aus. {#alarm-GET-alarm-id__ul_omz_dnf_ynb} Standard: Falsch Datentyp: Boolescher Wert |
| SourceSystemId | Instanz-ID des Quellalarms. Datentyp: Zeichenfolge |
| Spezifisches Problem | Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter o qualifizieren den Alarm. Datentyp: Zeichenfolge |
| Staat | Alarmstatus. Gültige Werte: * Fehler * Ignoriert * Bereit * Verarbeitet {#alarm-GET-alarm-id__ul_ilh_3jt_xnb}Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit `. Wenn der Status ist `Bereit `, Eine Warnung wird in der Tabelle Warnung \[em_Alert\] erstellt, und der Status wird dann zu `Verarbeitet `. Wenn der Status ist `Verarbeitet `, `Ignoriert `, Oder `Fehler `Es wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge |
[ ]

{#alarm-GET-alarm-id__table_gtd_dbg_qtb}  

### Curl-Anforderung

Dieses Beispiel ruft einen Alarm ab.

    curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

Antworttext.

    {
       "externalAlarmId": "2212331",
       "alarmType": "QualityOfServiceAlarm23",
       "perceivedSeverity": "MAJOR",
       "probableCause": "ProbB",
       "sourceSystemId": "checkSB",
       "alarmedObject": {
          "id": "vManage_000000",
          "href": " http://api/alarmedobject/000000"
       },
       "crossedThresholdInformation": {
          "direction": "111",
          "granularity": "1234",
          "indicatorName": "ind_name",
          "indicatorUnit": "ind_unit",
          "observedValue": "232",
          "thresholdId": "200",
          "thresholdCrossingDescription": "sample_description",
          "thresholdRef": "sample_ref"
       },
       "type": "QualityOfServiceAlarm",
       "ackState": "acknowledged",
       "specificProblem": "Inbound Traffic threshold crossed",
       "alarmedObjectType": "ROUTER",
       "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
       "state": "processed",
       "alarmChangedTime": "2017-08-15T07:04:15.666Z",
       "proposedRepairActions": "Switch in standby equipment",
       "alarmReportingTime": "2017-06-15T07:04:15.666Z",
       "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
       "plannedOutageIndication": "IN_SERVICE",
       "serviceAffecting": true,
       "affectedService": [
          {
             "id": "SD WAN Enterprise Solutions",
             "href": "http://api/service/vlan_dot0_dot0"
          },
          {
             "id": "Santa Clara SD WAN Application Service",
             "href": "http://api/service/vlan_dot0_dot0"
          }
       ],
       "source": "Alarm Management Open API",
       "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
       "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
    }

## Alarmmanagement -- API öffnen -- PATCH /sn_ind_tmf642/Alarm_mgmt/Alarm/{ID} {#ariaid-title4}

Aktualisiert einen angegebenen Alarm und alle zugehörigen Warnungen.
Dieser Endpunkt schreibt den Antworttext in Zusätzliche Informationen Feld des Ereignisdatensatzes in der Tabelle „Ereignisse \[em_event\]".

### URL-Format

Standard-URL: /api/sn_ind_tmf642/Alarm_mgmt/Alarm/{ID}

### Unterstützte Anforderungsparameter

{#alarm-PATCH__entry__2}

| Name | Beschreibung |
|-|-|
| ID | Eindeutiger Bezeichner des zu aktualisierenden Datensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel der Tabelle Ereignisse \[em_event\]. |
[Tabelle : 13. Pfad-Parameter]

{#alarm-PATCH__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 14. Abfrageparameter]

{#alarm-PATCH__table_kmr_mjs_xnb__entry__2}{#alarm-PATCH__alm-mgmt-affectedService-entry}{#alarm-PATCH__alm-mgmt-affectedServiceHREF-entry}{#alarm-PATCH__alm-mgmt-perceivedSeverity-desc}{#alarm-PATCH__alm-mgmt-specificProb-ph}

| Name | Beschreibung |
|-|-|
| Betroffener Service | Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten "affectedService":[ { "href": "String", "id": "String" }, ] |
| AffectedService.href | URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge |
| affectedService.id | Erforderlich. Bezeichner des vom Alarm betroffenen Service. Dieser Wert ist dem betroffenen Konfigurationselement (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge |
| AlarmChangedTime | Gibt das Datum und die Uhrzeit der letzten Alarmänderung im Alarmbesitzer-System an. Jede Änderung am Alarm aktualisiert diesen Wert, unabhängig davon, ob sie von der Ressource mit Warnungen stammt oder durch eine Änderung vom Client ausgelöst wird. Datentyp: Zeichenfolge |
| Alarmdetails | Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge |
| Alarmeskalation | Kennzeichnung, die eine Eskalation im Alarmschweregrad angibt. Gültige Werte: * Wahr: Es gibt eine Eskalation im Alarmschweregrad. * Falsch: Der Alarmschweregrad ist gleich oder niedriger. {#alarm-PATCH__ul_kkj_4jh_ynb} Standard: Falsch Datentyp: Boolescher Wert |
| CrossedThresholdInformationen | Details zum überschrittenen Schwellenwert. Datentyp: Objekt "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } |
| CrossedSchwellenwert Informationen.Richtung | Richtung des Schwellenwertüberschreitens. Gültige Werte: * AUSGEFALLEN * AKTIV {#alarm-PATCH__ul_fsb_jlg_ynb} Datentyp: Zeichenfolge |
| crossedThresholdInformation.granularity | Granularität, mit der der Indikator für die Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN `. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorName | Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorUnit | Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.observedWert | Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-CrossingDescription | Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-Id | Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.Schwellenwertref | URL des Schwellenwertobjekts. Datentyp: Zeichenfolge |
| href | URL-Verweis auf den Alarm. Datentyp: Zeichenfolge |
| WahrgenommenSchweregrad | Erforderlich. Alarmschweregrad. Gültige Werte: * LÖSCHEN * CRITICAL * SCHWERWIEGEND * GERING * WARNUNG {#alarm-PATCH__ul_vcp_c4f_ynb} Datentyp: Zeichenfolge |
| PlannedAusfallindikation | Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Beispiel: Geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge |
| ProbableCause | Erforderlich. Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge |
| ProposedReparaturaktionen | Stellt, falls für das System verfügbar, eine Reparaturaktion zur Behebung des Problems bereit, das den Alarm auslöst. Datentyp: Zeichenfolge |
| Servicerelevant | Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: * Wahr: Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. * Falsch: Alarm wirkt sich nicht auf den Service aus. {#alarm-PATCH__ul_omz_dnf_ynb} Standard: Falsch Datentyp: Boolescher Wert |
| Spezifisches Problem | Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter o qualifizieren den Alarm. Datentyp: Zeichenfolge |
[Tabelle : 15. Anforderungstext-Parameter (JSON)]

{#alarm-PATCH__table_kmr_mjs_xnb}

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-PATCH__entry__56}{#alarm-PATCH__accept-JSON-only-entry-RESTAPI}{#alarm-PATCH__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 16. Anforderungskopfzeilen.]

{#alarm-PATCH__table_jwc_bxs_xnb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. Antwort-Header]

{#alarm-PATCH__table_jwc_bxs_xnb}

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-PATCH__table_ifj_lyb_ynb__entry__2}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe: * Ungültige Nutzlast. Erforderliche Alarm-ID fehlt. * Ungültige Nutzlast. Pflichtfeld fehlt:\<field name\>. * Ungültige Nutzlast. Erforderliches Objekt fehlt. * Ereignis nicht erstellt, fehlgeschlagen. * Ereignis kann nicht gelöscht werden. * Ereignis kann nicht aktualisiert werden. * Das Ereignis ist nicht vorhanden. {#alarm-PATCH__ul_f4x_sdb_ynb} |
[Tabelle : 18. Statuscodes]

{#alarm-PATCH__table_ifj_lyb_ynb}

### Antworttext-Parameter (JSON)

{#alarm-PATCH__entry__72}

| Name | Beschreibung |
|-|-|
| AlarmChangedTime | Datum und Uhrzeit der Alarmänderung in GMT im Alarmbesitzer-System. Dieser Wert wird aktualisiert, wenn Änderungen am Alarm aus der Ressource mit Warnungen auftreten oder eine Änderung aus einem Client-Update den Alarm auslöst. Dieser Wert ist in der Antwort erforderlich. Datentyp: Zeichenfolge |
| href | URL-Verweis auf den Alarm. Datentyp: Zeichenfolge |
| ID | Eindeutiger Bezeichner des Alarms. Wert, der vom System bestimmt wird, das den Alarm besitzt. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

In diesem Beispiel wird der Schweregrad auf „GERING" reduziert.

    curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
         \"href\":\"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00\",
         \"externalAlarmId\":\"<external-alarm-id>\",
         \"alarmType\":\"QualityOfServiceAlarm\",
         \"type\":\"QualityOfServiceAlarm\",
         \"ackState\":\"acknowledged\",
         \"perceivedSeverity\":\"MINOR\",
         \"probableCause\":\"Threshold crossed\",
         \"specificProblem\":\"Inbound Traffic threshold crossed\",
         \"alarmedObjectType\":\"ROUTER\",
         \"alarmedObject\":{
            \"id\":\"vManage_000000\",
            \"href\":\" http://api/alarmedobject/000000\"
         },
         \"sourceSystemId\":\"SOURCE_SYSTEM_vManage_00000_000_00\",
         \"alarmDetails\":\"Software Failure on SD-WAN Controller vManage_000000\",
         \"alarmEscalation\": false,
         \"state\":\"RAISED\",
         \"alarmChangedTime\":\"2017-08-15T07:04:15.666Z\",
         \"proposedRepairActions\":\"Switch in standby equipment\",
         \"alarmReportingTime\":\"2017-06-15T07:04:15.666Z\",
         \"alarmRaisedTime\":\"2020-09-15T07:04:15.666Z\",
         \"plannedOutageIndication\":\"IN_SERVICE\",
         \"serviceAffecting\":true,
         \"affectedService\":[
            {
               \"id\":\"SD WAN Enterprise Solutions\",
               \"href\":\"http://api/service/vlan_dot0_dot0\"
            },
            {
               \"id\":\"Santa Clara SD WAN Application Service\",
               \"href\":\"http://api/service/vlan_dot0_dot0\"
            }
         ] 
     }" \
    --user 'user:'password'

Antworttext.

    {
      "result": {
        "alarmChangedTime": "2017-08-15T07:04:15.666Z",
        "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
      }
    }

## Alarmmanagement -- API öffnen -- POST /sn_ind_tmf642/Alarm_mgmt/Alarm {#ariaid-title5}

Erstellt einen Alarmdatensatz in der Tabelle „Ereignisse \[em_event\]".
Wenn der Alarmdatensatz erstellt wird, wird eine ID für den Alarm in hinzugefügt Message keyFeld.

Ein Warnungsdatensatz kann auch basierend auf erstellt werden [Warnungsverwaltungsregeln](https://www.servicenow.com/docs/access?context=alert-management-rule&version=yokohama&pubname=yokohama-it-operations-management&ft:locale=en-US).

Dieser Endpunkt schreibt den Antworttext in Zusätzliche Informationen Feld des Ereignisdatensatzes in der Tabelle „Ereignisse \[em_event\]".

### URL-Format

Standard-URL: /api/sn_ind_tmf642/Alarm_mgmt/Alarm

### Unterstützte Anforderungsparameter

{#alarm-POST-create__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 19. Pfad-Parameter]

{#alarm-POST-create__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 20. Abfrageparameter]

{#alarm-POST-create__entry__10}{#alarm-POST-create__alm-mgmt-affectedService-entry}{#alarm-POST-create__alm-mgmt-affectedServiceHREF-entry}{#alarm-POST-create__alm-mgmt-create-alarmobj-href-entry}{#alarm-POST-create__alm-mgmt-create-alarmtype}{#alarm-POST-create__alm-mgmt-perceivedSeverity-desc}{#alarm-POST-create__alm-mgmt-specificProb-ph}

| Name | Beschreibung |
|-|-|
| Betroffener Service | Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten "affectedService":[ { "href": "String", "id": "String" }, ] |
| AffectedService.href | URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge |
| affectedService.id | Erforderlich. Bezeichner des vom Alarm betroffenen Service. Dieser Wert ist dem betroffenen Konfigurationselement (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge |
| Alarmdetails | Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge |
| AlarmedObject | Erforderlich. Details des Alarmobjekts. "alarmedObject": { "href": "String", "id": "String" } Datentyp: Objekt |
| alarmedObject.id | Erforderlich. Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge |
| AlarmedObject.href | URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge |
| AlarmedObjectType | Typ oder Klasse des Objekts, das dem Ereignis zugeordnet ist. Datentyp: Zeichenfolge |
| AlarmRaisedTime | Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge |
| Alarmmeldezeit | Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: * Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). * Die alarmReportingTimeIst die Speicherzeit für den Alarmbericht in der EMS-Alarmliste. {#alarm-POST-create__ul_mbt_1rf_ynb} Datentyp: Zeichenfolge |
| Alarmtyp | Erforderlich. Alarmkategorie. Datentyp: Zeichenfolge |
| CrossedThresholdInformationen | Details zum überschrittenen Schwellenwert. Datentyp: Objekt "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } |
| CrossedSchwellenwert Informationen.Richtung | Richtung des Schwellenwertüberschreitens. Gültige Werte: * AUSGEFALLEN * AKTIV {#alarm-POST-create__ul_fsb_jlg_ynb} Datentyp: Zeichenfolge |
| crossedThresholdInformation.granularity | Granularität, mit der der Indikator für die Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN `. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorName | Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorUnit | Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.observedWert | Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-CrossingDescription | Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-Id | Erforderlich. Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.Schwellenwertref | URL des Schwellenwertobjekts. Datentyp: Zeichenfolge |
| ExternalAlarmId | Erforderlich. Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge |
| ID | Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Dieser Wert muss leer sein, wenn er in der Nutzlast verwendet wird. Das System generiert diese eindeutige ID für das Ereignis und sendet sie als Teil der Antwortnutzlast. Datentyp: Zeichenfolge |
| WahrgenommenSchweregrad | Erforderlich. Alarmschweregrad. Gültige Werte: * LÖSCHEN * CRITICAL * SCHWERWIEGEND * GERING * WARNUNG {#alarm-POST-create__ul_vcp_c4f_ynb} Datentyp: Zeichenfolge |
| PlannedAusfallindikation | Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Beispiel: Geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge |
| ProbableCause | Erforderlich. Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge |
| ProposedReparaturaktionen | Stellt, falls für das System verfügbar, eine Reparaturaktion zur Behebung des Problems bereit, das den Alarm auslöst. Datentyp: Zeichenfolge |
| Servicerelevant | Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: * Wahr: Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. * Falsch: Alarm wirkt sich nicht auf den Service aus. {#alarm-POST-create__ul_omz_dnf_ynb} Standard: Falsch Datentyp: Boolescher Wert |
| SourceSystemId | Erforderlich. Instanz-ID des Quellalarms. Datentyp: Zeichenfolge |
| Spezifisches Problem | Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter o qualifizieren den Alarm. Datentyp: Zeichenfolge |
| Staat | Alarmstatus. Gültige Werte: * Fehler * Ignoriert * Bereit * Verarbeitet {#alarm-POST-create__ul_ilh_3jt_xnb}Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit `. Wenn der Status ist `Bereit `, Eine Warnung wird in der Tabelle Warnung \[em_Alert\] erstellt, und der Status wird dann zu `Verarbeitet `. Wenn der Status ist `Verarbeitet `, `Ignoriert `, Oder `Fehler `Es wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge |
[Tabelle : 21. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-POST-create__entry__72}{#alarm-POST-create__accept-JSON-only-entry-RESTAPI}{#alarm-POST-create__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 22. Anforderungskopfzeilen.]

{#alarm-POST-create__table_vrm_1xs_xnb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 23. Antwort-Header]

{#alarm-POST-create__table_vrm_1xs_xnb}

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-POST-create__table_bly_lyb_ynb__entry__2}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe: * Ungültige Nutzlast. Erforderliche Alarm-ID fehlt. * Ungültige Nutzlast. Pflichtfeld fehlt:\<field name\>. * Ungültige Nutzlast. Erforderliches Objekt fehlt. * Ereignis nicht erstellt, fehlgeschlagen. * Ereignis kann nicht gelöscht werden. * Ereignis kann nicht aktualisiert werden. * Das Ereignis ist nicht vorhanden. {#alarm-POST-create__ul_f4x_sdb_ynb} |
[Tabelle : 24. Statuscodes]

{#alarm-POST-create__table_bly_lyb_ynb}

### Antworttext-Parameter (JSON)

{#alarm-POST-create__entry__88}{#alarm-POST-create__d3050e79}{#alarm-POST-create__d3050e92}{#alarm-POST-create__d3050e407}{#alarm-POST-create__d3050e346}

| Name | Beschreibung |
|-|-|
| Betroffener Service | Liste von mindestens einem Service, der vom Alarm betroffen ist. Datentyp: Array von Objekten "affectedService":[ { "href": "String", "id": "String" }, ] |
| AffectedService.href | URL-Referenz, die Details zum betroffenen Service bereitstellt. Datentyp: Zeichenfolge |
| affectedService.id | Bezeichner des vom Alarm betroffenen Service. Dieser Wert ist dem betroffenen Konfigurationselement (CI) in der Warnung zugeordnet. Datentyp: Zeichenfolge |
| Alarmdetails | Zusätzliche Details zum Alarm. Datentyp: Zeichenfolge |
| AlarmedObject | Details des Alarmobjekts. "alarmedObject": { "href": "String", "id": "String" } Datentyp: Objekt |
| AlarmedObject.ID | Eindeutiger Bezeichner des Alarmobjekts. Dieser Wert ist einem CI im System zugeordnet. Datentyp: Zeichenfolge |
| AlarmedObject.href | URL-Referenz zum Abrufen der Details des Alarmobjekts. Datentyp: Zeichenfolge |
| AlarmedObjectType | Typ oder Klasse des Objekts, das dem Ereignis zugeordnet ist. Datentyp: Zeichenfolge |
| AlarmRaisedTime | Datum und Uhrzeit, zu der der Alarm an seiner Quelle auftritt. Datentyp: Zeichenfolge |
| Alarmmeldezeit | Datum und Uhrzeit, zu der das OSS seinen Alarm meldet. Dieser Wert kann sich von unterscheiden alarmRaisedTimeWert. Beispiel: Wenn ein Elementverwaltungssystem (EMS) die Alarmliste verwaltet: * Die alarmRaisedTimeIst die Zeit der Alarmerkennung durch das Netzwerkelement (NE). * Die alarmReportingTimeIst die Speicherzeit für den Alarmbericht in der EMS-Alarmliste. {#alarm-POST-create__d3050e463} Datentyp: Zeichenfolge |
| Alarmtyp | Alarmkategorie. Datentyp: Zeichenfolge |
| CrossedThresholdInformationen | Details zum überschrittenen Schwellenwert. Datentyp: Objekt "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" } |
| CrossedSchwellenwert Informationen.Richtung | Richtung des Schwellenwertüberschreitens. Gültige Werte: * AUSGEFALLEN * AKTIV {#alarm-POST-create__d3050e147} Datentyp: Zeichenfolge |
| crossedThresholdInformation.granularity | Granularität, mit der der Indikator für die Schwellenwertüberschreitung ausgewertet wird. Beispiel: `5 MINUTEN `. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorName | Name des Indikators, der den Alarmschwellenwert überschreitet. Datentyp: Zeichenfolge |
| crossedThresholdInformation.indicatorUnit | Maßeinheit des Indikators, der dem überschrittenen Schwellenwert entspricht. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.observedWert | Nummer, die den Indikator identifiziert, der den Schwellenwert überschreitet. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-CrossingDescription | Weitere Schwellenwertdetails des Schwellenwertüberschreitungsalarms. Datentyp: Zeichenfolge |
| CrossedThresholdInformation.threshold-Id | Eindeutiger Bezeichner des Schwellenwerts, der den Alarm verursacht hat. Datentyp: Zeichenfolge |
| CrossedSchwellenwertInformationen.Schwellenwertref | URL des Schwellenwertobjekts. Datentyp: Zeichenfolge |
| ExternalAlarmId | Eindeutiger Bezeichner für den Alarm aus dem Quellsystem, das den Alarm sendet. Datentyp: Zeichenfolge |
| href | URL der Ressource. Datentyp: Zeichenfolge |
| ID | Eindeutiger Bezeichner für das System zur Identifizierung und Verarbeitung der Alarmnutzlast als Ereignis. Datentyp: Zeichenfolge |
| WahrgenommenSchweregrad | Alarmschweregrad. Gültige Werte: * LÖSCHEN * CRITICAL * SCHWERWIEGEND * GERING * WARNUNG {#alarm-POST-create__d3050e256} Datentyp: Zeichenfolge |
| PlannedAusfallindikation | Gibt an, dass sich das verwaltete Objekt für diesen Alarm in einem geplanten Ausfallstatus befindet. Beispiel: Geplante Wartung oder außer Betrieb. Datentyp: Zeichenfolge |
| ProbableCause | Höchstwahrscheinlich Situation, die den Alarm auslöst. Verwenden Sie mit alarmTypeUm den Alarm zu qualifizieren. Datentyp: Zeichenfolge |
| ProposedReparaturaktionen | Stellt, falls für das System verfügbar, eine Reparaturaktion zur Behebung des Problems bereit, das den Alarm auslöst. Datentyp: Zeichenfolge |
| Servicerelevant | Kennzeichnung, die angibt, ob sich der Alarm auf den Service auswirkt. Gültige Werte: * Wahr: Alarm wirkt sich auf die Serviceleistung oder -Verfügbarkeit aus. * Falsch: Alarm wirkt sich nicht auf den Service aus. {#alarm-POST-create__d3050e326} Standard: Falsch Datentyp: Boolescher Wert |
| SourceSystemId | Instanz-ID des Quellalarms. Datentyp: Zeichenfolge |
| Spezifisches Problem | Spezifisches Problem, das den Alarm auslöst. Verwenden Sie mit probableCauseTparameter o qualifizieren den Alarm. Datentyp: Zeichenfolge |
| Staat | Alarmstatus. Gültige Werte: * Fehler * Ignoriert * Bereit * Verarbeitet {#alarm-POST-create__d3050e544}Wenn ein ungültiger Wert angegeben wird, wird der Status auf festgelegt `Bereit `. Wenn der Status ist `Bereit `, Eine Warnung wird in der Tabelle Warnung \[em_Alert\] erstellt, und der Status wird dann zu `Verarbeitet `. Wenn der Status ist `Verarbeitet `, `Ignoriert `, Oder `Fehler `Es wird keine Warnung erstellt. Standardwert: Bereit Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Dieses Beispiel erstellt einen Alarm.

    curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
         "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
         "externalAlarmId":"<external-alarm-id>",
         "alarmType":"QualityOfServiceAlarm",
         "type":"QualityOfServiceAlarm",
         "ackState":"acknowledged",
         "perceivedSeverity":"CRITICAL",
         "probableCause":"Threshold crossed",
         "specificProblem":"Inbound Traffic threshold crossed",
         "alarmedObjectType":"ROUTER",
         "alarmedObject":{
            "id":"vManage_000000",
            "href":" http://api/alarmedobject/000000"
         },
         "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
         "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
         "state":"RAISED",
         "alarmChangedTime":"2017-08-15T07:04:15.666Z",
         "proposedRepairActions":"Switch in standby equipment",
         "alarmReportingTime":"2017-06-15T07:04:15.666Z",
         "alarmRaisedTime":"2020-09-15T07:04:15.666Z",
         "plannedOutageIndication":"IN_SERVICE",
         "serviceAffecting":true,
         "affectedService":[
            {
               "id":"SD WAN Enterprise Solutions",
               "href":"http://api/service/vlan_dot0_dot0"
            },
            {
               "id":"Santa Clara SD WAN Application Service",
               "href":"http://api/service/vlan_dot0_dot0"
            }
         ] 
     }" \
    --user 'user':'password'

Antworttext.

    {
         "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
         "externalAlarmId":"<external-alarm-id>",
         "alarmType":"QualityOfServiceAlarm",
         "type":"QualityOfServiceAlarm",
         "ackState":"acknowledged",
         "perceivedSeverity":"CRITICAL",
         "probableCause":"Threshold crossed",
         "specificProblem":"Inbound Traffic threshold crossed",
         "alarmedObjectType":"ROUTER",
         "alarmedObject":{
            "id":"vManage_000000",
            "href":" http://api/alarmedobject/000000"
         },
         "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
         "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
         "state":"RAISED",
         "alarmChangedTime":"2017-08-15T07:04:15.666Z",
         "proposedRepairActions":"Switch in standby equipment",
         "alarmReportingTime":"2017-06-15T07:04:15.666Z",
         "alarmRaisedTime":"2020-09-15T07:04:15.666Z",
         "plannedOutageIndication":"IN_SERVICE",
         "serviceAffecting":true,
         "affectedService":[
            {
               "id":"SD WAN Enterprise Solutions",
               "href":"http://api/service/vlan_dot0_dot0"
            },
            {
               "id":"Santa Clara SD WAN Application Service",
               "href":"http://api/service/vlan_dot0_dot0"
            }
         ] 
     }

## Alarmmanagement -- API öffnen -- POST /sn_ind_tmf642/Alarm_mgmt/Alarm/{ID}/Clear {#ariaid-title6}

Löscht einen angegebenen Alarm und schließt alle zugehörigen Warnungen.

### URL-Format

Standard-URL: /api/sn_ind_tmf642/Alarm_mgmt/Alarm/{ID}/Clear

### Unterstützte Anforderungsparameter

{#alarm-POST-clear__entry__2}

| Name | Beschreibung |
|-|-|
| ID | Eindeutiger Bezeichner des zu löschenden Alarms. Datentyp: Zeichenfolge Tabelle: Im Feld Nachrichtenschlüssel der Tabelle Ereignisse \[em_Events\]. |
[Tabelle : 25. Pfad-Parameter]

{#alarm-POST-clear__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 26. Abfrageparameter]

{#alarm-POST-clear__entry__10}

| Name | Beschreibung |
|-|-|
| AlarmClearedTime | Datum und Uhrzeit, zu der der Alarm an der Quelle gelöscht wird. Datentyp: Zeichenfolge Tabelle: Im Feld „Zeit des Ereignisses" der Tabelle „Ereignisse \[em_Events\]". |
| Eindeutige SystemID | Erforderlich. Name der Instanz, von der aus alarmClearedVorgang wurde aufgerufen. Datentyp: Zeichenfolge |
| ClearUserId | Erforderlich. Eindeutige ID des Anwenders, der aufgerufen hat alarmClearedVorgang. Datentyp: Zeichenfolge |
[Tabelle : 27. Anforderungstext-Parameter (JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-POST-clear__entry__18}{#alarm-POST-clear__accept-JSON-only-entry-RESTAPI}{#alarm-POST-clear__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 28. Anforderungskopfzeilen.]

{#alarm-POST-clear__entry__24}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 29. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#alarm-POST-clear__entry__28}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe: * Ungültige Nutzlast. Erforderliche Alarm-ID fehlt. * Ungültige Nutzlast. Pflichtfeld fehlt:\<field name\>. * Ungültige Nutzlast. Erforderliches Objekt fehlt. * Ereignis nicht erstellt, fehlgeschlagen. * Ereignis kann nicht gelöscht werden. * Ereignis kann nicht aktualisiert werden. * Das Ereignis ist nicht vorhanden. {#alarm-POST-clear__ul_f4x_sdb_ynb} |
[Tabelle : 30. Statuscodes]

### Antworttext-Parameter (JSON)

{#alarm-POST-clear__entry__34}

| Name | Beschreibung |
|-|-|
| AlarmClearedTime | Datum und Uhrzeit, zu der der Alarm an der Quelle gelöscht wird. Datentyp: Zeichenfolge Tabelle: Im Feld „Zeit des Ereignisses" der Tabelle „Ereignisse \[em_Events\]". |
| Eindeutige SystemID | Name der Instanz, von der aus alarmClearedVorgang wurde aufgerufen. Datentyp: Zeichenfolge |
| ClearUserId | Eindeutige ID des Anwenders, der aufgerufen hat alarmClearedVorgang. Datentyp: Zeichenfolge |
| href | URL des Alarms. Datentyp: Zeichenfolge |
| ID | Eindeutige ID. Datentyp: Zeichenfolge Tabelle: Im Feld „Nachrichtenschlüssel" des Datensatzes in der Tabelle „Ereignisse" \[em_Events\]. |
[ ]

### Curl-Anforderung

Dieses Beispiel löscht einen Alarm.

    curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>/clear" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
      \"alarmClearedTime\": \"2017-08-15 06:04:15\",
      \"clearSystemId\": \"<source_instance_name>\",
      \"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\" 
    }" \
    --user 'user':'password'

Antworttext.

    {
      "result": {
        "alarmClearedTime": "2017-08-15 06:04:15",
        "clearSystemId": "<source_instance_name>",
        "clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00",
        "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
      }
    }


