Service Test Management Open API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 75 Minuten Lesedauer
  • Die Service Test Management Open API bietet Endpunkte zum Erstellen und Abrufen von Servicetestdefinitionen und Servicetests.

    Verwenden Sie diese API, um Service-Problem-Management-Informationen zwischen externen Systemen und Now Platformzu verwalten. Die Service Test Management Open API ist eine ServiceNow Implementierung der REST-Spezifikation der TM Forum Service Problem Management API. Diese Implementierung basiert auf https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/.

    Diese REST API dient zum Verwalten und Ausführen von Servicetests in einer Telekommunikationsumgebung. Anwender können Servicetests definieren, auslösen und überwachen, um sicherzustellen, dass Services die Qualitäts- und Leistungsstandards erfüllen. Die API bietet Funktionen für das Testmanagement, einschließlich des Erstellens und Aktualisierens von Testdefinitionen, Ausführen von Tests, Abrufen von Testergebnissen und Verwalten von Testzeitplänen.

    Die Service Test Management Open API erfordert das Plugin „Customer Service Problem Management“ (com.sn_sprb_mgmt) und die Rolle sn_sprb_mgmt.test_integrator. Diese API gehört zum Namespace sn_sprb_mgmt. Weitere Informationen zu Service-Problem-Management. Weitere Informationen zu dieser Anwendung finden Sie unter Customer Service Problem Management.

    Die Service Test Management Open API erstellt oder aktualisiert Daten in den folgenden Tabellen:
    • Testlauf [sn_st_mgmt_test]
    • Servicetestdefinition [sn_st_mgmt_test_definition]
    • Testdefinitionsmerkmal [sn_st_mgmt_test_definition_characterific]
    • Testmerkmal [sn_st_mgmt_test_charakteristik]
    • Beziehung von Spezifikation zu Testdefinition [sn_st_mgmt_test_definition_m2m]
    • Testdefinitionsbeziehung [sn_st_mgmt_test_definition_rel]
    • Testmaß [sn_st_mgmt_test_measure]
    • Messkonsequenz [sn_st_mgmt_measure_consequence]
    • Testmaßdefinition [sn_st_mgmt_test_measure_definition]
    • Angewendete Konsequenz [sn_st_mgmt_apppliziert_consequence]
    • Schwellenwertregel [sn_st_mgmt_threshold_rule]
    • Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    Offene API für Service-Testmanagement: GET /sn_sprb_mgmt/servicetestmanagement/serviceTest

    Ruft eine Liste aller Servicetests ab.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle -Felder zurückgegeben. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].
    Gültige Felder:
    • Merkmal
    • Beschreibung
    • endDateTime
    • id
    • Modus
    • ZugehörigerService
    • startDateTime
    • Staat
    • testMeasure
    • testSpecification
    • validFor

    Datentyp: Zeichenfolge

    limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren.

    Datentyp: Zahl

    Höchstwert: 100

    Standard: 20

    Offset Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Parameter, um Ergebnisse in kleine und überschaubare Blöcke zu paginieren. Der erste Datensatz ist bei 0 indiziert.

    Datentyp: Zahl

    Standard: 0

    state Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. In der Antwort werden nur Testdefinitionen im angegebenen Status zurückgegeben.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Keine
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltsbereich Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird.

    Beispiel: Wenn Offset=2 und Limit=3, ist der Wert des Content-Range-Headers Elemente 3-5.

    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur application/json.
    Verknüpfung Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
    • zuerst
    • letzte
    • Weiter
    • previous
    X-Gesamtzahl Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    206 Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    Tabelle : 7. Parameter des Antworttexts (XML oder JSON)
    Name Beschreibung
    Merkmal Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Testdefinitionsmerkmalen finden Sie unter

    Datentyp: Array von Objekten

    "characteristic": [
     {
      "id": "String",
      "name": "String",
      "value": "String",
      "valueType": "String"
     }
    ]
    characteristic.id Sys_id oder external_id der Merkmale. Befindet sich in der Tabelle „Merkmale“ [sn_prd_pm_charakteristik]. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“.

    Datentyp: Zeichenfolge

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    Merkmal.Wert Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz.

    Datentyp: Zeichenfolge

    merkmal.wertTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    href Hyperlink-Referenz zum Servicetest.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    Modus Der Modus, in dem der Servicetest ausgeführt wird.
    Gültige Werte:
    • ONDEMAND: Löst den Servicetest manuell aus.
    • PROAKTIV: Löst den Servicetest automatisch aus.

    Standard: ONDEMAND

    name Erforderlich. Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigerService Erforderlich. Die dem Servicetest zugeordnete Testdefinition.

    Datentyp: Objekt

    "relatedService": {
     "href": "String",
     "id": "String",
     "name": "String"
    }
    relatedService.id Sys_id oder external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge

    ZugehörigerService.name Name des Produktbestands.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Staat Status, in dem sich der Servicetest befindet.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    testMeasure Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus.

    Datentyp: Array von Objekten

    "testMeasure": [
     {
     "accuracy": "String",
     "captureDateTime": "String",
     "captureMethod": "String",
     "id": "String",
     "metricDescription": "String",
     "metricName": "String",
     "ruleViolation": [Array],
     "unitOfMeasure": "String",
     "value": {Object}
     }
    ]
    testMeasure.accuracy Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt.

    Datentyp: Zahl

    Höchstwert: 40

    testMessen.ErfassungsdatumZeit Datum und Uhrzeit der Erfassung der Metrik.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasure.id Sys_id oder external_id der Testmaße. Befindet sich in den Feldern „sys_id“ oder „external_id“ der Tabelle „Testmaße“ [sn_st_mgmt_test_measure].

    Datentyp: Zeichenfolge

    testMessen.Messen.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMeasure.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasure.metricName Name der Testmaßmetrik.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung Ein Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn ein Verstoß gegen die Regel vorliegt.

    Datentyp: Array von Objekten

    "ruleViolation"[
      {
        appliedConsequence: [Array],
        conformanceTargetUpper: Number,
        conformanceComparatorUpper: "String",
        description: "String",
        id: "String",
        name: "String",
        numberOfAllowedCrossing: Number,
        thresholdRuleSeverity: "String",
        tolerancePeriod: "String"
      }
    ]
    testMessung.RegelVerstoß.Toleranzzeitraum.Betrag Die Anzahl der Zeiträume vor Anwendung der Konsequenz.

    Datentyp: Zahl

    testMessung.regelVerstoß.angewendeteKonsequenz Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird.

    Datentyp: Array von Objekten

    "appliedConsequence": [
     {
      "appliedAction": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "repeatAction": Boolean
     }
    ]
    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung Beschreibung der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.id Sys_id oder external_id der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.name Name der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.AngewendeteKonsequenz.Wiederholungsaktion Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt.

    Gültige Werte:

    • „wahr“: Wiederholen Sie die Aktion.
    • „falsch“: Aktion erneut wiederholen.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComporatorExact Kennzeichnung, die angibt, ob ein Wert identisch ist.
    Gültige Werte:
    • wahr: Der Wert ist identisch.
    • „falsch“: Der Wert ist nicht identisch.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComporatorLower Operator, mit dem überprüft wird, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceComporatorUpper Operator, mit dem überprüft wird, ob ein Wert über dem Schwellenwert liegt.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMessung.regelVerletzung.beschreibung Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Befindet sich in der Tabelle „Schwellenwertregelverstoß“ [sn_st_mgmt_threshold_rule_violation].

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.ruleViolation.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Toleranzzeitraum Angegebenes Zeitintervall, während dessen Überschreitungsereignisse aktiviert sind, ohne unmittelbare Konsequenzen oder Aktionen auszulösen.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMessung.regelVerletzung.toleranzzeitraum.einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasure.messageeinheit Gibt die Maßeinheit für die Konformitätszielwerte der Testmaßnahme an.

    Datentyp: Zeichenfolge

    testMeasure.value Der Wert der Testmaßnahme.

    Datentyp: Objekt

    "value": {
     "id": "String",
     "name": "String",
     "valueType": "String",
     "value": "String
    }
    testMeasure.value.id Die ID des Testmaßwerts.

    Datentyp: Zeichenfolge

    testMeasure.value.name Der Name des Testmaßwerts.

    Datentyp: Zeichenfolge

    testMeasure.value.value Der Wert der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMessung.Wert.WertTyp Der Typ des Testmaßwerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    testSpecification Erforderlich. Die Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "testSpecification": {
     "id": "String",
     "href": "String"
    }
    testSpecification.href Hyperlink-Verweis auf die Servicetestdefinition.

    Datentyp: Zeichenfolge

    testSpecification.id Die sys_id oder external_id der Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    validFor.endDateTime Gültigkeitsenddatum des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Gültigkeitsstartdatum des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel werden Informationen zu den beiden Servicetests in der Instanz abgerufen.

    curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest” \
    --user 'username’: ‘password'

    Antworttext.

    [
      {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/09d1f42e3be28210d140068aa4e45ae2",
        "id": "09d1f42e3be28210d140068aa4e45ae2",
        "description": "Service test",
        "endDateTime": "2025-01-31 15:05:43",
        "mode": "proactive",
        "name": "Speed Test TR0001002",
        "startDateTime": "2024-06-05 09:07:10",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "relatedService": {
          "id": "fa6d13f45b5620102dff5e92dc81c77f",
          "name": "Internet_VPLS_PI0000011"
        },
        "testSpecification": {
          "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
          "id": "7d3854864316c6500e51203d5fb8f2d8"
        },
        "characteristic": [],
        "testMeasure": [
          {
            "id": "61d1382e3be28210d140068aa4e45a2e",
            "accuracy": "0.0001",
            "captureDateTime": "",
            "captureMethod": "automatic",
            "metricDescription": "",
            "metricName": "Flow speed",
            "unitOfMeasure": "A second",
            "value": "3000",
            "ruleViolation": [
              {
                "id": "61d1382e3be28210d140068aa4e45a2f",
                "description": "This speed is greater than the target",
                "name": "tooMuchTraffic",
                "numberOfAllowedCrossing": "0",
                "thresholdRuleSeverity": "high",
                "tolerancePeriod": "",
                "conformanceTargetLower": "2500",
                "conformanceComparatorLower": "greater than",
                "appliedConsequence": [
                  {
                    "id": "65d1382e3be28210d140068aa4e45a31",
                    "appliedAction": "sendWarning",
                    "description": "send a warning to the system",
                    "name": "sendWarning",
                    "repeatAction": "0"
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/18682a2a3b2682107222bf9985e45a55",
        "id": "18682a2a3b2682107222bf9985e45a55",
        "description": "Service test",
        "endDateTime": "2025-01-31 15:05:43",
        "mode": "proactive",
        "name": "Speed Test TR0001012",
        "startDateTime": "2024-06-05 17:45:07",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "relatedService": {
          "id": "fa6d13f45b5620102dff5e92dc81c77f",
          "name": "Internet_VPLS_PI0000011"
        },
        "testSpecification": {
          "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
          "id": "7d3854864316c6500e51203d5fb8f2d8"
        },
        "characteristic": [
          {
            "id": "5c682a2a3b2682107222bf9985e45a5a",
            "name": "url",
            "valueType": "single_line_text",
            "value": "http://abc.com"
          }
        ],
        "testMeasure": [
          {
            "id": "7c686a2a3b2682107222bf9985e45a4d",
            "accuracy": "0.0001",
            "captureDateTime": "",
            "captureMethod": "automatic",
            "metricDescription": "",
            "metricName": "Flow speed",
            "unitOfMeasure": "A second",
            "value": "3000",
            "ruleViolation": [
              {
                "id": "38686a2a3b2682107222bf9985e45a4e",
                "description": "This speed is greater than the target",
                "name": "tooMuchTraffic",
                "numberOfAllowedCrossing": "0",
                "thresholdRuleSeverity": "high",
                "tolerancePeriod": "",
                "conformanceTargetLower": "2500",
                "conformanceComparatorLower": "greater than",
                "appliedConsequence": [
                  {
                    "id": "34686a2a3b2682107222bf9985e45a50",
                    "appliedAction": "sendWarning",
                    "description": "send a warning to the system",
                    "name": "sendWarning",
                    "repeatAction": "0"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]

    Service Test Management Open API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

    Ruft eine Servicetest-Entität basierend auf der angegebenen ID eines Servicetests ab.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

    Unterstützte Anforderungsparameter

    Tabelle : 8. Pfadparameter
    Name Beschreibung
    id Erforderlich. Sys_id oder external_id des abzurufenden Servicetests. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    Tabelle : 9. Abfrageparameter
    Name Beschreibung
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle -Felder zurückgegeben. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].
    Gültige Felder:
    • Merkmal
    • Beschreibung
    • endDateTime
    • id
    • Modus
    • ZugehörigerService
    • startDateTime
    • Staat
    • testMeasure
    • testSpecification
    • validFor

    Datentyp: Zeichenfolge

    Tabelle : 10. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 11. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Keine
    Tabelle : 12. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur application/json.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 13. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Merkmal Liste, die die Merkmale des zugehörigen Servicetests beschreibt.

    Datentyp: Array von Objekten

    "characteristic": [
     {
      "id": "String",
      "name": "String",
      "value": "String",
      "valueType": "String"
     }
    ]
    Merkmal.ID Sys_id oder external_id der Merkmale. Befindet sich in der Tabelle „Merkmale“ [sn_prd_pm_charakteristik]. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“.

    Datentyp: Zeichenfolge

    Merkmal.Name Name des Merkmals.

    Datentyp: Zeichenfolge

    Merkmal.Wert Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz.

    Datentyp: Zeichenfolge

    merkmal.wertTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    href Hyperlink-Referenz zum Servicetest.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    Modus Modus, in dem der Servicetest ausgeführt wird.
    Gültige Werte:
    • ONDEMAND: Löst den Servicetest manuell aus.
    • PROAKTIV: Löst den Servicetest automatisch aus.

    Standard: ONDEMAND

    name Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigerService Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
     "href": "String",
     "id": "String",
     "name": "String"
    }
    ZugehörigerService.id Die sys_id oder external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge

    ZugehörigerService.name Name des Produktbestandsartikels.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Staat Status des Servicetests.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt
    testMeasure Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "accuracy": "String",
      "captureDateTime": "String",
      "captureMethod": "String",
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "ruleViolation": [Array]
      "unitOfMeasure": "String",
      "value": {Object}
     }
    ]
    testMeasure.accuracy Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt.

    Datentyp: Zahl

    Höchstwert: 40

    testMessen.ErfassungsdatumZeit Datum und Uhrzeit der Erfassung der Metrik.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMessen.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMeasure.id Sys_id oder external_id der Testmaßnahme. Befindet sich in der Tabelle mit den Testmaßen [sn_st_mgmt_test_measure].

    Datentyp: Zeichenfolge

    testMeasure.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasure.metricName Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn die Regel verletzt wird.

    Datentyp: Array von Objekten

    "RuleViolation": [
    {
      "appliedConsequence": [Array],
      "conformanceComparatorExact": Boolean,
      "conformanceComparatorLower": "String",
      "conformanceComparatorUpper": "String",
      "conformanceTargetExact": "String",
      "conformanceTargetLower": "String",
      "conformanceTargetUpper": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "numberOfAllowedCrossing": Number,
      "thresholdRuleSeverity": "String",
      "tolerancePeriod": {Object}
     }
    ]
    testMessung.regelVerstoß.angewendeteKonsequenz Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird.

    Datentyp: Array von Objekten

    "appliedConsequence": [
     {
      "appliedAction": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "repeatAction": Boolean
     }
    ]
    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion.Wiederholungsaktion Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung Beschreibung der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.id Sys_id oder external_id der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.name Name der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessen.regelVerletzung.konformerVergleichGenau Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist.
    Gültige Werte:
    • wahr: Der Wert ist identisch.
    • „falsch“: Der Wert ist nicht identisch.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComparatorLower Ein Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceCvergleichUpper Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • ist
    • kleiner als

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMessung.regelVerletzung.beschreibung Beschreibung des Verstoßes gegen die Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.id Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Befindet sich in der Tabelle „Schwellenwertregelverstoß“ [sn_st_mgmt_threshold_rule_violation].

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Name Name des Verstoßes gegen die Schwellenwertregel.

    Datumstyp: Zeichenfolge

    testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Maximum: 40

    testMeasure.ruleViolation.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Toleranzzeitraum Dauer oder Zeitintervall, in der zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMessung.RegelVerstoß.Toleranzzeitraum.Betrag Betrag des Zeitraums als Nummer.

    Datentyp: Zahl

    testMessung.regelVerletzung.toleranzzeitraum.einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasure.messageeinheit Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasure.value Wert der Metrik im Test.

    Datentyp: Objekt

    "value": {
      "id": "String",
      "name": "String",
      "valueType": "String",
      "value": "String"
    }
    testMeasure.value.id ID des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.Name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMeasure.value.value Wert der Metrik im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.WertTyp Der Typ des Testmaßwerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    testSpecification Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "testSpecification": {
     "href": "String",
     "id": "String"
    }
    testSpecification.href Hyperlink-Verweis auf die Servicetestdefinition.

    Datentyp: Zeichenfolge

    testSpecification.id Sys_id oder external_id der Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
      "startDateTime": "String",
      "endDateTime": "String"
    }
    validFor.endDateTime Enddatum und -zeitstempel des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Startdatum und -zeitstempel des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel werden Details zur Servicetest-Entität abgerufen, die der angegebenen ID zugeordnet ist, 44b7a8ea3b6a42107222bf9985e45a45.

    curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45 \
    --user 'username’: ‘password'

    Antworttext.

    {
      "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45",
      "id": "44b7a8ea3b6a42107222bf9985e45a45",
      "description": "Service test",
      "endDateTime": "2025-01-31 15:05:43",
      "mode": "proactive",
      "name": "Speed Test TR0001001",
      "startDateTime": "2024-06-05 08:22:52",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "relatedService": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "name": "Internet_VPLS_PI0000011"
      },
      "testSpecification": {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
        "id": "7d3854864316c6500e51203d5fb8f2d8"
      },
      "characteristic": [
            { 
            "id": "5c682a2a3b2682107222bf9985e45a5a", 
            "name": "url", 
            "valueType": "single_line_text", 
            "value": "test" 
             }
    ],
      "testMeasure": [
        {
          "id": "62ade42a3ba28210d140068aa4e45a71",
          "accuracy": "0.0001",
          "captureDateTime": "",
          "captureMethod": "automatic",
          "metricDescription": "",
          "metricName": "Downstream Speed",
          "unitOfMeasure": "",
          "value": "16",
          "ruleViolation": [
            {
              "id": "b9bee4ae3ba28210d140068aa4e45a3a",
              "description": "This speed is less than the target upper",
              "name": "tooMuchTraffic",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "",
              "conformanceTargetUpper": "75",
              "conformanceComparatorUpper": "less than",
              "appliedConsequence": [
                {
                  "id": "489074aa3be28210d140068aa4e45a42",
                  "appliedAction": "generateReport",
                  "description": "",
                  "name": "generateReport",
                  "repeatAction": "0"
                },
                {
                  "id": "785f2ce23be28210d140068aa4e45a75",
                  "appliedAction": "sendWarning",
                  "description": "",
                  "name": "sendWarning",
                  "repeatAction": "0"
                }
              ]
            }
          ]
        }
      ]
    }

    Offene API für Service-Testmanagement – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

    Ruft eine Liste aller Servicetestdefinitionen ab.

    URL-Format

    Standard-URL: GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

    Unterstützte Anforderungsparameter

    Tabelle : 14. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Abfrageparameter
    Name Beschreibung
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle -Felder zurückgegeben. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].
    Gültige Werte:
    • Beschreibung
    • id
    • name
    • ZugehörigeServiceSpecification
    • serviceTestSpecRelationship
    • specCharacterificent
    • testMeasureDefinition
    • validFor

    Datentyp: Zeichenfolge

    limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren.

    Datentyp: Zahl

    Höchstwert: 100

    Standard: 20

    Offset Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Parameter, um Ergebnisse in kleine und überschaubare Blöcke zu paginieren. Der erste Datensatz ist bei 0 indiziert.

    Datentyp: Zahl

    Standard: 0

    state Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. In der Antwort werden nur Testdefinitionen im angegebenen Status zurückgegeben.

    Gültige Werte:

    • archiviert
    • Entwurf
    • Veröffentlicht
    • Deaktiviert

    Datentyp: Zeichenfolge

    Tabelle : 16. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 17. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 18. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltsbereich Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 und Limit=3, ist der Wert des Content-Range-Headers Elemente 3-5.
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur application/json.
    Verknüpfung Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse:
    • zuerst
    • letzte
    • Weiter
    • previous
    X-Gesamtzahl Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 19. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    206 Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigeServiceSpecification Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id Sys_id oder external_id der Servicespezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    Datentyp: Zeichenfolge

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship Zugehörige Servicetestdefinition.

    Datentyp: Array von Objekten

    "serviceTestSpecRelationship": [
     {
      "id": "String",
      "name": "String",
      "relationshipType": "String"
     }
    ]
    serviceTestSpecBeziehung.id Sys_id oder external_id der zugehörigen Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.Beziehungstyp Typ der Beziehung.
    Akzeptierte Werte:
    • Ersatz
    • Abhängigkeit
    • Ausschließlichkeit

    Datentyp: Zeichenfolge

    specCharacterificent Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacterific.characteristValueSpecification Array mit den möglichen Werten für das Merkmal.

    Datentyp: Array von Objekten

    "characteristicValueSpecification": [
      {
        "value": "String"
      }
    ]
    specCharacterific.characteristValueSpecification.value Wert des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Beschreibung Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    specCharacterific.validFor Datumsbereich, für den das Merkmal gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    specCharacterific.validFor.endDateTime Enddatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    specCharacterific.validFor.startDateTime Startdatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Spezifisches Merkmal.WerteTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    testMeasureDefinition Testmaßdefinitionen für diese Servicetestdefinition. Weitere Informationen finden Sie unter Define test measure definitions for a service test.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "captureFrequency": "String",
      "captureMethod": "String",
      "capturePeriod": {Object},
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "name": "String",
      "unitOfMeasure": "String",
      "thresholdRule": [Array],
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    testMeasureDefinition.captureFrequency Die Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

    • Keine
    • einmal
    • täglich
    • wöchentlich
    • monatlich

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungszeitraum Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

    "capturePeriod": {
      "amount": Number,
      "units": "String"
    }
    testMessdefinition.Erfassungszeitraum.Betrag Anzahl der Erfassungszeiträume.

    Datentyp: Zahl

    testMessdefinition.Erfassungszeitraum.Einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id Sys_id oder external_id der Testmaßdefinitionen. Befindet sich in der Tabelle „Testmaßdefinition“ [sn_st_mgmt_test_measure_definition].

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricName Benutzerdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition.

    Datentyp: Array von Objekten

    {
      "thresholdRule": {
        "consequence": Array,
        "conformanceComparatorExact": Boolean,
        "conformanceComparatorLower": "String",
        "conformanceComparatorUpper": "String",
        "conformanceTargetExact": "String",
        "conformanceTargetLower": "String",
        "conformanceTargetUpper": "String",
        "consequence": Array,
        "description": "String",
        "id": "String",
        "name": "String",
        "numberOfAllowedCrossing": Number,
        "thresholdRuleSeverity": "String",
        "tolerancePeriod": Object
      }
    }
    testMeasureDefinition.thresholdRule.conformanceCvergleichExact Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich.
    Gültige Werte:
    • wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • false: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.conformanceCvergleichLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceCvergleichUpper Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.consequence Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules.

    Datentyp: Array von Objekten

    "consequence": [
     {
      "description": "String",
      "id": "String",
      "name": "String",
      "prescribeAction": "String",
      "repeatAction": Boolean,
      "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
     }
    ]
    testMeasureDefinition.thresholdRule.consequence.description Beschreibung der Konsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.id Sys_id oder external_id der Messkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.prescribeAction Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.repeatAction Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.consequence.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime Gültigkeitsenddatum der Konsequenz

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id Sys_id oder external_id der Schwellenwertregeln. Zu finden im Feld „Befindet sich in sys_id“ oder „external_id“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Höchstwert: 40

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMeasureDefinition.unitOfMeasure Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Zeichenfolge

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    testMeasureDefinition.validFor.endDateTime Gültigkeitsenddatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor.startDateTime Gültigkeitsstartdatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den die Testdefinition gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    validFor.endDateTime Datum und Uhrzeit der Testdefinition, zu der der Status der Testdefinition stillgelegt wird.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Datum und Uhrzeit der Testdefinition, zu der ihr Status veröffentlicht wird.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden Details zu allen Testservice-Testdefinitionen in der Instanz abgerufen. In diesem Fall werden zwei Definitionen zurückgegeben.

    curl --location --request GET 
    “https://instance.servicenow.com//api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification” \
    --user 'username’: ‘password'
    

    Antworttext.

    [
      {
        "description": "Operation, Administration and Maintenance",
        "id": "76a3b160432a02104fefe4511fb8f2ad",
        "name": "OAM Test",
        "validFor": {
          "startDateTime": "",
          "endDateTime": ""
        },
        "testMeasureDefinition": [
          {
            "id": "77b9b964432a02104fefe4511fb8f26e",
            "captureFrequency": "once",
            "captureMethod": "automatic",
            "metricDescription": "This is the Rx signal level",
            "metricName": "Rx Optical Signal Level",
            "name": "Rx Optical Signal Level",
            "unitOfMeasure": "a minute",
            "valueType": "",
            "capturePeriod": "",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            },
            "thresholdRule": [
              {
                "id": "d3e97d64432a02104fefe4511fb8f281",
                "description": "",
                "name": "gponOntAniOpInfoRxOpticalSignalLevel",
                "numberOfAllowedCrossing": "",
                "thresholdRuleSeverity": "",
                "tolerancePeriod": "",
                "conformanceTargetUpper": "0",
                "conformanceComparatorUpper": "less than",
                "conformanceTargetLower": "-50",
                "conformanceComparatorLower": "greater than",
                "consequence": []
              }
            ]
          },
          {
            "id": "878afd64432a02104fefe4511fb8f28d",
            "captureFrequency": "once",
            "captureMethod": "automatic",
            "metricDescription": "This is the Tx signal level",
            "metricName": "TX Optical Signal Level",
            "name": "TX Optical Signal Level",
            "unitOfMeasure": "a minute",
            "valueType": "",
            "capturePeriod": "",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            },
            "thresholdRule": [
              {
                "id": "b3dab5a4432a02104fefe4511fb8f2d3",
                "description": "",
                "name": "gponOntAniOpInfoTxOpticalSignalLevel",
                "numberOfAllowedCrossing": "",
                "thresholdRuleSeverity": "",
                "tolerancePeriod": "",
                "conformanceTargetUpper": "65",
                "conformanceComparatorUpper": "less than",
                "conformanceTargetLower": "-65",
                "conformanceComparatorLower": "greater than",
                "consequence": []
              }
            ]
          }
        ],
        "specCharacteristic": [
          {
            "name": "AccessRequired",
            "description": "AccessRequired",
            "valueType": "yes_no",
            "validFor": {
              "startDatetime": "2024-05-30 09:09:57"
            },
            "characteristicValueSpecification": [
              {
                "value": "Yes",
                "validFor": {
                  "startDateTime": "",
                  "endDateTime": ""
                }
              },
              {
                "value": "No",
                "validFor": {
                  "startDateTime": "",
                  "endDateTime": ""
                }
              }
            ]
          }
        ],
        "serviceTestSpecRelationship": [],
        "relatedServiceSpecification": [
          {
            "id": "f559b564432a02104fefe4511fb8f2e0",
            "name": "OAM"
          }
        ]
      },
      {
        "description": "Upstream and Downstream speed ",
        "id": "89d2b920432a02104fefe4511fb8f22e",
        "name": "Speed Test",
        "validFor": {
          "startDateTime": "2024-05-31",
          "endDateTime": "2024-06-27"
        },
        "testMeasureDefinition": [
          {
            "id": "1a04f560432a02104fefe4511fb8f2ad",
            "captureFrequency": "once",
            "captureMethod": "automatic",
            "metricDescription": "This is the downstream speed in a service",
            "metricName": "Downstream Speed",
            "name": "Downstream Speed",
            "unitOfMeasure": "a second",
            "valueType": "",
            "capturePeriod": "30 Minutes",
            "validFor": {
              "startDateTime": "2024-05-30 08:49:26",
              "endDateTime": "2024-05-31 08:49:29"
            },
            "thresholdRule": [
              {
                "id": "a754f960432a02104fefe4511fb8f2d0",
                "description": "This speed is greater than the target upper",
                "name": "InternetSpeedValue",
                "numberOfAllowedCrossing": "0",
                "thresholdRuleSeverity": "high",
                "tolerancePeriod": "15 Minutes",
                "conformanceTargetLower": "75",
                "conformanceComparatorLower": "greater than",
                "consequence": [
                  {
                    "id": "15a4bd60432a02104fefe4511fb8f2b8",
                    "prescribeAction": "null",
                    "description": "generate a waring report",
                    "name": "degradedQualityOfService",
                    "repeatAction": "0",
                    "validFor": {
                      "startDateTime": "2024-05-30 08:51:29",
                      "endDateTime": "2024-08-06 08:51:31"
                    }
                  },
                  {
                    "id": "e6847d60432a02104fefe4511fb8f2c3",
                    "prescribeAction": "null",
                    "description": "send a warning to the system",
                    "name": "packetdrop",
                    "repeatAction": "0",
                    "validFor": {
                      "startDateTime": "2024-05-30 08:50:53",
                      "endDateTime": "2024-08-06 08:50:55"
                    }
                  }
                ]
              },
              {
                "id": "cb55b5a0432a02104fefe4511fb8f201",
                "description": "",
                "name": "InternetSpeedValue",
                "numberOfAllowedCrossing": "0",
                "thresholdRuleSeverity": "medium",
                "tolerancePeriod": "",
                "conformanceTargetUpper": "120",
                "conformanceComparatorUpper": "less than",
                "consequence": []
              }
            ]
          },
          {
            "id": "8f987524432a02104fefe4511fb8f2f0",
            "captureFrequency": "once",
            "captureMethod": "automatic",
            "metricDescription": "This is the upstream speed in the service",
            "metricName": "Upstream Speed",
            "name": "Upstream Speed",
            "unitOfMeasure": "a second",
            "valueType": "",
            "capturePeriod": "",
            "validFor": {
              "startDateTime": "",
              "endDateTime": ""
            },
            "thresholdRule": []
          }
        ],
        "specCharacteristic": [
          {
            "name": "restart",
            "description": "restart",
            "valueType": "yes_no",
            "validFor": {
              "startDatetime": "2024-05-30 08:45:49"
            },
            "characteristicValueSpecification": [
              {
                "value": "No",
                "validFor": {
                  "startDateTime": "",
                  "endDateTime": ""
                }
              },
              {
                "value": "Yes",
                "validFor": {
                  "startDateTime": "",
                  "endDateTime": ""
                }
              }
            ]
          }
        ],
        "serviceTestSpecRelationship": [
          {
            "id": "76a3b160432a02104fefe4511fb8f2ad",
            "name": "OAM Test",
            "relationshipType": ""
          }
        ],
        "relatedServiceSpecification": [
          {
            "id": "aeddcd1fb7d69910ff00f203ae11a990",
            "name": "Home Internet"
          }
        ]
      }
    ]

    Service Test Management Open API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

    Ruft eine Servicetest-Definitionsentität ab.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

    Unterstützte Anforderungsparameter

    Tabelle : 20. Pfadparameter
    Name Beschreibung
    id Erforderlich. Sys_id oder external_id der abzurufenden Servicetestdefinition. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    Tabelle : 21. Abfrageparameter
    Name Beschreibung
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle -Felder zurückgegeben. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].
    Gültige Werte:
    • Beschreibung
    • id
    • name
    • ZugehörigeServiceSpecification
    • serviceTestSpecRelationship
    • specCharacterificent
    • testMeasureDefinition
    • validFor

    Datentyp: Zeichenfolge

    state Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. In der Antwort werden nur Testdefinitionen im angegebenen Status zurückgegeben.

    Gültige Werte:

    • archiviert
    • Entwurf
    • Veröffentlicht
    • Deaktiviert

    Datentyp: Zeichenfolge

    Tabelle : 22. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 23. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 24. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 25. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigeServiceSpecification Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id Sys_id oder external_id der Servicespezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    Datentyp: Zeichenfolge

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship Zugehörige Servicetestdefinition.

    Datentyp: Array von Objekten

    "serviceTestSpecRelationship": [
     {
      "id": "String",
      "name": "String",
      "relationshipType": "String"
     }
    ]
    serviceTestSpecBeziehung.id Sys_id oder external_id der zugehörigen Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.Beziehungstyp Typ der Beziehung.
    Akzeptierte Werte:
    • Ersatz
    • Abhängigkeit
    • Ausschließlichkeit

    Datentyp: Zeichenfolge

    specCharacterificent Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacterific.characteristValueSpecification Array mit den möglichen Werten für das Merkmal.

    Datentyp: Array von Objekten

    "characteristicValueSpecification": [
      {
        "value": "String"
      }
    ]
    specCharacterific.characteristValueSpecification.value Wert des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Beschreibung Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    specCharacterific.validFor Datumsbereich, für den das Merkmal gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    specCharacterific.validFor.endDateTime Enddatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    specCharacterific.validFor.startDateTime Startdatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Spezifisches Merkmal.WerteTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    testMeasureDefinition Testmaßdefinitionen für diese Servicetestdefinition. Weitere Informationen finden Sie unter Define test measure definitions for a service test.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "captureFrequency": "String",
      "captureMethod": "String",
      "capturePeriod": {Object},
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "name": "String",
      "unitOfMeasure": "String",
      "thresholdRule": [Array],
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    testMeasureDefinition.captureFrequency Die Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

    • Keine
    • einmal
    • täglich
    • wöchentlich
    • monatlich

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungszeitraum Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

    "capturePeriod": {
      "amount": Number,
      "units": "String"
    }
    testMessdefinition.Erfassungszeitraum.Betrag Anzahl der Erfassungszeiträume.

    Datentyp: Zahl

    testMessdefinition.Erfassungszeitraum.Einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id Sys_id oder external_id der Testmaßdefinitionen. Befindet sich in der Tabelle „Testmaßdefinition“ [sn_st_mgmt_test_measure_definition].

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricName Benutzerdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition.

    Datentyp: Array von Objekten

    {
      "thresholdRule": {
        "consequence": Array,
        "conformanceComparatorExact": Boolean,
        "conformanceComparatorLower": "String",
        "conformanceComparatorUpper": "String",
        "conformanceTargetExact": "String",
        "conformanceTargetLower": "String",
        "conformanceTargetUpper": "String",
        "consequence": Array,
        "description": "String",
        "id": "String",
        "name": "String",
        "numberOfAllowedCrossing": Number,
        "thresholdRuleSeverity": "String",
        "tolerancePeriod": Object
      }
    }
    testMeasureDefinition.thresholdRule.conformanceCvergleichExact Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich.
    Gültige Werte:
    • wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • false: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.conformanceCvergleichLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceCvergleichUpper Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.consequence Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules.

    Datentyp: Array von Objekten

    "consequence": [
     {
      "description": "String",
      "id": "String",
      "name": "String",
      "prescribeAction": "String",
      "repeatAction": Boolean,
      "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
     }
    ]
    testMeasureDefinition.thresholdRule.consequence.description Beschreibung der Konsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.id Sys_id oder external_id der Messkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.prescribeAction Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.repeatAction Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.consequence.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime Gültigkeitsenddatum der Konsequenz

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id Sys_id oder external_id der Schwellenwertregeln. Zu finden im Feld „Befindet sich in sys_id“ oder „external_id“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Höchstwert: 40

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMeasureDefinition.unitOfMeasure Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Zeichenfolge

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    testMeasureDefinition.validFor.endDateTime Gültigkeitsenddatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor.startDateTime Gültigkeitsstartdatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den die Testdefinition gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    validFor.endDateTime Datum und Uhrzeit der Testdefinition, zu der der Status der Testdefinition stillgelegt wird.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Datum und Uhrzeit der Testdefinition, zu der ihr Status veröffentlicht wird.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden Details einer Servicetestdefinition mit einer angegebenen ID abgerufen.

    curl --location --request GET "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e" \
    --user 'username’: ‘password'

    Antworttext.

    {
      "description": "Upstream and Downstream speed ",
      "id": "89d2b920432a02104fefe4511fb8f22e",
      "name": "Speed Test",
      "validFor": {
        "startDateTime": "2024-05-31",
        "endDateTime": "2024-06-27"
      },
      "testMeasureDefinition": [
        {
          "id": "1a04f560432a02104fefe4511fb8f2ad",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the downstream speed in a service",
          "metricName": "Downstream Speed",
          "name": "Downstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "30 Minutes",
          "validFor": {
            "startDateTime": "2024-05-30 08:49:26",
            "endDateTime": "2024-05-31 08:49:29"
          },
          "thresholdRule": [
            {
              "id": "a754f960432a02104fefe4511fb8f2d0",
              "description": "This speed is greater than the target upper",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "15 Minutes",
              "conformanceTargetLower": "75",
              "conformanceComparatorLower": "greater than",
              "consequence": [
                {
                  "id": "15a4bd60432a02104fefe4511fb8f2b8",
                  "prescribeAction": "null",
                  "description": "generate a waring report",
                  "name": "degradedQualityOfService",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:51:29",
                    "endDateTime": "2024-08-06 08:51:31"
                  }
                },
                {
                  "id": "e6847d60432a02104fefe4511fb8f2c3",
                  "prescribeAction": "null",
                  "description": "send a warning to the system",
                  "name": "packetdrop",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:50:53",
                    "endDateTime": "2024-08-06 08:50:55"
                  }
                }
              ]
            },
            {
              "id": "cb55b5a0432a02104fefe4511fb8f201",
              "description": "",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "medium",
              "tolerancePeriod": "",
              "conformanceTargetUpper": "120",
              "conformanceComparatorUpper": "less than",
              "consequence": []
            }
          ]
        }
      ],
      "specCharacteristic": [
        {
          "name": "restart",
          "description": "restart",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2024-05-30 08:45:49"
          },
          "characteristicValueSpecification": [
            {
              "value": "No",
              "validFor": {
                "startDateTime": "",
                "endDateTime": ""
              }
            },
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": "",
                "endDateTime": ""
              }
            }
          ]
        }
      ],
      "serviceTestSpecRelationship": [
        {
          "id": "76a3b160432a02104fefe4511fb8f2ad",
          "name": "OAM Test",
          "relationshipType": ""
        }
      ],
      "relatedServiceSpecification": [
        {
          "id": "aeddcd1fb7d69910ff00f203ae11a990",
          "name": "Home Internet"
        }
      ]
    }

    Service Test Management Open API – PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

    Aktualisiert eine Servicetest-Entität.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}

    Unterstützte Anforderungsparameter

    Tabelle : 26. Pfadparameter
    Name Beschreibung
    id Erforderlich. Sys_id oder external_id des abzurufenden Servicetests. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    Tabelle : 27. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 28. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Merkmal Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Testdefinitionsmerkmalen finden Sie unter

    Datentyp: Array von Objekten

    "characteristic": [
     {
      "id": "String",
      "name": "String",
      "value": "String",
      "valueType": "String"
     }
    ]
    characteristic.id Sys_id oder external_id der Merkmale. Befindet sich in der Tabelle „Merkmale“ [sn_prd_pm_charakteristik]. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“.

    Datentyp: Zeichenfolge

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    Merkmal.Wert Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz.

    Datentyp: Zeichenfolge

    merkmal.wertTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Modus Der Modus, in dem der Servicetest ausgeführt wird.
    Gültige Werte:
    • ONDEMAND: Löst den Servicetest manuell aus.
    • PROAKTIV: Löst den Servicetest automatisch aus.

    Standard: ONDEMAND

    name Erforderlich. Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigerService Erforderlich. Die dem Servicetest zugeordnete Testdefinition.

    Datentyp: Objekt

    "relatedService": {
     "href": "String",
     "id": "String",
     "name": "String"
    }
    relatedService.href Hyperlink-Verweis auf den zugehörigen Service.

    Datentyp: Zeichenfolge

    relatedService.id Sys_id oder external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Staat Status, in dem sich der Servicetest befindet.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    testMeasure Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus.

    Datentyp: Array von Objekten

    "testMeasure": [
     {
     "accuracy": "String",
     "captureDateTime": "String",
     "captureMethod": "String",
     "id": "String",
     "metricDescription": "String",
     "metricName": "String",
     "ruleViolation": [Array],
     "unitOfMeasure": "String",
     "value": {Object}
     }
    ]
    testMeasure.accuracy Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt.

    Datentyp: Zahl

    Höchstwert: 40

    testMessen.ErfassungsdatumZeit Datum und Uhrzeit der Erfassung der Metrik.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasure.id Sys_id oder external_id der Testmaße. Befindet sich in den Feldern „sys_id“ oder „external_id“ der Tabelle „Testmaße“ [sn_st_mgmt_test_measure].

    Datentyp: Zeichenfolge

    testMessen.Messen.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMeasure.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasure.metricName Name der Testmaßmetrik.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung Ein Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn ein Verstoß gegen die Regel vorliegt.

    Datentyp: Array von Objekten

    "ruleViolation"[
      {
        appliedConsequence: [Array],
        conformanceTargetUpper: Number,
        conformanceComparatorUpper: "String",
        description: "String",
        id: "String",
        name: "String",
        numberOfAllowedCrossing: Number,
        thresholdRuleSeverity: "String",
        tolerancePeriod: "String"
      }
    ]
    testMessung.RegelVerstoß.Toleranzzeitraum.Betrag Die Anzahl der Zeiträume vor Anwendung der Konsequenz.

    Datentyp: Zahl

    testMessung.regelVerstoß.angewendeteKonsequenz Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird.

    Datentyp: Array von Objekten

    "appliedConsequence": [
     {
      "appliedAction": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "repeatAction": Boolean
     }
    ]
    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung Beschreibung der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.id Sys_id oder external_id der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.name Name der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.AngewendeteKonsequenz.Wiederholungsaktion Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt.

    Gültige Werte:

    • „wahr“: Wiederholen Sie die Aktion.
    • „falsch“: Aktion erneut wiederholen.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComporatorExact Kennzeichnung, die angibt, ob ein Wert identisch ist.
    Gültige Werte:
    • wahr: Der Wert ist identisch.
    • „falsch“: Der Wert ist nicht identisch.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComporatorLower Operator, mit dem überprüft wird, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceComporatorUpper Operator, mit dem überprüft wird, ob ein Wert über dem Schwellenwert liegt.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMessung.regelVerletzung.beschreibung Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Befindet sich in der Tabelle „Schwellenwertregelverstoß“ [sn_st_mgmt_threshold_rule_violation].

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.ruleViolation.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Toleranzzeitraum Angegebenes Zeitintervall, während dessen Überschreitungsereignisse aktiviert sind, ohne unmittelbare Konsequenzen oder Aktionen auszulösen.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMessung.regelVerletzung.toleranzzeitraum.einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasure.messageeinheit Gibt die Maßeinheit für die Konformitätszielwerte der Testmaßnahme an.

    Datentyp: Zeichenfolge

    testMeasure.value Der Wert der Testmaßnahme.

    Datentyp: Objekt

    "value": {
     "id": "String",
     "name": "String",
     "valueType": "String",
     "value": "String
    }
    testMeasure.value.id Die ID des Testmaßwerts.

    Datentyp: Zeichenfolge

    testMeasure.value.name Der Name des Testmaßwerts.

    Datentyp: Zeichenfolge

    testMeasure.value.value Der Wert der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMessung.Wert.WertTyp Der Typ des Testmaßwerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    testSpecification Erforderlich. Die Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "testSpecification": {
     "id": "String",
     "href": "String"
    }
    testSpecification.href Hyperlink-Verweis auf die Servicetestdefinition.

    Datentyp: Zeichenfolge

    testSpecification.id Die sys_id oder external_id der Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    validFor.endDateTime Gültigkeitsenddatum des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Gültigkeitsstartdatum des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 29. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 30. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 31. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Merkmal Liste, die die Merkmale des zugehörigen Servicetests beschreibt.

    Datentyp: Array von Objekten

    "characteristic": [
     {
      "id": "String",
      "name": "String",
      "value": "String",
      "valueType": "String"
     }
    ]
    Merkmal.ID Sys_id oder external_id der Merkmale. Befindet sich in der Tabelle „Merkmale“ [sn_prd_pm_charakteristik]. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“.

    Datentyp: Zeichenfolge

    Merkmal.Name Name des Merkmals.

    Datentyp: Zeichenfolge

    Merkmal.Wert Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz.

    Datentyp: Zeichenfolge

    merkmal.wertTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    name Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigerService Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
      "href": "string",
      "id": "String",
      "name": "String"
    }
    ZugehörigerService.id Sys_id oder external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge

    ZugehörigerService.name Name des Produktbestands.

    Datentyp: Zeichenfolge

    testMeasure Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "accuracy": "String",
      "captureDateTime": "String",
      "captureMethod": "String",
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "ruleViolation": [Array]
      "unitOfMeasure": "String",
      "value": {Object}
     }
    ]
    testMeasure.accuracy Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt.

    Datentyp: Zahl

    Höchstwert: 40

    testMessen.ErfassungsdatumZeit Datum und Uhrzeit der Erfassung der Metrik.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMessen.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMeasure.id Sys_id oder external_id der Testmaßnahme. Befindet sich in der Tabelle mit den Testmaßen [sn_st_mgmt_test_measure].

    Datentyp: Zeichenfolge

    testMeasure.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasure.metricName Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn die Regel verletzt wird.

    Datentyp: Array von Objekten

    "RuleViolation": [
    {
      "appliedConsequence": [Array],
      "conformanceComparatorExact": Boolean,
      "conformanceComparatorLower": "String",
      "conformanceComparatorUpper": "String",
      "conformanceTargetExact": "String",
      "conformanceTargetLower": "String",
      "conformanceTargetUpper": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "numberOfAllowedCrossing": Number,
      "thresholdRuleSeverity": "String",
      "tolerancePeriod": {Object}
     }
    ]
    testMessung.regelVerstoß.angewendeteKonsequenz Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird.

    Datentyp: Array von Objekten

    "appliedConsequence": [
     {
      "appliedAction": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "repeatAction": Boolean
     }
    ]
    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion.Wiederholungsaktion Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung Beschreibung der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.id Sys_id oder external_id der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.name Name der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessen.regelVerletzung.konformerVergleichGenau Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist.
    Gültige Werte:
    • wahr: Der Wert ist identisch.
    • „falsch“: Der Wert ist nicht identisch.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComparatorLower Ein Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceCvergleichUpper Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • ist
    • kleiner als

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMessung.regelVerletzung.beschreibung Beschreibung des Verstoßes gegen die Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.id Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Befindet sich in der Tabelle „Schwellenwertregelverstoß“ [sn_st_mgmt_threshold_rule_violation].

    Datentyp: Zeichenfolge

    testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Maximum: 40

    testMeasure.ruleViolation.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Toleranzzeitraum Dauer oder Zeitintervall, in der zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMessung.RegelVerstoß.Toleranzzeitraum.Betrag Betrag des Zeitraums als Nummer.

    Datentyp: Zahl

    testMessung.regelVerletzung.toleranzzeitraum.einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasure.messageeinheit Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasure.value Wert der Metrik im Test.

    Datentyp: Objekt

    "value": {
      "id": "String",
      "name": "String",
      "valueType": "String",
      "value": "String"
    }
    testMeasure.value.id ID des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.Name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMeasure.value.value Wert der Metrik im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.WertTyp Der Typ des Testmaßwerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    testSpecification Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "testSpecification": {
      "href": "String",
      "id": "String"
    }
    testSpecification.href Hyperlink-Verweis auf die Servicetestdefinition.

    Datentyp: Zeichenfolge

    testSpecification.id Sys_id oder external_id der Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
      "startDateTime": "String",
      "endDateTime": "String"
    }
    validFor.endDateTime Enddatum und -zeitstempel des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Startdatum und -zeitstempel des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel wird die angegebene Servicetest-Entität gemäß den im Anforderungstext angegebenen Details aktualisiert.

    curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/2b406ec043b202104fefe4511fb8f211" \ 
    --request PATCH \
    --header "Accept:application/json" \
    --user 'username':'password'
    --data {
      "description": "Service test description",
      "endDateTime": "2025-01-31 15:05:43",
      "mode": "proactive",
      "name": "Speed Test TR0001002",
      "startDateTime": "2024-06-05 09:07:10",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "relatedService": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "name": "Internet_VPLS_PI0000011"
      },
      "testSpecification": {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
        "id": "76a3b160432a02104fefe4511fb8f2ad"
      },
      "characteristic": [
        {
          "id": "e7ef960443f202104fefe4511fb8f224",
          "name": "AccessRequired",
          "valueType": "yes_no",
          "value": "No"
        }
      ],
      "testMeasure": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2e",
          "accuracy": "0.0001",
          "captureDateTime": "",
          "captureMethod": "automatic",
          "metricDescription": "",
          "metricName": "Flow speed",
          "unitOfMeasure": "A second",
          "value": "3000",
          "ruleViolation": [
            {
              "id": "61d1382e3be28210d140068aa4e45a2f",
              "description": "This speed is greater than the target",
              "name": "tooMuchTraffic",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "",
              "conformanceTargetLower": "2500",
              "conformanceComparatorLower": "greater than",
              "appliedConsequence": [
                {
                  "id": "65d1382e3be28210d140068aa4e45a31",
                  "appliedAction": "sendWarning",
                  "description": "send a warning to the system",
                  "name": "sendWarning",
                  "repeatAction": "0"
                }
              ]
            }
          ]
        }
      ]
    }

    Die Antwort zeigt eine erfolgreiche Aktualisierung, indem die geänderten Informationen im angegebenen Testservice zurückgegeben werden.

    {
      "description": "Service test description",
      "endDateTime": "2025-01-31 15:05:43",
      "mode": "proactive",
      "name": "Speed Test TR0001002",
      "startDateTime": "2024-06-05 09:07:10",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "relatedService": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "name": "Internet_VPLS_PI0000011"
      },
      "testSpecification": {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
        "id": "76a3b160432a02104fefe4511fb8f2ad"
      },
      "characteristic": [
        {
          "id": "e7ef960443f202104fefe4511fb8f224",
          "name": "AccessRequired",
          "valueType": "yes_no",
          "value": "yes"
        }
      ],
      "testMeasure": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2e",
          "accuracy": "0.0001",
          "captureDateTime": "",
          "captureMethod": "automatic",
          "metricDescription": "",
          "metricName": "Flow speed",
          "unitOfMeasure": "A second",
          "value": "3000",
          "ruleViolation": [
            {
              "id": "61d1382e3be28210d140068aa4e45a2f",
              "description": "This speed is greater than the target",
              "name": "tooMuchTraffic",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "",
              "conformanceTargetLower": "2500",
              "conformanceComparatorLower": "greater than",
              "appliedConsequence": [
                {
                  "id": "65d1382e3be28210d140068aa4e45a31",
                  "appliedAction": "sendWarning",
                  "description": "send a warning to the system",
                  "name": "sendWarning",
                  "repeatAction": "0"
                }
              ]
            }
          ]
        }
      ]
    }

    Service Test Management Open API – PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

    Ermöglicht teilweise Aktualisierungen einer Servicetestdefinitionsentität.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}

    Unterstützte Anforderungsparameter

    Tabelle : 32. Pfadparameter
    Name Beschreibung
    id Erforderlich. Sys_id oder external_id der abzurufenden Servicetestdefinition. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    Tabelle : 33. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 34. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigeServiceSpecification Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id Sys_id oder external_id der Servicespezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    Datentyp: Zeichenfolge

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship Zugehörige Servicetestdefinition.

    Datentyp: Array von Objekten

    "serviceTestSpecRelationship": [
     {
      "id": "String",
      "name": "String",
      "relationshipType": "String"
     }
    ]
    serviceTestSpecBeziehung.id Sys_id oder external_id der zugehörigen Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.Beziehungstyp Typ der Beziehung.
    Akzeptierte Werte:
    • Ersatz
    • Abhängigkeit
    • Ausschließlichkeit

    Datentyp: Zeichenfolge

    specCharacterificent Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacterific.characteristValueSpecification Array mit den möglichen Werten für das Merkmal.

    Datentyp: Array von Objekten

    "characteristicValueSpecification": [
      {
        "value": "String"
      }
    ]
    specCharacterific.characteristValueSpecification.value Wert des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Beschreibung Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    specCharacterific.validFor Datumsbereich, für den das Merkmal gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    specCharacterific.validFor.endDateTime Enddatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    specCharacterific.validFor.startDateTime Startdatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Spezifisches Merkmal.WerteTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    testMeasureDefinition Testmaßdefinitionen für diese Servicetestdefinition. Weitere Informationen finden Sie unter Define test measure definitions for a service test.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "captureFrequency": "String",
      "captureMethod": "String",
      "capturePeriod": {Object},
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "name": "String",
      "unitOfMeasure": "String",
      "thresholdRule": [Array],
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    testMeasureDefinition.captureFrequency Die Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

    • Keine
    • einmal
    • täglich
    • wöchentlich
    • monatlich

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungszeitraum Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

    "capturePeriod": {
      "amount": Number,
      "units": "String"
    }
    testMessdefinition.Erfassungszeitraum.Betrag Anzahl der Erfassungszeiträume.

    Datentyp: Zahl

    testMessdefinition.Erfassungszeitraum.Einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id Sys_id oder external_id der Testmaßdefinitionen. Befindet sich in der Tabelle „Testmaßdefinition“ [sn_st_mgmt_test_measure_definition].

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricName Benutzerdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition.

    Datentyp: Array von Objekten

    {
      "thresholdRule": {
        "consequence": Array,
        "conformanceComparatorExact": Boolean,
        "conformanceComparatorLower": "String",
        "conformanceComparatorUpper": "String",
        "conformanceTargetExact": "String",
        "conformanceTargetLower": "String",
        "conformanceTargetUpper": "String",
        "consequence": Array,
        "description": "String",
        "id": "String",
        "name": "String",
        "numberOfAllowedCrossing": Number,
        "thresholdRuleSeverity": "String",
        "tolerancePeriod": Object
      }
    }
    testMeasureDefinition.thresholdRule.conformanceCvergleichExact Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich.
    Gültige Werte:
    • wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • false: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.conformanceCvergleichLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceCvergleichUpper Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.consequence Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules.

    Datentyp: Array von Objekten

    "consequence": [
     {
      "description": "String",
      "id": "String",
      "name": "String",
      "prescribeAction": "String",
      "repeatAction": Boolean,
      "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
     }
    ]
    testMeasureDefinition.thresholdRule.consequence.description Beschreibung der Konsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.id Sys_id oder external_id der Messkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.prescribeAction Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.repeatAction Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.consequence.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime Gültigkeitsenddatum der Konsequenz

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id Sys_id oder external_id der Schwellenwertregeln. Zu finden im Feld „Befindet sich in sys_id“ oder „external_id“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Höchstwert: 40

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMeasureDefinition.unitOfMeasure Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Zeichenfolge

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    testMeasureDefinition.validFor.endDateTime Gültigkeitsenddatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor.startDateTime Gültigkeitsstartdatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 35. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 36. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur application/json.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 37. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    id Die sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    name Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigeServiceSpecification Servicespezifikationen für die Testdefinitionen.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
     {
      "id": "String",
      "name": "String"
     }
    ]
    ZugehörigeServiceSpezifikation.ID Die sys_id oder external_id der Servicespezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    Datentyp: Zeichenfolge

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship Zugehörige Servicetestdefinition.

    Datentyp: Array von Objekten

    "serviceTestSpecRelationship": [
     {
      "id": "String",
      "name": "String",
      "relationshipType": "String"
     }
    ]
    serviceTestSpecBeziehung.id Sys_id oder external_id der zugehörigen Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.Beziehungstyp Typ der Beziehung.
    Akzeptierte Werte:
    • Ersatz
    • Abhängigkeit
    • Ausschließlichkeit

    Datentyp: Zeichenfolge

    specCharacterificent Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
     }
    ]
    specCharacterific.characteristValueSpecification Array mit den möglichen Werten für das Merkmal.

    Datentyp: Array von Objekten

    "characteristicValueSpecification": [
     {
      "value": "String"
     }
    ]
    specCharacterific.characteristValueSpecification.value Wert des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Beschreibung Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Name Name des Merkmals.

    Datentyp: Zeichenfolge

    specCharacterific.validFor Datumsbereich, für den das Merkmal gültig ist.

    Datentyp: Objekt

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    specCharacterific.validFor.endDateTime Enddatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    specCharacterific.validFor.startDateTime Startdatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Spezifisches Merkmal.WerteTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    testMeasureDefinition Testmaßdefinitionen für diese Servicetestdefinition. Weitere Informationen finden Sie unter Define test measure definitions for a service test.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "captureFrequency": "String",
      "captureMethod": "String",
      "capturePeriod": {Object},
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "name": "String",
      "unitOfMeasure": "String",
      "thresholdRule": [Array],
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    testMeasureDefinition.captureFrequency Die Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

    • täglich
    • monatlich
    • Keine
    • einmal
    • wöchentlich

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • manual: Erfasst die Metrik manuell.
    • automatisch: Erfasst die Metrik automatisch.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungszeitraum Eine Dauer oder ein Zeitraum der Erfassung.

    Datentyp: Objekt

    "capturePeriod": {
      "amount": Number,
      "units": "String"
    }
    testMessdefinition.Erfassungszeitraum.Betrag Anzahl der Erfassungszeiträume.

    Datentyp: Zahl

    testMessdefinition.Erfassungszeitraum.Einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id Sys_id oder external_id der Testmaßdefinitionen. Befindet sich in der Tabelle „Testmaßdefinition“ [sn_st_mgmt_test_measure_definition].

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricName Benutzerdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule Regel, die die Bedingung (erhöhen oder löschen) definiert, die erfüllt sein muss, um Konsequenzen anzuwenden, wenn ein Schwellenwert für eine bestimmte Testmaßdefinition überschritten wird oder nicht mehr überschritten wird​.

    Datentyp: Array von Objekten

    {
      "thresholdRule": {
        "conformanceComparatorExact": Boolean,
        "conformanceComparatorLower": "String",
        "conformanceComparatorUpper": "String",
        "conformanceTargetExact": "String",
        "conformanceTargetLower": "String",
        "conformanceTargetUpper": "String",
        "consequence": Array,
        "description": "String",
        "id": "String",
        "name": "String",
        "numberOfAllowedCrossing": Number,
        "thresholdRuleSeverity": "String",
        "tolerancePeriod": Object
      }
    }
    testMeasureDefinition.thresholdRule.conformanceCvergleichExact Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist.
    Gültige Werte:
    • wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • false: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.conformanceCvergleichLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceCvergleichUpper Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • kleiner als
    • ist

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.consequence Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird.

    Datentyp: Array von Objekten

    "consequence": [
     {
      "description": "String",
      "id": "String",
      "name": "String",
      "prescribeAction": "String",
      "repeatAction": Boolean,
      "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
     }
    ]
    testMeasureDefinition.thresholdRule.consequence.description Beschreibung der Konsequenz.

    Datentyp: Zeichenfolge

    testMessgrößenDefinition.thresholdRule.consequence.id Sys_id oder external_id der Messkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.prescribeAction Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.repeatAction Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.

    Gültige Werte:

    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.consequence.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime Gültigkeitsenddatum der Konsequenz

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id Sys_id oder external_id der Schwellenwertregeln. Befindet sich in der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    Datentyp: Zeichenfolge

    testMessgrößenDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasureDefinition.thresholdRule.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    testMeasureDefinition.unitOfMeasure Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime": "String"
    }
    testMeasureDefinition.validFor.endDateTime Gültigkeitsenddatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor.startDateTime Gültigkeitsstartdatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel wird die angegebene ID der Servicetestdefinition teilweise aktualisiert, je nachdem, welche Änderungen im Anforderungstext vorgenommen wurden.

    curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e " 
    --request PATCH
    --header "Accept:application/json" 
    --user 'username':'password'
    --data {
      "description": "Upstream and Downstream speed ",
      "name": "This is my new Speed Test",
      "testMeasureDefinition": [
        {
          "id": "1a04f560432a02104fefe4511fb8f2ad",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the downstream speed in a service",
          "metricName": "Downstream Speed",
          "name": "Downstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "30 Minutes",
          "validFor": {
            "startDateTime": "2024-05-30 08:49:26",
            "endDateTime": "2024-05-31 08:49:29"
          },
          "thresholdRule": [
            {
              "id": "a754f960432a02104fefe4511fb8f2d0",
              "description": "This speed is greater than the target upper",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "15 Minutes",
              "conformanceTargetLower": "75",
              "conformanceComparatorLower": "greater than",
              "consequence": [
                {
                  "id": "15a4bd60432a02104fefe4511fb8f2b8",
                  "prescribeAction": "null",
                  "description": "generate a waring report",
                  "name": "degradedQualityOfService",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:51:29",
                    "endDateTime": "2024-08-06 08:51:31"
                  }
                },
                {
                  "id": "e6847d60432a02104fefe4511fb8f2c3",
                  "prescribeAction": "null",
                  "description": "send a warning to the system",
                  "name": "packetdrop",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:50:53",
                    "endDateTime": "2024-08-06 08:50:55"
                  }
                }
              ]
            },
            {
              "id": "cb55b5a0432a02104fefe4511fb8f201",
              "description": "",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "medium",
              "tolerancePeriod": "",
              "conformanceTargetUpper": "120",
              "conformanceComparatorUpper": "less than",
              "consequence": []
            }
          ]
        },
        {
          "id": "8f987524432a02104fefe4511fb8f2f0",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the upstream speed in the service",
          "metricName": "Upstream Speed",
          "name": "Upstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          },
          "thresholdRule": []
        }
      ],
      "specCharacteristic": [
        {
          "name": "restart",
          "description": "restart",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2024-05-30 08:45:49"
          }
        }
      ],
      "serviceTestSpecRelationship": [
        {
          "id": "76a3b160432a02104fefe4511fb8f2ad",
          "name": "OAM Test",
          "relationshipType": ""
        }
      ],
      "relatedServiceSpecification": [
        {
          "id": "aeddcd1fb7d69910ff00f203ae11a990",
          "name": "Home Internet"
        }
      ]
    }

    Der Antworttext gibt den aktualisierten Teil der Servicetestspezifikation zurück:

    {
      "description": "Upstream and Downstream speed ",
      "name": "This is my new Speed Test",
      "testMeasureDefinition": [
        {
          "id": "1a04f560432a02104fefe4511fb8f2ad",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the downstream speed in a service",
          "metricName": "Downstream Speed",
          "name": "Downstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "30 Minutes",
          "validFor": {
            "startDateTime": "2024-05-30 08:49:26",
            "endDateTime": "2024-05-31 08:49:29"
          },
          "thresholdRule": [
            {
              "id": "a754f960432a02104fefe4511fb8f2d0",
              "description": "This speed is greater than the target upper",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "15 Minutes",
              "conformanceTargetLower": "75",
              "conformanceComparatorLower": "greater than",
              "consequence": [
                {
                  "id": "15a4bd60432a02104fefe4511fb8f2b8",
                  "prescribeAction": "null",
                  "description": "generate a waring report",
                  "name": "degradedQualityOfService",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:51:29",
                    "endDateTime": "2024-08-06 08:51:31"
                  }
                },
                {
                  "id": "e6847d60432a02104fefe4511fb8f2c3",
                  "prescribeAction": "null",
                  "description": "send a warning to the system",
                  "name": "packetdrop",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:50:53",
                    "endDateTime": "2024-08-06 08:50:55"
                  }
                }
              ]
            },
            {
              "id": "cb55b5a0432a02104fefe4511fb8f201",
              "description": "",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "medium",
              "tolerancePeriod": "",
              "conformanceTargetUpper": "120",
              "conformanceComparatorUpper": "less than",
              "consequence": []
            }
          ]
        },
        {
          "id": "8f987524432a02104fefe4511fb8f2f0",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the upstream speed in the service",
          "metricName": "Upstream Speed",
          "name": "Upstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          },
          "thresholdRule": []
        }
      ],
      "specCharacteristic": [
        {
          "name": "restart",
          "description": "restart",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2024-05-30 08:45:49"
          }
        }
      ],
      "serviceTestSpecRelationship": [
        {
          "id": "76a3b160432a02104fefe4511fb8f2ad",
          "name": "OAM Test",
          "relationshipType": ""
        }
      ],
      "relatedServiceSpecification": [
        {
          "id": "aeddcd1fb7d69910ff00f203ae11a990",
          "name": "Home Internet"
        }
      ]
    }

    Service Test Management Open API – POST /sn_sprb_mgmt/servicetestmanagement/serviceTest

    Erstellt einen Servicetest.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest

    Unterstützte Anforderungsparameter

    Tabelle : 38. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 39. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 40. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Merkmal Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Testdefinitionsmerkmalen finden Sie unter

    Datentyp: Array von Objekten

    "characteristic": [
     {
      "id": "String",
      "name": "String",
      "value": "String",
      "valueType": "String"
     }
    ]
    characteristic.id Sys_id oder external_id der Merkmale. Befindet sich in der Tabelle „Merkmale“ [sn_prd_pm_charakteristik]. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“.

    Datentyp: Zeichenfolge

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    Merkmal.Wert Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz.

    Datentyp: Zeichenfolge

    merkmal.wertTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id des Servicetests. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test]. Diese ID erstellt einen Servicetest und wird als external_id verwendet.

    Datentyp: Zeichenfolge

    Modus Der Modus, in dem der Servicetest ausgeführt wird.
    Gültige Werte:
    • ONDEMAND: Löst den Servicetest manuell aus.
    • PROAKTIV: Löst den Servicetest automatisch aus.

    Standard: ONDEMAND

    name Erforderlich. Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigerService Erforderlich. Die dem Servicetest zugeordnete Testdefinition.

    Datentyp: Objekt

    "relatedService": {
     "href": "String",
     "id": "String",
     "name": "String"
    }
    relatedService.href Hyperlink-Verweis auf den zugehörigen Service.

    Datentyp: Zeichenfolge

    relatedService.id Sys_id oder external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge

    relatedService.name Name des Produktbestandsartikels.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Staat Status, in dem sich der Servicetest befindet.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    testMeasure Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus.

    Datentyp: Array von Objekten

    "testMeasure": [
     {
     "accuracy": "String",
     "captureDateTime": "String",
     "captureMethod": "String",
     "id": "String",
     "metricDescription": "String",
     "metricName": "String",
     "ruleViolation": [Array],
     "unitOfMeasure": "String",
     "value": {Object}
     }
    ]
    testMeasure.accuracy Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt.

    Datentyp: Zahl

    Höchstwert: 40

    testMessen.ErfassungsdatumZeit Datum und Uhrzeit der Erfassung der Metrik.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasure.id Sys_id oder external_id der Testmaße. Befindet sich in den Feldern „sys_id“ oder „external_id“ der Tabelle „Testmaße“ [sn_st_mgmt_test_measure].

    Datentyp: Zeichenfolge

    testMessen.Messen.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMeasure.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasure.metricName Name der Testmaßmetrik.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung Ein Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn ein Verstoß gegen die Regel vorliegt.

    Datentyp: Array von Objekten

    "ruleViolation"[
      {
        appliedConsequence: [Array],
        conformanceTargetUpper: Number,
        conformanceComparatorUpper: "String",
        description: "String",
        id: "String",
        name: "String",
        numberOfAllowedCrossing: Number,
        thresholdRuleSeverity: "String",
        tolerancePeriod: "String"
      }
    ]
    testMessung.regelVerstoß.angewendeteKonsequenz Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird.

    Datentyp: Array von Objekten

    "appliedConsequence": [
     {
      "appliedAction": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "repeatAction": Boolean
     }
    ]
    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung Beschreibung der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.id Sys_id oder external_id der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.name Name der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.AngewendeteKonsequenz.Wiederholungsaktion Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt.

    Gültige Werte:

    • „wahr“: Wiederholen Sie die Aktion.
    • „falsch“: Aktion erneut wiederholen.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComporatorExact Kennzeichnung, die angibt, ob ein Wert identisch ist.
    Gültige Werte:
    • wahr: Der Wert ist identisch.
    • „falsch“: Der Wert ist nicht identisch.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComporatorLower Operator, mit dem überprüft wird, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceComporatorUpper Operator, mit dem überprüft wird, ob ein Wert über dem Schwellenwert liegt.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMessung.regelVerletzung.beschreibung Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Befindet sich in der Tabelle „Schwellenwertregelverstoß“ [sn_st_mgmt_threshold_rule_violation].

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.ruleViolation.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Toleranzzeitraum Angegebenes Zeitintervall, während dessen Überschreitungsereignisse aktiviert sind, ohne unmittelbare Konsequenzen oder Aktionen auszulösen.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMessung.RegelVerstoß.Toleranzzeitraum.Betrag Die Anzahl der Zeiträume vor Anwendung der Konsequenz.

    Datentyp: Zahl

    testMessung.regelVerletzung.toleranzzeitraum.einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasure.messageeinheit Gibt die Maßeinheit für die Konformitätszielwerte der Testmaßnahme an.

    Datentyp: Zeichenfolge

    testMeasure.value Der Wert der Testmaßnahme.

    Datentyp: Objekt

    "value": {
     "id": "String",
     "name": "String",
     "valueType": "String",
     "value": "String
    }
    testMeasure.value.id Die ID des Testmaßwerts.

    Datentyp: Zeichenfolge

    testMeasure.value.name Der Name des Testmaßwerts.

    Datentyp: Zeichenfolge

    testMeasure.value.value Der Wert der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMessung.Wert.WertTyp Der Typ des Testmaßwerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    testSpecification Erforderlich. Die Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "testSpecification": {
     "id": "String",
     "href": "String"
    }
    testSpecification.href Hyperlink-Verweis auf die Servicetestdefinition.

    Datentyp: Zeichenfolge

    testSpecification.id Die sys_id oder external_id der Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    validFor.endDateTime Gültigkeitsenddatum des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Gültigkeitsstartdatum des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 41. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json

    Tabelle : 42. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 43. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Merkmal Liste, die die Merkmale des zugehörigen Servicetests beschreibt.

    Datentyp: Array von Objekten

    "characteristic": [
     {
      "id": "String",
      "name": "String",
      "value": "String",
      "valueType": "String"
     }
    ]
    Merkmal.ID Sys_id oder external_id der Merkmale. Befindet sich in der Tabelle „Merkmale“ [sn_prd_pm_charakteristik]. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“.

    Datentyp: Zeichenfolge

    Merkmal.Name Name des Merkmals.

    Datentyp: Zeichenfolge

    Merkmal.Wert Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz.

    Datentyp: Zeichenfolge

    merkmal.wertTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    Modus Modus, in dem der Servicetest ausgeführt wird.
    Gültige Werte:
    • ONDEMAND: Löst den Servicetest manuell aus.
    • PROAKTIV: Löst den Servicetest automatisch aus.

    Standard: ONDEMAND

    name Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigerService Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
      "href": "string",
      "id": "String",
      "name": "String"
    }
    ZugehörigerService.id Sys_id oder external_id des Produktbestands. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge

    ZugehörigerService.name Name des Produktbestands.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Staat Status des Servicetests.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt
    testMeasure Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "accuracy": "String",
      "captureDateTime": "String",
      "captureMethod": "String",
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "ruleViolation": [Array]
      "unitOfMeasure": "String",
      "value": {Object}
     }
    ]
    testMeasure.accuracy Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt.

    Datentyp: Zahl

    Höchstwert: 40

    testMessen.ErfassungsdatumZeit Datum und Uhrzeit der Erfassung der Metrik.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMessen.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMeasure.id Sys_id oder external_id der Testmaßnahme. Befindet sich in der Tabelle mit den Testmaßen [sn_st_mgmt_test_measure].

    Datentyp: Zeichenfolge

    testMeasure.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasure.metricName Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn die Regel verletzt wird.

    Datentyp: Array von Objekten

    "RuleViolation": [
    {
      "appliedConsequence": [Array],
      "conformanceComparatorExact": Boolean,
      "conformanceComparatorLower": "String",
      "conformanceComparatorUpper": "String",
      "conformanceTargetExact": "String",
      "conformanceTargetLower": "String",
      "conformanceTargetUpper": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "numberOfAllowedCrossing": Number,
      "thresholdRuleSeverity": "String",
      "tolerancePeriod": {Object}
     }
    ]
    testMessung.regelVerstoß.angewendeteKonsequenz Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird.

    Datentyp: Array von Objekten

    "appliedConsequence": [
     {
      "appliedAction": "String",
      "description": "String",
      "id": "String",
      "name": "String",
      "repeatAction": Boolean
     }
    ]
    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion.Wiederholungsaktion Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung Beschreibung der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.id Sys_id oder external_id der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.angewendeteKonsequenz.name Name der angewendeten Konsequenz.

    Datentyp: Zeichenfolge

    testMessen.regelVerletzung.konformerVergleichGenau Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist.
    Gültige Werte:
    • wahr: Der Wert ist identisch.
    • „falsch“: Der Wert ist nicht identisch.

    Datentyp: Boolesch

    Standardwert: false

    testMeasure.ruleViolation.conformanceComparatorLower Ein Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceCvergleichUpper Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • ist
    • kleiner als

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird.

    Datentyp: Zahl

    testMessung.regelVerletzung.beschreibung Beschreibung des Verstoßes gegen die Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMessung.regelVerletzung.id Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Befindet sich in der Tabelle „Schwellenwertregelverstoß“ [sn_st_mgmt_threshold_rule_violation].

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Name Name des Verstoßes gegen die Schwellenwertregel.

    Datumstyp: Zeichenfolge

    testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Maximum: 40

    testMeasure.ruleViolation.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    testMessung.RegelVerstoß.Toleranzzeitraum Dauer oder Zeitintervall, in der zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMessung.RegelVerstoß.Toleranzzeitraum.Betrag Betrag des Zeitraums als Nummer.

    Datentyp: Zahl

    testMessung.regelVerletzung.toleranzzeitraum.einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasure.messageeinheit Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasure.value Wert der Metrik im Test.

    Datentyp: Objekt

    "value": {
      "id": "String",
      "name": "String",
      "valueType": "String",
      "value": "String"
    }
    testMeasure.value.id ID des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.Name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.Name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMeasure.value.value Wert der Metrik im Test.

    Datentyp: Zeichenfolge

    testMessung.Wert.WertTyp Der Typ des Testmaßwerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    testSpecification Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "testSpecification": {
      "href": "String",
      "id": "String"
    }
    testSpecification.href Hyperlink-Verweis auf die Servicetestdefinition.

    Datentyp: Zeichenfolge

    testSpecification.id Sys_id oder external_id der Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
      "startDateTime": "String",
      "endDateTime": "String"
    }
    validFor.endDateTime Enddatum und -zeitstempel des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Startdatum und -zeitstempel des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel wird ein neuer Servicetest gemäß den im Anforderungstext angegebenen Details erstellt.

    curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data {
      "description": "Service test",
      "endDateTime": "2025-01-31 15:05:43",
      "mode": "proactive",
      "name": "Speed Test TR0001002",
      "startDateTime": "2024-06-05 09:07:10",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "relatedService": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "name": "Internet_VPLS_PI0000011"
      },
      "testSpecification": {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
        "id": "76a3b160432a02104fefe4511fb8f2ad"
      },
      "characteristic": [
        {
          "id": "e7ef960443f202104fefe4511fb8f224",
          "name": "AccessRequired",
          "valueType": "yes_no",
          "value": "Yes"
        }
      ],
      "testMeasure": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2e",
          "accuracy": "0.0001",
          "captureDateTime": "",
          "captureMethod": "automatic",
          "metricDescription": "",
          "metricName": "Flow speed",
          "unitOfMeasure": "A second",
          "value": "3000",
          "ruleViolation": [
            {
              "id": "61d1382e3be28210d140068aa4e45a2f",
              "description": "This speed is greater than the target",
              "name": "tooMuchTraffic",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "",
              "conformanceTargetLower": "2500",
              "conformanceComparatorLower": "greater than",
              "appliedConsequence": [
                {
                  "id": "65d1382e3be28210d140068aa4e45a31",
                  "appliedAction": "sendWarning",
                  "description": "send a warning to the system",
                  "name": "sendWarning",
                  "repeatAction": "0"
                }
              ]
            }
          ]
        }
      ]
    }

    Die Antwort gibt Bestätigungsdetails zum neuen Testservice zurück und weist ihm eine eindeutige ID zu: 2b406ec043b202104fefe4511fb8f211:

    {
      "description": "Service test",
      "endDateTime": "2025-01-31 15:05:43",
      "mode": "proactive",
      "name": "Speed Test TR0001002",
      "startDateTime": "2024-06-05 09:07:10",
      "validFor": {
        "startDateTime": "",
        "endDateTime": ""
      },
      "relatedService": {
        "id": "fa6d13f45b5620102dff5e92dc81c77f",
        "name": "Internet_VPLS_PI0000011"
      },
      "testSpecification": {
        "href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
        "id": "76a3b160432a02104fefe4511fb8f2ad"
      },
      "characteristic": [
        {
          "id": "e7ef960443f202104fefe4511fb8f224",
          "name": "AccessRequired",
          "valueType": "yes_no",
          "value": "Yes"
        }
      ],
      "testMeasure": [
        {
          "id": "61d1382e3be28210d140068aa4e45a2e",
          "accuracy": "0.0001",
          "captureDateTime": "",
          "captureMethod": "automatic",
          "metricDescription": "",
          "metricName": "Flow speed",
          "unitOfMeasure": "A second",
          "value": "3000",
          "ruleViolation": [
            {
              "id": "61d1382e3be28210d140068aa4e45a2f",
              "description": "This speed is greater than the target",
              "name": "tooMuchTraffic",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "",
              "conformanceTargetLower": "2500",
              "conformanceComparatorLower": "greater than",
              "appliedConsequence": [
                {
                  "id": "65d1382e3be28210d140068aa4e45a31",
                  "appliedAction": "sendWarning",
                  "description": "send a warning to the system",
                  "name": "sendWarning",
                  "repeatAction": "0"
                }
              ]
            }
          ]
        }
      ],
      "id": "2b406ec043b202104fefe4511fb8f211"
    }

    Service Test Management Open API – POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

    Erstellt eine neue Servicetestdefinition.

    URL-Format

    Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification

    Unterstützte Anforderungsparameter

    Tabelle : 44. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 45. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 46. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    id Sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigeServiceSpecification Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id Sys_id oder external_id der Servicespezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    Datentyp: Zeichenfolge

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship Die zugehörige Servicetestdefinition.

    Datentyp: Array von Objekten

    "serviceTestSpecRelationship": [
    {
      "id": "String",
      "name": "String",
      "relationshipType": "String"
     }
    ]
    serviceTestSpecRelationship.id Sys_id oder external_id der zugehörigen Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.Beziehungstyp Typ der Beziehung.
    Akzeptierte Werte:
    • Ersatz
    • Abhängigkeit
    • Ausschließlichkeit

    Datentyp: Zeichenfolge

    specCharacterificent Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacterific.characteristValueSpecification Array mit den möglichen Werten für das Merkmal.

    Datentyp: Array von Objekten

    "characteristicValueSpecification": [
      {
        "value": "String"
      }
    ]
    specCharacterific.characteristValueSpecification.value Wert des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Beschreibung Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

    specCharacterific.validFor Datumsbereich, für den das Merkmal gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    specCharacterific.validFor.endDateTime Enddatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    specCharacterific.validFor.startDateTime Startdatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Spezifisches Merkmal.WerteTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    testMeasureDefinition Testmaßdefinitionen für diese Servicetestdefinition. Weitere Informationen finden Sie unter Define test measure definitions for a service test.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "captureFrequency": "String",
      "captureMethod": "String",
      "capturePeriod": {Object},
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "name": "String",
      "unitOfMeasure": "String",
      "thresholdRule": [Array],
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    testMeasureDefinition.captureFrequency Die Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

    • Keine
    • einmal
    • täglich
    • wöchentlich
    • monatlich

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • automatisch: Erfasst die Metrik automatisch.
    • manual: Erfasst die Metrik manuell.
    • keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungszeitraum Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

    "capturePeriod": {
      "amount": Number,
      "units": "String"
    }
    testMessdefinition.Erfassungszeitraum.Betrag Anzahl der Erfassungszeiträume.

    Datentyp: Zahl

    testMessdefinition.Erfassungszeitraum.Einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id Sys_id oder external_id der Testmaßdefinitionen. Befindet sich in der Tabelle „Testmaßdefinition“ [sn_st_mgmt_test_measure_definition].

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricName Benutzerdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition.

    Datentyp: Array von Objekten

    {
      "thresholdRule": {
        "consequence": Array,
        "conformanceComparatorExact": Boolean,
        "conformanceComparatorLower": "String",
        "conformanceComparatorUpper": "String",
        "conformanceTargetExact": "String",
        "conformanceTargetLower": "String",
        "conformanceTargetUpper": "String",
        "consequence": Array,
        "description": "String",
        "id": "String",
        "name": "String",
        "numberOfAllowedCrossing": Number,
        "thresholdRuleSeverity": "String",
        "tolerancePeriod": Object
      }
    }
    testMeasureDefinition.thresholdRule.conformanceCvergleichExact Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich.
    Gültige Werte:
    • wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • false: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.conformanceCvergleichLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • größer als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceCvergleichUpper Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.consequence Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules.

    Datentyp: Array von Objekten

    "consequence": [
     {
      "description": "String",
      "id": "String",
      "name": "String",
      "prescribeAction": "String",
      "repeatAction": Boolean,
      "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
     }
    ]
    testMeasureDefinition.thresholdRule.consequence.description Beschreibung der Konsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.id Sys_id oder external_id der Messkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.prescribeAction Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.repeatAction Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.consequence.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime Gültigkeitsenddatum der Konsequenz

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id Sys_id oder external_id der Schwellenwertregeln. Zu finden im Feld „Befindet sich in sys_id“ oder „external_id“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Höchstwert: 40

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    testMeasureDefinition.unitOfMeasure Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Zeichenfolge

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    testMeasureDefinition.validFor.endDateTime Gültigkeitsenddatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor.startDateTime Gültigkeitsstartdatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den die Testdefinition gültig ist.

    Datentyp: Objekt

    "validFor": {
     "endDateTime": "String",
     "startDateTime": "String"
    }
    validFor.endDateTime Datum und Uhrzeit der Testdefinition, zu der der Status der Testdefinition stillgelegt wird.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Datum und Uhrzeit der Testdefinition, zu der ihr Status veröffentlicht wird.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

    Tabelle : 47. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 48. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur application/json.

    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 49. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    id Die sys_id oder external_id der Servicetestdefinition. Befindet sich in der Tabelle „Servicetest“ [sn_st_mgmt_test].

    Datentyp: Zeichenfolge

    name Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigeServiceSpecification Servicespezifikationen für die Testdefinitionen.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
     {
      "id": "String",
      "name": "String"
     }
    ]
    ZugehörigeServiceSpezifikation.ID Die sys_id oder external_id der Servicespezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    Datentyp: Zeichenfolge

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

    serviceTestSpecRelationship Zugehörige Servicetestdefinition.

    Datentyp: Array von Objekten

    "serviceTestSpecRelationship": [
     {
      "id": "String",
      "name": "String",
      "relationshipType": "String"
     }
    ]
    serviceTestSpecBeziehung.id Sys_id oder external_id der zugehörigen Servicetestdefinition. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    serviceTestSpecBeziehung.Beziehungstyp Typ der Beziehung.
    Akzeptierte Werte:
    • Ersatz
    • Abhängigkeit
    • Ausschließlichkeit

    Datentyp: Zeichenfolge

    specCharacterificent Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": Array,
      "description": "String",
      "name": "String",
      "validFor": Object,
      "valueType": "String"
     }
    ]
    specCharacterific.characteristValueSpecification Array mit den möglichen Werten für das Merkmal.

    Datentyp: Array von Objekten

    "characteristicValueSpecification": [
     {
      "value": "String"
     }
    ]
    specCharacterific.characteristValueSpecification.value Wert des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Beschreibung Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    Spez. Merkmal. Name Name des Merkmals.

    Datentyp: Zeichenfolge

    specCharacterific.validFor Datumsbereich, für den das Merkmal gültig ist.

    Datentyp: Objekt

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    specCharacterific.validFor.endDateTime Enddatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    specCharacterific.validFor.startDateTime Startdatum des Merkmals.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    Spezifisches Merkmal.WerteTyp Typ des Merkmalswerts.
    • ja/nein
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test

    Datentyp: Zeichenfolge

    testMeasureDefinition Testmaßdefinitionen für diese Servicetestdefinition. Weitere Informationen finden Sie unter Define test measure definitions for a service test.

    Datentyp: Array von Objekten

    "testMeasureDefinition": [
     {
      "captureFrequency": "String",
      "captureMethod": "String",
      "capturePeriod": {Object},
      "id": "String",
      "metricDescription": "String",
      "metricName": "String",
      "name": "String",
      "unitOfMeasure": "String",
      "thresholdRule": [Array],
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    testMeasureDefinition.captureFrequency Die Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

    • täglich
    • monatlich
    • Keine
    • einmal
    • wöchentlich

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungsmethode Methode zum Erfassen der Metrik.

    Gültige Werte:

    • manual: Erfasst die Metrik manuell.
    • automatisch: Erfasst die Metrik automatisch.
    • keine: Metrik wird nicht erfasst.

    Datentyp: Zeichenfolge

    testMessDefinition.Erfassungszeitraum Eine Dauer oder ein Zeitraum der Erfassung.

    Datentyp: Objekt

    "capturePeriod": {
      "amount": Number,
      "units": "String"
    }
    testMessdefinition.Erfassungszeitraum.Betrag Anzahl der Erfassungszeiträume.

    Datentyp: Zahl

    testMessdefinition.Erfassungszeitraum.Einheiten Einheiten des Zeitraums.
    Akzeptierte Werte:
    • seconds
    • Minuten
    • Tage
    • Stunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id Sys_id oder external_id der Testmaßdefinitionen. Befindet sich in der Tabelle „Testmaßdefinition“ [sn_st_mgmt_test_measure_definition].

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricDescription Kurzbeschreibung der Metrik.

    Datentyp: Zeichenfolge

    testMeasureDefinition.metricName Benutzerdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule Regel, die die Bedingung (erhöhen oder löschen) definiert, die erfüllt sein muss, um Konsequenzen anzuwenden, wenn ein Schwellenwert für eine bestimmte Testmaßdefinition überschritten wird oder nicht mehr überschritten wird​.

    Datentyp: Array von Objekten

    {
      "thresholdRule": {
        "conformanceComparatorExact": Boolean,
        "conformanceComparatorLower": "String",
        "conformanceComparatorUpper": "String",
        "conformanceTargetExact": "String",
        "conformanceTargetLower": "String",
        "conformanceTargetUpper": "String",
        "consequence": Array,
        "description": "String",
        "id": "String",
        "name": "String",
        "numberOfAllowedCrossing": Number,
        "thresholdRuleSeverity": "String",
        "tolerancePeriod": Object
      }
    }
    testMeasureDefinition.thresholdRule.conformanceCvergleichExact Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist.
    Gültige Werte:
    • wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • false: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.conformanceCvergleichLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceCvergleichUpper Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • kleiner als
    • ist

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    testMeasureDefinition.thresholdRule.consequence Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird.

    Datentyp: Array von Objekten

    "consequence": [
     {
      "description": "String",
      "id": "String",
      "name": "String",
      "prescribeAction": "String",
      "repeatAction": Boolean,
      "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
     }
    ]
    testMeasureDefinition.thresholdRule.consequence.description Beschreibung der Konsequenz.

    Datentyp: Zeichenfolge

    testMessgrößenDefinition.thresholdRule.consequence.id Sys_id oder external_id der Messkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.prescribeAction Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.repeatAction Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.

    Gültige Werte:

    • true: Wiederholt die Aktion.
    • „falsch“: Wiederholt die Aktion nicht.

    Datentyp: Boolesch

    Standardwert: false

    testMeasureDefinition.thresholdRule.consequence.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime Gültigkeitsenddatum der Konsequenz

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id Sys_id oder external_id der Schwellenwertregeln. Befindet sich in der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    Datentyp: Zeichenfolge

    testMessgrößenDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasureDefinition.thresholdRule.thresholdRuleSeverity Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    testMeasureDefinition.unitOfMeasure Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime": "String"
    }
    testMeasureDefinition.validFor.endDateTime Gültigkeitsenddatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    testMeasureDefinition.validFor.startDateTime Gültigkeitsstartdatum der Testmaßdefinition.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor Datumsbereich, für den der Servicetest gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    validFor.endDateTime Enddatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    validFor.startDateTime Startdatum und -uhrzeit des Servicetests.

    Format: JJJJ-MM-TT 00:00:00. Beispiel: 2025-01-31 09:35:43.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Im folgenden Beispiel wird eine neue Servicetestdefinition erstellt.

    curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --user 'username':'password'
    -- data {
      "description": "Upstream and Downstream speed ",
      "name": "Speed Test",
      "validFor": {
        "startDateTime": "2024-05-31",
        "endDateTime": "2024-06-27"
      },
      "testMeasureDefinition": [
        {
          "id": "1a04f560432a02104fefe4511fb8f2ad",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the downstream speed in a service",
          "metricName": "Downstream Speed",
          "name": "Downstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "30 Minutes",
          "validFor": {
            "startDateTime": "2024-05-30 08:49:26",
            "endDateTime": "2024-05-31 08:49:29"
          },
          "thresholdRule": [
            {
              "id": "a754f960432a02104fefe4511fb8f2d0",
              "description": "This speed is greater than the target upper",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "15 Minutes",
              "conformanceTargetLower": "75",
              "conformanceComparatorLower": "greater than",
              "consequence": [
                {
                  "id": "15a4bd60432a02104fefe4511fb8f2b8",
                  "prescribeAction": "null",
                  "description": "generate a waring report",
                  "name": "degradedQualityOfService",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:51:29",
                    "endDateTime": "2024-08-06 08:51:31"
                  }
                },
                {
                  "id": "e6847d60432a02104fefe4511fb8f2c3",
                  "prescribeAction": "null",
                  "description": "send a warning to the system",
                  "name": "packetdrop",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:50:53",
                    "endDateTime": "2024-08-06 08:50:55"
                  }
                }
              ]
            },
            {
              "id": "cb55b5a0432a02104fefe4511fb8f201",
              "description": "",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "medium",
              "tolerancePeriod": "",
              "conformanceTargetUpper": "120",
              "conformanceComparatorUpper": "less than",
              "consequence": []
            }
          ]
        },
        {
          "id": "8f987524432a02104fefe4511fb8f2f0",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the upstream speed in the service",
          "metricName": "Upstream Speed",
          "name": "Upstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          },
          "thresholdRule": []
        }
      ],
      "specCharacteristic": [
        {
          "name": "restart",
          "description": "restart",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2024-05-30 08:45:49"
          },
          "characteristicValueSpecification": [
            {
              "value": "No",
            },
            {
              "value": "Yes",
            }
          ]
        }
      ],
      "serviceTestSpecRelationship": [
        {
          "id": "76a3b160432a02104fefe4511fb8f2ad",
          "name": "OAM Test",
          "relationshipType": ""
        }
      ],
      "relatedServiceSpecification": [
        {
          "id": "aeddcd1fb7d69910ff00f203ae11a990",
          "name": "Home Internet"
        }
      ]
    }

    Antworttext.

    {
      "description": "Upstream and Downstream speed ",  
      "name": "Speed Test",
      "validFor": {
        "startDateTime": "2024-05-31",
        "endDateTime": "2024-06-27"
      },
      "testMeasureDefinition": [
        {
          "id": "1a04f560432a02104fefe4511fb8f2ad",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the downstream speed in a service",
          "metricName": "Downstream Speed",
          "name": "Downstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "30 Minutes",
          "validFor": {
            "startDateTime": "2024-05-30 08:49:26",
            "endDateTime": "2024-05-31 08:49:29"
          },
          "thresholdRule": [
            {
              "id": "a754f960432a02104fefe4511fb8f2d0",
              "description": "This speed is greater than the target upper",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "high",
              "tolerancePeriod": "15 Minutes",
              "conformanceTargetLower": "75",
              "conformanceComparatorLower": "greater than",
              "consequence": [
                {
                  "id": "15a4bd60432a02104fefe4511fb8f2b8",
                  "prescribeAction": "null",
                  "description": "generate a waring report",
                  "name": "degradedQualityOfService",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:51:29",
                    "endDateTime": "2024-08-06 08:51:31"
                  }
                },
                {
                  "id": "e6847d60432a02104fefe4511fb8f2c3",
                  "prescribeAction": "null",
                  "description": "send a warning to the system",
                  "name": "packetdrop",
                  "repeatAction": "0",
                  "validFor": {
                    "startDateTime": "2024-05-30 08:50:53",
                    "endDateTime": "2024-08-06 08:50:55"
                  }
                }
              ]
            },
            {
              "id": "cb55b5a0432a02104fefe4511fb8f201",
              "description": "",
              "name": "InternetSpeedValue",
              "numberOfAllowedCrossing": "0",
              "thresholdRuleSeverity": "medium",
              "tolerancePeriod": "",
              "conformanceTargetUpper": "120",
              "conformanceComparatorUpper": "less than",
              "consequence": []
            }
          ]
        },
        {
          "id": "8f987524432a02104fefe4511fb8f2f0",
          "captureFrequency": "once",
          "captureMethod": "automatic",
          "metricDescription": "This is the upstream speed in the service",
          "metricName": "Upstream Speed",
          "name": "Upstream Speed",
          "unitOfMeasure": "a second",
          "valueType": "",
          "capturePeriod": "",
          "validFor": {
            "startDateTime": "",
            "endDateTime": ""
          },
          "thresholdRule": []
        }
      ],
      "specCharacteristic": [
        {
          "name": "restart",
          "description": "restart",
          "valueType": "yes_no",
          "validFor": {
            "startDatetime": "2024-05-30 08:45:49"
          },
          "characteristicValueSpecification": [
            {
              "value": "No",
              "validFor": {
                "startDateTime": "",
                "endDateTime": ""
              }
            },
            {
              "value": "Yes",
              "validFor": {
                "startDateTime": "",
                "endDateTime": ""
              }
            }
          ]
        }
      ],
      "serviceTestSpecRelationship": [
        {
          "id": "76a3b160432a02104fefe4511fb8f2ad",
          "name": "OAM Test",
          "relationshipType": ""
        }
      ],
      "relatedServiceSpecification": [
        {
          "id": "aeddcd1fb7d69910ff00f203ae11a990",
          "name": "Home Internet"
        }
      ]
      "id": "89d2b920432a02104fefe4511fb8f22e"
    }