Service-Test-Management – API öffnen
Die Service-Test-Management 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 ServiceNow AI Platform. Die Service-Test-Management Offen API ist ein ServiceNow Implementierung der REST-Spezifikation der TM Forum Service Problem Management API. Diese Implementierung basiert auf https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/ .
Diese REST-API wurde entwickelt, um Servicetests in einer Telekommunikationsumgebung zu verwalten und auszuführen. Mit dieser Option können Anwender 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 Service-Test-Management Offen Die API erfordert das Plugin „Customer Service Problem Management“ (com.sn_sprb_mgmt) und die Rolle „sn_sprb_mgmt.Test_Integrator“. Diese API gehört zum Namespace sn_sprb_mgmt. Weitere Informationen zu Service Problem Management. Siehe Customer Service Problem Management Um weitere Informationen zu dieser Anwendung zu erhalten.
- Testlauf [sn_St_mgmt_Test]
- Servicetestdefinition [sn_St_mgmt_Test_Definition]
- Testdefinitionsmerkmal [sn_St_mgmt_Test_Definition_Merkmal]
- Testmerkmal [sn_St_mgmt_Test_Merkmal]
- Beziehung zwischen Spezifikation und Testdefinition [sn_St_mgmt_Test_Definition_m2m]
- Testdefinitionsbeziehung [sn_St_mgmt_Test_Definition_rel]
- Testmaß [sn_St_mgmt_Test_measure]
- Messungskonsequenz [sn_St_mgmt_measure_COUNITION]
- Testmaßdefinition [sn_St_mgmt_Test_measure_Definition]
- Angewendete Konsequenz [sn_St_mgmt_applied_Konsequenz]
- Schwellenwertregel [sn_St_mgmt_threshold_rule]
- Verstoß gegen Schwellenwertregel [sn_St_mgmt_threshold_rule_violation]
Service-Testmanagement – API öffnen – GET /sn_sprb_mgmt/servicetestManagement/serviceTest
Ruft eine Liste aller Servicetests ab.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestManagement/serviceTest
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| 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:
Datentyp: Zeichenfolge |
| limit | Maximale Anzahl der zurückzugebenden 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 |
| state | Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. Nur Testdefinitionen im angegebenen Status werden in der Antwort zurückgegeben. Gültige Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Gibt den Bereich der Inhalte an, die in einem paginierten Aufruf zurückgegeben werden. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur Anwendung/JSON. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Bei paginierten 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Merkmalen der Testdefinition finden Sie unter Datentyp: Array von Objekten |
| 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. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| Merkmal.WertTyp | Typ des Merkmalwerts.
Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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:
Datentyp: Zeichenfolge Standard: ONDEMAND |
| name | Erforderlich. Name des Servicetests. Datentyp: Zeichenfolge |
| ZugehörigService | Erforderlich. Testdefinition, die dem Servicetest zugeordnet ist. Datentyp: Objekt |
| 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: |
| Status | Status, in dem sich der Servicetest befindet. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure | Maß für einen bestimmten Aspekt eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| TestMessung.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: |
| 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:
Datentyp: Zeichenfolge |
| TestMeasure.metricBeschreibung | Kurzbeschreibung 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 |
| 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 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Zum Beispiel das Senden einer Warnung oder das 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:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComporatorExact | Kennzeichnung, die angibt, ob ein Wert identisch ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComporatorLower | Operator zum Überprüfen, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComporatorUpper | Operator zum Überprüfen, ob ein Wert über dem Schwellenwert liegt. Gültige Werte:
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: Schwellenwertregelverstoß [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:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.tolerancePeriod | Angegebenes Zeitintervall, in dem Überschreitungsvorkommen aktiviert werden, ohne unmittelbare Konsequenzen oder Aktionen auszulösen. Datumstyp: Objekt |
| testMeasure.ruleViolation.tolerancePeriod.units | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.EinheitenMessung | Maßeinheit für die Konformitätszielwerte der Testmaßnahme. Datentyp: Zeichenfolge |
| TestMeasure.value | Wert der Testmaßnahme. Datentyp: Objekt |
| 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.value.valueType | Typ des Testmesswerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| TestSpezifikation | Erforderlich. Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| 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 | Gültigkeitsenddatum des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Gültigkeitsstartdatum des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
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"
}
]
}
]
}
]
}
]
Service-Testmanagement – API öffnen – GET /sn_sprb_mgmt/servicetestManagement/serviceTest/{ID}
Ruft eine Servicetest-Entität basierend auf der angegebenen ID eines Servicetests ab.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestManagement/serviceTest/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID oder external_ID des abzurufenden Servicetests. Datentyp: Zeichenfolge Tabelle: Servicetest [sn_St_mgmt_Test] |
| 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:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Datentyp: Array von Objekten |
| 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. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| Merkmal.WertTyp | Typ des Merkmalwerts.
Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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:
Datentyp: Zeichenfolge Standard: ONDEMAND |
| name | Name des Servicetests. Datentyp: Zeichenfolge |
| ZugehörigService | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| ZugehörigService.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: |
| Status | Status des Servicetests. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure | Maß für einen bestimmten Aspekt eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| TestMessung.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: |
| testMeasure.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.ID | SYS_ID oder external_ID der Testmaßnahme. Datentyp: Zeichenfolge Tabelle: Testmaßnahmen [sn_St_mgmt_Test_measure] |
| TestMeasure.metricBeschreibung | Kurzbeschreibung 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 |
| testMeasure.ruleViolation.appliedConsequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Datentyp: Array von Objekten |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Zum Beispiel das Senden einer Warnung oder das 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:
Datentyp: Boolesch Standardwert: false |
| 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:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComparatorLower | Ein Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComparatorUpper | Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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: Schwellenwertregelverstoß [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:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.tolerancePeriod | Dauer oder Zeitintervall, in dem zulässige Kreuzungen auftreten können, bevor eine Konsequenz initiiert wird. Datumstyp: Objekt |
| testMeasure.ruleViolation.tolerancePeriod.amount | Betrag des Zeitraums in Zahl. Datentyp: Zahl |
| testMeasure.ruleViolation.tolerancePeriod.units | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.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 |
| 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.value.valueType | Typ des Testmesswerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| TestSpezifikation | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| 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 | Enddatum und Zeitstempel des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Startdatum und Zeitstempel des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
cURL-Anforderung
Das folgende Beispiel ruft Details zur Servicetest-Entität ab, die der angegebenen ID 44b7a8ea3b6a42107222bf9985e45a45 zugeordnet ist.
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"
}
]
}
]
}
]
}
Service-Testmanagement – API öffnen – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Ruft eine Liste aller Servicetestdefinitionen ab.
URL-Format
Standard-URL: RUFEN SIE /api/sn_sprb_mgmt/servicetestManagement/serviceTestSpecification AB
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| 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:
Datentyp: Zeichenfolge |
| limit | Maximale Anzahl der zurückzugebenden 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 |
| state | Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. Nur Testdefinitionen im angegebenen Status werden in der Antwort zurückgegeben. Gültige Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | 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 Headers „Inhaltsbereich“ ist „Elemente“ 3-5 . |
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur Anwendung/JSON. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse:
|
| X-Gesamtzahl | Bei paginierten 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte 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 | 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 | 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:
Datentyp: Zeichenfolge |
| Merkmal | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.description | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Spektrales Merkmal.validFür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| SpecCharacteristic.validFor.endDateTime | Enddatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.validFor.startDateTime | Startdatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.valueType | Typ des Merkmalwerts.
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 | Die Häufigkeit, mit der die Metrik erfasst werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.capturePeriod | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMeasureDefinition.capturePeriod.amount | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMeasureDefinition.capturePeriod.units | Einheiten des Zeitraums. Gültige Werte:
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 | Kurzbeschreibung 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 Schwellenwertin 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 |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorExact | 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorOber | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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.conformanceTargetLower | 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.Rule.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 |
| 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.Rule.Konsequenz.prescribeAktion | Anwenderdefinierte Aktion für Schwellenwertverletzungen. 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime | Gültigkeitsstartdatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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.ThreholdRule.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:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.EinheitenMessung | Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden. Datentyp: Zeichenfolge |
| TestMessgrößenDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| TestMeasureDefinition.validFor.endDateTime | Gültigkeitsenddatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.validFor.startDateTime | Gültigkeitsstartdatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| Validiertfür | Datumsbereich, für den die Testdefinition gültig ist. Datentyp: Objekt |
| 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: |
| ValidFor.startDateTime | Datum und Uhrzeit der Testdefinition, an der der Status veröffentlicht wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
cURL-Anforderung
Dieses Beispiel ruft Details zu allen Testservicetestdefinitionen 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"
}
]
}
]
Service-Testmanagement – API öffnen – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{ID}
Ruft eine Service-Testdefinitionsentität ab.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestManagement/serviceTestSpecification/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID oder external_ID der abzurufenden Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Servicetestdefinition [sn_St_mgmt_Test_Definition] |
| 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:
Datentyp: Zeichenfolge |
| state | Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. Nur Testdefinitionen im angegebenen Status werden in der Antwort zurückgegeben. Gültige Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
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 | 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 | 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:
Datentyp: Zeichenfolge |
| Merkmal | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.description | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Spektrales Merkmal.validFür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| SpecCharacteristic.validFor.endDateTime | Enddatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.validFor.startDateTime | Startdatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.valueType | Typ des Merkmalwerts.
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 | Die Häufigkeit, mit der die Metrik erfasst werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.capturePeriod | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMeasureDefinition.capturePeriod.amount | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMeasureDefinition.capturePeriod.units | Einheiten des Zeitraums. Gültige Werte:
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 | Kurzbeschreibung 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 Schwellenwertin 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 |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorExact | 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorOber | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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.conformanceTargetLower | 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.Rule.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 |
| 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.Rule.Konsequenz.prescribeAktion | Anwenderdefinierte Aktion für Schwellenwertverletzungen. 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime | Gültigkeitsstartdatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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.ThreholdRule.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:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.EinheitenMessung | Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden. Datentyp: Zeichenfolge |
| TestMessgrößenDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| TestMeasureDefinition.validFor.endDateTime | Gültigkeitsenddatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.validFor.startDateTime | Gültigkeitsstartdatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| Validiertfür | Datumsbereich, für den die Testdefinition gültig ist. Datentyp: Objekt |
| 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: |
| ValidFor.startDateTime | Datum und Uhrzeit der Testdefinition, an der der Status veröffentlicht wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
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"
}
]
}
Service-Test-Management – API öffnen – 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
| Name | Beschreibung |
|---|---|
| id | SYS_ID oder external_ID des abzurufenden Servicetests. Datentyp: Zeichenfolge Tabelle: Servicetest [sn_St_mgmt_Test] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Merkmalen der Testdefinition finden Sie unter Datentyp: Array von Objekten |
| 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. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| Merkmal.WertTyp | Typ des Merkmalwerts.
Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| Modus | Modus, in dem der Servicetest ausgeführt wird. Gültige Werte:
Datentyp: Zeichenfolge Standard: ONDEMAND |
| name | Erforderlich. Name des Servicetests. Datentyp: Zeichenfolge |
| ZugehörigService | Erforderlich. Testdefinition, die dem Servicetest zugeordnet ist. Datentyp: Objekt |
| 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: |
| Status | Status, in dem sich der Servicetest befindet. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure | Maß für einen bestimmten Aspekt eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| TestMessung.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: |
| 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:
Datentyp: Zeichenfolge |
| TestMeasure.metricBeschreibung | Kurzbeschreibung 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 |
| 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 |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Zum Beispiel das Senden einer Warnung oder das 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:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComporatorExact | Kennzeichnung, die angibt, ob ein Wert identisch ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComporatorLower | Operator zum Überprüfen, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComporatorUpper | Operator zum Überprüfen, ob ein Wert über dem Schwellenwert liegt. Gültige Werte:
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: Schwellenwertregelverstoß [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:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.tolerancePeriod | Angegebenes Zeitintervall, in dem Überschreitungsvorkommen aktiviert werden, ohne unmittelbare Konsequenzen oder Aktionen auszulösen. Datumstyp: Objekt |
| testMeasure.ruleViolation.tolerancePeriod.units | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.EinheitenMessung | Maßeinheit für die Konformitätszielwerte der Testmaßnahme. Datentyp: Zeichenfolge |
| TestMeasure.value | Wert der Testmaßnahme. Datentyp: Objekt |
| 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.value.valueType | Typ des Testmesswerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| TestSpezifikation | Erforderlich. Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| 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 | Gültigkeitsenddatum des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Gültigkeitsstartdatum des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Datentyp: Array von Objekten |
| 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. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| Merkmal.WertTyp | Typ des Merkmalwerts.
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 |
| ZugehörigService.ID | SYS_ID oder external_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| relatedService.name | Name des Produktbestands. Datentyp: Zeichenfolge |
| TestMeasure | Maß für einen bestimmten Aspekt eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| TestMessung.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: |
| testMeasure.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.ID | SYS_ID oder external_ID der Testmaßnahme. Datentyp: Zeichenfolge Tabelle: Testmaßnahmen [sn_St_mgmt_Test_measure] |
| TestMeasure.metricBeschreibung | Kurzbeschreibung 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 |
| testMeasure.ruleViolation.appliedConsequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Datentyp: Array von Objekten |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Zum Beispiel das Senden einer Warnung oder das 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:
Datentyp: Boolesch Standardwert: false |
| 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:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComparatorLower | Ein Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComparatorUpper | Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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: Schwellenwertregelverstoß [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:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.tolerancePeriod | Dauer oder Zeitintervall, in dem zulässige Kreuzungen auftreten können, bevor eine Konsequenz initiiert wird. Datumstyp: Objekt |
| testMeasure.ruleViolation.tolerancePeriod.amount | Betrag des Zeitraums in Zahl. Datentyp: Zahl |
| testMeasure.ruleViolation.tolerancePeriod.units | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.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 |
| 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.value.valueType | Typ des Testmesswerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| TestSpezifikation | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| 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 | Enddatum und Zeitstempel des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Startdatum und Zeitstempel des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
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"
}
]
}
]
}
]
}
Service-Testmanagement – API öffnen – PATCH /sn_sprb_mgmt/servicetestManagement/serviceTestSpecification/{ID}
Ermöglicht teilweise Aktualisierungen einer Service-Testdefinitionsentität.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestManagement/serviceTestSpecification/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID oder external_ID der abzurufenden Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Servicetestdefinition [sn_St_mgmt_Test_Definition] |
| Name | Beschreibung |
|---|---|
| Keine |
| 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 | 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 | 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:
Datentyp: Zeichenfolge |
| Merkmal | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.description | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Spektrales Merkmal.validFür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| SpecCharacteristic.validFor.endDateTime | Enddatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.validFor.startDateTime | Startdatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.valueType | Typ des Merkmalwerts.
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 | Die Häufigkeit, mit der die Metrik erfasst werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.capturePeriod | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMeasureDefinition.capturePeriod.amount | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMeasureDefinition.capturePeriod.units | Einheiten des Zeitraums. Gültige Werte:
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 | Kurzbeschreibung 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 Schwellenwertin 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 |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorExact | 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorOber | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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.conformanceTargetLower | 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.Rule.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 |
| 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.Rule.Konsequenz.prescribeAktion | Anwenderdefinierte Aktion für Schwellenwertverletzungen. 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime | Gültigkeitsstartdatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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.ThreholdRule.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:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.EinheitenMessung | Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden. Datentyp: Zeichenfolge |
| TestMessgrößenDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| TestMeasureDefinition.validFor.endDateTime | Gültigkeitsenddatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.validFor.startDateTime | Gültigkeitsstartdatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
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 |
| ZugehörigServiceSpecification.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 | 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:
Datentyp: Zeichenfolge |
| Merkmal | Testdefinitionsmerkmale. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.description | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Spektrales Merkmal.validFür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| SpecCharacteristic.validFor.endDateTime | Enddatum des Merkmals. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| SpecCharacteristic.validFor.startDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| SpecCharacteristic.valueType | Typ des Merkmalwerts.
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 | Häufigkeit, mit der die Metrik erfasst werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.capturePeriod | Dauer oder Zeitraum der Erfassung. Datentyp: Objekt |
| testMeasureDefinition.capturePeriod.amount | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMeasureDefinition.capturePeriod.units | Einheiten des Zeitraums. Akzeptierte Werte:
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 | Kurzbeschreibung 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 Schwellenwertfür eine bestimmte Testmaßdefinition überschritten wird oder nicht mehr überschritten wird. Datentyp: Array von Objekten |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorExact | Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorOber | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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.conformanceTargetLower | 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.Rule.Konsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| 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.Rule.Konsequenz.prescribeAktion | Anwenderdefinierte Aktion für Schwellenwertverletzungen. 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime | Gültigkeitsstartdatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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.ThreholdRule.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:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.EinheitenMessung | Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden. Datentyp: Zeichenfolge |
| TestMessgrößenDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.validFor.endDateTime | Gültigkeitsenddatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.validFor.startDateTime | Gültigkeitsstartdatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
cURL-Anforderung
Im folgenden Beispiel wird die angegebene Service-Testdefinitions-ID gemäß den im Anforderungstext angegebenen Änderungen teilweise aktualisiert.
curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e "
--request PATCH
--header "Accept:application/json"
--user 'username':'password'
--data {
"description": "Upstream and Downstream speed ",
"name": "This is my new Speed Test",
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
}
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
Der Antworttext gibt den aktualisierten Teil der Servicetestspezifikation zurück:
{
"description": "Upstream and Downstream speed ",
"name": "This is my new Speed Test",
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
}
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
Service-Testmanagement – API öffnen – POST /sn_sprb_mgmt/servicetestManagement/serviceTest
Erstellt einen Servicetest.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestManagement/serviceTest
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Merkmalen der Testdefinition finden Sie unter Datentyp: Array von Objekten |
| 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. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| Merkmal.WertTyp | Typ des Merkmalwerts.
Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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:
Datentyp: Zeichenfolge Standard: ONDEMAND |
| name | Erforderlich. Name des Servicetests. Datentyp: Zeichenfolge |
| ZugehörigService | Erforderlich. Testdefinition, die dem Servicetest zugeordnet ist. Datentyp: Objekt |
| 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: |
| Status | Status, in dem sich der Servicetest befindet. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure | Maß für einen bestimmten Aspekt eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| TestMessung.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: |
| 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:
Datentyp: Zeichenfolge |
| TestMeasure.metricBeschreibung | Kurzbeschreibung 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 |
| testMeasure.ruleViolation.appliedConsequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Zum Beispiel das Senden einer Warnung oder das 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:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComporatorExact | Kennzeichnung, die angibt, ob ein Wert identisch ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComporatorLower | Operator zum Überprüfen, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComporatorUpper | Operator zum Überprüfen, ob ein Wert über dem Schwellenwert liegt. Gültige Werte:
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: Schwellenwertregelverstoß [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:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.tolerancePeriod | Angegebenes Zeitintervall, in dem Überschreitungsvorkommen aktiviert werden, ohne unmittelbare Konsequenzen oder Aktionen auszulösen. Datumstyp: Objekt |
| 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:
Datentyp: Zeichenfolge |
| TestMeasure.EinheitenMessung | Maßeinheit für die Konformitätszielwerte der Testmaßnahme. Datentyp: Zeichenfolge |
| TestMeasure.value | Wert der Testmaßnahme. Datentyp: Objekt |
| 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.value.valueType | Typ des Testmesswerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| TestSpezifikation | Erforderlich. Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| 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 | Gültigkeitsenddatum des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Gültigkeitsstartdatum des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Datentyp: Array von Objekten |
| 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. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| Merkmal.WertTyp | Typ des Merkmalwerts.
Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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:
Datentyp: Zeichenfolge Standard: ONDEMAND |
| name | Name des Servicetests. Datentyp: Zeichenfolge |
| ZugehörigService | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| ZugehörigService.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: |
| Status | Status des Servicetests. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure | Maß für einen bestimmten Aspekt eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| TestMessung.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: |
| testMeasure.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.ID | SYS_ID oder external_ID der Testmaßnahme. Datentyp: Zeichenfolge Tabelle: Testmaßnahmen [sn_St_mgmt_Test_measure] |
| TestMeasure.metricBeschreibung | Kurzbeschreibung 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 |
| testMeasure.ruleViolation.appliedConsequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Datentyp: Array von Objekten |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Zum Beispiel das Senden einer Warnung oder das 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:
Datentyp: Boolesch Standardwert: false |
| 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:
Datentyp: Boolesch Standardwert: false |
| testMeasure.ruleViolation.conformanceComparatorLower | Ein Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComparatorUpper | Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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: Schwellenwertregelverstoß [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:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.tolerancePeriod | Dauer oder Zeitintervall, in dem zulässige Kreuzungen auftreten können, bevor eine Konsequenz initiiert wird. Datumstyp: Objekt |
| testMeasure.ruleViolation.tolerancePeriod.amount | Betrag des Zeitraums in Zahl. Datentyp: Zahl |
| testMeasure.ruleViolation.tolerancePeriod.units | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasure.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 |
| 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.value.valueType | Typ des Testmesswerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| TestSpezifikation | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| 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 | Enddatum und Zeitstempel des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Startdatum und Zeitstempel des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
cURL-Anforderung
Das folgende Beispiel erstellt einen neuen Servicetest gemäß bestimmten Details, die im Anforderungstext angegeben werden.
curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data {
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "Yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
Die Antwort gibt Bestätigungsdetails zum neuen Testservice zurück und weist ihm eine eindeutige ID zu, 2b406ec043b202104fefe4511fb8f211:
{
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "Yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
],
"id": "2b406ec043b202104fefe4511fb8f211"
}
Service-Testmanagement – API öffnen – POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Erstellt eine neue Servicetestdefinition.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestManagement/serviceTestSpecification
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| 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 | 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 | 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:
Datentyp: Zeichenfolge |
| Merkmal | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.description | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Spektrales Merkmal.validFür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| SpecCharacteristic.validFor.endDateTime | Enddatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.validFor.startDateTime | Startdatum des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| SpecCharacteristic.valueType | Typ des Merkmalwerts.
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 | Die Häufigkeit, mit der die Metrik erfasst werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.capturePeriod | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMeasureDefinition.capturePeriod.amount | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMeasureDefinition.capturePeriod.units | Einheiten des Zeitraums. Gültige Werte:
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 | Kurzbeschreibung 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 Schwellenwertin 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 |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorExact | 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorOber | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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.conformanceTargetLower | 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.Rule.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 |
| 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.Rule.Konsequenz.prescribeAktion | Anwenderdefinierte Aktion für Schwellenwertverletzungen. 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime | Gültigkeitsstartdatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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.ThreholdRule.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:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.EinheitenMessung | Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden. Datentyp: Zeichenfolge |
| TestMessgrößenDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| TestMeasureDefinition.validFor.endDateTime | Gültigkeitsenddatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.validFor.startDateTime | Gültigkeitsstartdatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| Validiertfür | Datumsbereich, für den die Testdefinition gültig ist. Datentyp: Objekt |
| 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: |
| ValidFor.startDateTime | Datum und Uhrzeit der Testdefinition, an der der Status veröffentlicht wird. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte 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 |
| ZugehörigServiceSpecification.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 | 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:
Datentyp: Zeichenfolge |
| Merkmal | Testdefinitionsmerkmale. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacteristic.characteristicValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.description | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Spektrales Merkmal.validFür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| SpecCharacteristic.validFor.endDateTime | Enddatum des Merkmals. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| SpecCharacteristic.validFor.startDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| SpecCharacteristic.valueType | Typ des Merkmalwerts.
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 | Häufigkeit, mit der die Metrik erfasst werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.captureMethod | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.capturePeriod | Dauer oder Zeitraum der Erfassung. Datentyp: Objekt |
| testMeasureDefinition.capturePeriod.amount | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMeasureDefinition.capturePeriod.units | Einheiten des Zeitraums. Akzeptierte Werte:
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 | Kurzbeschreibung 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 Schwellenwertfür eine bestimmte Testmaßdefinition überschritten wird oder nicht mehr überschritten wird. Datentyp: Array von Objekten |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorExact | Kennzeichnung, die angibt, ob ein Wert mit dem Wert von identisch ist conformanceTargetExact. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.threshold.Rule.conformanceComparatorOber | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
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.conformanceTargetLower | 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.Rule.Konsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| 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.Rule.Konsequenz.prescribeAktion | Anwenderdefinierte Aktion für Schwellenwertverletzungen. 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:
Datentyp: Boolesch Standardwert: false |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.threshold.Rule.Konsequenz.validFor.startDateTime | Gültigkeitsstartdatum der Konsequenz. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| 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.ThreholdRule.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:
Datentyp: Zeichenfolge |
| TestMeasureDefinition.EinheitenMessung | Messbarer Wert der Zeit, die zur Berechnung der Leistung eines Service verwendet wird, in Tagen, Minuten und Sekunden. Datentyp: Zeichenfolge |
| TestMessgrößenDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Objekt |
| TestMeasureDefinition.validFor.endDateTime | Gültigkeitsenddatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| TestMeasureDefinition.validFor.startDateTime | Gültigkeitsstartdatum der Testmaßdefinition. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| Validiertfür | Datumsbereich, für den der Servicetest gültig ist. Datentyp: Objekt |
| ValidFor.endDateTime | Enddatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
| ValidFor.startDateTime | Startdatum und -Uhrzeit des Servicetests. Datentyp: Zeichenfolge FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: |
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"
}