API ouverte de Gestion des tests de service
L’API ouverte de gestion des tests de service fournit des points de terminaison pour créer et récupérer des définitions de test de service et des tests de service.
Utilisez cette API pour gérer les informations de gestion des problèmes de service entre les systèmes externes et le Now Platform. L’API ouverte de gestion des tests de service est une ServiceNow implémentation de la spécification REST de l’API de gestion des problèmes de service TM Forum. Cette implémentation est basée sur https://www.tmforum.org/resources/specification/tmf653-service-test-management-api-user-guide-v4-1-0/.
Cette API REST est conçue pour gérer et exécuter des tests de service dans un environnement de télécommunications. Elle permet aux utilisateurs de définir, de déclencher et de surveiller les tests de service, afin de s’assurer que les services répondent aux normes de qualité et de performances. L’API fournit des options pour la gestion des tests, y compris la création et la mise à jour des définitions de test, l’exécution de tests, la récupération des résultats des tests et la gestion des calendriers de tests.
L’API ouverte Gestion des tests de service nécessite le module d’extension Gestion des problèmes du service clientèle (com.sn_sprb_mgmt) et le rôle sn_sprb_mgmt.test_integrator. Cette API appartient à l’espace de noms sn_sprb_mgmt. Pour plus d’informations sur la gestion des problèmes de service. Consultez Customer Service Problem Management pour plus d’informations sur cette application.
- Exécution du test [sn_st_mgmt_test]
- Définition du test de service [sn_st_mgmt_test_definition]
- Caractéristique de la définition de test [sn_st_mgmt_test_definition_characteristic]
- Caractéristique du test [sn_st_mgmt_test_characteristic]
- Relation entre spécification et définition de test [sn_st_mgmt_test_definition_m2m]
- Relation de définition de test [sn_st_mgmt_test_definition_rel]
- Mesure de test [sn_st_mgmt_test_measure]
- Mesurer la conséquence [sn_st_mgmt_measure_consequence]
- Définition de la mesure de test [sn_st_mgmt_test_measure_definition]
- Conséquence appliquée [sn_st_mgmt_applied_consequence]
- Règle de seuil [sn_st_mgmt_threshold_rule]
- Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]
API ouverte de gestion des tests de service : GET /sn_sprb_mgmt/servicetestmanagement/serviceTest
Récupère une liste de tous les tests de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTest
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n’est pas utilisé, tous les champs sont renvoyés. Situé dans la table Test de service [sn_st_mgmt_test]. Champs valides :
Type de données : chaîne |
| limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement offset . Type de données : nombre Valeur maximale : 100 Par défaut : 20 |
| décalage | Index de départ auquel commencer à récupérer des enregistrements. Utilisez ce paramètre pour paginer les résultats en petits blocs faciles à gérer. Le premier enregistrement est indexé à 0. Type de données : nombre Par défaut : 0 |
| État | Filtrez les définitions de test en fonction de l’état actuel du test. Seules les définitions de test dans l’état spécifié sont renvoyées dans la réponse. Valeurs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Aucun |
| En-tête | Description |
|---|---|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si |
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Lien | Contient les liens suivants pour parcourir les résultats de la requête.
|
| X-Total-Count | Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| Nom | Description |
|---|---|
| characteristic | Liste décrivant les caractéristiques du test de service associé. Pour plus d’informations sur les caractéristiques des définitions de test, voir Type de données : tableau d’objets |
| characteristic.id | Sys_id ou external_id de caractéristiques. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Si external_id est présent pour cet enregistrement, la réponse renvoie le external_id sinon elle renvoie le sys_id. Type de données : chaîne |
| characteristic.name | Nom de la caractéristique. Type de données : chaîne |
| valeur.caractéristique | Options de la caractéristique associées au test de service. Les caractéristiques varient en fonction de l’instance client. Type de données : chaîne |
| type.valeur.caractéristique | Type de valeur caractéristique.
Type de données : chaîne |
| description | Description du test de service. Type de données : chaîne |
| endDateTime | Date et heure de fin du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| href | Lien hypertexte renvoyant au test de service. Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| Mode | Mode dans lequel le test de service s’exécute. Valeurs valides :
Par défaut : ONDEMAND |
| nom | Requis. Nom du test de service. Type de données : chaîne |
| service connexe | Requis. La définition de test associée au test de service. Type de données : objet |
| relatedService.id | Sys_id ou external_id de l’inventaire des produits. Situé dans le champ sys_id ou external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| relatedService.name | Nom de l’inventaire des produits. Type de données : chaîne |
| startDateTime | Date et heure de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| État | État dans lequel se trouve le test de service. Valeurs valides :
Type de données : chaîne |
| testMeasure (en anglais seulement) | Mesure d’un aspect spécifique d’un test de produit, de service ou de ressource, comme les paquets perdus ou l’état de connectivité. Type de données : tableau d’objets |
| testMeasure.accuracy | Valeur décimale flottante représentant la précision de la mesure de test capturée pour les mesures associées. Type de données : nombre Valeur maximale : 40 |
| testMeasure.captureDateTime | Date et heure de capture de la mesure. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasure.id | Sys_id ou external_id des mesures de test. Situé dans les champs sys_id ou external_id de la table Mesures de test [sn_st_mgmt_test_measure]. Type de données : chaîne |
| testMeasure.Measure.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasure.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasure.metricName | Nom de la mesure de test. Type de données : chaîne |
| testMeasure.ruleViolation | Objet pour la définition d’une règle dans la définition de la règle de seuil, ainsi que les conséquences en cas de violation de la règle. Type de données : tableau d’objets |
| testMeasure.ruleViolation.tolerancePeriod.amount | Nombre de périodes avant l’application de la conséquence. Type de données : nombre |
| testMeasure.ruleViolation.appliedConsequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Action à exécuter en cas de violation d’une règle de seuil. Par exemple, l’envoi d’un avertissement ou la génération d’un rapport. Les actions appliquées peuvent varier d’une instance à l’autre. Type de données : chaîne |
| testMeasure.ruleViolation.appliedSequence.description | Description de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id ou external_id de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.name | Nom de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence lorsqu’une deuxième infraction se produit. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMesure.règleViolation.conformitéComporatorExact | Marqueur indiquant si une valeur est identique. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMesure.règleViolation.conformitéComporatorInférieur | Opérateur permettant de vérifier si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMesure.règleViolation.conformitéComporatorSupérieur | Opérateur permettant de vérifier si une valeur est supérieure au seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.id | Sys_id ou external_id de la violation de la règle de seuil. Situé dans la table Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]. Type de données : chaîne |
| testMeasure.ruleViolation.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Valeur maximale : 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.tolerancePeriod | Intervalle de temps spécifié pendant lequel les occurrences de croisement sont activées sans déclencher de conséquences ou d’actions immédiates. Type de date : Objet |
| testMeasure.ruleViolation.tolerancePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasure.unitOfMeasure | Spécifie l’unité de mesure pour les valeurs cibles de conformité de la mesure d’essai. Type de données : chaîne |
| testMeasure.value | Valeur de la mesure de test. Type de données : objet |
| testMeasure.value.id | ID de la valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.value | Valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.valueType | Type de valeur de mesure de test (numérique, texte, etc.). Type de données : chaîne |
| testSpecification (Spécification de test) | Requis. La définition de test associée à ce test. Type de données : objet |
| testSpecification.href | Lien hypertexte renvoyant à la définition de test de service. Type de données : chaîne |
| testSpecification.id | Le sys_id ou le external_id de la définition de test de service. Situé dans le champ sys_id ou external_id de la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date de fin de validité du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date de début de validité du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
L’exemple suivant récupère des informations sur les deux tests de service dans l’instance.
curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest” \
--user 'username’: ‘password'
Corps de réponse.
[
{
"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"
}
]
}
]
}
]
}
]
API ouverte de gestion des tests de service : GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Récupère une entité de test de service en fonction de l’ID donné d’un test de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Requis. Sys_id ou external_id du test de service à récupérer. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n’est pas utilisé, tous les champs sont renvoyés. Situé dans la table Test de service [sn_st_mgmt_test]. Champs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Aucun |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| characteristic | Liste décrivant les caractéristiques du test de service associé. Type de données : tableau d’objets |
| characteristic.id | Sys_id ou external_id de caractéristiques. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Si external_id est présent pour cet enregistrement, la réponse renvoie le external_id sinon elle renvoie le sys_id. Type de données : chaîne |
| characteristic.name | Nom de la caractéristique. Type de données : chaîne |
| valeur.caractéristique | Options de la caractéristique associées au test de service. Les caractéristiques varient en fonction de l’instance client. Type de données : chaîne |
| type.valeur.caractéristique | Type de valeur caractéristique.
Type de données : chaîne |
| description | Description du test de service. Type de données : chaîne |
| endDateTime | Date et heure de fin du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| href | Lien hypertexte renvoyant au test de service. Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| Mode | Mode dans lequel le test de service s’exécute. Valeurs valides :
Par défaut : ONDEMAND |
| nom | Nom du test de service. Type de données : chaîne |
| service connexe | Définition de test associée à ce test. Type de données : objet |
| relatedService.id | sys_id ou external_id de l’inventaire des produits. Situé dans le champ sys_id ou external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| relatedService.name | Nom de l’élément d’inventaire de produits. Type de données : chaîne |
| startDateTime | Date et heure de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| État | État du test de service. Valeurs valides :
|
| testMeasure (en anglais seulement) | Mesure d’un aspect spécifique d’un test de produit, de service ou de ressource, comme les paquets perdus ou l’état de connectivité. Type de données : tableau d’objets |
| testMeasure.accuracy | Valeur décimale flottante représentant la précision de la mesure de test capturée pour les mesures associées. Type de données : nombre Valeur maximale : 40 |
| testMeasure.captureDateTime | Date et heure de capture de la mesure. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasure.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasure.id | Sys_id ou external_id de la mesure d’essai. Situé dans la table Mesures de test [sn_st_mgmt_test_measure]. Type de données : chaîne |
| testMeasure.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasure.metricName | Nom d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasure.ruleViolation | Objet pour la définition d’une règle dans la définition de la règle de seuil, ainsi que les conséquences en cas de violation de la règle. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence | Action (action prescrite ou notification) à prendre en cas de violation d’une règle de seuil. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Action à exécuter en cas de violation d’une règle de seuil. Par exemple, l’envoi d’un avertissement ou la génération d’un rapport. Les actions appliquées peuvent varier d’une instance à l’autre. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction | Marqueur indiquant s’il faut répéter l’action appliquée ou non. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasure.ruleViolation.appliedSequence.description | Description de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id ou external_id de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.name | Nom de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur de conformanceTargetExact. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasure.ruleViolation.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.description | Description de la violation de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.id | Sys_id ou external_id de la violation de la règle de seuil. Situé dans la table Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]. Type de données : chaîne |
| testMeasure.ruleViolation.name | Nom de la violation de la règle de seuil. Type de date : chaîne |
| testMeasure.ruleViolation.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Maximum : 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.tolerancePeriod | Durée ou intervalle de temps pendant lequel des croisements autorisés peuvent se produire avant qu’une conséquence ne soit déclenchée. Type de date : Objet |
| testMeasure.ruleViolation.tolerancePeriod.amount | Montant de la période en nombre. Type de données : nombre |
| testMeasure.ruleViolation.tolerancePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasure.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasure.value | Valeur de la mesure dans le test. Type de données : objet |
| testMeasure.value.id | ID de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.value | Valeur de la mesure dans le test. Type de données : chaîne |
| testMeasure.value.valueType | Type de valeur de mesure de test (numérique, texte, etc.). Type de données : chaîne |
| testSpecification (Spécification de test) | Définition de test associée pour ce test. Type de données : objet |
| testSpecification.href | Lien hypertexte renvoyant à la définition de test de service. Type de données : chaîne |
| testSpecification.id | Sys_id ou external_id de la définition de test de service. Situé dans le champ sys_id ou external_id de la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date de fin et horodatage du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et horodatage de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
L’exemple suivant récupère les détails sur l’entité de test de service associée à l’ID donné, 44b7a8ea3b6a42107222bf9985e45a45.
curl --location --request GET “https://instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTest/44b7a8ea3b6a42107222bf9985e45a45 \
--user 'username’: ‘password'
Corps de réponse.
{
"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"
}
]
}
]
}
]
}
API ouverte de gestion des tests de service : GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Récupère une liste de toutes les définitions de test de service.
Format d'URL
URL par défaut : GET /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n’est pas utilisé, tous les champs sont renvoyés. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Valeurs valides :
Type de données : chaîne |
| limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la récupération de l’enregistrement offset . Type de données : nombre Valeur maximale : 100 Par défaut : 20 |
| décalage | Index de départ auquel commencer à récupérer des enregistrements. Utilisez ce paramètre pour paginer les résultats en petits blocs faciles à gérer. Le premier enregistrement est indexé à 0. Type de données : nombre Par défaut : 0 |
| État | Filtrez les définitions de test en fonction de l’état actuel du test. Seules les définitions de test dans l’état spécifié sont renvoyées dans la réponse. Valeurs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si offset=2 et limit=3, la valeur de l’en-tête Content-Range est les éléments 3 à 5. |
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Lien | Contient les liens suivants pour parcourir les résultats de la requête :
|
| X-Total-Count | Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| description | Description de la définition de test de service. Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| nom | Requis. Nom de la définition de test de service. Type de données : chaîne |
| relatedServiceSpecification (en anglais seulement) | Requis. Spécifications de service de la définition de test. Type de données : tableau d’objets |
| relatedServiceSpecification.id | Sys_id ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification [sn_prd_pm_specification]. Type de données : chaîne |
| relatedServiceSpecification.name | Nom de la spécification de service. Type de données : chaîne |
| serviceTestSpecRelationship | Définition de test de service connexe. Type de données : tableau d’objets |
| serviceTestSpecRelationship.id | Sys_id ou external_id de la définition de test du service connexe. Situé dans le champ sys_id ou external_id de la table Définition de test [sn_st_mgmt_test_definition]. Type de données : chaîne |
| serviceTestSpecRelationship.name | Nom de la définition de test connexe. Type de données : chaîne |
| serviceTestSpecRelationship.relationshipType | Type de relation. Valeurs acceptées :
Type de données : chaîne |
| specCharacteristic (en anglais seulement) | Caractéristiques de la définition de test. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne |
| specCharacteristic.description | Description de la caractéristique. Type de données : chaîne |
| specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet |
| specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.valueType | Type de valeur caractéristique.
Type de données : chaîne |
| testMeasureDefinition | Définitions de mesure de test pour cette définition de test de service. Pour plus d'informations, consultez Define test measure definitions for a service test. Type de données : tableau d’objets |
| testMeasureDefinition.captureFrequency | Fréquence à laquelle capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.capturePeriod | Période ou durée de la capture de mesure. Type de données : objet |
| testMeasureDefinition.capturePeriod.amount | Nombre de périodes de capture. Type de données : nombre |
| testMeasureDefinition.capturePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasureDefinition.id | Sys_id ou external_id des définitions de mesure de test. Situé dans la table de définition de mesure de test [sn_st_mgmt_test_measure_definition]. Type de données : chaîne |
| testMeasureDefinition.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasureDefinition.metricName | Nom défini par l’utilisateur d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasureDefinition.name | Nom de la définition de la mesure de test. Type de données : chaîne |
| testMeasureDefinition.thresholdRule | Règle qui définit les conditions à remplir avant d’appliquer des conséquences lorsqu’un seuil est franchi (ou non dépassé) dans la définition de la mesure de test. Pour plus d'informations, consultez Define threshold rules for a test measure definition. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur définie pour testMeasureDefinition.thresholdRule.conformanceTargetExact. Si la valeur est définie sur vrai, testMeasureDefinition.thresholdRule.conformanceTargetExact est requise. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.consequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Pour plus d'informations, consultez Define measure consequences for the threshold rules. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.consequence.description | Description de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id ou external_id de la conséquence de la mesure. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.name | Nom de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Action définie par l’utilisateur à prendre en cas de violation de seuil. Les actions varient d’une instance à l’autre. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence appliquée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Plage de dates pour laquelle la conséquence est valide. Type de données : objet |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Date de fin de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | Date de début de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.id | Sys_id ou external_id des règles de seuil. Situé dans le champ Situé dans le champ sys_id ou external_id de la table Règles de seuil [sn_st_mgmt_threshold_rule]. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Valeur maximale : 40 Type de données : nombre |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Niveau de gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasureDefinition.validFor | Plage de dates pour laquelle la définition de mesure de test est valide. Type de données : chaîne |
| testMeasureDefinition.validFor.endDateTime | Date de fin de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.validFor.startDateTime | Date de début de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor | Plage de dates pour laquelle la définition de test est valide. Type de données : objet |
| valideFor.endDateTime | Date et heure de la définition de test sur lesquelles l’état de celle-ci est mis hors service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et heure de la définition de test sur laquelle son état est publié. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
Cet exemple récupère les détails de toutes les définitions de test de service de test dans l’instance. Dans ce cas, deux définitions sont renvoyées.
curl --location --request GET
“https://instance.servicenow.com//api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification” \
--user 'username’: ‘password'
Corps de réponse.
[
{
"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"
}
]
}
]
API ouverte de gestion des tests de service : GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Récupère une entité de définition de test de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Requis. Sys_id ou external_id de la définition de test de service à récupérer. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| Nom | Description |
|---|---|
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n’est pas utilisé, tous les champs sont renvoyés. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Valeurs valides :
Type de données : chaîne |
| État | Filtrez les définitions de test en fonction de l’état actuel du test. Seules les définitions de test dans l’état spécifié sont renvoyées dans la réponse. Valeurs valides :
Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| description | Description de la définition de test de service. Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| nom | Requis. Nom de la définition de test de service. Type de données : chaîne |
| relatedServiceSpecification (en anglais seulement) | Requis. Spécifications de service de la définition de test. Type de données : tableau d’objets |
| relatedServiceSpecification.id | Sys_id ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification [sn_prd_pm_specification]. Type de données : chaîne |
| relatedServiceSpecification.name | Nom de la spécification de service. Type de données : chaîne |
| serviceTestSpecRelationship | Définition de test de service connexe. Type de données : tableau d’objets |
| serviceTestSpecRelationship.id | Sys_id ou external_id de la définition de test du service connexe. Situé dans le champ sys_id ou external_id de la table Définition de test [sn_st_mgmt_test_definition]. Type de données : chaîne |
| serviceTestSpecRelationship.name | Nom de la définition de test connexe. Type de données : chaîne |
| serviceTestSpecRelationship.relationshipType | Type de relation. Valeurs acceptées :
Type de données : chaîne |
| specCharacteristic (en anglais seulement) | Caractéristiques de la définition de test. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne |
| specCharacteristic.description | Description de la caractéristique. Type de données : chaîne |
| specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet |
| specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.valueType | Type de valeur caractéristique.
Type de données : chaîne |
| testMeasureDefinition | Définitions de mesure de test pour cette définition de test de service. Pour plus d'informations, consultez Define test measure definitions for a service test. Type de données : tableau d’objets |
| testMeasureDefinition.captureFrequency | Fréquence à laquelle capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.capturePeriod | Période ou durée de la capture de mesure. Type de données : objet |
| testMeasureDefinition.capturePeriod.amount | Nombre de périodes de capture. Type de données : nombre |
| testMeasureDefinition.capturePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasureDefinition.id | Sys_id ou external_id des définitions de mesure de test. Situé dans la table de définition de mesure de test [sn_st_mgmt_test_measure_definition]. Type de données : chaîne |
| testMeasureDefinition.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasureDefinition.metricName | Nom défini par l’utilisateur d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasureDefinition.name | Nom de la définition de la mesure de test. Type de données : chaîne |
| testMeasureDefinition.thresholdRule | Règle qui définit les conditions à remplir avant d’appliquer des conséquences lorsqu’un seuil est franchi (ou non dépassé) dans la définition de la mesure de test. Pour plus d'informations, consultez Define threshold rules for a test measure definition. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur définie pour testMeasureDefinition.thresholdRule.conformanceTargetExact. Si la valeur est définie sur vrai, testMeasureDefinition.thresholdRule.conformanceTargetExact est requise. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.consequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Pour plus d'informations, consultez Define measure consequences for the threshold rules. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.consequence.description | Description de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id ou external_id de la conséquence de la mesure. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.name | Nom de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Action définie par l’utilisateur à prendre en cas de violation de seuil. Les actions varient d’une instance à l’autre. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence appliquée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Plage de dates pour laquelle la conséquence est valide. Type de données : objet |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Date de fin de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | Date de début de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.id | Sys_id ou external_id des règles de seuil. Situé dans le champ Situé dans le champ sys_id ou external_id de la table Règles de seuil [sn_st_mgmt_threshold_rule]. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Valeur maximale : 40 Type de données : nombre |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Niveau de gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasureDefinition.validFor | Plage de dates pour laquelle la définition de mesure de test est valide. Type de données : chaîne |
| testMeasureDefinition.validFor.endDateTime | Date de fin de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.validFor.startDateTime | Date de début de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor | Plage de dates pour laquelle la définition de test est valide. Type de données : objet |
| valideFor.endDateTime | Date et heure de la définition de test sur lesquelles l’état de celle-ci est mis hors service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et heure de la définition de test sur laquelle son état est publié. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
Cet exemple récupère les détails d’une définition de test de service avec un ID donné.
curl --location --request GET "https:/instance.servicenow.com/api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/89d2b920432a02104fefe4511fb8f22e" \
--user 'username’: ‘password'
Corps de réponse.
{
"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"
}
]
}
API ouverte de gestion des tests de service : PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Met à jour une entité de test de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Requis. Sys_id ou external_id du test de service à récupérer. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| characteristic | Liste décrivant les caractéristiques du test de service associé. Pour plus d’informations sur les caractéristiques des définitions de test, voir Type de données : tableau d’objets |
| characteristic.id | Sys_id ou external_id de caractéristiques. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Si external_id est présent pour cet enregistrement, la réponse renvoie le external_id sinon elle renvoie le sys_id. Type de données : chaîne |
| characteristic.name | Nom de la caractéristique. Type de données : chaîne |
| valeur.caractéristique | Options de la caractéristique associées au test de service. Les caractéristiques varient en fonction de l’instance client. Type de données : chaîne |
| type.valeur.caractéristique | Type de valeur caractéristique.
Type de données : chaîne |
| description | Description du test de service. Type de données : chaîne |
| endDateTime | Date et heure de fin du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| Mode | Mode dans lequel le test de service s’exécute. Valeurs valides :
Par défaut : ONDEMAND |
| nom | Requis. Nom du test de service. Type de données : chaîne |
| service connexe | Requis. La définition de test associée au test de service. Type de données : objet |
| relatedService.href | Lien hypertexte renvoyant au service connexe. Type de données : chaîne |
| relatedService.id | Sys_id ou external_id de l’inventaire des produits. Situé dans le champ sys_id ou external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| startDateTime | Date et heure de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| État | État dans lequel se trouve le test de service. Valeurs valides :
Type de données : chaîne |
| testMeasure (en anglais seulement) | Mesure d’un aspect spécifique d’un test de produit, de service ou de ressource, comme les paquets perdus ou l’état de connectivité. Type de données : tableau d’objets |
| testMeasure.accuracy | Valeur décimale flottante représentant la précision de la mesure de test capturée pour les mesures associées. Type de données : nombre Valeur maximale : 40 |
| testMeasure.captureDateTime | Date et heure de capture de la mesure. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasure.id | Sys_id ou external_id des mesures de test. Situé dans les champs sys_id ou external_id de la table Mesures de test [sn_st_mgmt_test_measure]. Type de données : chaîne |
| testMeasure.Measure.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasure.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasure.metricName | Nom de la mesure de test. Type de données : chaîne |
| testMeasure.ruleViolation | Objet pour la définition d’une règle dans la définition de la règle de seuil, ainsi que les conséquences en cas de violation de la règle. Type de données : tableau d’objets |
| testMeasure.ruleViolation.tolerancePeriod.amount | Nombre de périodes avant l’application de la conséquence. Type de données : nombre |
| testMeasure.ruleViolation.appliedConsequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Action à exécuter en cas de violation d’une règle de seuil. Par exemple, l’envoi d’un avertissement ou la génération d’un rapport. Les actions appliquées peuvent varier d’une instance à l’autre. Type de données : chaîne |
| testMeasure.ruleViolation.appliedSequence.description | Description de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id ou external_id de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.name | Nom de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence lorsqu’une deuxième infraction se produit. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMesure.règleViolation.conformitéComporatorExact | Marqueur indiquant si une valeur est identique. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMesure.règleViolation.conformitéComporatorInférieur | Opérateur permettant de vérifier si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMesure.règleViolation.conformitéComporatorSupérieur | Opérateur permettant de vérifier si une valeur est supérieure au seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.id | Sys_id ou external_id de la violation de la règle de seuil. Situé dans la table Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]. Type de données : chaîne |
| testMeasure.ruleViolation.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Valeur maximale : 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.tolerancePeriod | Intervalle de temps spécifié pendant lequel les occurrences de croisement sont activées sans déclencher de conséquences ou d’actions immédiates. Type de date : Objet |
| testMeasure.ruleViolation.tolerancePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasure.unitOfMeasure | Spécifie l’unité de mesure pour les valeurs cibles de conformité de la mesure d’essai. Type de données : chaîne |
| testMeasure.value | Valeur de la mesure de test. Type de données : objet |
| testMeasure.value.id | ID de la valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.value | Valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.valueType | Type de valeur de mesure de test (numérique, texte, etc.). Type de données : chaîne |
| testSpecification (Spécification de test) | Requis. La définition de test associée à ce test. Type de données : objet |
| testSpecification.href | Lien hypertexte renvoyant à la définition de test de service. Type de données : chaîne |
| testSpecification.id | Le sys_id ou le external_id de la définition de test de service. Situé dans le champ sys_id ou external_id de la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date de fin de validité du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date de début de validité du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| characteristic | Liste décrivant les caractéristiques du test de service associé. Type de données : tableau d’objets |
| characteristic.id | Sys_id ou external_id de caractéristiques. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Si external_id est présent pour cet enregistrement, la réponse renvoie le external_id sinon elle renvoie le sys_id. Type de données : chaîne |
| characteristic.name | Nom de la caractéristique. Type de données : chaîne |
| valeur.caractéristique | Options de la caractéristique associées au test de service. Les caractéristiques varient en fonction de l’instance client. Type de données : chaîne |
| type.valeur.caractéristique | Type de valeur caractéristique.
Type de données : chaîne |
| description | Description du test de service. Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| nom | Nom du test de service. Type de données : chaîne |
| service connexe | Définition de test associée pour ce test. Type de données : objet |
| relatedService.id | Sys_id ou external_id de l’inventaire des produits. Situé dans le champ sys_id ou external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| relatedService.name | Nom de l’inventaire des produits. Type de données : chaîne |
| testMeasure (en anglais seulement) | Mesure d’un aspect spécifique d’un test de produit, de service ou de ressource, comme les paquets perdus ou l’état de connectivité. Type de données : tableau d’objets |
| testMeasure.accuracy | Valeur décimale flottante représentant la précision de la mesure de test capturée pour les mesures associées. Type de données : nombre Valeur maximale : 40 |
| testMeasure.captureDateTime | Date et heure de capture de la mesure. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasure.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasure.id | Sys_id ou external_id de la mesure d’essai. Situé dans la table Mesures de test [sn_st_mgmt_test_measure]. Type de données : chaîne |
| testMeasure.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasure.metricName | Nom d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasure.ruleViolation | Objet pour la définition d’une règle dans la définition de la règle de seuil, ainsi que les conséquences en cas de violation de la règle. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence | Action (action prescrite ou notification) à prendre en cas de violation d’une règle de seuil. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Action à exécuter en cas de violation d’une règle de seuil. Par exemple, l’envoi d’un avertissement ou la génération d’un rapport. Les actions appliquées peuvent varier d’une instance à l’autre. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction | Marqueur indiquant s’il faut répéter l’action appliquée ou non. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasure.ruleViolation.appliedSequence.description | Description de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id ou external_id de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.name | Nom de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur de conformanceTargetExact. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasure.ruleViolation.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.description | Description de la violation de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.id | Sys_id ou external_id de la violation de la règle de seuil. Situé dans la table Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]. Type de données : chaîne |
| testMeasure.ruleViolation.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Maximum : 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.tolerancePeriod | Durée ou intervalle de temps pendant lequel des croisements autorisés peuvent se produire avant qu’une conséquence ne soit déclenchée. Type de date : Objet |
| testMeasure.ruleViolation.tolerancePeriod.amount | Montant de la période en nombre. Type de données : nombre |
| testMeasure.ruleViolation.tolerancePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasure.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasure.value | Valeur de la mesure dans le test. Type de données : objet |
| testMeasure.value.id | ID de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.value | Valeur de la mesure dans le test. Type de données : chaîne |
| testMeasure.value.valueType | Type de valeur de mesure de test (numérique, texte, etc.). Type de données : chaîne |
| testSpecification (Spécification de test) | Définition de test associée pour ce test. Type de données : objet |
| testSpecification.href | Lien hypertexte renvoyant à la définition de test de service. Type de données : chaîne |
| testSpecification.id | Sys_id ou external_id de la définition de test de service. Situé dans le champ sys_id ou external_id de la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date de fin et horodatage du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et horodatage de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
L’exemple suivant met à jour l’entité de test du service donné en fonction des détails fournis dans le corps de la demande.
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"
}
]
}
]
}
]
}
La réponse montre une mise à jour réussie en renvoyant les informations modifiées dans le service de test donné.
{
"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"
}
]
}
]
}
]
}
API ouverte de gestion des tests de service : PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Autorise les mises à jour partielles d’une entité de définition de test de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| id | Requis. Sys_id ou external_id de la définition de test de service à récupérer. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| description | Description de la définition de test de service. Type de données : chaîne |
| nom | Requis. Nom de la définition de test de service. Type de données : chaîne |
| relatedServiceSpecification (en anglais seulement) | Requis. Spécifications de service de la définition de test. Type de données : tableau d’objets |
| relatedServiceSpecification.id | Sys_id ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification [sn_prd_pm_specification]. Type de données : chaîne |
| relatedServiceSpecification.name | Nom de la spécification de service. Type de données : chaîne |
| serviceTestSpecRelationship | Définition de test de service connexe. Type de données : tableau d’objets |
| serviceTestSpecRelationship.id | Sys_id ou external_id de la définition de test du service connexe. Situé dans le champ sys_id ou external_id de la table Définition de test [sn_st_mgmt_test_definition]. Type de données : chaîne |
| serviceTestSpecRelationship.name | Nom de la définition de test connexe. Type de données : chaîne |
| serviceTestSpecRelationship.relationshipType | Type de relation. Valeurs acceptées :
Type de données : chaîne |
| specCharacteristic (en anglais seulement) | Caractéristiques de la définition de test. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne |
| specCharacteristic.description | Description de la caractéristique. Type de données : chaîne |
| specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet |
| specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.valueType | Type de valeur caractéristique.
Type de données : chaîne |
| testMeasureDefinition | Définitions de mesure de test pour cette définition de test de service. Pour plus d'informations, consultez Define test measure definitions for a service test. Type de données : tableau d’objets |
| testMeasureDefinition.captureFrequency | Fréquence à laquelle capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.capturePeriod | Période ou durée de la capture de mesure. Type de données : objet |
| testMeasureDefinition.capturePeriod.amount | Nombre de périodes de capture. Type de données : nombre |
| testMeasureDefinition.capturePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasureDefinition.id | Sys_id ou external_id des définitions de mesure de test. Situé dans la table de définition de mesure de test [sn_st_mgmt_test_measure_definition]. Type de données : chaîne |
| testMeasureDefinition.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasureDefinition.metricName | Nom défini par l’utilisateur d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasureDefinition.name | Nom de la définition de la mesure de test. Type de données : chaîne |
| testMeasureDefinition.thresholdRule | Règle qui définit les conditions à remplir avant d’appliquer des conséquences lorsqu’un seuil est franchi (ou non dépassé) dans la définition de la mesure de test. Pour plus d'informations, consultez Define threshold rules for a test measure definition. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur définie pour testMeasureDefinition.thresholdRule.conformanceTargetExact. Si la valeur est définie sur vrai, testMeasureDefinition.thresholdRule.conformanceTargetExact est requise. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.consequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Pour plus d'informations, consultez Define measure consequences for the threshold rules. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.consequence.description | Description de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id ou external_id de la conséquence de la mesure. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.name | Nom de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Action définie par l’utilisateur à prendre en cas de violation de seuil. Les actions varient d’une instance à l’autre. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence appliquée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Plage de dates pour laquelle la conséquence est valide. Type de données : objet |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Date de fin de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | Date de début de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.id | Sys_id ou external_id des règles de seuil. Situé dans le champ Situé dans le champ sys_id ou external_id de la table Règles de seuil [sn_st_mgmt_threshold_rule]. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Valeur maximale : 40 Type de données : nombre |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Niveau de gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasureDefinition.validFor | Plage de dates pour laquelle la définition de mesure de test est valide. Type de données : chaîne |
| testMeasureDefinition.validFor.endDateTime | Date de fin de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.validFor.startDateTime | Date de début de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
| 404 | Introuvable. L’élément demandé est introuvable. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| description | Description de la définition de test de service. Type de données : chaîne |
| id | Le sys_id ou le external_id de la définition de test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| nom | Nom de la définition de test de service. Type de données : chaîne |
| relatedServiceSpecification (en anglais seulement) | Spécifications de service pour les définitions de test. Type de données : tableau d’objets |
| relatedServiceSpecification.id | Le sys_id ou le external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification [sn_prd_pm_specification]. Type de données : chaîne |
| relatedServiceSpecification.name | Nom de la spécification de service. Type de données : chaîne |
| serviceTestSpecRelationship | Définition de test de service connexe. Type de données : tableau d’objets |
| serviceTestSpecRelationship.id | Sys_id ou external_id de la définition de test du service connexe. Situé dans le champ sys_id ou external_id de la table Définition de test [sn_st_mgmt_test_definition]. Type de données : chaîne |
| serviceTestSpecRelationship.name | Nom de la définition de test connexe. Type de données : chaîne |
| serviceTestSpecRelationship.relationshipType | Type de relation. Valeurs acceptées :
Type de données : chaîne |
| specCharacteristic (en anglais seulement) | Caractéristiques de la définition de test. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne |
| specCharacteristic.description | Description de la caractéristique. Type de données : chaîne |
| specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet |
| specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.valueType | Type de valeur caractéristique.
Type de données : chaîne |
| testMeasureDefinition | Définitions de mesure de test pour cette définition de test de service. Pour plus d'informations, consultez Define test measure definitions for a service test. Type de données : tableau d’objets |
| testMeasureDefinition.captureFrequency | Fréquence à laquelle capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.capturePeriod | Une durée ou une période de la capture. Type de données : objet |
| testMeasureDefinition.capturePeriod.amount | Nombre de périodes de capture. Type de données : nombre |
| testMeasureDefinition.capturePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasureDefinition.id | Sys_id ou external_id des définitions de la mesure de test. Situé dans la table de définition de mesure de test [sn_st_mgmt_test_measure_definition]. Type de données : chaîne |
| testMeasureDefinition.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasureDefinition.metricName | Nom défini par l’utilisateur d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasureDefinition.name | Nom de la définition de la mesure de test. Type de données : chaîne |
| testMeasureDefinition.thresholdRule | Règle qui définit la condition (raise ou clear) à atteindre pour appliquer les conséquences lorsqu’un seuil est franchi ou cesse d’être franchi pour une définition de mesure de test particulière. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur de conformanceTargetExact. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.consequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.consequence.description | Description de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id ou external_id de la conséquence de la mesure. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.name | Nom de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Action définie par l’utilisateur à prendre en cas de violation de seuil. Les actions varient d’une instance à l’autre. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Marqueur indiquant s’il faut répéter l’action appliquée ou non. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Plage de dates pour laquelle la conséquence est valide. Type de données : objet |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Date de fin de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | Date de début de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.id | Sys_id ou external_id des règles de seuil. Situé dans la table Règles de seuil [sn_st_mgmt_threshold_rule]. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Valeur maximale : 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasureDefinition.validFor | Plage de dates pour laquelle la définition de la mesure de test est valide. Type de données : objet |
| testMeasureDefinition.validFor.endDateTime | Date de fin de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.validFor.startDateTime | Date de début de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
L’exemple suivant met à jour partiellement l’ID de définition de test de service donné en fonction des modifications fournies dans le corps de la demande.
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"
}
]
}
Le corps de la réponse renvoie la partie mise à jour de la spécification de test de service :
{
"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"
}
]
}
API ouverte de gestion des tests de service : POST /sn_sprb_mgmt/servicetestmanagement/serviceTest
Crée un test de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTest
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| characteristic | Liste décrivant les caractéristiques du test de service associé. Pour plus d’informations sur les caractéristiques des définitions de test, voir Type de données : tableau d’objets |
| characteristic.id | Sys_id ou external_id de caractéristiques. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Si external_id est présent pour cet enregistrement, la réponse renvoie le external_id sinon elle renvoie le sys_id. Type de données : chaîne |
| characteristic.name | Nom de la caractéristique. Type de données : chaîne |
| valeur.caractéristique | Options de la caractéristique associées au test de service. Les caractéristiques varient en fonction de l’instance client. Type de données : chaîne |
| type.valeur.caractéristique | Type de valeur caractéristique.
Type de données : chaîne |
| description | Description du test de service. Type de données : chaîne |
| endDateTime | Date et heure de fin du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| id | Sys_id ou external_id du test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Cet ID crée un test de service et est utilisé comme external_id. Type de données : chaîne |
| Mode | Mode dans lequel le test de service s’exécute. Valeurs valides :
Par défaut : ONDEMAND |
| nom | Requis. Nom du test de service. Type de données : chaîne |
| service connexe | Requis. La définition de test associée au test de service. Type de données : objet |
| relatedService.href | Lien hypertexte renvoyant au service connexe. Type de données : chaîne |
| relatedService.id | Sys_id ou external_id de l’inventaire des produits. Situé dans le champ sys_id ou external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| relatedService.name | Nom de l’élément d’inventaire de produits. Type de données : chaîne |
| startDateTime | Date et heure de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| État | État dans lequel se trouve le test de service. Valeurs valides :
Type de données : chaîne |
| testMeasure (en anglais seulement) | Mesure d’un aspect spécifique d’un test de produit, de service ou de ressource, comme les paquets perdus ou l’état de connectivité. Type de données : tableau d’objets |
| testMeasure.accuracy | Valeur décimale flottante représentant la précision de la mesure de test capturée pour les mesures associées. Type de données : nombre Valeur maximale : 40 |
| testMeasure.captureDateTime | Date et heure de capture de la mesure. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasure.id | Sys_id ou external_id des mesures de test. Situé dans les champs sys_id ou external_id de la table Mesures de test [sn_st_mgmt_test_measure]. Type de données : chaîne |
| testMeasure.Measure.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasure.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasure.metricName | Nom de la mesure de test. Type de données : chaîne |
| testMeasure.ruleViolation | Objet pour la définition d’une règle dans la définition de la règle de seuil, ainsi que les conséquences en cas de violation de la règle. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Action à exécuter en cas de violation d’une règle de seuil. Par exemple, l’envoi d’un avertissement ou la génération d’un rapport. Les actions appliquées peuvent varier d’une instance à l’autre. Type de données : chaîne |
| testMeasure.ruleViolation.appliedSequence.description | Description de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id ou external_id de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.name | Nom de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence lorsqu’une deuxième infraction se produit. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMesure.règleViolation.conformitéComporatorExact | Marqueur indiquant si une valeur est identique. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMesure.règleViolation.conformitéComporatorInférieur | Opérateur permettant de vérifier si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMesure.règleViolation.conformitéComporatorSupérieur | Opérateur permettant de vérifier si une valeur est supérieure au seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.id | Sys_id ou external_id de la violation de la règle de seuil. Situé dans la table Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]. Type de données : chaîne |
| testMeasure.ruleViolation.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Valeur maximale : 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.tolerancePeriod | Intervalle de temps spécifié pendant lequel les occurrences de croisement sont activées sans déclencher de conséquences ou d’actions immédiates. Type de date : Objet |
| testMeasure.ruleViolation.tolerancePeriod.amount | Nombre de périodes avant l’application de la conséquence. Type de données : nombre |
| testMeasure.ruleViolation.tolerancePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasure.unitOfMeasure | Spécifie l’unité de mesure pour les valeurs cibles de conformité de la mesure d’essai. Type de données : chaîne |
| testMeasure.value | Valeur de la mesure de test. Type de données : objet |
| testMeasure.value.id | ID de la valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.value | Valeur de la mesure de test. Type de données : chaîne |
| testMeasure.value.valueType | Type de valeur de mesure de test (numérique, texte, etc.). Type de données : chaîne |
| testSpecification (Spécification de test) | Requis. La définition de test associée à ce test. Type de données : objet |
| testSpecification.href | Lien hypertexte renvoyant à la définition de test de service. Type de données : chaîne |
| testSpecification.id | Le sys_id ou le external_id de la définition de test de service. Situé dans le champ sys_id ou external_id de la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date de fin de validité du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date de début de validité du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| characteristic | Liste décrivant les caractéristiques du test de service associé. Type de données : tableau d’objets |
| characteristic.id | Sys_id ou external_id de caractéristiques. Situé dans la table Caractéristiques [sn_prd_pm_characteristic]. Si external_id est présent pour cet enregistrement, la réponse renvoie le external_id sinon elle renvoie le sys_id. Type de données : chaîne |
| characteristic.name | Nom de la caractéristique. Type de données : chaîne |
| valeur.caractéristique | Options de la caractéristique associées au test de service. Les caractéristiques varient en fonction de l’instance client. Type de données : chaîne |
| type.valeur.caractéristique | Type de valeur caractéristique.
Type de données : chaîne |
| description | Description du test de service. Type de données : chaîne |
| endDateTime | Date et heure de fin du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| Mode | Mode dans lequel le test de service s’exécute. Valeurs valides :
Par défaut : ONDEMAND |
| nom | Nom du test de service. Type de données : chaîne |
| service connexe | Définition de test associée pour ce test. Type de données : objet |
| relatedService.id | Sys_id ou external_id de l’inventaire des produits. Situé dans le champ sys_id ou external_id de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| relatedService.name | Nom de l’inventaire des produits. Type de données : chaîne |
| startDateTime | Date et heure de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| État | État du test de service. Valeurs valides :
|
| testMeasure (en anglais seulement) | Mesure d’un aspect spécifique d’un test de produit, de service ou de ressource, comme les paquets perdus ou l’état de connectivité. Type de données : tableau d’objets |
| testMeasure.accuracy | Valeur décimale flottante représentant la précision de la mesure de test capturée pour les mesures associées. Type de données : nombre Valeur maximale : 40 |
| testMeasure.captureDateTime | Date et heure de capture de la mesure. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasure.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasure.id | Sys_id ou external_id de la mesure d’essai. Situé dans la table Mesures de test [sn_st_mgmt_test_measure]. Type de données : chaîne |
| testMeasure.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasure.metricName | Nom d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasure.ruleViolation | Objet pour la définition d’une règle dans la définition de la règle de seuil, ainsi que les conséquences en cas de violation de la règle. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence | Action (action prescrite ou notification) à prendre en cas de violation d’une règle de seuil. Type de données : tableau d’objets |
| testMeasure.ruleViolation.appliedConsequence.appliedAction | Action à exécuter en cas de violation d’une règle de seuil. Par exemple, l’envoi d’un avertissement ou la génération d’un rapport. Les actions appliquées peuvent varier d’une instance à l’autre. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.appliedAction.repeatAction | Marqueur indiquant s’il faut répéter l’action appliquée ou non. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasure.ruleViolation.appliedSequence.description | Description de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.id | Sys_id ou external_id de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.appliedConsequence.name | Nom de la conséquence appliquée. Type de données : chaîne |
| testMeasure.ruleViolation.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur de conformanceTargetExact. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasure.ruleViolation.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Détermine si le seuil est atteint ou plus. Type de données : nombre |
| testMeasure.ruleViolation.description | Description de la violation de la règle de seuil. Type de données : chaîne |
| testMeasure.ruleViolation.id | Sys_id ou external_id de la violation de la règle de seuil. Situé dans la table Violation de la règle de seuil [sn_st_mgmt_threshold_rule_violation]. Type de données : chaîne |
| testMeasure.ruleViolation.name | Nom de la violation de la règle de seuil. Type de date : chaîne |
| testMeasure.ruleViolation.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Maximum : 40 |
| testMeasure.ruleViolation.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasure.ruleViolation.tolerancePeriod | Durée ou intervalle de temps pendant lequel des croisements autorisés peuvent se produire avant qu’une conséquence ne soit déclenchée. Type de date : Objet |
| testMeasure.ruleViolation.tolerancePeriod.amount | Montant de la période en nombre. Type de données : nombre |
| testMeasure.ruleViolation.tolerancePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasure.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasure.value | Valeur de la mesure dans le test. Type de données : objet |
| testMeasure.value.id | ID de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.name | Nom de la valeur de mesure dans le test. Type de données : chaîne |
| testMeasure.value.value | Valeur de la mesure dans le test. Type de données : chaîne |
| testMeasure.value.valueType | Type de valeur de mesure de test (numérique, texte, etc.). Type de données : chaîne |
| testSpecification (Spécification de test) | Définition de test associée pour ce test. Type de données : objet |
| testSpecification.href | Lien hypertexte renvoyant à la définition de test de service. Type de données : chaîne |
| testSpecification.id | Sys_id ou external_id de la définition de test de service. Situé dans le champ sys_id ou external_id de la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date de fin et horodatage du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et horodatage de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
L’exemple suivant crée un nouveau test de service en fonction des détails spécifiques fournis dans le corps de la demande.
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"
}
]
}
]
}
]
}
La réponse renvoie les détails de confirmation du nouveau service de test et lui attribue un ID unique, 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"
}
API ouverte de gestion des tests de service : POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Crée une nouvelle définition de test de service.
Format d'URL
URL par défaut : /api/sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| description | Description de la définition de test de service. Type de données : chaîne |
| id | Sys_id ou external_id de la définition de test de service. Situé dans la table Définition de test de service [sn_st_mgmt_test_definition]. Type de données : chaîne |
| nom | Requis. Nom de la définition de test de service. Type de données : chaîne |
| relatedServiceSpecification (en anglais seulement) | Requis. Spécifications de service de la définition de test. Type de données : tableau d’objets |
| relatedServiceSpecification.id | Sys_id ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification [sn_prd_pm_specification]. Type de données : chaîne |
| relatedServiceSpecification.name | Nom de la spécification de service. Type de données : chaîne |
| serviceTestSpecRelationship | Définition de test du service connexe. Type de données : tableau d’objets |
| serviceTestSpecRelationship.id | Sys_id ou external_id de la définition de test du service connexe. Situé dans le champ sys_id ou external_id de la table Définition de test [sn_st_mgmt_test_definition]. Type de données : chaîne |
| serviceTestSpecRelationship.name | Nom de la définition de test connexe. Type de données : chaîne |
| serviceTestSpecRelationship.relationshipType | Type de relation. Valeurs acceptées :
Type de données : chaîne |
| specCharacteristic (en anglais seulement) | Caractéristiques de la définition de test. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne |
| specCharacteristic.description | Description de la caractéristique. Type de données : chaîne |
| specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet |
| specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.valueType | Type de valeur caractéristique.
Type de données : chaîne |
| testMeasureDefinition | Définitions de mesure de test pour cette définition de test de service. Pour plus d'informations, consultez Define test measure definitions for a service test. Type de données : tableau d’objets |
| testMeasureDefinition.captureFrequency | Fréquence à laquelle capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.capturePeriod | Période ou durée de la capture de mesure. Type de données : objet |
| testMeasureDefinition.capturePeriod.amount | Nombre de périodes de capture. Type de données : nombre |
| testMeasureDefinition.capturePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasureDefinition.id | Sys_id ou external_id des définitions de mesure de test. Situé dans la table de définition de mesure de test [sn_st_mgmt_test_measure_definition]. Type de données : chaîne |
| testMeasureDefinition.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasureDefinition.metricName | Nom défini par l’utilisateur d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasureDefinition.name | Nom de la définition de la mesure de test. Type de données : chaîne |
| testMeasureDefinition.thresholdRule | Règle qui définit les conditions à remplir avant d’appliquer des conséquences lorsqu’un seuil est franchi (ou non dépassé) dans la définition de la mesure de test. Pour plus d'informations, consultez Define threshold rules for a test measure definition. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur définie pour testMeasureDefinition.thresholdRule.conformanceTargetExact. Si la valeur est définie sur vrai, testMeasureDefinition.thresholdRule.conformanceTargetExact est requise. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.consequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Pour plus d'informations, consultez Define measure consequences for the threshold rules. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.consequence.description | Description de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id ou external_id de la conséquence de la mesure. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.name | Nom de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Action définie par l’utilisateur à prendre en cas de violation de seuil. Les actions varient d’une instance à l’autre. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Marqueur indiquant s’il faut répéter la conséquence appliquée. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Plage de dates pour laquelle la conséquence est valide. Type de données : objet |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Date de fin de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | Date de début de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.id | Sys_id ou external_id des règles de seuil. Situé dans le champ Situé dans le champ sys_id ou external_id de la table Règles de seuil [sn_st_mgmt_threshold_rule]. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Valeur maximale : 40 Type de données : nombre |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Niveau de gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasureDefinition.validFor | Plage de dates pour laquelle la définition de mesure de test est valide. Type de données : chaîne |
| testMeasureDefinition.validFor.endDateTime | Date de fin de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.validFor.startDateTime | Date de début de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor | Plage de dates pour laquelle la définition de test est valide. Type de données : objet |
| valideFor.endDateTime | Date et heure de la définition de test sur lesquelles l’état de celle-ci est mis hors service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et heure de la définition de test sur laquelle son état est publié. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 400 | Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté. |
Paramètres du corps de réponse (JSON ou XML)
| Nom | Description |
|---|---|
| description | Description de la définition de test de service. Type de données : chaîne |
| id | Le sys_id ou le external_id de la définition de test de service. Situé dans la table Test de service [sn_st_mgmt_test]. Type de données : chaîne |
| nom | Nom de la définition de test de service. Type de données : chaîne |
| relatedServiceSpecification (en anglais seulement) | Spécifications de service pour les définitions de test. Type de données : tableau d’objets |
| relatedServiceSpecification.id | Le sys_id ou le external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification [sn_prd_pm_specification]. Type de données : chaîne |
| relatedServiceSpecification.name | Nom de la spécification de service. Type de données : chaîne |
| serviceTestSpecRelationship | Définition de test de service connexe. Type de données : tableau d’objets |
| serviceTestSpecRelationship.id | Sys_id ou external_id de la définition de test du service connexe. Situé dans le champ sys_id ou external_id de la table Définition de test [sn_st_mgmt_test_definition]. Type de données : chaîne |
| serviceTestSpecRelationship.name | Nom de la définition de test connexe. Type de données : chaîne |
| serviceTestSpecRelationship.relationshipType | Type de relation. Valeurs acceptées :
Type de données : chaîne |
| specCharacteristic (en anglais seulement) | Caractéristiques de la définition de test. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets |
| specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne |
| specCharacteristic.description | Description de la caractéristique. Type de données : chaîne |
| specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet |
| specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| specCharacteristic.valueType | Type de valeur caractéristique.
Type de données : chaîne |
| testMeasureDefinition | Définitions de mesure de test pour cette définition de test de service. Pour plus d'informations, consultez Define test measure definitions for a service test. Type de données : tableau d’objets |
| testMeasureDefinition.captureFrequency | Fréquence à laquelle capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.captureMethod | Méthode utilisée pour capturer la mesure. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.capturePeriod | Une durée ou une période de la capture. Type de données : objet |
| testMeasureDefinition.capturePeriod.amount | Nombre de périodes de capture. Type de données : nombre |
| testMeasureDefinition.capturePeriod.units | Unités de la période. Valeurs acceptées :
Type de données : chaîne |
| testMeasureDefinition.id | Sys_id ou external_id des définitions de la mesure de test. Situé dans la table de définition de mesure de test [sn_st_mgmt_test_measure_definition]. Type de données : chaîne |
| testMeasureDefinition.metricDescription | Brève description de la mesure. Type de données : chaîne |
| testMeasureDefinition.metricName | Nom défini par l’utilisateur d’une mesure dans la mesure de test. Type de données : chaîne |
| testMeasureDefinition.name | Nom de la définition de la mesure de test. Type de données : chaîne |
| testMeasureDefinition.thresholdRule | Règle qui définit la condition (raise ou clear) à atteindre pour appliquer les conséquences lorsqu’un seuil est franchi ou cesse d’être franchi pour une définition de mesure de test particulière. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.conformanceComparatorExact | Marqueur indiquant si une valeur est identique à la valeur de conformanceTargetExact. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.conformanceComparatorLower | Opérateur qui vérifie si une valeur tombe en dessous du seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceComparatorUpper | Opérateur qui vérifie si une valeur dépasse le seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.thresholdRule.conformanceTargetExact | Obligatoire si conformanceComparatorExact est défini sur vrai. Si la conformanceComparatorExact valeur est définie sur vrai, sa valeur correspond à la valeur définie dans conformanceTargetExact. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetLower | Valeur de seuil inférieure pour comparer les résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.conformanceTargetUpper | Valeur de seuil supérieure pour la comparaison des résultats de la mesure de test. Type de données : nombre |
| testMeasureDefinition.thresholdRule.consequence | Action (action prescrite ou notification) à prendre lorsqu’une règle de seuil est franchie. Type de données : tableau d’objets |
| testMeasureDefinition.thresholdRule.consequence.description | Description de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.id | Sys_id ou external_id de la conséquence de la mesure. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.name | Nom de la conséquence. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.prescribeAction | Action définie par l’utilisateur à prendre en cas de violation de seuil. Les actions varient d’une instance à l’autre. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.repeatAction | Marqueur indiquant s’il faut répéter l’action appliquée ou non. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| testMeasureDefinition.thresholdRule.consequence.validFor | Plage de dates pour laquelle la conséquence est valide. Type de données : objet |
| testMeasureDefinition.thresholdRule.consequence.validFor.endDateTime | Date de fin de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.consequence.validFor.startDateTime | Date de début de validité de la conséquence. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.thresholdRule.description | Description de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.id | Sys_id ou external_id des règles de seuil. Situé dans la table Règles de seuil [sn_st_mgmt_threshold_rule]. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.name | Nom de la règle de seuil. Type de données : chaîne |
| testMeasureDefinition.thresholdRule.numberOfAllowedCrossing | Croisements maximaux autorisés pendant la période de tolérance avant l’application des conséquences. Type de données : nombre Valeur maximale : 40 |
| testMeasureDefinition.thresholdRule.thresholdRuleSeverity | Gravité de la règle de seuil. Valeurs valides :
Type de données : chaîne |
| testMeasureDefinition.unitOfMeasure | Valeur mesurable de temps utilisée pour calculer la performance d’un service en jours, minutes et secondes. Type de données : chaîne |
| testMeasureDefinition.validFor | Plage de dates pour laquelle la définition de la mesure de test est valide. Type de données : objet |
| testMeasureDefinition.validFor.endDateTime | Date de fin de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| testMeasureDefinition.validFor.startDateTime | Date de début de validité de la définition de la mesure d’essai. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor | Plage de dates pour laquelle le test de service est valide. Type de données : objet |
| valideFor.endDateTime | Date et heure de fin du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
| valideFor.startDateTime | Date et heure de début du test de service. Format : JJ-MM-AAAA 00:00:00. Par exemple, Type de données : chaîne |
Demande cURL
L’exemple suivant crée une nouvelle définition de test de service.
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"
}
]
}
Corps de réponse.
{
"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"
}