Servicetestmanagement – offene API

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 73 Minuten Lesedauer
  • Die Servicetestmanagement Offen Die API stellt Endpunkte zum Erstellen und Abrufen von Servicetestdefinitionen und Servicetests bereit.

    Verwenden Sie diese API, um Service Problem Management-Informationen zwischen externen Systemen und zu verwalten Now Platform. Die Servicetestmanagement Offen API ist ein ServiceNowImplementierung der REST-Spezifikation der TM-Forumsservice-Problemmanagement-API. Diese Implementierung basiert auf https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/ .

    Diese REST-API wurde entwickelt, um Servicetests in einer Telekommunikationsumgebung zu verwalten und auszuführen. Anwender können Servicetests definieren, auslösen und überwachen, um sicherzustellen, dass Services Qualitäts- und Leistungsstandards erfüllen. Die API bietet Funktionen für das Testmanagement, einschließlich Erstellen und Aktualisieren von Testdefinitionen, Ausführen von Tests, Abrufen von Testergebnissen und Verwaltung von Testzeitplänen.

    Die Servicetestmanagement Offen API erfordert das Plugin „Kundenservice-Problemmanagement“ (com.sn_sprb_mgmt) und die Rolle „sn_sprb_mgmt.test_integrator“. Diese API gehört zum Namespace sn_sprb_mgmt. Für weitere Informationen zum Serviceproblem-Management. Siehe Customer Service Problem ManagementUm weitere Informationen zu dieser Anwendung zu erhalten.

    Die Servicetestmanagement Offen 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_characteristic]
    • Testmerkmal [sn_st_mgmt_test_characteristic]
    • Beziehung von Spezifikation zu Testdefinition [sn_st_mgmt_test_definition_m2m]
    • Testdefinitionsbeziehung [sn_st_mgmt_test_definition_rel]
    • Testmaßnahme [sn_st_mgmt_test_measure]
    • Messkonsequenz [sn_st_mgmt_measure_consequence]
    • Testmaßdefinition [sn_st_mgmt_test_measure_definition]
    • Angewendete Konsequenz [sn_st_mgmt_applied_consequence]
    • Schwellenwertregel [sn_st_mgmt_threshold_rule]
    • Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    Servicetestmanagement – offene API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest AB

    Ruft eine Liste aller Servicetests ab.

    URL-Format

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

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    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örigService
    • startDateTime
    • Staat
    • Testmessung
    • Testspezifikation
    • ValidiertFür

    Datentyp: Zeichenfolge

    limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Datentyp: Zahl

    Höchstwert: 100

    Standard: 20

    Offset Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Parameter, um Ergebnisse in kleinen und verwaltbaren Blöcken zu paginieren. Der erste Datensatz wird bei 0 indiziert.

    Datentyp: Zahl

    Standard: 0

    status Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. Nur Testdefinitionen im angegebenen Status werden in der Antwort zurückgegeben.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • Abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 5. Antwort-Header
    Header Beschreibung
    Inhaltsbereich Gibt den Bereich der Inhalte an, die in einem paginierten Aufruf zurückgegeben werden.

    Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert des Inhaltsbereichs-Headers ist Elemente 3-5 .

    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur Anwendung/JSON.
    Verknüpfen 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    206 In Antwort zurückgegebene Teilressource (mit Paginierung).
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    Tabelle : 7. Antworttext-Parameter (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 von Merkmalen. Wenn „external_ID“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_ID“ zurück, andernfalls wird die sys_ID zurückgegeben

    Datentyp: Zeichenfolge

    Tabelle: Merkmale [sn_prd_pm_characteristic]

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Merkmal.WertTyp Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    href Hyperlink-Verweis auf den Servicetest.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    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.

    Datentyp: Zeichenfolge

    Standard: ONDEMAND

    name Erforderlich. Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigService Erforderlich. Testdefinition, die dem Servicetest zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
     "href": "String",
     "id": "String",
     "name": "String"
    }
    relatedService.id SYS_ID oder external_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    relatedService.name Name des Produktbestands.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    Testmessung Maß für einen bestimmten Aspekt 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}
     }
    ]
    Testmaß.Genauigkeit Float-Dezimalwert, der die Genauigkeit der Testmessung darstellt, die für die zugehörigen Metriken erfasst wurde.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.captureDateTime Datum und Uhrzeit der Erfassung der Metrik.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasure.id SYS_ID oder external_ID der Testmaßnahmen.

    Datentyp: Zeichenfolge

    Tabelle: In den Feldern „sys_ID“ oder „external_ID“ der Tabelle „Testmaßnahmen“ [sn_st_mgmt_test_measure].

    testMeasure.Measure.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    TestMeasure.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasure.metricName Name der Testmaßmetrik.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation Ein Objekt zum Definieren einer Regel in der Schwellenwertregeldefinition, zusammen mit Konsequenzen, wenn die Regel verletzt wird.

    Datentyp: Array von Objekten

    "ruleViolation"[
      {
        appliedConsequence: [Array],
        conformanceTargetUpper: Number,
        conformanceComparatorUpper: "String",
        description: "String",
        id: "String",
        name: "String",
        numberOfAllowedCrossing: Number,
        thresholdRuleSeverity: "String",
        tolerancePeriod: "String"
      }
    ]
    testMeasure.ruleViolation.tolerancePeriod.amount Anzahl der Zeiträume, bevor die Konsequenz angewendet wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.appliedConsequence 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.ruleViolation.appliedConsequence.appliedAction Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispiel: Senden einer Warnung oder Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.description 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

    testMeasure.ruleViolation.appliedConsequence.repeatAction Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt.

    Gültige Werte:

    • Wahr: Wiederholen Sie die Aktion.
    • Falsch: Wiederholen Sie die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    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: Boolescher Wert

    Standard: Falsch

    testMeasure.ruleViolation.conformanceComporatorLower Operator zum Überprüfen, 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 zum Überprüfen, ob ein Wert über dem Schwellenwert liegt.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

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

    Datentyp: Zahl

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

    Datentyp: Zahl

    testMeasure.ruleViolation.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id SYS_ID oder external_ID des Schwellenwertregelverstoßes.

    Datentyp: Zeichenfolge

    Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    testMeasure.ruleViolation.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.numberOfAllowedCrossing 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

    testMeasure.ruleViolation.tolerancePeriod Angegebenes Zeitintervall, in dem das Überschreiten von Vorkommen aktiviert wird, ohne unmittelbare Konsequenzen oder Aktionen auszulösen.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMeasure.ruleViolation.tolerancePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    Testmaß.EinheitenMessung Maßeinheit für die Konformitätszielwerte der Testmessung.

    Datentyp: Zeichenfolge

    TestMeasure.value Wert der Testmaßnahme.

    Datentyp: Objekt

    "value": {
     "id": "String",
     "name": "String",
     "valueType": "String",
     "value": "String
    }
    testMeasure.value.id ID des Testmesswerts.

    Datentyp: Zeichenfolge

    testMeasure.value.name Name des Testmesswerts.

    Datentyp: Zeichenfolge

    TestMeasure.value.value Wert der Testmaßnahme.

    Datentyp: Zeichenfolge

    TestMeasure.Wert.WertTyp Typ des Testmesswerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    Testspezifikation Erforderlich. 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.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Gültigkeitsstartdatum des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Das folgende Beispiel ruft Informationen zu den beiden Servicetests in der Instanz ab.

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

    Servicetestmanagement – offene API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{ID} ab

    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. Pfad-Parameter
    Name Beschreibung
    id SYS_ID oder external_ID des abzurufenden Servicetests.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    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örigService
    • startDateTime
    • Staat
    • Testmessung
    • Testspezifikation
    • ValidiertFür

    Datentyp: Zeichenfolge

    Tabelle : 10. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 11. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 12. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur Anwendung/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 REST-API-HTTP-Antwortcodes .

    Tabelle : 13. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Antworttext-Parameter (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 von Merkmalen.wenn external_ID für diesen Datensatz vorhanden ist, gibt die Antwort die external_ID zurück, andernfalls wird die sys_ID zurückgegeben

    Datentyp: Zeichenfolge

    Tabelle: Merkmale [sn_prd_pm_characteristic]

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Merkmal.WertTyp Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    href Hyperlink-Verweis auf den Servicetest.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    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.

    Datentyp: Zeichenfolge

    Standard: ONDEMAND

    name Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigService Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
     "href": "String",
     "id": "String",
     "name": "String"
    }
    RelatedService.ID SYS_ID oder external_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    relatedService.name Name des Produktbestandsartikels.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Staat Status des Servicetests.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • Abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    Testmessung Maß für einen bestimmten Aspekt 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}
     }
    ]
    Testmaß.Genauigkeit Float-Dezimalwert, der die Genauigkeit der Testmessung darstellt, die für die zugehörigen Metriken erfasst wurde.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.captureDateTime Datum und Uhrzeit der Erfassung der Metrik.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasure.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    TestMeasure.ID SYS_ID oder external_ID der Testmaßnahme.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßnahmen [sn_st_mgmt_test_measure]

    TestMeasure.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation Objekt zum Definieren einer Regel in der Schwellenwertregeldefinition, zusammen mit 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}
     }
    ]
    testMeasure.ruleViolation.appliedConsequence 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.ruleViolation.appliedConsequence.appliedAction Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispiel: Senden einer Warnung oder Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    testMeasure.ruleViolation.appliedConsequence.description 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

    testMeasure.ruleViolation.conformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact.
    Gültige Werte:
    • Wahr: Der Wert ist identisch.
    • Falsch: Der Wert ist nicht identisch.

    Datentyp: Boolescher Wert

    Standard: Falsch

    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.conformanceComparatorUpper Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • ist
    • Kleiner als

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

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

    Datentyp: Zahl

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

    Datentyp: Zahl

    testMeasure.ruleViolation.description Beschreibung des Verstoßes gegen die Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id SYS_ID oder external_ID des Schwellenwertregelverstoßes.

    Datentyp: Zeichenfolge

    Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    testMeasure.ruleViolation.name Name des Verstoßes gegen die Schwellenwertregel.

    Datumstyp: Zeichenfolge

    testMeasure.ruleViolation.numberOfAllowedCrossing 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

    testMeasure.ruleViolation.tolerancePeriod Dauer oder Zeitintervall, in dem zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMeasure.ruleViolation.tolerancePeriod.amount Betrag des Zeitraums in Zahl.

    Datentyp: Zahl

    testMeasure.ruleViolation.tolerancePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    Testmaß.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    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

    testMeasure.value.name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    TestMeasure.value.value Wert der Metrik im Test.

    Datentyp: Zeichenfolge

    TestMeasure.Wert.WertTyp Typ des Testmesswerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

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

    Datentyp: Objekt

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor.endDateTime Enddatum und Zeitstempel des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Startdatum und Zeitstempel des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Das folgende Beispiel ruft Details zur Servicetestentität ab, 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"
                }
              ]
            }
          ]
        }
      ]
    }

    Servicetestmanagement – offene API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification ab

    Ruft eine Liste aller Servicetestdefinitionen ab.

    URL-Format

    Standard-URL: RUFEN SIE die /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification AB

    Unterstützte Anforderungsparameter

    Tabelle : 14. Pfad-Parameter
    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örigServicespezifikation
    • ServiceTestSpecRelationship
    • Merkmal
    • TestMeasureDefinition
    • ValidiertFür

    Datentyp: Zeichenfolge

    limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Datentyp: Zahl

    Höchstwert: 100

    Standard: 20

    Offset Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Parameter, um Ergebnisse in kleinen und verwaltbaren Blöcken zu paginieren. Der erste Datensatz wird bei 0 indiziert.

    Datentyp: Zahl

    Standard: 0

    status Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. Nur Testdefinitionen im angegebenen Status werden in der Antwort zurückgegeben.

    Gültige Werte:

    • archiviert
    • Entwurf
    • Veröffentlicht
    • Stillgelegt

    Datentyp: Zeichenfolge

    Tabelle : 16. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 17. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Tabelle : 18. Antwort-Header
    Header Beschreibung
    Inhaltsbereich Gibt den Bereich der Inhalte an, die in einem paginierten Aufruf zurückgegeben werden. Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert des Inhaltsbereichs-Headers ist Elemente 3-5 .
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur Anwendung/JSON.
    Verknüpfen 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 19. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    206 In Antwort zurückgegebene Teilressource (mit Paginierung).
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigServicespezifikation Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id SYS_ID oder external_ID der Servicespezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Testdefinition [sn_st_mgmt_test_definition]

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    ServiceTestSpecRelationship.RelationshipType Typ der Beziehung.
    Akzeptierte Werte:
    • Abhängigkeit
    • Exklusivität
    • Ersatz

    Datentyp: Zeichenfolge

    Merkmal Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacteristic.characteristicValueSpecification Mögliche Werte des Merkmals.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    specCharacteristic.description Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

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

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.validFor.startDateTime Startdatum des Merkmals.

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.valueType Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    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

    testMeasureDefinition.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMeasureDefinition.capturePeriod Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

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

    Datentyp: Zahl

    testMeasureDefinition.capturePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id SYS_ID oder external_ID der Testmaßdefinitionen.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßdefinitionstabelle [sn_st_mgmt_test_measure_definition]

    TestMeasureDefinition.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.metricName Anwenderdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel Regel, die Bedingungen definiert, die erreicht werden sollen, bevor Konsequenzen angewendet werden, wenn ein Schwellenwert​in der Testmaßdefinition ü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.threshold.Rule.KonformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem für festgelegten Wert identisch ist testMeasureDefinition.thresholdRule.conformanceTargetExact. Wenn auf „wahr“ festgelegt, testMeasureDefinition.thresholdRule.conformanceTargetExactIst erforderlich.
    Gültige Werte:
    • Wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • Falsch: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorLower 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.threshold.Rule.KonformanceComparatorOber Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceZielLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Regel.Konsequenz 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 Maßkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel.Konsequenz.vorgeschriebenen Aktion Anwenderdefinierte Aktion für Schwellenwertverstöße. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.Konsequenz.wiederholte Aktion Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime Gültigkeitsenddatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id SYS_ID oder external_ID der Schwellenwertregeln.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    TestMeasureDefinition.threshold-Regel.threshold-Regelschweregrad Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    TestMeasureDefinition.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.validFür 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.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidiertFür 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 Definition stillgelegt wird.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Datum und Uhrzeit der Testdefinition, an der der Status veröffentlicht wird.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Dieses Beispiel ruft Details zu allen Testservice-Testdefinitionen in der Instanz ab. 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"
          }
        ]
      }
    ]

    Servicetestmanagement – offene API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{ID} AB

    Ruft eine Servicetest-Definitionsentität ab.

    URL-Format

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

    Unterstützte Anforderungsparameter

    Tabelle : 20. Pfad-Parameter
    Name Beschreibung
    id SYS_ID oder external_ID der abzurufenden Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

    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örigServicespezifikation
    • ServiceTestSpecRelationship
    • Merkmal
    • TestMeasureDefinition
    • ValidiertFür

    Datentyp: Zeichenfolge

    status Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. Nur Testdefinitionen im angegebenen Status werden in der Antwort zurückgegeben.

    Gültige Werte:

    • archiviert
    • Entwurf
    • Veröffentlicht
    • Stillgelegt

    Datentyp: Zeichenfolge

    Tabelle : 22. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 23. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Tabelle : 24. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 25. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigServicespezifikation Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id SYS_ID oder external_ID der Servicespezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Testdefinition [sn_st_mgmt_test_definition]

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    ServiceTestSpecRelationship.RelationshipType Typ der Beziehung.
    Akzeptierte Werte:
    • Abhängigkeit
    • Exklusivität
    • Ersatz

    Datentyp: Zeichenfolge

    Merkmal Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacteristic.characteristicValueSpecification Mögliche Werte des Merkmals.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    specCharacteristic.description Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

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

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.validFor.startDateTime Startdatum des Merkmals.

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.valueType Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    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

    testMeasureDefinition.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMeasureDefinition.capturePeriod Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

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

    Datentyp: Zahl

    testMeasureDefinition.capturePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id SYS_ID oder external_ID der Testmaßdefinitionen.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßdefinitionstabelle [sn_st_mgmt_test_measure_definition]

    TestMeasureDefinition.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.metricName Anwenderdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel Regel, die Bedingungen definiert, die erreicht werden sollen, bevor Konsequenzen angewendet werden, wenn ein Schwellenwert​in der Testmaßdefinition ü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.threshold.Rule.KonformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem für festgelegten Wert identisch ist testMeasureDefinition.thresholdRule.conformanceTargetExact. Wenn auf „wahr“ festgelegt, testMeasureDefinition.thresholdRule.conformanceTargetExactIst erforderlich.
    Gültige Werte:
    • Wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • Falsch: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorLower 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.threshold.Rule.KonformanceComparatorOber Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceZielLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Regel.Konsequenz 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 Maßkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel.Konsequenz.vorgeschriebenen Aktion Anwenderdefinierte Aktion für Schwellenwertverstöße. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.Konsequenz.wiederholte Aktion Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime Gültigkeitsenddatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id SYS_ID oder external_ID der Schwellenwertregeln.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    TestMeasureDefinition.threshold-Regel.threshold-Regelschweregrad Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    TestMeasureDefinition.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.validFür 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.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidiertFür 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 Definition stillgelegt wird.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Datum und Uhrzeit der Testdefinition, an der der Status veröffentlicht wird.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Dieses Beispiel ruft Details einer Servicetestdefinition mit einer bestimmten ID ab.

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

    Servicetestmanagement – offene 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. Pfad-Parameter
    Name Beschreibung
    id SYS_ID oder external_ID des abzurufenden Servicetests.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    Tabelle : 27. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 28. Anforderungstext-Parameter (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 von Merkmalen. Wenn „external_ID“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_ID“ zurück, andernfalls wird die sys_ID zurückgegeben

    Datentyp: Zeichenfolge

    Tabelle: Merkmale [sn_prd_pm_characteristic]

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Merkmal.WertTyp Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    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.

    Datentyp: Zeichenfolge

    Standard: ONDEMAND

    name Erforderlich. Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigService Erforderlich. Testdefinition, die dem Servicetest zugeordnet ist.

    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.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    startDateTime Startdatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    Testmessung Maß für einen bestimmten Aspekt 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}
     }
    ]
    Testmaß.Genauigkeit Float-Dezimalwert, der die Genauigkeit der Testmessung darstellt, die für die zugehörigen Metriken erfasst wurde.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.captureDateTime Datum und Uhrzeit der Erfassung der Metrik.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasure.id SYS_ID oder external_ID der Testmaßnahmen.

    Datentyp: Zeichenfolge

    Tabelle: In den Feldern „sys_ID“ oder „external_ID“ der Tabelle „Testmaßnahmen“ [sn_st_mgmt_test_measure].

    testMeasure.Measure.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    TestMeasure.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasure.metricName Name der Testmaßmetrik.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation Ein Objekt zum Definieren einer Regel in der Schwellenwertregeldefinition, zusammen mit Konsequenzen, wenn die Regel verletzt wird.

    Datentyp: Array von Objekten

    "ruleViolation"[
      {
        appliedConsequence: [Array],
        conformanceTargetUpper: Number,
        conformanceComparatorUpper: "String",
        description: "String",
        id: "String",
        name: "String",
        numberOfAllowedCrossing: Number,
        thresholdRuleSeverity: "String",
        tolerancePeriod: "String"
      }
    ]
    testMeasure.ruleViolation.tolerancePeriod.amount Anzahl der Zeiträume, bevor die Konsequenz angewendet wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.appliedConsequence 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.ruleViolation.appliedConsequence.appliedAction Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispiel: Senden einer Warnung oder Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.description 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

    testMeasure.ruleViolation.appliedConsequence.repeatAction Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt.

    Gültige Werte:

    • Wahr: Wiederholen Sie die Aktion.
    • Falsch: Wiederholen Sie die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    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: Boolescher Wert

    Standard: Falsch

    testMeasure.ruleViolation.conformanceComporatorLower Operator zum Überprüfen, 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 zum Überprüfen, ob ein Wert über dem Schwellenwert liegt.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

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

    Datentyp: Zahl

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

    Datentyp: Zahl

    testMeasure.ruleViolation.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id SYS_ID oder external_ID des Schwellenwertregelverstoßes.

    Datentyp: Zeichenfolge

    Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    testMeasure.ruleViolation.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.numberOfAllowedCrossing 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

    testMeasure.ruleViolation.tolerancePeriod Angegebenes Zeitintervall, in dem das Überschreiten von Vorkommen aktiviert wird, ohne unmittelbare Konsequenzen oder Aktionen auszulösen.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMeasure.ruleViolation.tolerancePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    Testmaß.EinheitenMessung Maßeinheit für die Konformitätszielwerte der Testmessung.

    Datentyp: Zeichenfolge

    TestMeasure.value Wert der Testmaßnahme.

    Datentyp: Objekt

    "value": {
     "id": "String",
     "name": "String",
     "valueType": "String",
     "value": "String
    }
    testMeasure.value.id ID des Testmesswerts.

    Datentyp: Zeichenfolge

    testMeasure.value.name Name des Testmesswerts.

    Datentyp: Zeichenfolge

    TestMeasure.value.value Wert der Testmaßnahme.

    Datentyp: Zeichenfolge

    TestMeasure.Wert.WertTyp Typ des Testmesswerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    Testspezifikation Erforderlich. 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.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Gültigkeitsstartdatum des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Header

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

    Tabelle : 29. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Tabelle : 30. Antwort-Header
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 31. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Antworttext-Parameter (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 von Merkmalen. Wenn „external_ID“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_ID“ zurück, andernfalls wird die sys_ID zurückgegeben

    Datentyp: Zeichenfolge

    Tabelle: Merkmale [sn_prd_pm_characteristic]

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Merkmal.WertTyp Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    name Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigService Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
      "href": "string",
      "id": "String",
      "name": "String"
    }
    RelatedService.ID SYS_ID oder external_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]

    relatedService.name Name des Produktbestands.

    Datentyp: Zeichenfolge

    Testmessung Maß für einen bestimmten Aspekt 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}
     }
    ]
    Testmaß.Genauigkeit Float-Dezimalwert, der die Genauigkeit der Testmessung darstellt, die für die zugehörigen Metriken erfasst wurde.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.captureDateTime Datum und Uhrzeit der Erfassung der Metrik.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasure.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    TestMeasure.ID SYS_ID oder external_ID der Testmaßnahme.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßnahmen [sn_st_mgmt_test_measure]

    TestMeasure.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation Objekt zum Definieren einer Regel in der Schwellenwertregeldefinition, zusammen mit 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}
     }
    ]
    testMeasure.ruleViolation.appliedConsequence 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.ruleViolation.appliedConsequence.appliedAction Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispiel: Senden einer Warnung oder Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    testMeasure.ruleViolation.appliedConsequence.description 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

    testMeasure.ruleViolation.conformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact.
    Gültige Werte:
    • Wahr: Der Wert ist identisch.
    • Falsch: Der Wert ist nicht identisch.

    Datentyp: Boolescher Wert

    Standard: Falsch

    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.conformanceComparatorUpper Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • ist
    • Kleiner als

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

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

    Datentyp: Zahl

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

    Datentyp: Zahl

    testMeasure.ruleViolation.description Beschreibung des Verstoßes gegen die Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id SYS_ID oder external_ID des Schwellenwertregelverstoßes.

    Datentyp: Zeichenfolge

    Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    testMeasure.ruleViolation.numberOfAllowedCrossing 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

    testMeasure.ruleViolation.tolerancePeriod Dauer oder Zeitintervall, in dem zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMeasure.ruleViolation.tolerancePeriod.amount Betrag des Zeitraums in Zahl.

    Datentyp: Zahl

    testMeasure.ruleViolation.tolerancePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    Testmaß.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    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

    testMeasure.value.name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    TestMeasure.value.value Wert der Metrik im Test.

    Datentyp: Zeichenfolge

    TestMeasure.Wert.WertTyp Typ des Testmesswerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

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

    Datentyp: Objekt

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor.endDateTime Enddatum und Zeitstempel des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Startdatum und Zeitstempel des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Das folgende Beispiel aktualisiert die angegebene Servicetest-Entität gemäß den im Anforderungstext angegebenen Details.

    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 an, 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"
                }
              ]
            }
          ]
        }
      ]
    }

    Servicetestmanagement – offene 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. Pfad-Parameter
    Name Beschreibung
    id SYS_ID oder external_ID der abzurufenden Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

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

    Datentyp: Zeichenfolge

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigServicespezifikation Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id SYS_ID oder external_ID der Servicespezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Testdefinition [sn_st_mgmt_test_definition]

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    ServiceTestSpecRelationship.RelationshipType Typ der Beziehung.
    Akzeptierte Werte:
    • Abhängigkeit
    • Exklusivität
    • Ersatz

    Datentyp: Zeichenfolge

    Merkmal Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacteristic.characteristicValueSpecification Mögliche Werte des Merkmals.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    specCharacteristic.description Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

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

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.validFor.startDateTime Startdatum des Merkmals.

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.valueType Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    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

    testMeasureDefinition.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMeasureDefinition.capturePeriod Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

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

    Datentyp: Zahl

    testMeasureDefinition.capturePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id SYS_ID oder external_ID der Testmaßdefinitionen.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßdefinitionstabelle [sn_st_mgmt_test_measure_definition]

    TestMeasureDefinition.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.metricName Anwenderdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel Regel, die Bedingungen definiert, die erreicht werden sollen, bevor Konsequenzen angewendet werden, wenn ein Schwellenwert​in der Testmaßdefinition ü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.threshold.Rule.KonformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem für festgelegten Wert identisch ist testMeasureDefinition.thresholdRule.conformanceTargetExact. Wenn auf „wahr“ festgelegt, testMeasureDefinition.thresholdRule.conformanceTargetExactIst erforderlich.
    Gültige Werte:
    • Wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • Falsch: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorLower 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.threshold.Rule.KonformanceComparatorOber Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceZielLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Regel.Konsequenz 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 Maßkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel.Konsequenz.vorgeschriebenen Aktion Anwenderdefinierte Aktion für Schwellenwertverstöße. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.Konsequenz.wiederholte Aktion Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime Gültigkeitsenddatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id SYS_ID oder external_ID der Schwellenwertregeln.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    TestMeasureDefinition.threshold-Regel.threshold-Regelschweregrad Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    TestMeasureDefinition.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.validFür 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.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Header

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

    Tabelle : 35. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 36. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur Anwendung/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 REST-API-HTTP-Antwortcodes .

    Tabelle : 37. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    name Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigServicespezifikation Servicespezifikationen für die Testdefinitionen.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
     {
      "id": "String",
      "name": "String"
     }
    ]
    RelatedServicespezifikation.ID SYS_ID oder external_ID der Servicespezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Testdefinition [sn_st_mgmt_test_definition]

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    ServiceTestSpecRelationship.RelationshipType Typ der Beziehung.
    Akzeptierte Werte:
    • Abhängigkeit
    • Exklusivität
    • Ersatz

    Datentyp: Zeichenfolge

    Merkmal Testdefinitionsmerkmale.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacteristic.characteristicValueSpecification Mögliche Werte des Merkmals.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    specCharacteristic.description Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    SpecCharacteristic.validFor.startDateTime Startdatum des Merkmals.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    SpecCharacteristic.valueType Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    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 Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

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

    Datentyp: Zeichenfolge

    testMeasureDefinition.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    testMeasureDefinition.capturePeriod Dauer oder Zeitraum der Erfassung.

    Datentyp: Objekt

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

    Datentyp: Zahl

    testMeasureDefinition.capturePeriod.units Einheiten des Zeitraums.
    Akzeptierte Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    TestMeasureDefinition.ID SYS_ID oder external_ID der Testmaßdefinitionen.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßdefinition [sn_st_mgmt_test_measure_definition]

    TestMeasureDefinition.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.metricName Anwenderdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel Regel, die die Bedingung (erhöhen oder löschen) definiert, 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.threshold.Rule.KonformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact.
    Gültige Werte:
    • Wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • Falsch: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorOber Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • Kleiner als
    • ist

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceZielLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Regel.Konsequenz 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

    TestMeasureDefinition.threshold.Rule.Konsequenz.ID SYS_ID oder external_ID der Maßkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel.Konsequenz.vorgeschriebenen Aktion Anwenderdefinierte Aktion für Schwellenwertverstöße. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.Konsequenz.wiederholte Aktion Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.

    Gültige Werte:

    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime Gültigkeitsenddatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.ID SYS_ID oder external_ID der Schwellenwertregeln.

    Datentyp: Zeichenfolge

    Tabelle: Schwellenwertregeln [sn_st_mgmt_threshold_rule]

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    TestMeasureDefinition.threshold-Regel.threshold-Regelschweregrad Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    TestMeasureDefinition.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.validFür Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Das folgende Beispiel aktualisiert die angegebene Servicetestdefinitions-ID gemäß den im Anforderungstext angegebenen Änderungen teilweise.

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

    Servicetestmanagement – offene 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. Pfad-Parameter
    Name Beschreibung
    Keine
    Tabelle : 39. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 40. Anforderungstext-Parameter (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 von Merkmalen. Wenn „external_ID“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_ID“ zurück, andernfalls wird die sys_ID zurückgegeben

    Datentyp: Zeichenfolge

    Tabelle: Merkmale [sn_prd_pm_characteristic]

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Merkmal.WertTyp Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ID SYS_ID oder external_ID des Servicetests. Diese ID erstellt einen Servicetest und wird als external_ID verwendet

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    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.

    Datentyp: Zeichenfolge

    Standard: ONDEMAND

    name Erforderlich. Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigService Erforderlich. Testdefinition, die dem Servicetest zugeordnet ist.

    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.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    relatedService.name Name des Produktbestandsartikels.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    Testmessung Maß für einen bestimmten Aspekt 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}
     }
    ]
    Testmaß.Genauigkeit Float-Dezimalwert, der die Genauigkeit der Testmessung darstellt, die für die zugehörigen Metriken erfasst wurde.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.captureDateTime Datum und Uhrzeit der Erfassung der Metrik.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasure.id SYS_ID oder external_ID der Testmaßnahmen.

    Datentyp: Zeichenfolge

    Tabelle: In den Feldern „sys_ID“ oder „external_ID“ der Tabelle „Testmaßnahmen“ [sn_st_mgmt_test_measure].

    testMeasure.Measure.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    TestMeasure.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasure.metricName Name der Testmaßmetrik.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation Ein Objekt zum Definieren einer Regel in der Schwellenwertregeldefinition, zusammen mit Konsequenzen, wenn die Regel verletzt wird.

    Datentyp: Array von Objekten

    "ruleViolation"[
      {
        appliedConsequence: [Array],
        conformanceTargetUpper: Number,
        conformanceComparatorUpper: "String",
        description: "String",
        id: "String",
        name: "String",
        numberOfAllowedCrossing: Number,
        thresholdRuleSeverity: "String",
        tolerancePeriod: "String"
      }
    ]
    testMeasure.ruleViolation.appliedConsequence 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.ruleViolation.appliedConsequence.appliedAction Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispiel: Senden einer Warnung oder Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.description 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

    testMeasure.ruleViolation.appliedConsequence.repeatAction Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt.

    Gültige Werte:

    • Wahr: Wiederholen Sie die Aktion.
    • Falsch: Wiederholen Sie die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    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: Boolescher Wert

    Standard: Falsch

    testMeasure.ruleViolation.conformanceComporatorLower Operator zum Überprüfen, 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 zum Überprüfen, ob ein Wert über dem Schwellenwert liegt.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

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

    Datentyp: Zahl

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

    Datentyp: Zahl

    testMeasure.ruleViolation.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id SYS_ID oder external_ID des Schwellenwertregelverstoßes.

    Datentyp: Zeichenfolge

    Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    testMeasure.ruleViolation.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.numberOfAllowedCrossing 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

    testMeasure.ruleViolation.tolerancePeriod Angegebenes Zeitintervall, in dem das Überschreiten von Vorkommen aktiviert wird, ohne unmittelbare Konsequenzen oder Aktionen auszulösen.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMeasure.ruleViolation.tolerancePeriod.amount Anzahl der Zeiträume, bevor die Konsequenz angewendet wird.

    Datentyp: Zahl

    testMeasure.ruleViolation.tolerancePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    Testmaß.EinheitenMessung Maßeinheit für die Konformitätszielwerte der Testmessung.

    Datentyp: Zeichenfolge

    TestMeasure.value Wert der Testmaßnahme.

    Datentyp: Objekt

    "value": {
     "id": "String",
     "name": "String",
     "valueType": "String",
     "value": "String
    }
    testMeasure.value.id ID des Testmesswerts.

    Datentyp: Zeichenfolge

    testMeasure.value.name Name des Testmesswerts.

    Datentyp: Zeichenfolge

    TestMeasure.value.value Wert der Testmaßnahme.

    Datentyp: Zeichenfolge

    TestMeasure.Wert.WertTyp Typ des Testmesswerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

    Testspezifikation Erforderlich. 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.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Servicetestdefinition“ [sn_st_mgmt_test_definition].

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Gültigkeitsstartdatum des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Header

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

    Tabelle : 41. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml.

    Standard: application/json

    Tabelle : 42. Antwort-Header
    Header 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 43. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.

    Antworttext-Parameter (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 von Merkmalen. Wenn „external_ID“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_ID“ zurück, andernfalls wird die sys_ID zurückgegeben

    Datentyp: Zeichenfolge

    Tabelle: Merkmale [sn_prd_pm_characteristic]

    characteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Merkmal.WertTyp Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung des Servicetests.

    Datentyp: Zeichenfolge

    endDateTime Enddatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    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.

    Datentyp: Zeichenfolge

    Standard: ONDEMAND

    name Name des Servicetests.

    Datentyp: Zeichenfolge

    ZugehörigService Testdefinition, die diesem Test zugeordnet ist.

    Datentyp: Objekt

    "relatedService": {
      "href": "string",
      "id": "String",
      "name": "String"
    }
    RelatedService.ID SYS_ID oder external_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]

    relatedService.name Name des Produktbestands.

    Datentyp: Zeichenfolge

    startDateTime Startdatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Staat Status des Servicetests.
    Gültige Werte:
    • bestätigt
    • Abgebrochen
    • Abgeschlossen
    • Fehlgeschlagen
    • inProgress
    • Ausstehend
    • abgelehnt

    Datentyp: Zeichenfolge

    Testmessung Maß für einen bestimmten Aspekt 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}
     }
    ]
    Testmaß.Genauigkeit Float-Dezimalwert, der die Genauigkeit der Testmessung darstellt, die für die zugehörigen Metriken erfasst wurde.

    Datentyp: Zahl

    Höchstwert: 40

    testMeasure.captureDateTime Datum und Uhrzeit der Erfassung der Metrik.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasure.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    TestMeasure.ID SYS_ID oder external_ID der Testmaßnahme.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßnahmen [sn_st_mgmt_test_measure]

    TestMeasure.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation Objekt zum Definieren einer Regel in der Schwellenwertregeldefinition, zusammen mit 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}
     }
    ]
    testMeasure.ruleViolation.appliedConsequence 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.ruleViolation.appliedConsequence.appliedAction Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispiel: Senden einer Warnung oder Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    testMeasure.ruleViolation.appliedConsequence.description 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

    testMeasure.ruleViolation.conformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact.
    Gültige Werte:
    • Wahr: Der Wert ist identisch.
    • Falsch: Der Wert ist nicht identisch.

    Datentyp: Boolescher Wert

    Standard: Falsch

    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.conformanceComparatorUpper Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • ist
    • Kleiner als

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

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

    Datentyp: Zahl

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

    Datentyp: Zahl

    testMeasure.ruleViolation.description Beschreibung des Verstoßes gegen die Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasure.ruleViolation.id SYS_ID oder external_ID des Schwellenwertregelverstoßes.

    Datentyp: Zeichenfolge

    Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]

    testMeasure.ruleViolation.name Name des Verstoßes gegen die Schwellenwertregel.

    Datumstyp: Zeichenfolge

    testMeasure.ruleViolation.numberOfAllowedCrossing 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

    testMeasure.ruleViolation.tolerancePeriod Dauer oder Zeitintervall, in dem zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird.

    Datumstyp: Objekt

    "tolerancePeriod": {
     "amount": Number,
     "units": "String"
    }
    testMeasure.ruleViolation.tolerancePeriod.amount Betrag des Zeitraums in Zahl.

    Datentyp: Zahl

    testMeasure.ruleViolation.tolerancePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    Testmaß.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    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

    testMeasure.value.name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    testMeasure.value.name Name des Metrikwerts im Test.

    Datentyp: Zeichenfolge

    TestMeasure.value.value Wert der Metrik im Test.

    Datentyp: Zeichenfolge

    TestMeasure.Wert.WertTyp Typ des Testmesswerts, z. B. numerisch, Text usw.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

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

    Datentyp: Objekt

    "validFor": {
      "endDateTime": "String",
      "startDateTime": "String"
    }
    ValidFor.endDateTime Enddatum und Zeitstempel des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Startdatum und Zeitstempel des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Curl-Anforderung

    Das folgende Beispiel erstellt einen neuen Servicetest gemäß bestimmten Details, die im Anforderungstext angegeben sind.

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

    Servicetestmanagement – offene 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. Pfad-Parameter
    Name Beschreibung
    Keine
    Tabelle : 45. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 46. Anforderungstext-Parameter (XML oder JSON)
    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetestdefinition [sn_st_mgmt_test_definition]

    name Erforderlich. Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigServicespezifikation Erforderlich. Servicespezifikationen der Testdefinition.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
      {
        "id": "String",
        "name": "String"
      }
    ]
    relatedServiceSpecification.id SYS_ID oder external_ID der Servicespezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Testdefinition“ [sn_st_mgmt_test_definition].

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    ServiceTestSpecRelationship.RelationshipType Typ der Beziehung.
    Gültige Werte:
    • Abhängigkeit
    • Exklusivität
    • Ersatz

    Datentyp: Zeichenfolge

    Merkmal Merkmale der Testdefinition.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacteristic.characteristicValueSpecification Mögliche Werte des Merkmals.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    specCharacteristic.description Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

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

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.validFor.startDateTime Startdatum des Merkmals.

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Datentyp: Zeichenfolge

    SpecCharacteristic.valueType Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    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

    testMeasureDefinition.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfasst die Metrik nicht.

    Datentyp: Zeichenfolge

    testMeasureDefinition.capturePeriod Zeitraum oder Dauer der Metrikerfassung.

    Datentyp: Objekt

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

    Datentyp: Zahl

    testMeasureDefinition.capturePeriod.units Einheiten des Zeitraums.
    Gültige Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    testMeasureDefinition.id SYS_ID oder external_ID der Testmaßdefinitionen.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßdefinitionstabelle [sn_st_mgmt_test_measure_definition]

    TestMeasureDefinition.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.metricName Anwenderdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel Regel, die Bedingungen definiert, die erreicht werden sollen, bevor Konsequenzen angewendet werden, wenn ein Schwellenwert​in der Testmaßdefinition ü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.threshold.Rule.KonformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem für festgelegten Wert identisch ist testMeasureDefinition.thresholdRule.conformanceTargetExact. Wenn auf „wahr“ festgelegt, testMeasureDefinition.thresholdRule.conformanceTargetExactIst erforderlich.
    Gültige Werte:
    • Wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • Falsch: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorLower 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.threshold.Rule.KonformanceComparatorOber Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • weniger als
    • weniger als oder gleich

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceZielLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Regel.Konsequenz 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 Maßkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel.Konsequenz.vorgeschriebenen Aktion Anwenderdefinierte Aktion für Schwellenwertverstöße. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.Konsequenz.wiederholte Aktion Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll.
    Gültige Werte:
    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime Gültigkeitsenddatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.id SYS_ID oder external_ID der Schwellenwertregeln.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Schwellenwertregeln“ [sn_st_mgmt_threshold_rule].

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    TestMeasureDefinition.threshold-Regel.threshold-Regelschweregrad Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • mittel
    • niedrig

    Datentyp: Zeichenfolge

    TestMeasureDefinition.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.validFür 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.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidiertFür 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 Definition stillgelegt wird.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Datum und Uhrzeit der Testdefinition, an der der Status veröffentlicht wird.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    Header

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

    Tabelle : 47. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 48. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Unterstützt nur Anwendung/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 REST-API-HTTP-Antwortcodes .

    Tabelle : 49. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Beschreibung Beschreibung der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ID SYS_ID oder external_ID der Servicetestdefinition.

    Datentyp: Zeichenfolge

    Tabelle: Servicetest [sn_st_mgmt_test]

    name Name der Servicetestdefinition.

    Datentyp: Zeichenfolge

    ZugehörigServicespezifikation Servicespezifikationen für die Testdefinitionen.

    Datentyp: Array von Objekten

    "relatedServiceSpecification": [
     {
      "id": "String",
      "name": "String"
     }
    ]
    RelatedServicespezifikation.ID SYS_ID oder external_ID der Servicespezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Spezifikation“ [sn_prd_pm_specification].

    relatedServiceSpecification.name Name der Servicespezifikation.

    Datentyp: Zeichenfolge

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

    Datentyp: Zeichenfolge

    Tabelle: Testdefinition [sn_st_mgmt_test_definition]

    serviceTestSpecRelationship.name Name der zugehörigen Testdefinition.

    Datentyp: Zeichenfolge

    ServiceTestSpecRelationship.RelationshipType Typ der Beziehung.
    Akzeptierte Werte:
    • Abhängigkeit
    • Exklusivität
    • Ersatz

    Datentyp: Zeichenfolge

    Merkmal Testdefinitionsmerkmale.

    Datentyp: Array von Objekten

    "specCharacteristic": [
     {
      "characteristicValueSpecification": [Array],
      "description": "String",
      "name": "String",
      "validFor": {Object},
      "valueType": "String"
     }
    ]
    specCharacteristic.characteristicValueSpecification Mögliche Werte des Merkmals.

    Datentyp: Array von Objekten

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

    Datentyp: Zeichenfolge

    specCharacteristic.description Beschreibung des Merkmals.

    Datentyp: Zeichenfolge

    specCharacteristic.name Name des Merkmals.

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    SpecCharacteristic.validFor.startDateTime Startdatum des Merkmals.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    SpecCharacteristic.valueType Typ des Merkmalwerts.
    • Auswahl
    • Datum
    • Datum/Uhrzeit
    • Dauer
    • E-Mail
    • label
    • Einzeiliger Test
    • ja/Nein

    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 Häufigkeit, mit der die Metrik erfasst werden soll.

    Gültige Werte:

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

    Datentyp: Zeichenfolge

    testMeasureDefinition.captureMethod Methode zum Erfassen der Metrik.

    Gültige Werte:

    • Automatisch: Erfassen Sie die Metrik automatisch.
    • Manuell: Erfassen Sie die Metrik manuell.
    • Keine: Erfassen Sie die Metrik nicht.

    Datentyp: Zeichenfolge

    testMeasureDefinition.capturePeriod Dauer oder Zeitraum der Erfassung.

    Datentyp: Objekt

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

    Datentyp: Zahl

    testMeasureDefinition.capturePeriod.units Einheiten des Zeitraums.
    Akzeptierte Werte:
    • Tage
    • Stunden
    • Minuten
    • Sekunden

    Datentyp: Zeichenfolge

    TestMeasureDefinition.ID SYS_ID oder external_ID der Testmaßdefinitionen.

    Datentyp: Zeichenfolge

    Tabelle: Testmaßdefinition [sn_st_mgmt_test_measure_definition]

    TestMeasureDefinition.metricBeschreibung Kurze Beschreibung der Metrik.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.metricName Anwenderdefinierter Name einer Metrik in der Testmaßnahme.

    Datentyp: Zeichenfolge

    testMeasureDefinition.name Name der Testmaßdefinition.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel Regel, die die Bedingung (erhöhen oder löschen) definiert, 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.threshold.Rule.KonformanceComparatorExact Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact.
    Gültige Werte:
    • Wahr: Der Wert ist identisch mit dem Wert von conformanceTargetExact.
    • Falsch: Der Wert ist nicht identisch conformanceTargetExact.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorLower Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt.

    Gültige Werte:

    • größer als
    • ist

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.KonformanceComparatorOber Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet.

    Gültige Werte:

    • Kleiner als
    • ist

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.conformanceTargetExact Erforderlich, wenn conformanceComparatorExactIst auf „wahr“ festgelegt. Wenn conformanceComparatorExactWert ist auf „wahr“ festgelegt. Sein Wert stimmt mit dem in definierten Wert überein conformanceTargetExact.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceZielLower Unterer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Rule.conformanceTargetUpper Oberer Schwellenwert für den Vergleich der Testmessergebnisse.

    Datentyp: Zahl

    TestMeasureDefinition.threshold.Regel.Konsequenz 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

    TestMeasureDefinition.threshold.Rule.Konsequenz.ID SYS_ID oder external_ID der Maßkonsequenz.

    Datentyp: Zeichenfolge

    testMeasureDefinition.thresholdRule.consequence.name Name der Konsequenz.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold-Regel.Konsequenz.vorgeschriebenen Aktion Anwenderdefinierte Aktion für Schwellenwertverstöße. Aktionen variieren zwischen Instanzen.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.Konsequenz.wiederholte Aktion Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht.

    Gültige Werte:

    • Wahr: Wiederholt die Aktion.
    • Falsch: Wiederholt die Aktion nicht.

    Datentyp: Boolescher Wert

    Standard: Falsch

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor Datumsbereich, für den die Konsequenz gültig ist.

    Datentyp: Objekt

    "validFor": {
     "startDateTime": "String",
     "endDateTime ": "String"
    }
    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime Gültigkeitsenddatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime Gültigkeitsstartdatum der Konsequenz.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    testMeasureDefinition.thresholdRule.description Beschreibung der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.ID SYS_ID oder external_ID der Schwellenwertregeln.

    Datentyp: Zeichenfolge

    Tabelle: Schwellenwertregeln [sn_st_mgmt_threshold_rule]

    testMeasureDefinition.thresholdRule.name Name der Schwellenwertregel.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.threshold.Rule.numberOfAllowedCrossing Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden.

    Datentyp: Zahl

    Höchstwert: 40

    TestMeasureDefinition.threshold-Regel.threshold-Regelschweregrad Schweregrad der Schwellenwertregel.

    Gültige Werte:

    • hoch
    • niedrig
    • mittel

    Datentyp: Zeichenfolge

    TestMeasureDefinition.EinheitenMessung Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden.

    Datentyp: Zeichenfolge

    TestMeasureDefinition.validFür Datumsbereich, für den die Testmaßdefinition gültig ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

    ValidFor.startDateTime Startdatum und -Uhrzeit des Servicetests.

    Datentyp: Zeichenfolge

    FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 31.01.2025 09:35:43 .

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