Gestion des alarmes API ouverte

Rversion finale: Washingtondc

Mis à jour 1 févr. 2024

28 minutes de lecture

L’API ouverte Alarm Management fournit des points de terminaison pour créer, mettre à jour et récupérer des données à partir des tables Événements [em_event] et Alerte [em_alert].

L’API ouverte de gestion des alarmes de télécommunications (sn_ind_tmf642) est une ServiceNow® implémentation de la spécification TM Forum Open API. Cette API est basée sur la version 20 de la spécification REST de l’API de gestion des alarmes TMF642 d’avril 2020.

L’utilisateur appelant doit avoir accès au point de terminaison sn_ind_tmf642.alarm_mgmt_integration .

Cette API est fournie dans l’espace de noms sn_ind_tmf642 .

La spécification TM Forum Open API exige une réponse synchrone pour chaque demande entrante qu’elle reçoit. Appliquez la corrélation et la déduplication dans le système de support opérationnel (OSS) source avant de transférer les charges utiles au système.

Cette API peut être étendue pour effectuer des personnalisations autour des paramètres requis, de la validation du corps de la demande, des opérations REST supplémentaires et des mappages de champs. Pour plus d'informations, voir le Guide du développeur de l’API ouverte Alarm Management.

L’API ouverte de gestion des alarmes est certifiée conforme par TM Forum.

Logo de conformité TMF

API ouverte de gestion des alarmes : GET /sn_ind_tmf642/alarm_mgmt/alarm

Récupère une liste de tous les enregistrements d’alarme des tables Événements [em_event] et Alerte [em_alert].

Format d'URL

URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 2. Paramètres de requête
Nom	Description
alarmRaisedTime	Date à laquelle l’alarme a été déclenchée. Seules les alarmes dont la date correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : Objet alarmé alarmRaisedTime Type d’alarme CrossedThresholdInformation ID d’alarme externe ID perceivedSeverity cause probable source SourceSystemId (en anglais seulement) État type Valeur par défaut : Tous les champs Type de données : chaîne
ID	ID d’alarme. Seules les alarmes avec un ID correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Situé dans le champ Clé de message de la table Événements [em_event]. Type de données : chaîne
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le offset paramètre pour paginer la récupération des enregistrements. Par défaut : 1 000 Maximum : 2000 Type de données : nombre
décalage	Index de départ auquel commencer la récupération d’enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre
cause probable	Cause probable de l’alarme. Seules les alarmes dont la cause probable correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne
État	État de l’alarme. Seules les alarmes dont l’état correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne
SourceSystemId (en anglais seulement)	ID du système source de l’alarme. Seules les alarmes dont l’ID système source correspond à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne

Tableau 3. Paramètres de corps de demande (JSON)
Nom	Description
Néant

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes
En-tête	Description
Aucun

