Service Test Management Open API
Die Service Test Management Open API bietet Endpunkte zum Erstellen und Abrufen von Servicetestdefinitionen und Servicetests.
Verwenden Sie diese API, um Service-Problem-Management-Informationen zwischen externen Systemen und Now Platformzu verwalten. Die Service Test Management Open API ist eine ServiceNow Implementierung der REST-Spezifikation der TM Forum Service Problem Management API. Diese Implementierung basiert auf https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/.
Diese REST API dient zum Verwalten und Ausführen von Servicetests in einer Telekommunikationsumgebung. Anwender können Servicetests definieren, auslösen und überwachen, um sicherzustellen, dass Services die Qualitäts- und Leistungsstandards erfüllen. Die API bietet Funktionen für das Testmanagement, einschließlich des Erstellens und Aktualisierens von Testdefinitionen, Ausführen von Tests, Abrufen von Testergebnissen und Verwalten von Testzeitplänen.
Die Service Test Management Open API erfordert das Plugin „Customer Service Problem Management“ (com.sn_sprb_mgmt) und die Rolle sn_sprb_mgmt.test_integrator. Diese API gehört zum Namespace sn_sprb_mgmt. Weitere Informationen zu Service-Problem-Management. Weitere Informationen zu dieser Anwendung finden Sie unter Customer Service Problem Management.
- Testlauf [sn_st_mgmt_test]
- Servicetestdefinition [sn_st_mgmt_test_definition]
- Testdefinitionsmerkmal [sn_st_mgmt_test_definition_characterific]
- Testmerkmal [sn_st_mgmt_test_charakteristik]
- Beziehung von Spezifikation zu Testdefinition [sn_st_mgmt_test_definition_m2m]
- Testdefinitionsbeziehung [sn_st_mgmt_test_definition_rel]
- Testmaß [sn_st_mgmt_test_measure]
- Messkonsequenz [sn_st_mgmt_measure_consequence]
- Testmaßdefinition [sn_st_mgmt_test_measure_definition]
- Angewendete Konsequenz [sn_st_mgmt_apppliziert_consequence]
- Schwellenwertregel [sn_st_mgmt_threshold_rule]
- Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation]
Offene API für Service-Testmanagement: GET /sn_sprb_mgmt/servicetestmanagement/serviceTest
Ruft eine Liste aller Servicetests ab.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest
Unterstützte Anforderungsparameter
| 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. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Höchstwert: 100 Standard: 20 |
| Offset | Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Parameter, um Ergebnisse in kleine und überschaubare Blöcke zu paginieren. Der erste Datensatz ist bei 0 indiziert. Datentyp: Zahl Standard: 0 |
| state | Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. In der Antwort werden nur Testdefinitionen im angegebenen Status zurückgegeben. Gültige Werte:
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 Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 206 | Teilressource, die als Antwort zurückgegeben wird (mit Paginierung). |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Testdefinitionsmerkmalen finden Sie unter Datentyp: Array von Objekten |
| characteristic.id | Sys_id oder external_id der Merkmale. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“. Datentyp: Zeichenfolge Tabelle: Merkmale [sn_prd_pm_charakteristik] |
| characteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Merkmal.Wert | Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| merkmal.wertTyp | Typ des Merkmalswerts.
Datentyp: Zeichenfolge |
| description | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -uhrzeit des Servicetests. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| href | Hyperlink-Referenz zum 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örigerService | 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]. |
| ZugehörigerService.name | Name des Produktbestands. Datentyp: Zeichenfolge |
| startDateTime | Startdatum und -uhrzeit des Servicetests. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| state | Status, in dem sich der Servicetest befindet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure | Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| testMeasure.accuracy | Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt. Datentyp: Zahl Höchstwert: 40 |
| testMessen.ErfassungsdatumZeit | Datum und Uhrzeit der Erfassung der Metrik. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasure.id | Sys_id oder external_id der Testmaße. Datentyp: Zeichenfolge Tabelle: In den Feldern „sys_id“ oder „external_id“ der Tabelle „Testmaße“ [sn_st_mgmt_test_measure]. |
| testMessen.Messen.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasure.metricName | Name der Testmaßmetrik. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung | Ein Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn ein Verstoß gegen die Regel vorliegt. Datentyp: Array von Objekten |
| testMessung.RegelVerstoß.Toleranzzeitraum.Betrag | Anzahl der Zeiträume vor Anwendung der Konsequenz. Datentyp: Zahl |
| testMessung.regelVerstoß.angewendeteKonsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung | Beschreibung der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id oder external_id der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.appliedConsequence.name | Name der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.AngewendeteKonsequenz.Wiederholungsaktion | Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt. Gültige Werte:
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, mit dem überprüft wird, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComporatorUpper | Operator, mit dem überprüft wird, ob ein Wert über dem Schwellenwert liegt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMessung.regelVerletzung.beschreibung | Beschreibung der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.id | Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation] |
| testMeasure.ruleViolation.name | Name der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.Toleranzzeitraum | Angegebenes Zeitintervall, während dessen Überschreitungsereignisse aktiviert sind, ohne unmittelbare Konsequenzen oder Aktionen auszulösen. Datumstyp: Objekt |
| testMessung.regelVerletzung.toleranzzeitraum.einheiten | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.messageeinheit | 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 Testmaßwerts Datentyp: Zeichenfolge |
| testMeasure.value.name | Name des Testmaßwerts. Datentyp: Zeichenfolge |
| testMeasure.value.value | Wert der Testmaßnahme. Datentyp: Zeichenfolge |
| testMessung.Wert.WertTyp | Typ des Testmaßwerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| testSpecification | 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]. |
| validFor | 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
Im folgenden Beispiel werden Informationen zu den beiden Servicetests in der Instanz abgerufen.
curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest” \
--user 'username’: ‘password'
Antworttext.
[
{
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/09d1f42e3be28210d140068aa4e45ae2",
"id": "09d1f42e3be28210d140068aa4e45ae2",
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
"id": "7d3854864316c6500e51203d5fb8f2d8"
},
"characteristic": [],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
},
{
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/18682a2a3b2682107222bf9985e45a55",
"id": "18682a2a3b2682107222bf9985e45a55",
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001012",
"startDateTime": "2024-06-05 17:45:07",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
"id": "7d3854864316c6500e51203d5fb8f2d8"
},
"characteristic": [
{
"id": "5c682a2a3b2682107222bf9985e45a5a",
"name": "url",
"valueType": "single_line_text",
"value": "http://abc.com"
}
],
"testMeasure": [
{
"id": "7c686a2a3b2682107222bf9985e45a4d",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "38686a2a3b2682107222bf9985e45a4e",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "34686a2a3b2682107222bf9985e45a50",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
]
Service Test Management Open API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Ruft eine Servicetest-Entität basierend auf der angegebenen ID eines Servicetests ab.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Unterstützte Anforderungsparameter
| 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 application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Datentyp: Array von Objekten |
| 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 die sys_id. Datentyp: Zeichenfolge Tabelle: Merkmale [sn_prd_pm_charakteristik] |
| Merkmal.Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Merkmal.Wert | Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| merkmal.wertTyp | Typ des Merkmalswerts.
Datentyp: Zeichenfolge |
| description | Beschreibung des Servicetests. Datentyp: Zeichenfolge |
| endDateTime | Enddatum und -uhrzeit des Servicetests. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| href | Hyperlink-Referenz zum 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örigerService | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| ZugehörigerService.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]. |
| ZugehörigerService.name | Name des Produktbestandsartikels. Datentyp: Zeichenfolge |
| startDateTime | Startdatum und -uhrzeit des Servicetests. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| state | Status des Servicetests. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure | Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| testMeasure.accuracy | Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt. Datentyp: Zahl Höchstwert: 40 |
| testMessen.ErfassungsdatumZeit | Datum und Uhrzeit der Erfassung der Metrik. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMessen.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.id | Sys_id oder external_id der Testmaßnahme. Datentyp: Zeichenfolge Tabelle: Testmaße [sn_st_mgmt_test_measure] |
| testMeasure.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasure.metricName | Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung | Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn die Regel verletzt wird. Datentyp: Array von Objekten |
| testMessung.regelVerstoß.angewendeteKonsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Datentyp: Array von Objekten |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren. Datentyp: Zeichenfolge |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion.Wiederholungsaktion | Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung | Beschreibung der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.id | Sys_id oder external_id der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.name | Name der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessen.regelVerletzung.konformerVergleichGenau | Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist. Gültige Werte:
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.conformanceCvergleichUpper | Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMessung.regelVerletzung.beschreibung | Beschreibung des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.id | Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation] |
| testMessung.RegelVerstoß.Name | Name des Verstoßes gegen die Schwellenwertregel. Datumstyp: Zeichenfolge |
| testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Maximum: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.Toleranzzeitraum | Dauer oder Zeitintervall, in der zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird. Datumstyp: Objekt |
| testMessung.RegelVerstoß.Toleranzzeitraum.Betrag | Betrag des Zeitraums als Nummer. Datentyp: Zahl |
| testMessung.regelVerletzung.toleranzzeitraum.einheiten | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.messageeinheit | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasure.value | Wert der Metrik im Test. Datentyp: Objekt |
| testMeasure.value.id | ID des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.Name | Name des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMeasure.value.value | Wert der Metrik im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.WertTyp | Typ des Testmaßwerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| testSpecification | 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] |
| validFor | 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
Im folgenden Beispiel werden Details zur Servicetest-Entität abgerufen, die der angegebenen ID zugeordnet ist, 44b7a8ea3b6a42107222bf9985e45a45.
curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45 \
--user 'username’: ‘password'
Antworttext.
{
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45",
"id": "44b7a8ea3b6a42107222bf9985e45a45",
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001001",
"startDateTime": "2024-06-05 08:22:52",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/7d3854864316c6500e51203d5fb8f2d8",
"id": "7d3854864316c6500e51203d5fb8f2d8"
},
"characteristic": [
{
"id": "5c682a2a3b2682107222bf9985e45a5a",
"name": "url",
"valueType": "single_line_text",
"value": "test"
}
],
"testMeasure": [
{
"id": "62ade42a3ba28210d140068aa4e45a71",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Downstream Speed",
"unitOfMeasure": "",
"value": "16",
"ruleViolation": [
{
"id": "b9bee4ae3ba28210d140068aa4e45a3a",
"description": "This speed is less than the target upper",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetUpper": "75",
"conformanceComparatorUpper": "less than",
"appliedConsequence": [
{
"id": "489074aa3be28210d140068aa4e45a42",
"appliedAction": "generateReport",
"description": "",
"name": "generateReport",
"repeatAction": "0"
},
{
"id": "785f2ce23be28210d140068aa4e45a75",
"appliedAction": "sendWarning",
"description": "",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
Offene API für Service-Testmanagement – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Ruft eine Liste aller Servicetestdefinitionen ab.
URL-Format
Standard-URL: GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Unterstützte Anforderungsparameter
| 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. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Höchstwert: 100 Standard: 20 |
| Offset | Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Parameter, um Ergebnisse in kleine und überschaubare Blöcke zu paginieren. Der erste Datensatz ist bei 0 indiziert. Datentyp: Zahl Standard: 0 |
| state | Filtern Sie Testdefinitionen nach dem aktuellen Status des Tests. In der Antwort werden nur Testdefinitionen im angegebenen Status zurückgegeben. Gültige Werte:
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 Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 und Limit=3, ist der Wert des Content-Range-Headers Elemente 3-5. |
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse:
|
| X-Gesamtzahl | Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 206 | Teilressource, die als Antwort zurückgegeben wird (mit Paginierung). |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| description | 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örigeServiceSpecification | 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 |
| serviceTestSpecBeziehung.id | Sys_id oder external_id der zugehörigen Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Testdefinition [sn_st_mgmt_test_definition] |
| serviceTestSpecBeziehung.name | Name der zugehörigen Testdefinition. Datentyp: Zeichenfolge |
| serviceTestSpecBeziehung.Beziehungstyp | Typ der Beziehung. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| specCharacterificent | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| specCharacterific.validFor | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| specCharacterific.validFor.endDateTime | Enddatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| specCharacterific.validFor.startDateTime | Startdatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| Spezifisches Merkmal.WerteTyp | Typ des Merkmalswerts.
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 |
| testMessDefinition.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessDefinition.Erfassungszeitraum | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMessdefinition.Erfassungszeitraum.Betrag | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMessdefinition.Erfassungszeitraum.Einheiten | 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.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasureDefinition.metricName | Benutzerdefinierter Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMeasureDefinition.name | Name der Testmaßdefinition. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule | Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.conformanceCvergleichExact | Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.conformanceCvergleichLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceCvergleichUpper | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.consequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.consequence.description | Beschreibung der Konsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id oder external_id der Messkonsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.name | Name der Konsequenz Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasureDefinition.thresholdRule.consequence.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.thresholdRule.numberOfAllowedCrossing | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.unitOfMeasure | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasureDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| 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: |
| validFor | Datumsbereich, für den die Testdefinition gültig ist. Datentyp: Objekt |
| validFor.endDateTime | Datum und Uhrzeit der Testdefinition, zu der der Status der Testdefinition stillgelegt wird. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| validFor.startDateTime | Datum und Uhrzeit der Testdefinition, zu der ihr Status veröffentlicht wird. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
cURL-Anforderung
In diesem Beispiel werden Details zu allen Testservice-Testdefinitionen in der Instanz abgerufen. In diesem Fall werden zwei Definitionen zurückgegeben.
curl --location --request GET
“https://instance.servicenow.com//api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification” \
--user 'username’: ‘password'
Antworttext.
[
{
"description": "Operation, Administration and Maintenance",
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"testMeasureDefinition": [
{
"id": "77b9b964432a02104fefe4511fb8f26e",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the Rx signal level",
"metricName": "Rx Optical Signal Level",
"name": "Rx Optical Signal Level",
"unitOfMeasure": "a minute",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": [
{
"id": "d3e97d64432a02104fefe4511fb8f281",
"description": "",
"name": "gponOntAniOpInfoRxOpticalSignalLevel",
"numberOfAllowedCrossing": "",
"thresholdRuleSeverity": "",
"tolerancePeriod": "",
"conformanceTargetUpper": "0",
"conformanceComparatorUpper": "less than",
"conformanceTargetLower": "-50",
"conformanceComparatorLower": "greater than",
"consequence": []
}
]
},
{
"id": "878afd64432a02104fefe4511fb8f28d",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the Tx signal level",
"metricName": "TX Optical Signal Level",
"name": "TX Optical Signal Level",
"unitOfMeasure": "a minute",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": [
{
"id": "b3dab5a4432a02104fefe4511fb8f2d3",
"description": "",
"name": "gponOntAniOpInfoTxOpticalSignalLevel",
"numberOfAllowedCrossing": "",
"thresholdRuleSeverity": "",
"tolerancePeriod": "",
"conformanceTargetUpper": "65",
"conformanceComparatorUpper": "less than",
"conformanceTargetLower": "-65",
"conformanceComparatorLower": "greater than",
"consequence": []
}
]
}
],
"specCharacteristic": [
{
"name": "AccessRequired",
"description": "AccessRequired",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 09:09:57"
},
"characteristicValueSpecification": [
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [],
"relatedServiceSpecification": [
{
"id": "f559b564432a02104fefe4511fb8f2e0",
"name": "OAM"
}
]
},
{
"description": "Upstream and Downstream speed ",
"id": "89d2b920432a02104fefe4511fb8f22e",
"name": "Speed Test",
"validFor": {
"startDateTime": "2024-05-31",
"endDateTime": "2024-06-27"
},
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
},
"characteristicValueSpecification": [
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
]
Service Test Management Open API – GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Ruft eine Servicetest-Definitionsentität ab.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Unterstützte Anforderungsparameter
| 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. In der Antwort werden nur Testdefinitionen im angegebenen Status 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 HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| description | 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örigeServiceSpecification | 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 |
| serviceTestSpecBeziehung.id | Sys_id oder external_id der zugehörigen Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Testdefinition [sn_st_mgmt_test_definition] |
| serviceTestSpecBeziehung.name | Name der zugehörigen Testdefinition. Datentyp: Zeichenfolge |
| serviceTestSpecBeziehung.Beziehungstyp | Typ der Beziehung. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| specCharacterificent | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| specCharacterific.validFor | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| specCharacterific.validFor.endDateTime | Enddatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| specCharacterific.validFor.startDateTime | Startdatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| Spezifisches Merkmal.WerteTyp | Typ des Merkmalswerts.
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 |
| testMessDefinition.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessDefinition.Erfassungszeitraum | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMessdefinition.Erfassungszeitraum.Betrag | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMessdefinition.Erfassungszeitraum.Einheiten | 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.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasureDefinition.metricName | Benutzerdefinierter Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMeasureDefinition.name | Name der Testmaßdefinition. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule | Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.conformanceCvergleichExact | Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.conformanceCvergleichLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceCvergleichUpper | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.consequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.consequence.description | Beschreibung der Konsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id oder external_id der Messkonsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.name | Name der Konsequenz Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasureDefinition.thresholdRule.consequence.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.thresholdRule.numberOfAllowedCrossing | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.unitOfMeasure | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasureDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| 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: |
| validFor | Datumsbereich, für den die Testdefinition gültig ist. Datentyp: Objekt |
| validFor.endDateTime | Datum und Uhrzeit der Testdefinition, zu der der Status der Testdefinition stillgelegt wird. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| validFor.startDateTime | Datum und Uhrzeit der Testdefinition, zu der ihr Status veröffentlicht wird. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
cURL-Anforderung
In diesem Beispiel werden Details einer Servicetestdefinition mit einer angegebenen ID abgerufen.
curl --location --request GET "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e" \
--user 'username’: ‘password'
Antworttext.
{
"description": "Upstream and Downstream speed ",
"id": "89d2b920432a02104fefe4511fb8f22e",
"name": "Speed Test",
"validFor": {
"startDateTime": "2024-05-31",
"endDateTime": "2024-06-27"
},
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
},
"characteristicValueSpecification": [
{
"value": "No",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": "",
"endDateTime": ""
}
}
]
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
Service Test Management Open API – PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Aktualisiert eine Servicetest-Entität.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Unterstützte Anforderungsparameter
| 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 Testdefinitionsmerkmalen finden Sie unter Datentyp: Array von Objekten |
| characteristic.id | Sys_id oder external_id der Merkmale. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“. Datentyp: Zeichenfolge Tabelle: Merkmale [sn_prd_pm_charakteristik] |
| characteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Merkmal.Wert | Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| merkmal.wertTyp | Typ des Merkmalswerts.
Datentyp: Zeichenfolge |
| description | 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örigerService | 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: |
| state | Status, in dem sich der Servicetest befindet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure | Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| testMeasure.accuracy | Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt. Datentyp: Zahl Höchstwert: 40 |
| testMessen.ErfassungsdatumZeit | Datum und Uhrzeit der Erfassung der Metrik. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasure.id | Sys_id oder external_id der Testmaße. Datentyp: Zeichenfolge Tabelle: In den Feldern „sys_id“ oder „external_id“ der Tabelle „Testmaße“ [sn_st_mgmt_test_measure]. |
| testMessen.Messen.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasure.metricName | Name der Testmaßmetrik. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung | Ein Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn ein Verstoß gegen die Regel vorliegt. Datentyp: Array von Objekten |
| testMessung.RegelVerstoß.Toleranzzeitraum.Betrag | Anzahl der Zeiträume vor Anwendung der Konsequenz. Datentyp: Zahl |
| testMessung.regelVerstoß.angewendeteKonsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung | Beschreibung der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id oder external_id der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.appliedConsequence.name | Name der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.AngewendeteKonsequenz.Wiederholungsaktion | Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt. Gültige Werte:
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, mit dem überprüft wird, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComporatorUpper | Operator, mit dem überprüft wird, ob ein Wert über dem Schwellenwert liegt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMessung.regelVerletzung.beschreibung | Beschreibung der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.id | Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation] |
| testMeasure.ruleViolation.name | Name der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.Toleranzzeitraum | Angegebenes Zeitintervall, während dessen Überschreitungsereignisse aktiviert sind, ohne unmittelbare Konsequenzen oder Aktionen auszulösen. Datumstyp: Objekt |
| testMessung.regelVerletzung.toleranzzeitraum.einheiten | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.messageeinheit | 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 Testmaßwerts Datentyp: Zeichenfolge |
| testMeasure.value.name | Name des Testmaßwerts. Datentyp: Zeichenfolge |
| testMeasure.value.value | Wert der Testmaßnahme. Datentyp: Zeichenfolge |
| testMessung.Wert.WertTyp | Typ des Testmaßwerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| testSpecification | 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]. |
| validFor | 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 HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Datentyp: Array von Objekten |
| Merkmal.ID | Sys_id oder external_id der Merkmale. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“. Datentyp: Zeichenfolge Tabelle: Merkmale [sn_prd_pm_charakteristik] |
| Merkmal.Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Merkmal.Wert | Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| merkmal.wertTyp | Typ des Merkmalswerts.
Datentyp: Zeichenfolge |
| description | 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örigerService | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| ZugehörigerService.id | Sys_id oder external_id des Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_product_inventory] |
| ZugehörigerService.name | Name des Produktbestands. Datentyp: Zeichenfolge |
| testMeasure | Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| testMeasure.accuracy | Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt. Datentyp: Zahl Höchstwert: 40 |
| testMessen.ErfassungsdatumZeit | Datum und Uhrzeit der Erfassung der Metrik. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMessen.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.id | Sys_id oder external_id der Testmaßnahme. Datentyp: Zeichenfolge Tabelle: Testmaße [sn_st_mgmt_test_measure] |
| testMeasure.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasure.metricName | Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung | Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn die Regel verletzt wird. Datentyp: Array von Objekten |
| testMessung.regelVerstoß.angewendeteKonsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Datentyp: Array von Objekten |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren. Datentyp: Zeichenfolge |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion.Wiederholungsaktion | Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung | Beschreibung der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.id | Sys_id oder external_id der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.name | Name der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessen.regelVerletzung.konformerVergleichGenau | Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist. Gültige Werte:
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.conformanceCvergleichUpper | Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMessung.regelVerletzung.beschreibung | Beschreibung des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.id | Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation] |
| testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Maximum: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.Toleranzzeitraum | Dauer oder Zeitintervall, in der zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird. Datumstyp: Objekt |
| testMessung.RegelVerstoß.Toleranzzeitraum.Betrag | Betrag des Zeitraums als Nummer. Datentyp: Zahl |
| testMessung.regelVerletzung.toleranzzeitraum.einheiten | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.messageeinheit | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasure.value | Wert der Metrik im Test. Datentyp: Objekt |
| testMeasure.value.id | ID des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.Name | Name des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMeasure.value.value | Wert der Metrik im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.WertTyp | Typ des Testmaßwerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| testSpecification | 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] |
| validFor | 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
Im folgenden Beispiel wird die angegebene Servicetest-Entität gemäß den im Anforderungstext angegebenen Details aktualisiert.
curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/2b406ec043b202104fefe4511fb8f211" \
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'
--data {
"description": "Service test description",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "No"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
Die Antwort zeigt eine erfolgreiche Aktualisierung, indem die geänderten Informationen im angegebenen Testservice zurückgegeben werden.
{
"description": "Service test description",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
Service Test Management Open API – PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Ermöglicht teilweise Aktualisierungen einer Servicetestdefinitionsentität.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Unterstützte Anforderungsparameter
| 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 |
|---|---|
| description | Beschreibung der Servicetestdefinition. Datentyp: Zeichenfolge |
| name | Erforderlich. Name der Servicetestdefinition. Datentyp: Zeichenfolge |
| ZugehörigeServiceSpecification | 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 |
| serviceTestSpecBeziehung.id | Sys_id oder external_id der zugehörigen Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Testdefinition [sn_st_mgmt_test_definition] |
| serviceTestSpecBeziehung.name | Name der zugehörigen Testdefinition. Datentyp: Zeichenfolge |
| serviceTestSpecBeziehung.Beziehungstyp | Typ der Beziehung. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| specCharacterificent | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| specCharacterific.validFor | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| specCharacterific.validFor.endDateTime | Enddatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| specCharacterific.validFor.startDateTime | Startdatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| Spezifisches Merkmal.WerteTyp | Typ des Merkmalswerts.
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 |
| testMessDefinition.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessDefinition.Erfassungszeitraum | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMessdefinition.Erfassungszeitraum.Betrag | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMessdefinition.Erfassungszeitraum.Einheiten | 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.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasureDefinition.metricName | Benutzerdefinierter Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMeasureDefinition.name | Name der Testmaßdefinition. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule | Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.conformanceCvergleichExact | Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.conformanceCvergleichLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceCvergleichUpper | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.consequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.consequence.description | Beschreibung der Konsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id oder external_id der Messkonsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.name | Name der Konsequenz Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasureDefinition.thresholdRule.consequence.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.thresholdRule.numberOfAllowedCrossing | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.unitOfMeasure | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasureDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| 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 application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| description | 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örigeServiceSpecification | Servicespezifikationen für die Testdefinitionen. Datentyp: Array von Objekten |
| ZugehörigeServiceSpezifikation.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 |
| serviceTestSpecBeziehung.id | Sys_id oder external_id der zugehörigen Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Testdefinition [sn_st_mgmt_test_definition] |
| serviceTestSpecBeziehung.name | Name der zugehörigen Testdefinition. Datentyp: Zeichenfolge |
| serviceTestSpecBeziehung.Beziehungstyp | Typ der Beziehung. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| specCharacterificent | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| specCharacterific.validFor | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| specCharacterific.validFor.endDateTime | Enddatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| specCharacterific.validFor.startDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| Spezifisches Merkmal.WerteTyp | Typ des Merkmalswerts.
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 |
| testMessDefinition.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessDefinition.Erfassungszeitraum | Dauer oder Zeitraum der Erfassung. Datentyp: Objekt |
| testMessdefinition.Erfassungszeitraum.Betrag | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMessdefinition.Erfassungszeitraum.Einheiten | 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.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasureDefinition.metricName | Benutzerdefinierter Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMeasureDefinition.name | Name der Testmaßdefinition. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule | Regel, die die Bedingung (erhöhen oder löschen) definiert, die erfüllt sein muss, um Konsequenzen anzuwenden, wenn ein Schwellenwert für eine bestimmte Testmaßdefinition überschritten wird oder nicht mehr überschritten wird. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.conformanceCvergleichExact | Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.conformanceCvergleichLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceCvergleichUpper | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.consequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.consequence.description | Beschreibung der Konsequenz. Datentyp: Zeichenfolge |
| testMessgrößenDefinition.thresholdRule.consequence.id | Sys_id oder external_id der Messkonsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.name | Name der Konsequenz Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasureDefinition.thresholdRule.consequence.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: Schwellenwertregeln [sn_st_mgmt_threshold_rule] |
| testMessgrößenDefinition.thresholdRule.name | Name der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.unitOfMeasure | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasureDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Objekt |
| 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 ID der Servicetestdefinition teilweise aktualisiert, je nachdem, welche Änderungen im Anforderungstext vorgenommen wurden.
curl "http://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e "
--request PATCH
--header "Accept:application/json"
--user 'username':'password'
--data {
"description": "Upstream and Downstream speed ",
"name": "This is my new Speed Test",
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
}
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
Der Antworttext gibt den aktualisierten Teil der Servicetestspezifikation zurück:
{
"description": "Upstream and Downstream speed ",
"name": "This is my new Speed Test",
"testMeasureDefinition": [
{
"id": "1a04f560432a02104fefe4511fb8f2ad",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the downstream speed in a service",
"metricName": "Downstream Speed",
"name": "Downstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "30 Minutes",
"validFor": {
"startDateTime": "2024-05-30 08:49:26",
"endDateTime": "2024-05-31 08:49:29"
},
"thresholdRule": [
{
"id": "a754f960432a02104fefe4511fb8f2d0",
"description": "This speed is greater than the target upper",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "15 Minutes",
"conformanceTargetLower": "75",
"conformanceComparatorLower": "greater than",
"consequence": [
{
"id": "15a4bd60432a02104fefe4511fb8f2b8",
"prescribeAction": "null",
"description": "generate a waring report",
"name": "degradedQualityOfService",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:51:29",
"endDateTime": "2024-08-06 08:51:31"
}
},
{
"id": "e6847d60432a02104fefe4511fb8f2c3",
"prescribeAction": "null",
"description": "send a warning to the system",
"name": "packetdrop",
"repeatAction": "0",
"validFor": {
"startDateTime": "2024-05-30 08:50:53",
"endDateTime": "2024-08-06 08:50:55"
}
}
]
},
{
"id": "cb55b5a0432a02104fefe4511fb8f201",
"description": "",
"name": "InternetSpeedValue",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "medium",
"tolerancePeriod": "",
"conformanceTargetUpper": "120",
"conformanceComparatorUpper": "less than",
"consequence": []
}
]
},
{
"id": "8f987524432a02104fefe4511fb8f2f0",
"captureFrequency": "once",
"captureMethod": "automatic",
"metricDescription": "This is the upstream speed in the service",
"metricName": "Upstream Speed",
"name": "Upstream Speed",
"unitOfMeasure": "a second",
"valueType": "",
"capturePeriod": "",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"thresholdRule": []
}
],
"specCharacteristic": [
{
"name": "restart",
"description": "restart",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2024-05-30 08:45:49"
}
}
],
"serviceTestSpecRelationship": [
{
"id": "76a3b160432a02104fefe4511fb8f2ad",
"name": "OAM Test",
"relationshipType": ""
}
],
"relatedServiceSpecification": [
{
"id": "aeddcd1fb7d69910ff00f203ae11a990",
"name": "Home Internet"
}
]
}
Service Test Management Open API – POST /sn_sprb_mgmt/servicetestmanagement/serviceTest
Erstellt einen Servicetest.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTest
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Weitere Informationen zu Testdefinitionsmerkmalen finden Sie unter Datentyp: Array von Objekten |
| characteristic.id | Sys_id oder external_id der Merkmale. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“. Datentyp: Zeichenfolge Tabelle: Merkmale [sn_prd_pm_charakteristik] |
| characteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Merkmal.Wert | Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| merkmal.wertTyp | Typ des Merkmalswerts.
Datentyp: Zeichenfolge |
| description | 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örigerService | 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: |
| state | Status, in dem sich der Servicetest befindet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure | Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| testMeasure.accuracy | Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt. Datentyp: Zahl Höchstwert: 40 |
| testMessen.ErfassungsdatumZeit | Datum und Uhrzeit der Erfassung der Metrik. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasure.id | Sys_id oder external_id der Testmaße. Datentyp: Zeichenfolge Tabelle: In den Feldern „sys_id“ oder „external_id“ der Tabelle „Testmaße“ [sn_st_mgmt_test_measure]. |
| testMessen.Messen.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasure.metricName | Name der Testmaßmetrik. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung | Ein Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn ein Verstoß gegen die Regel vorliegt. Datentyp: Array von Objekten |
| testMessung.regelVerstoß.angewendeteKonsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung | Beschreibung der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id oder external_id der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.appliedConsequence.name | Name der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.AngewendeteKonsequenz.Wiederholungsaktion | Kennzeichnung, die angibt, ob die Konsequenz wiederholt werden soll, wenn ein zweiter Verstoß auftritt. Gültige Werte:
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, mit dem überprüft wird, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceComporatorUpper | Operator, mit dem überprüft wird, ob ein Wert über dem Schwellenwert liegt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMessung.regelVerletzung.beschreibung | Beschreibung der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.id | Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation] |
| testMeasure.ruleViolation.name | Name der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.Toleranzzeitraum | Angegebenes Zeitintervall, während dessen Überschreitungsereignisse aktiviert sind, ohne unmittelbare Konsequenzen oder Aktionen auszulösen. Datumstyp: Objekt |
| testMessung.RegelVerstoß.Toleranzzeitraum.Betrag | Anzahl der Zeiträume vor Anwendung der Konsequenz. Datentyp: Zahl |
| testMessung.regelVerletzung.toleranzzeitraum.einheiten | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.messageeinheit | 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 Testmaßwerts Datentyp: Zeichenfolge |
| testMeasure.value.name | Name des Testmaßwerts. Datentyp: Zeichenfolge |
| testMeasure.value.value | Wert der Testmaßnahme. Datentyp: Zeichenfolge |
| testMessung.Wert.WertTyp | Typ des Testmaßwerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| testSpecification | 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]. |
| validFor | 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 HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Merkmal | Liste, die die Merkmale des zugehörigen Servicetests beschreibt. Datentyp: Array von Objekten |
| Merkmal.ID | Sys_id oder external_id der Merkmale. Wenn „external_id“ für diesen Datensatz vorhanden ist, gibt die Antwort die „external_id“ zurück, andernfalls die „sys_id“. Datentyp: Zeichenfolge Tabelle: Merkmale [sn_prd_pm_charakteristik] |
| Merkmal.Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Merkmal.Wert | Merkmalsoptionen, die dem Servicetest zugeordnet sind. Die Merkmale variieren je nach Kundeninstanz. Datentyp: Zeichenfolge |
| merkmal.wertTyp | Typ des Merkmalswerts.
Datentyp: Zeichenfolge |
| description | 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örigerService | Testdefinition, die diesem Test zugeordnet ist. Datentyp: Objekt |
| ZugehörigerService.id | Sys_id oder external_id des Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_product_inventory] |
| ZugehörigerService.name | Name des Produktbestands. Datentyp: Zeichenfolge |
| startDateTime | Startdatum und -uhrzeit des Servicetests. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| state | Status des Servicetests. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure | Messung eines bestimmten Aspekts eines Produkt-, Service- oder Ressourcentests, z. B. verlorene Pakete oder Konnektivitätsstatus. Datentyp: Array von Objekten |
| testMeasure.accuracy | Gleitkomma-Dezimalwert, der die für die zugeordneten Metriken erfasste Testmaßgenauigkeit darstellt. Datentyp: Zahl Höchstwert: 40 |
| testMessen.ErfassungsdatumZeit | Datum und Uhrzeit der Erfassung der Metrik. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMessen.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.id | Sys_id oder external_id der Testmaßnahme. Datentyp: Zeichenfolge Tabelle: Testmaße [sn_st_mgmt_test_measure] |
| testMeasure.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasure.metricName | Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung | Objekt zum Definieren einer Regel in der Definition der Schwellenwertregel, zusammen mit den Konsequenzen, wenn die Regel verletzt wird. Datentyp: Array von Objekten |
| testMessung.regelVerstoß.angewendeteKonsequenz | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Datentyp: Array von Objekten |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion | Aktion, die ausgeführt werden soll, wenn eine Schwellenwertregel verletzt wird. Beispielsweise das Senden einer Warnung oder das Generieren eines Berichts. Angewendete Aktionen können zwischen Instanzen variieren. Datentyp: Zeichenfolge |
| testMeasure.ruleVerletzung.angewendeteKonsequenz.angewendeteAktion.Wiederholungsaktion | Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMessung.regelVerletzung.angewendeteKonsequenz.beschreibung | Beschreibung der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.id | Sys_id oder external_id der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.angewendeteKonsequenz.name | Name der angewendeten Konsequenz. Datentyp: Zeichenfolge |
| testMessen.regelVerletzung.konformerVergleichGenau | Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist. Gültige Werte:
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.conformanceCvergleichUpper | Ein Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.ruleViolation.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMeasure.ruleViolation.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Bestimmt, ob der Schwellenwert überschritten oder nicht mehr überschritten wird. Datentyp: Zahl |
| testMessung.regelVerletzung.beschreibung | Beschreibung des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge |
| testMessung.regelVerletzung.id | Sys_id oder external_id des Verstoßes gegen die Schwellenwertregel. Datentyp: Zeichenfolge Tabelle: Verstoß gegen Schwellenwertregel [sn_st_mgmt_threshold_rule_violation] |
| testMessung.RegelVerstoß.Name | Name des Verstoßes gegen die Schwellenwertregel. Datumstyp: Zeichenfolge |
| testMessen.regelVerstoß.anzahlZulässigerÜberschreitungen | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Maximum: 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessung.RegelVerstoß.Toleranzzeitraum | Dauer oder Zeitintervall, in der zulässige Überschreitungen auftreten können, bevor eine Konsequenz initiiert wird. Datumstyp: Objekt |
| testMessung.RegelVerstoß.Toleranzzeitraum.Betrag | Betrag des Zeitraums als Nummer. Datentyp: Zahl |
| testMessung.regelVerletzung.toleranzzeitraum.einheiten | Einheiten des Zeitraums. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasure.messageeinheit | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasure.value | Wert der Metrik im Test. Datentyp: Objekt |
| testMeasure.value.id | ID des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.Name | Name des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.Name | Name des Metrikwerts im Test. Datentyp: Zeichenfolge |
| testMeasure.value.value | Wert der Metrik im Test. Datentyp: Zeichenfolge |
| testMessung.Wert.WertTyp | Typ des Testmaßwerts, z. B. numerisch, Text usw. Datentyp: Zeichenfolge |
| testSpecification | 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] |
| validFor | 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
Im folgenden Beispiel wird ein neuer Servicetest gemäß den im Anforderungstext angegebenen Details erstellt.
curl "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data {
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "Yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
]
}
Die Antwort gibt Bestätigungsdetails zum neuen Testservice zurück und weist ihm eine eindeutige ID zu: 2b406ec043b202104fefe4511fb8f211:
{
"description": "Service test",
"endDateTime": "2025-01-31 15:05:43",
"mode": "proactive",
"name": "Speed Test TR0001002",
"startDateTime": "2024-06-05 09:07:10",
"validFor": {
"startDateTime": "",
"endDateTime": ""
},
"relatedService": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"name": "Internet_VPLS_PI0000011"
},
"testSpecification": {
"href": "/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/76a3b160432a02104fefe4511fb8f2ad",
"id": "76a3b160432a02104fefe4511fb8f2ad"
},
"characteristic": [
{
"id": "e7ef960443f202104fefe4511fb8f224",
"name": "AccessRequired",
"valueType": "yes_no",
"value": "Yes"
}
],
"testMeasure": [
{
"id": "61d1382e3be28210d140068aa4e45a2e",
"accuracy": "0.0001",
"captureDateTime": "",
"captureMethod": "automatic",
"metricDescription": "",
"metricName": "Flow speed",
"unitOfMeasure": "A second",
"value": "3000",
"ruleViolation": [
{
"id": "61d1382e3be28210d140068aa4e45a2f",
"description": "This speed is greater than the target",
"name": "tooMuchTraffic",
"numberOfAllowedCrossing": "0",
"thresholdRuleSeverity": "high",
"tolerancePeriod": "",
"conformanceTargetLower": "2500",
"conformanceComparatorLower": "greater than",
"appliedConsequence": [
{
"id": "65d1382e3be28210d140068aa4e45a31",
"appliedAction": "sendWarning",
"description": "send a warning to the system",
"name": "sendWarning",
"repeatAction": "0"
}
]
}
]
}
],
"id": "2b406ec043b202104fefe4511fb8f211"
}
Service Test Management Open API – POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Erstellt eine neue Servicetestdefinition.
URL-Format
Standard-URL: /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| description | 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örigeServiceSpecification | 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 |
| serviceTestSpecBeziehung.Beziehungstyp | Typ der Beziehung. Gültige Werte:
Datentyp: Zeichenfolge |
| specCharacterificent | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| specCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| specCharacterific.validFor | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| specCharacterific.validFor.endDateTime | Enddatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| specCharacterific.validFor.startDateTime | Startdatum des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| Spezifisches Merkmal.WerteTyp | Typ des Merkmalswerts.
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 |
| testMessDefinition.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessDefinition.Erfassungszeitraum | Zeitraum oder Dauer der Metrikerfassung. Datentyp: Objekt |
| testMessdefinition.Erfassungszeitraum.Betrag | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMessdefinition.Erfassungszeitraum.Einheiten | 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.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasureDefinition.metricName | Benutzerdefinierter Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMeasureDefinition.name | Name der Testmaßdefinition. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule | Regel, die Bedingungen definiert, die erfüllt werden müssen, bevor Konsequenzen angewendet werden, wenn in der Testmaßdefinition ein Schwellenwert überschritten (oder nicht überschritten) wird. Weitere Informationen finden Sie unter Define threshold rules for a test measure definition. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.conformanceCvergleichExact | Kennzeichnung, die angibt, ob ein Wert mit dem für testMeasureDefinition.thresholdRule.conformanceTargetExactfestgelegten Wert identisch ist. Bei „wahr“ ist testMeasureDefinition.thresholdRule.conformanceTargetExact erforderlich. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.conformanceCvergleichLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceCvergleichUpper | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.consequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Weitere Informationen finden Sie unter Define measure consequences for the threshold rules. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.consequence.description | Beschreibung der Konsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id oder external_id der Messkonsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.name | Name der Konsequenz Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Kennzeichnung, die angibt, ob die angewendete Konsequenz wiederholt werden soll. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasureDefinition.thresholdRule.consequence.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.thresholdRule.numberOfAllowedCrossing | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.unitOfMeasure | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasureDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Zeichenfolge |
| 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: |
| validFor | Datumsbereich, für den die Testdefinition gültig ist. Datentyp: Objekt |
| validFor.endDateTime | Datum und Uhrzeit der Testdefinition, zu der der Status der Testdefinition stillgelegt wird. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| validFor.startDateTime | Datum und Uhrzeit der Testdefinition, zu der ihr 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 application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| description | 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örigeServiceSpecification | Servicespezifikationen für die Testdefinitionen. Datentyp: Array von Objekten |
| ZugehörigeServiceSpezifikation.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 |
| serviceTestSpecBeziehung.id | Sys_id oder external_id der zugehörigen Servicetestdefinition. Datentyp: Zeichenfolge Tabelle: Testdefinition [sn_st_mgmt_test_definition] |
| serviceTestSpecBeziehung.name | Name der zugehörigen Testdefinition. Datentyp: Zeichenfolge |
| serviceTestSpecBeziehung.Beziehungstyp | Typ der Beziehung. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| specCharacterificent | Merkmale der Testdefinition. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification | Mögliche Werte des Merkmals. Datentyp: Array von Objekten |
| specCharacterific.characteristValueSpecification.value | Wert des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Spez. Merkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| specCharacterific.validFor | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| specCharacterific.validFor.endDateTime | Enddatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| specCharacterific.validFor.startDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| Spezifisches Merkmal.WerteTyp | Typ des Merkmalswerts.
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 |
| testMessDefinition.Erfassungsmethode | Methode zum Erfassen der Metrik. Gültige Werte:
Datentyp: Zeichenfolge |
| testMessDefinition.Erfassungszeitraum | Dauer oder Zeitraum der Erfassung. Datentyp: Objekt |
| testMessdefinition.Erfassungszeitraum.Betrag | Anzahl der Erfassungszeiträume. Datentyp: Zahl |
| testMessdefinition.Erfassungszeitraum.Einheiten | 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.metricDescription | Kurzbeschreibung der Metrik. Datentyp: Zeichenfolge |
| testMeasureDefinition.metricName | Benutzerdefinierter Name einer Metrik in der Testmaßnahme. Datentyp: Zeichenfolge |
| testMeasureDefinition.name | Name der Testmaßdefinition. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule | Regel, die die Bedingung (erhöhen oder löschen) definiert, die erfüllt sein muss, um Konsequenzen anzuwenden, wenn ein Schwellenwert für eine bestimmte Testmaßdefinition überschritten wird oder nicht mehr überschritten wird. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.conformanceCvergleichExact | Kennzeichnung, die angibt, ob ein Wert identisch mit dem Wert von conformanceTargetExactist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.conformanceCvergleichLower | Operator, der überprüft, ob ein Wert unter den Schwellenwert fällt. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceCvergleichUpper | Operator, der überprüft, ob ein Wert den Schwellenwert überschreitet. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Erforderlich, wenn conformanceComparatorExact auf „wahr“ festgelegt ist. Wenn der Wert conformanceComparatorExact auf true festgelegt ist, stimmt sein Wert mit dem in conformanceTargetExactdefinierten Wert überein. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Unterer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Oberer Schwellenwert für den Vergleich der Testmessergebnisse. Datentyp: Zahl |
| testMeasureDefinition.thresholdRule.consequence | Aktion (vorgeschriebene Aktion oder Benachrichtigung), die ausgeführt werden soll, wenn eine Schwellenwertregel überschritten wird. Datentyp: Array von Objekten |
| testMeasureDefinition.thresholdRule.consequence.description | Beschreibung der Konsequenz. Datentyp: Zeichenfolge |
| testMessgrößenDefinition.thresholdRule.consequence.id | Sys_id oder external_id der Messkonsequenz. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.name | Name der Konsequenz Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Anwenderdefinierte Aktion, die bei Verstößen gegen den Schwellenwert ausgeführt werden soll. Aktionen variieren zwischen Instanzen. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Kennzeichnung, die angibt, ob die angewendete Aktion wiederholt werden soll oder nicht. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Datumsbereich, für den die Konsequenz gültig ist. Datentyp: Objekt |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Gültigkeitsenddatum der Konsequenz Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: |
| testMeasureDefinition.thresholdRule.consequence.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: Schwellenwertregeln [sn_st_mgmt_threshold_rule] |
| testMessgrößenDefinition.thresholdRule.name | Name der Schwellenwertregel. Datentyp: Zeichenfolge |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Maximal zulässige Überschreitungen innerhalb des Toleranzzeitraums, bevor Konsequenzen angewendet werden. Datentyp: Zahl Höchstwert: 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Schweregrad der Schwellenwertregel. Gültige Werte:
Datentyp: Zeichenfolge |
| testMeasureDefinition.unitOfMeasure | Messbarer Zeitwert, der zur Berechnung der Leistung eines Service in Tagen, Minuten und Sekunden verwendet wird. Datentyp: Zeichenfolge |
| testMeasureDefinition.validFor | Datumsbereich, für den die Testmaßdefinition gültig ist. Datentyp: Objekt |
| 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: |
| validFor | 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"
}