Gestion des alarmes API ouverte

Rversion finale: Zurich

Mis à jour 31 juil. 2025

27 minutes de lecture

L’API ouverte de gestion des alarmes 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 de l’API ouverte TM Forum. Cette API est basée sur la spécification REST de l’API de gestion des alarmes TMF642, version 20, avril 2020.

L’utilisateur appelant doit accéder 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 de l’API ouverte TM Forum 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 soutien opérationnel (OSS) source avant de transmettre 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 de gestion des alarmes.

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

Logo de conformité TMF

Gestion des alarmes API ouverte – GET /sn_ind_tmf642/alarm_mgmt/alarm

Récupère une liste de tous les enregistrements d’alarme à partir 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 : alarmedObject alarmRaisedTime type d’alarme crossedThresholdInformation externalAlarmId id PerceptiondSeverity Cause probable source sourceSystemId État type 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. Type de données : chaîne Table : dans le champ Clé du message de la table Événements [em_event].
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Valeur par défaut : 1 000 Maximum : 2000 Type de données : nombre
décalage	Index de début auquel commencer à récupérer les 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. Type de données : nombre Par défaut : 0
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	ID du système source de l’alarme. Seules les alarmes dont l’ID du 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 du corps de la demande (JSON)
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.

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	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `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. 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 la 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 complète renvoyée en réponse (aucune pagination).
206	Ressource partielle retourné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
serviceaffecté	Liste d’un ou plusieurs services affectés par l’alarme. Type de données : tableau d’objets `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	Référence d’URL qui fournit les détails du 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
alarmDétails	Détails supplémentaires sur l’alarme. Type de données : chaîne
alarmedObject	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 URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmdObjectType	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
alarmReportingTime	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) tient à jour la liste des alarmes : Il s’agit alarmRaisedTime de l’heure de détection de l’alarme par l’élément de réseau (NE). Il s’agit alarmReportingTime de l’heure 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 franchi. Type de données : objet `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
crossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs valides : En bas En haut Type de données : chaîne
crossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le dépassement du seuil. Par exemple, `5MINUTES.` Type de données : chaîne
crossedThresholdInformation.indicatorName	Nom de l’indicateur qui franchit 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.observValue	Numéro identifiant l’indicateur qui franchit 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 à l’origine de l’alarme. Type de données : chaîne
crossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
externalAlarmId	Identificateur unique pour 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 pour le système afin d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Type de données : chaîne
PerceptiondSeverity	Gravité de l’alarme. Valeurs valides : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans un état de 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 alarmType pour qualifier l’alarme. Type de données : chaîne
proposedRepairActions	Si le système est disponible, 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 : vrai : l’alarme affecte les performances 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	ID d’instance de l’alarme source. Type de données : chaîne
specificProblem	Problème spécifique qui déclenche l’alarme. Utiliser avec le probableCause paramètre t pour qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Erreur Ignoré Prêt Traité 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 passe alors `à Traité`. 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"
   }
]

Gestion des alarmes API ouverte – 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. Type de données : chaîne Table : dans le champ Clé du message de la table Événements [em_event].

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 : alarmedObject alarmRaisedTime type d’alarme crossedThresholdInformation externalAlarmId id PerceptiondSeverity Cause probable source sourceSystemId État type Valeur par défaut : Tous les champs Type de données : chaîne

Tableau 9. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

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 la 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 incorrect ou une demande mal formée 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] ni Alerte [em_alert].

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


Nom	Description
serviceaffecté	Liste d’un ou plusieurs services affectés par l’alarme. Type de données : tableau d’objets `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	Référence d’URL qui fournit les détails du 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
alarmDétails	Détails supplémentaires sur l’alarme. Type de données : chaîne
alarmedObject	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 URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmdObjectType	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
alarmReportingTime	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) tient à jour la liste des alarmes : Il s’agit alarmRaisedTime de l’heure de détection de l’alarme par l’élément de réseau (NE). Il s’agit alarmReportingTime de l’heure 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 franchi. Type de données : objet `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
crossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs valides : En bas En haut Type de données : chaîne
crossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le dépassement du seuil. Par exemple, `5MINUTES.` Type de données : chaîne
crossedThresholdInformation.indicatorName	Nom de l’indicateur qui franchit 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.observValue	Numéro identifiant l’indicateur qui franchit 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 à l’origine de l’alarme. Type de données : chaîne
crossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
externalAlarmId	Identificateur unique pour 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 pour le système afin d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Type de données : chaîne
PerceptiondSeverity	Gravité de l’alarme. Valeurs valides : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans un état de 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 alarmType pour qualifier l’alarme. Type de données : chaîne
proposedRepairActions	Si le système est disponible, 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 : vrai : l’alarme affecte les performances 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	ID d’instance de l’alarme source. Type de données : chaîne
specificProblem	Problème spécifique qui déclenche l’alarme. Utiliser avec le probableCause paramètre t pour qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Erreur Ignoré Prêt Traité 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 passe alors `à Traité`. 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"
}

Gestion des alarmes API ouverte – 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. Type de données : chaîne Table : dans le champ Clé du message de la table Événements [em_event].

Tableau 14. Paramètres de requête
Nom	Description
Aucun

Tableau 15. Paramètres du corps de la demande (JSON)
Nom	Description
serviceaffecté	Liste d’un ou plusieurs services affectés par l’alarme. Type de données : tableau d’objets `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	Référence d’URL qui fournit les détails du 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
alarmChangedTime	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. Tout changement apporté à l’alarme met à jour cette valeur, qu’il provienne de la ressource alarmée ou qu’il soit déclenché par un changement du client. Type de données : chaîne
alarmDétails	Détails supplémentaires sur l’alarme. Type de données : chaîne
alarmEscalade	Marqueur qui indique une escalade dans la gravité de l’alarme. Valeurs valides : vrai : il y a une escalade dans la gravité de l’alarme. faux : la gravité de l’alarme est identique ou inférieure. Valeur par défaut : false Type de données : booléennes
crossedThresholdInformation	Détails sur le seuil franchi. Type de données : objet `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
crossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs valides : En bas En haut Type de données : chaîne
crossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le dépassement du seuil. Par exemple, `5MINUTES.` Type de données : chaîne
crossedThresholdInformation.indicatorName	Nom de l’indicateur qui franchit 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.observValue	Numéro identifiant l’indicateur qui franchit 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 à l’origine de 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 URL de l’alarme. Type de données : chaîne
PerceptiondSeverity	Requis. Gravité de l’alarme. Valeurs valides : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans un état de 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 alarmType pour qualifier l’alarme. Type de données : chaîne
proposedRepairActions	Si le système est disponible, 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 : vrai : l’alarme affecte les performances ou la disponibilité du service. false : l’alarme n’affecte pas le service. Valeur par défaut : false Type de données : booléennes
specificProblem	Problème spécifique qui déclenche l’alarme. Utiliser avec le probableCause paramètre t pour 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 la 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 de 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
alarmChangedTime	Date et heure auxquelles l’alarme a changé en GMT sur le système propriétaire de l’alarme. Cette valeur est mise à jour lorsque des changements apportés à l’alarme à partir de la ressource alarmée se produisent ou qu’un changement à partir 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 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>"
  }
}

Gestion des alarmes API ouverte – 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 de l’alarme est ajouté dans le Message key champ.

Un enregistrement d’alerte peut également être créé 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
Aucun

Tableau 21. Paramètres du corps de la demande (JSON)
Nom	Description
serviceaffecté	Liste d’un ou plusieurs services affectés par l’alarme. Type de données : tableau d’objets `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	Référence d’URL qui fournit les détails du 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
alarmDétails	Détails supplémentaires sur l’alarme. Type de données : chaîne
alarmedObject	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 URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmdObjectType	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
alarmReportingTime	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) tient à jour la liste des alarmes : Il s’agit alarmRaisedTime de l’heure de détection de l’alarme par l’élément de réseau (NE). Il s’agit alarmReportingTime de l’heure 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 franchi. Type de données : objet `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
crossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs valides : En bas En haut Type de données : chaîne
crossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le dépassement du seuil. Par exemple, `5MINUTES.` Type de données : chaîne
crossedThresholdInformation.indicatorName	Nom de l’indicateur qui franchit 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.observValue	Numéro identifiant l’indicateur qui franchit 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 à l’origine de l’alarme. Type de données : chaîne
crossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
externalAlarmId	Requis. Identificateur unique pour l’alarme provenant du système source qui publie l’alarme. Type de données : chaîne
id	Identificateur unique pour le système afin d’identifier et de traiter la charge utile de l’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
PerceptiondSeverity	Requis. Gravité de l’alarme. Valeurs valides : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans un état de 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 alarmType pour qualifier l’alarme. Type de données : chaîne
proposedRepairActions	Si le système est disponible, 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 : vrai : l’alarme affecte les performances 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	Requis. ID d’instance de l’alarme source. Type de données : chaîne
specificProblem	Problème spécifique qui déclenche l’alarme. Utiliser avec le probableCause paramètre t pour qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Erreur Ignoré Prêt Traité 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 passe alors `à Traité`. 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 la 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 de 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
serviceaffecté	Liste d’un ou plusieurs services affectés par l’alarme. Type de données : tableau d’objets `"affectedService":[ { "href": "String", "id": "String" }, ]`
affectedService.href	Référence d’URL qui fournit les détails du 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
alarmDétails	Détails supplémentaires sur l’alarme. Type de données : chaîne
alarmedObject	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 URL pour obtenir les détails de l’objet d’alarme. Type de données : chaîne
alarmdObjectType	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
alarmReportingTime	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) tient à jour la liste des alarmes : Il s’agit alarmRaisedTime de l’heure de détection de l’alarme par l’élément de réseau (NE). Il s’agit alarmReportingTime de l’heure 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 franchi. Type de données : objet `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }`
crossedThresholdInformation.direction	Sens de franchissement du seuil. Valeurs valides : En bas En haut Type de données : chaîne
crossedThresholdInformation.granularity	Granularité à laquelle l’indicateur est évalué pour le dépassement du seuil. Par exemple, `5MINUTES.` Type de données : chaîne
crossedThresholdInformation.indicatorName	Nom de l’indicateur qui franchit 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.observValue	Numéro identifiant l’indicateur qui franchit 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 à l’origine de l’alarme. Type de données : chaîne
crossedThresholdInformation.thresholdRef	URL de l’objet de seuil. Type de données : chaîne
externalAlarmId	Identificateur unique pour 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 pour le système afin d’identifier et de traiter la charge utile de l’alarme en tant qu’événement. Type de données : chaîne
PerceptiondSeverity	Gravité de l’alarme. Valeurs valides : CLAIR CRITIQUE MAJEUR MINEUR AVERTISSEMENT Type de données : chaîne
plannedOutageIndication	Indique que l’objet géré pour cette alarme est dans un état de 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 alarmType pour qualifier l’alarme. Type de données : chaîne
proposedRepairActions	Si le système est disponible, 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 : vrai : l’alarme affecte les performances 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	ID d’instance de l’alarme source. Type de données : chaîne
specificProblem	Problème spécifique qui déclenche l’alarme. Utiliser avec le probableCause paramètre t pour qualifier l’alarme. Type de données : chaîne
État	État de l’alarme. Valeurs valides : Erreur Ignoré Prêt Traité 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 passe alors `à Traité`. 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. Type de données : chaîne Table : dans le champ Clé du message de la table Événements [em_events].

Tableau 26. Paramètres de requête
Nom	Description
Aucun

Tableau 27. Paramètres du corps de la demande (JSON)
Nom	Description
alarmClearedTime	Date et heure auxquelles l’alarme s’éteint à la source. Type de données : chaîne Table : dans le champ Heure de l’événement de la table Événements [em_events].
clearSystemId	Requis. Nom de l’instance à partir de laquelle l’opération alarmCleared a été invoquée. Type de données : chaîne
clearUserId	Requis. ID unique de l’utilisateur qui a invoqué l’opération alarmCleared . 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 la 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 de 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’éteint à la source. Type de données : chaîne Table : dans le champ Heure de l’événement de la table Événements [em_events].
clearSystemId	Nom de l’instance à partir de laquelle l’opération alarmCleared a été invoquée. Type de données : chaîne
clearUserId	ID unique de l’utilisateur qui a invoqué l’opération alarmCleared . Type de données : chaîne
href	URL de l’alarme. Type de données : chaîne
id	ID unique. Type de données : chaîne Table : dans le champ Clé du message de l’enregistrement dans la table Événements [em_events].

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