Tableau 5. En-têtes de réponses
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 correspond `aux é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. premier dernier suivant previous
X-Total-Count	Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource entière renvoyée en réponse (aucune pagination).
206	Ressource partielle renvoyée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)


Nom	Description
service affecté	Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau `"affectedService":[ { "href": "String", "id": "String" }, ]`
serviceaffecté.href	Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne
affectedService.id	Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne
alarmDetails (en anglais seulement)	Détails supplémentaires sur l’alarme. Type de données : chaîne
Objet alarmé	Détails de l’objet d’alarme. `"alarmedObject": { "href": "String", "id": "String" }` Type de données : objet
alarmedObject.id	Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne
alarmedObject.href	Référence de l’URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmedObjectType	Type ou classe d’objet associé à l’événement. Type de données : chaîne
alarmRaisedTime	Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne
alarmeReportingTime	Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) maintient la liste d’alarmes : Il alarmRaisedTime s’agit de l’heure de détection de l’alarme par l’élément de réseau (NE). Il alarmReportingTime s’agit de la durée de stockage du rapport d’alarme dans la liste des alarmes EMS. Type de données : chaîne
Type d’alarme	Catégorie d’alarme. Type de données : chaîne
CrossedThresholdInformation	Détails sur le seuil dépassé. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Type de données : objet
CrossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs possibles : VERS LE HAUT VERS LE BAS Type de données : chaîne
CrossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, `5MINUTES.` Type de données : chaîne
CrossedThresholdInformation.indicatorName	Nom de l’indicateur qui dépasse le seuil d’alarme. Type de données : chaîne
CrossedThresholdInformation.indicatorUnit	Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne
CrossedThresholdInformation.observedValue	Nombre identifiant l’indicateur dépassant le seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdCrossingDescription	Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdId	Identificateur unique du seuil qui a déclenché l’alarme. Type de données : chaîne
CrossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
ID d’alarme externe	Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne
href	URL de la ressource. Type de données : chaîne
ID	Identificateur unique permettant au système d’identifier et de traiter la charge utile d’alarme en tant qu’événement. Type de données : chaîne
perceivedSeverity	Sévérité de l’alarme. Valeurs possibles : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans l’état d’une panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne
cause probable	Situation la plus susceptible de déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne
proposéesRéparationActions	S’il est disponible pour le système, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne
serviceAffectant	Marqueur indiquant si l’alarme affecte le service. Valeurs valides : true : l’alarme affecte la performance ou la disponibilité du service. false : l’alarme n’affecte pas le service. Valeur par défaut : false Type de données : booléennes
SourceSystemId (en anglais seulement)	ID d’instance de l’alarme source. Type de données : chaîne
Problème spécifique	Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Prêt Traité Ignoré Erreur Si une valeur non valide est fournie, l’état est défini sur `Prêt`. Si l’état est `Prêt`, une alerte est créée dans la table Alerte [em_alert] et l’état devient `alors Traitée`. Si l’état est `Traité,Ignoré` ou `Erreur` , aucune alerte n’est créée. Valeur par défaut : Prêt Type de données : chaîne

Demande cURL

Cet exemple récupère toutes les alarmes.

curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

[
   {
      "externalAlarmId": "2212331",
      "alarmType": "QualityOfServiceAlarm23",
      "perceivedSeverity": "MAJOR",
      "probableCause": "ProbB",
      "sourceSystemId": "checkSB",
      "alarmedObject": {
         "id": "vManage_000000",
         "href": " http://api/alarmedobject/000000"
      },
      "crossedThresholdInformation": {
         "direction": "111",
         "granularity": "1234",
         "indicatorName": "sdfgds",
         "indicatorUnit": "asdfdsaf",
         "observedValue": "adsfds",
         "thresholdId": "12fasdfasdfasd",
         "thresholdCrossingDescription": "S23rtring",
         "thresholdRef": "asdfasf"
      },
      "type": "QualityOfServiceAlarm",
      "ackState": "acknowledged",
      "specificProblem": "Inbound Traffic threshold crossed",
      "alarmedObjectType": "ROUTER",
      "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
      "state": "processed",
      "alarmChangedTime": "2017-08-15T07:04:15.666Z",
      "proposedRepairActions": "Switch in standby equipment",
      "alarmReportingTime": "2017-06-15T07:04:15.666Z",
      "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
      "plannedOutageIndication": "IN_SERVICE",
      "serviceAffecting": true,
      "affectedService": [
         {
            "id": "SD WAN Enterprise Solutions",
            "href": "http://api/service/vlan_dot0_dot0"
         },
         {
            "id": "Santa Clara SD WAN Application Service",
            "href": "http://api/service/vlan_dot0_dot0"
         }
      ],
      "source": "Alarm Management Open API",
      "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
      "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
   },
   {
      "externalAlarmId": "2212331",
      "alarmType": "QualityOfServiceAlarm23",
      "perceivedSeverity": "MAJOR",
      "probableCause": "ProbB",
      "sourceSystemId": "checkSB",
      "alarmedObject": {
         "id": "vManage_000000",
         "href": " http://api/alarmedobject/000000"
      },
      "crossedThresholdInformation": {
         "direction": "111",
         "granularity": "1234",
         "indicatorName": "sdfgds",
         "indicatorUnit": "asdfdsaf",
         "observedValue": "adsfds",
         "thresholdId": "12fasdfasdfasd",
         "thresholdCrossingDescription": "S23rtring",
         "thresholdRef": "asdfasf"
      },
      "type": "QualityOfServiceAlarm",
      "ackState": "acknowledged",
      "specificProblem": "Inbound Traffic threshold crossed",
      "alarmedObjectType": "ROUTER",
      "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
      "state": "processed",
      "alarmChangedTime": "2017-08-15T07:04:15.666Z",
      "proposedRepairActions": "Switch in standby equipment",
      "alarmReportingTime": "2017-06-15T07:04:15.666Z",
      "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
      "plannedOutageIndication": "IN_SERVICE",
      "serviceAffecting": true,
      "affectedService": [
         {
            "id": "SD WAN Enterprise Solutions",
            "href": "http://api/service/vlan_dot0_dot0"
         },
         {
            "id": "Santa Clara SD WAN Application Service",
            "href": "http://api/service/vlan_dot0_dot0"
         }
      ],
      "source": "Alarm Management Open API",
      "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001c84aa29078d10f87759e2f69e4cfa_2212331",
      "id": "001c84aa29078d10f87759e2f69e4cfa_2212331"
   }
]

API ouverte de gestion des alarmes : GET /sn_ind_tmf642/alarm_mgmt/alarm/{id}

Récupère un enregistrement d’alarme spécifié à partir de la table Événements [em_event] ou Alerte [em_alert].

Format d'URL

URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
ID	Identificateur unique de l’enregistrement à récupérer. Situé dans le champ Clé de message de la table Événements [em_event]. Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : Objet alarmé alarmRaisedTime Type d’alarme CrossedThresholdInformation ID d’alarme externe ID perceivedSeverity cause probable source SourceSystemId (en anglais seulement) État type Valeur par défaut : Tous les champs Type de données : chaîne

Tableau 9. Paramètres de corps de demande (JSON)
Nom	Description
Néant

En-têtes

Tableau 10. En-têtes de demandes
En-tête	Description
Accepter	Format de données du corps de la réponse. Prend uniquement en charge application/json.

Tableau 11. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 12. Codes d'état
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é pour une ou plusieurs des raisons suivantes. Paramètre de chemin d’accès non valide. URI non valide.
404	Enregistrement introuvable. Aucun enregistrement associé à l’ID spécifié ne se trouve dans la table Événement [em_event] ou Alerte [em_alert].

Paramètres de corps de réponse (JSON)


Nom	Description
service affecté	Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau `"affectedService":[ { "href": "String", "id": "String" }, ]`
serviceaffecté.href	Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne
affectedService.id	Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne
alarmDetails (en anglais seulement)	Détails supplémentaires sur l’alarme. Type de données : chaîne
Objet alarmé	Détails de l’objet d’alarme. Type de données : objet `"alarmedObject": { "href": "String", "id": "String" }`
alarmedObject.id	Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne
alarmedObject.href	Référence de l’URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmedObjectType	Type ou classe d’objet associé à l’événement. Type de données : chaîne
alarmRaisedTime	Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne
alarmeReportingTime	Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) maintient la liste d’alarmes : Il alarmRaisedTime s’agit de l’heure de détection de l’alarme par l’élément de réseau (NE). Il alarmReportingTime s’agit de la durée de stockage du rapport d’alarme dans la liste des alarmes EMS. Type de données : chaîne
Type d’alarme	Catégorie d’alarme. Type de données : chaîne
CrossedThresholdInformation	Détails sur le seuil dépassé. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Type de données : objet
CrossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs possibles : VERS LE HAUT VERS LE BAS Type de données : chaîne
CrossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, `5MINUTES.` Type de données : chaîne
CrossedThresholdInformation.indicatorName	Nom de l’indicateur qui dépasse le seuil d’alarme. Type de données : chaîne
CrossedThresholdInformation.indicatorUnit	Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne
CrossedThresholdInformation.observedValue	Nombre identifiant l’indicateur dépassant le seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdCrossingDescription	Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdId	Identificateur unique du seuil qui a déclenché l’alarme. Type de données : chaîne
CrossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
ID d’alarme externe	Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne
href	URL de la ressource. Type de données : chaîne
ID	Identificateur unique permettant au système d’identifier et de traiter la charge utile d’alarme en tant qu’événement. Type de données : chaîne
perceivedSeverity	Sévérité de l’alarme. Valeurs possibles : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans l’état d’une panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne
cause probable	Situation la plus susceptible de déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne
proposéesRéparationActions	S’il est disponible pour le système, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne
serviceAffectant	Marqueur indiquant si l’alarme affecte le service. Valeurs valides : true : l’alarme affecte la performance ou la disponibilité du service. false : l’alarme n’affecte pas le service. Valeur par défaut : false Type de données : booléennes
SourceSystemId (en anglais seulement)	ID d’instance de l’alarme source. Type de données : chaîne
Problème spécifique	Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Prêt Traité Ignoré Erreur Si une valeur non valide est fournie, l’état est défini sur `Prêt`. Si l’état est `Prêt`, une alerte est créée dans la table Alerte [em_alert] et l’état devient `alors Traitée`. Si l’état est `Traité,Ignoré` ou `Erreur` , aucune alerte n’est créée. Valeur par défaut : Prêt Type de données : chaîne

Demande cURL

Cet exemple récupère une alarme.

curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Corps de la réponse.

{
   "externalAlarmId": "2212331",
   "alarmType": "QualityOfServiceAlarm23",
   "perceivedSeverity": "MAJOR",
   "probableCause": "ProbB",
   "sourceSystemId": "checkSB",
   "alarmedObject": {
      "id": "vManage_000000",
      "href": " http://api/alarmedobject/000000"
   },
   "crossedThresholdInformation": {
      "direction": "111",
      "granularity": "1234",
      "indicatorName": "ind_name",
      "indicatorUnit": "ind_unit",
      "observedValue": "232",
      "thresholdId": "200",
      "thresholdCrossingDescription": "sample_description",
      "thresholdRef": "sample_ref"
   },
   "type": "QualityOfServiceAlarm",
   "ackState": "acknowledged",
   "specificProblem": "Inbound Traffic threshold crossed",
   "alarmedObjectType": "ROUTER",
   "alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
   "state": "processed",
   "alarmChangedTime": "2017-08-15T07:04:15.666Z",
   "proposedRepairActions": "Switch in standby equipment",
   "alarmReportingTime": "2017-06-15T07:04:15.666Z",
   "alarmRaisedTime": "2020-09-15T14:04:15.000Z",
   "plannedOutageIndication": "IN_SERVICE",
   "serviceAffecting": true,
   "affectedService": [
      {
         "id": "SD WAN Enterprise Solutions",
         "href": "http://api/service/vlan_dot0_dot0"
      },
      {
         "id": "Santa Clara SD WAN Application Service",
         "href": "http://api/service/vlan_dot0_dot0"
      }
   ],
   "source": "Alarm Management Open API",
   "href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
   "id": "001a0ca629078d10f87759e2f69e4c64_2212331"
}

API ouverte de gestion des alarmes – PATCH /sn_ind_tmf642/alarm_mgmt/alarm/{id}

Met à jour une alarme spécifiée et toute alerte associée.

Ce point de terminaison écrit le corps de la réponse dans le champ Informations supplémentaires de l’enregistrement d’événement dans la table Événements [em_event].

Format d'URL

URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

Paramètres de demande pris en charge

Tableau 13. Paramètres de chemin d'accès
Nom	Description
ID	Identificateur unique de l’enregistrement à mettre à jour. Situé dans le champ Clé de message de la table Événements [em_event]. Type de données : chaîne

Tableau 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (JSON)
Nom	Description
service affecté	Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau `"affectedService":[ { "href": "String", "id": "String" }, ]`
serviceaffecté.href	Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne
affectedService.id	Requis. Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne
alarmeChangedTime	Indique la date et l’heure auxquelles l’alarme a été modifiée pour la dernière fois sur le système propriétaire de l’alarme. Toute modification de l’alarme met à jour cette valeur, qu’elle provienne de la ressource alarmée ou qu’elle soit déclenchée par une modification du client. Type de données : chaîne
alarmDetails (en anglais seulement)	Détails supplémentaires sur l’alarme. Type de données : chaîne
alarmeEscalade	Marqueur qui indique une escalade de la gravité de l’alarme. Valeurs valides : true : il y a une escalade de la gravité de l’alarme. false : la gravité de l’alarme est égale ou inférieure. Valeur par défaut : false Type de données : booléennes
CrossedThresholdInformation	Détails sur le seuil dépassé. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Type de données : objet
CrossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs possibles : VERS LE HAUT VERS LE BAS Type de données : chaîne
CrossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, `5MINUTES.` Type de données : chaîne
CrossedThresholdInformation.indicatorName	Nom de l’indicateur qui dépasse le seuil d’alarme. Type de données : chaîne
CrossedThresholdInformation.indicatorUnit	Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne
CrossedThresholdInformation.observedValue	Nombre identifiant l’indicateur dépassant le seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdCrossingDescription	Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdId	Requis. Identificateur unique du seuil qui a déclenché l’alarme. Type de données : chaîne
CrossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
href	Référence de l’URL de l’alarme. Type de données : chaîne
perceivedSeverity	Requis. Sévérité de l’alarme. Valeurs possibles : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans l’état d’une panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne
cause probable	Requis. Situation la plus susceptible de déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne
proposéesRéparationActions	S’il est disponible pour le système, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne
serviceAffectant	Marqueur indiquant si l’alarme affecte le service. Valeurs valides : true : l’alarme affecte la performance ou la disponibilité du service. false : l’alarme n’affecte pas le service. Valeur par défaut : false Type de données : booléennes
Problème spécifique	Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne

En-têtes

Tableau 16. En-têtes de demandes
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.

Tableau 17. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 18. Codes d'état
Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Raisons possibles : Charge utile non valide. ID d’alarme requis manquant. Charge utile non valide. Champ obligatoire manquant :<nom du champ>. Charge utile non valide. Objet requis manquant. Événement non créé, échec. Impossible d’effacer l’événement. Impossible de mettre à jour l’événement. L’événement n’existe pas.

Paramètres de corps de réponse (JSON)


Nom	Description
alarmeChangedTime	Date et heure auxquelles l’alarme a changé en GMT sur le système propriétaire de l’alarme. Cette valeur est au format GlideDateTime et se trouve dans le Time of event champ d’un enregistrement de la table Événements [em_events]. Cette valeur est mise à jour lorsque des changements apportés à l’alarme à partir de la ressource alarmée se produisent ou qu’un changement provenant d’une mise à jour du client déclenche l’alarme. Cette valeur est requise dans la réponse. Type de données : chaîne
href	Référence de l’URL de l’alarme. Type de données : chaîne
ID	Identificateur unique de l’alarme. Valeur déterminée par le système propriétaire de l’alarme. Type de données : chaîne

Demande cURL

Dans cet exemple, la gravité est réduite à MINEURE.

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
     \"href\":\"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00\",
     \"externalAlarmId\":\"<external-alarm-id>\",
     \"alarmType\":\"QualityOfServiceAlarm\",
     \"type\":\"QualityOfServiceAlarm\",
     \"ackState\":\"acknowledged\",
     \"perceivedSeverity\":\"MINOR\",
     \"probableCause\":\"Threshold crossed\",
     \"specificProblem\":\"Inbound Traffic threshold crossed\",
     \"alarmedObjectType\":\"ROUTER\",
     \"alarmedObject\":{
        \"id\":\"vManage_000000\",
        \"href\":\" http://api/alarmedobject/000000\"
     },
     \"sourceSystemId\":\"SOURCE_SYSTEM_vManage_00000_000_00\",
     \"alarmDetails\":\"Software Failure on SD-WAN Controller vManage_000000\",
     \"alarmEscalation\": false,
     \"state\":\"RAISED\",
     \"alarmChangedTime\":\"2017-08-15T07:04:15.666Z\",
     \"proposedRepairActions\":\"Switch in standby equipment\",
     \"alarmReportingTime\":\"2017-06-15T07:04:15.666Z\",
     \"alarmRaisedTime\":\"2020-09-15T07:04:15.666Z\",
     \"plannedOutageIndication\":\"IN_SERVICE\",
     \"serviceAffecting\":true,
     \"affectedService\":[
        {
           \"id\":\"SD WAN Enterprise Solutions\",
           \"href\":\"http://api/service/vlan_dot0_dot0\"
        },
        {
           \"id\":\"Santa Clara SD WAN Application Service\",
           \"href\":\"http://api/service/vlan_dot0_dot0\"
        }
     ] 
 }" \
--user 'user:'password'

Corps de la réponse.

{
  "result": {
    "alarmChangedTime": "2017-08-15T07:04:15.666Z",
    "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
  }
}

API ouverte de gestion des alarmes – POST /sn_ind_tmf642/alarm_mgmt/alarm

Crée un enregistrement d’alarme dans la table Événements [em_event].

Lorsque l’enregistrement d’alarme est créé, un ID pour l’alarme est ajouté dans le Message key champ.

Il est également possible de créer un enregistrement d’alerte en fonction des règles de gestion des alertes.

Ce point de terminaison écrit le corps de la réponse dans le champ Informations supplémentaires de l’enregistrement d’événement dans la table Événements [em_event].

Format d'URL

URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm

Paramètres de demande pris en charge

Tableau 19. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 20. Paramètres de requête
Nom	Description
Néant

Tableau 21. Paramètres de corps de demande (JSON)
Nom	Description
service affecté	Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau `"affectedService":[ { "href": "String", "id": "String" }, ]`
serviceaffecté.href	Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne
affectedService.id	Requis. Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne
alarmDetails (en anglais seulement)	Détails supplémentaires sur l’alarme. Type de données : chaîne
Objet alarmé	Requis. Détails de l’objet d’alarme. `"alarmedObject": { "href": "String", "id": "String" }` Type de données : objet
alarmedObject.id	Requis. Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne
alarmedObject.href	Référence de l’URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmedObjectType	Type ou classe d’objet associé à l’événement. Type de données : chaîne
alarmRaisedTime	Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne
alarmeReportingTime	Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) maintient la liste d’alarmes : Il alarmRaisedTime s’agit de l’heure de détection de l’alarme par l’élément de réseau (NE). Il alarmReportingTime s’agit de la durée de stockage du rapport d’alarme dans la liste des alarmes EMS. Type de données : chaîne
Type d’alarme	Requis. Catégorie d’alarme. Type de données : chaîne
CrossedThresholdInformation	Détails sur le seuil dépassé. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Type de données : objet
CrossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs possibles : VERS LE HAUT VERS LE BAS Type de données : chaîne
CrossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, `5MINUTES.` Type de données : chaîne
CrossedThresholdInformation.indicatorName	Nom de l’indicateur qui dépasse le seuil d’alarme. Type de données : chaîne
CrossedThresholdInformation.indicatorUnit	Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne
CrossedThresholdInformation.observedValue	Nombre identifiant l’indicateur dépassant le seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdCrossingDescription	Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdId	Requis. Identificateur unique du seuil qui a déclenché l’alarme. Type de données : chaîne
CrossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
ID d’alarme externe	Requis. Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne
ID	Identificateur unique permettant au système d’identifier et de traiter la charge utile d’alarme en tant qu’événement. Cette valeur doit être vide si elle est utilisée dans la charge utile. Le système génère cet ID unique pour l’événement et l’envoie dans le cadre de la charge utile de la réponse. Type de données : chaîne
perceivedSeverity	Requis. Sévérité de l’alarme. Valeurs possibles : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans l’état d’une panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne
cause probable	Requis. Situation la plus susceptible de déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne
proposéesRéparationActions	S’il est disponible pour le système, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne
serviceAffectant	Marqueur indiquant si l’alarme affecte le service. Valeurs valides : true : l’alarme affecte la performance ou la disponibilité du service. false : l’alarme n’affecte pas le service. Valeur par défaut : false Type de données : booléennes
SourceSystemId (en anglais seulement)	Requis. ID d’instance de l’alarme source. Type de données : chaîne
Problème spécifique	Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Prêt Traité Ignoré Erreur Si une valeur non valide est fournie, l’état est défini sur `Prêt`. Si l’état est `Prêt`, une alerte est créée dans la table Alerte [em_alert] et l’état devient `alors Traitée`. Si l’état est `Traité,Ignoré` ou `Erreur` , aucune alerte n’est créée. Valeur par défaut : Prêt Type de données : chaîne

En-têtes

Tableau 22. En-têtes de demandes
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.

Tableau 23. En-têtes de réponses
En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 24. Codes d'état
Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Raisons possibles : Charge utile non valide. ID d’alarme requis manquant. Charge utile non valide. Champ obligatoire manquant :<nom du champ>. Charge utile non valide. Objet requis manquant. Événement non créé, échec. Impossible d’effacer l’événement. Impossible de mettre à jour l’événement. L’événement n’existe pas.

Paramètres de corps de réponse (JSON)


Nom	Description
service affecté	Liste des objets identifiant un ou plusieurs services affectés par l’alarme. Type de données : tableau `"affectedService":[ { "href": "String", "id": "String" }, ]`
serviceaffecté.href	Référence d’URL fournissant des détails sur le service affecté. Type de données : chaîne
affectedService.id	Identificateur du service affecté par l’alarme. Cette valeur est mappée à l’élément de configuration (CI) affecté sur l’alerte. Type de données : chaîne
alarmDetails (en anglais seulement)	Détails supplémentaires sur l’alarme. Type de données : chaîne
Objet alarmé	Détails de l’objet d’alarme. `"alarmedObject": { "href": "String", "id": "String" }` Type de données : objet
alarmedObject.id	Identificateur unique de l’objet d’alarme. Cette valeur est mappée à un CI dans le système. Type de données : chaîne
alarmedObject.href	Référence de l’URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmedObjectType	Type ou classe d’objet associé à l’événement. Type de données : chaîne
alarmRaisedTime	Date et heure auxquelles l’alarme se produit à sa source. Type de données : chaîne
alarmeReportingTime	Date et heure auxquelles l’OSS signale son alarme. Cette valeur peut différer de la alarmRaisedTime valeur. Par exemple, si un système de gestion des éléments (EMS) maintient la liste d’alarmes : Il alarmRaisedTime s’agit de l’heure de détection de l’alarme par l’élément de réseau (NE). Il alarmReportingTime s’agit de la durée de stockage du rapport d’alarme dans la liste des alarmes EMS. Type de données : chaîne
Type d’alarme	Catégorie d’alarme. Type de données : chaîne
CrossedThresholdInformation	Détails sur le seuil dépassé. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Type de données : objet
CrossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs possibles : VERS LE HAUT VERS LE BAS Type de données : chaîne
CrossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le franchissement de seuil. Par exemple, `5MINUTES.` Type de données : chaîne
CrossedThresholdInformation.indicatorName	Nom de l’indicateur qui dépasse le seuil d’alarme. Type de données : chaîne
CrossedThresholdInformation.indicatorUnit	Unité de mesure de l’indicateur correspondant au seuil franchi. Type de données : chaîne
CrossedThresholdInformation.observedValue	Nombre identifiant l’indicateur dépassant le seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdCrossingDescription	Plus de détails sur le seuil de l’alarme de franchissement de seuil. Type de données : chaîne
CrossedThresholdInformation.thresholdId	Identificateur unique du seuil qui a déclenché l’alarme. Type de données : chaîne
CrossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
ID d’alarme externe	Identificateur unique de l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne
href	URL de la ressource. Type de données : chaîne
ID	Identificateur unique permettant au système d’identifier et de traiter la charge utile d’alarme en tant qu’événement. Type de données : chaîne
perceivedSeverity	Sévérité de l’alarme. Valeurs possibles : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans l’état d’une panne planifiée. Par exemple, maintenance planifiée ou hors service. Type de données : chaîne
cause probable	Situation la plus susceptible de déclencher l’alarme. Utilisez avec pour alarmType qualifier l’alarme. Type de données : chaîne
proposéesRéparationActions	S’il est disponible pour le système, fournit une action de réparation pour résoudre le problème qui déclenche l’alarme. Type de données : chaîne
serviceAffectant	Marqueur indiquant si l’alarme affecte le service. Valeurs valides : true : l’alarme affecte la performance ou la disponibilité du service. false : l’alarme n’affecte pas le service. Valeur par défaut : false Type de données : booléennes
SourceSystemId (en anglais seulement)	ID d’instance de l’alarme source. Type de données : chaîne
Problème spécifique	Problème spécifique qui déclenche l’alarme. Utilisez avec pour probableCause qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Prêt Traité Ignoré Erreur Si une valeur non valide est fournie, l’état est défini sur `Prêt`. Si l’état est `Prêt`, une alerte est créée dans la table Alerte [em_alert] et l’état devient `alors Traitée`. Si l’état est `Traité,Ignoré` ou `Erreur` , aucune alerte n’est créée. Valeur par défaut : Prêt Type de données : chaîne

Demande cURL

Cet exemple crée une alarme.

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
     "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
     "externalAlarmId":"<external-alarm-id>",
     "alarmType":"QualityOfServiceAlarm",
     "type":"QualityOfServiceAlarm",
     "ackState":"acknowledged",
     "perceivedSeverity":"CRITICAL",
     "probableCause":"Threshold crossed",
     "specificProblem":"Inbound Traffic threshold crossed",
     "alarmedObjectType":"ROUTER",
     "alarmedObject":{
        "id":"vManage_000000",
        "href":" http://api/alarmedobject/000000"
     },
     "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
     "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
     "state":"RAISED",
     "alarmChangedTime":"2017-08-15T07:04:15.666Z",
     "proposedRepairActions":"Switch in standby equipment",
     "alarmReportingTime":"2017-06-15T07:04:15.666Z",
     "alarmRaisedTime":"2020-09-15T07:04:15.666Z",
     "plannedOutageIndication":"IN_SERVICE",
     "serviceAffecting":true,
     "affectedService":[
        {
           "id":"SD WAN Enterprise Solutions",
           "href":"http://api/service/vlan_dot0_dot0"
        },
        {
           "id":"Santa Clara SD WAN Application Service",
           "href":"http://api/service/vlan_dot0_dot0"
        }
     ] 
 }" \
--user 'user':'password'

Corps de la réponse.

{
     "href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
     "externalAlarmId":"<external-alarm-id>",
     "alarmType":"QualityOfServiceAlarm",
     "type":"QualityOfServiceAlarm",
     "ackState":"acknowledged",
     "perceivedSeverity":"CRITICAL",
     "probableCause":"Threshold crossed",
     "specificProblem":"Inbound Traffic threshold crossed",
     "alarmedObjectType":"ROUTER",
     "alarmedObject":{
        "id":"vManage_000000",
        "href":" http://api/alarmedobject/000000"
     },
     "sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
     "alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
     "state":"RAISED",
     "alarmChangedTime":"2017-08-15T07:04:15.666Z",
     "proposedRepairActions":"Switch in standby equipment",
     "alarmReportingTime":"2017-06-15T07:04:15.666Z",
     "alarmRaisedTime":"2020-09-15T07:04:15.666Z",
     "plannedOutageIndication":"IN_SERVICE",
     "serviceAffecting":true,
     "affectedService":[
        {
           "id":"SD WAN Enterprise Solutions",
           "href":"http://api/service/vlan_dot0_dot0"
        },
        {
           "id":"Santa Clara SD WAN Application Service",
           "href":"http://api/service/vlan_dot0_dot0"
        }
     ] 
 }

API ouverte de gestion des alarmes – POST /sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

Efface une alarme spécifiée et ferme toute alerte associée.

Format d'URL

URL par défaut : /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

Paramètres de demande pris en charge

Tableau 25. Paramètres de chemin d'accès
Nom	Description
ID	Identificateur unique de l’alarme à effacer. Situé dans le champ Clé de message de la table Événements [em_events]. Type de données : chaîne

Tableau 26. Paramètres de requête
Nom	Description
Néant

Tableau 27. Paramètres de corps de demande (JSON)
Nom	Description
alarmClearedTime	Date et heure auxquelles l’alarme s’efface à la source. Cette valeur se trouve dans le Time of event champ de l’enregistrement dans la table Événements [em_events]. Type de données : chaîne
clearSystemId (en anglais seulement)	Requis. Nom de l’instance à partir de laquelle l’opération alarmCleared a été appelée. Type de données : chaîne
clearUserId (en anglais seulement)	Requis. ID unique de l’utilisateur qui a invoqué l’opération alarmCleared . Cette valeur se trouve dans le Source champ de l’enregistrement dans la table Événements [em_events]. Type de données : chaîne

En-têtes

Tableau 28. En-têtes de demandes
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.

Tableau 29. En-têtes de réponses
Nom	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 30. Codes d'état
Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Raisons possibles : Charge utile non valide. ID d’alarme requis manquant. Charge utile non valide. Champ obligatoire manquant :<nom du champ>. Charge utile non valide. Objet requis manquant. Événement non créé, échec. Impossible d’effacer l’événement. Impossible de mettre à jour l’événement. L’événement n’existe pas.

Paramètres de corps de réponse (JSON)


Nom	Description
alarmClearedTime	Date et heure auxquelles l’alarme s’efface à la source. Cette valeur se trouve dans le Time of event champ de l’enregistrement dans la table Événements [em_events]. Type de données : chaîne
clearSystemId (en anglais seulement)	Nom de l’instance à partir de laquelle l’opération alarmCleared a été appelée. Type de données : chaîne
clearUserId (en anglais seulement)	ID unique de l’utilisateur qui a invoqué l’opération alarmCleared . Cette valeur se trouve dans le Source champ de l’enregistrement dans la table Événements [em_events]. Type de données : chaîne
href	URL de l’alarme. Type de données : chaîne
ID	ID unique dans le Message key champ d’un enregistrement de la table Événements [em_events]. Type de données : chaîne

Demande cURL

Cet exemple efface une alarme.

curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"alarmClearedTime\": \"2017-08-15 06:04:15\",
  \"clearSystemId\": \"<source_instance_name>\",
  \"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\" 
}" \
--user 'user':'password'

Corps de la réponse.

{
  "result": {
    "alarmClearedTime": "2017-08-15 06:04:15",
    "clearSystemId": "<source_instance_name>",
    "clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00",
    "id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
  }
}