API de Gestão de alarmes em aberto

. Gestão de alarmes aberta A API fornece endpoints para criar, atualizar e recuperar dados das tabelas Eventos [em_event] e Alerta [em_alert].

Telecomunicações Gestão de alarmes aberta A API (sn_ind_tmf642) é uma ServiceNow® Implementação da especificação de API aberta do TM Forum. Esta API é baseada em Especificação REST DA API de gestão de alarmes TMF642 versão 20 Abril de 2020.

O usuário chamador deve ter para acessar sn_ind_tmf642.alarm_mgmt_integration endpoint.

Esta API é fornecida no sn_ind_tmf642 namespace.

A especificação de API aberta do TM Forum requer uma resposta síncrona para cada solicitação de entrada recebida. Aplique correlação e desduplicação no OSS (Operational Support System, sistema de suporte operacional) de origem antes de encaminhar cargas úteis para o sistema.

Esta API pode ser estendida para fazer personalizações em relação aos parâmetros necessários, solicitar validação de corpo, operações REST adicionais e mapeamentos de campo. Para obter mais informações, consulte. Guia do desenvolvedor da API de Gestão de alarmes aberta .

. Gestão de alarmes aberta A API tem certificação de conformidade pelo TM Forum.

API aberta da Gestão de alarmes - OBTER /sn_ind_tmf642/alarm_mgmt/alarm

Recupera uma lista de todos os registros de alarme das tabelas Eventos [em_event] e Alerta [em_alert].

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm

Parâmetros de solicitação compatíveis

Tabela 1. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 2. Parâmetros de consulta

Nome	Descrição
AlarmRaisedTime	Data em que o alarme foi acionado. Somente alarmes com uma data correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: AlarmedObject AlarmRaisedTime Tipo de alarme CrossedThresholdInformation ExternalAlarmId id PercetivdoSeveridade ProbableCause origem SourceSystemId estado tipo Padrão: Todos os campos Tipo de dados: Cadeia de caracteres
id	ID do alarme. Somente alarmes com um ID correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres Tabela: No campo Chave da mensagem na tabela Eventos [em_event].
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use offsetparâmetro para paginar a recuperação de registro. Padrão: 1000 Máximo: 2000 Tipo de dados: Número
deslocamento	Índice inicial no qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Tipo de dados: Número Padrão: 0
ProbableCause	Provável causa do alarme. Somente alarmes com uma causa provável correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres
estado	Estado do alarme. Somente alarmes com um estado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres
SourceSystemId	ID do sistema de origem do alarme. Somente alarmes com um ID do sistema de origem correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: Cadeia de caracteres

Tabela 3. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 4. Cabeçalhos da solicitação

Cabeçalho	Descrição
Nenhum(a)

Tabela 5. Cabeçalhos de resposta

Cabeçalho	Descrição
Intervalo de conteúdo	Intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se deslocamento: 2 e. limite: 3 , o valor de Content-Rangeo cabeçalho é itens 3-5 .
Tipo de conteúdo	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Link	Contém os seguintes links para navegar pelos resultados da consulta. primeiro último avançar anterior
X-Total-Count	Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor.

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 6. Códigos de status

Código do status	Descrição
200	Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação).
206	Recurso parcial retornado na resposta (com paginação).
400	Solicitação incorreta. Possíveis motivos: Parâmetro de caminho inválido URI inválido
404	Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
AffectedService	Lista de um ou mais serviços afetados pelo alarme. Tipo de dados: Matriz de objetos "affectedService":[ { "href": "String", "id": "String" }, ]
AffectedService.href	Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: Cadeia de caracteres
affectedService.id	Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: Cadeia de caracteres
AlarmDetails	Detalhes adicionais sobre o alarme. Tipo de dados: Cadeia de caracteres
AlarmedObject	Detalhes do objeto de alarme. "alarmedObject": { "href": "String", "id": "String" } Tipo de dados: Objeto
alarmedObject.id	Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: Cadeia de caracteres
AlarmedObject.href	Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: Cadeia de caracteres
AlarmedObjectType	Tipo ou classe de objeto associado ao evento. Tipo de dados: Cadeia de caracteres
AlarmRaisedTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: Cadeia de caracteres
RelaringTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente de alarmRaisedTimevalor. Por exemplo, se um sistema de gestão de elemento (EMS) manter a lista de alarmes: . alarmRaisedTimeÉ o tempo de detecção do alarme pelo elemento de rede (NE). . alarmReportingTimeÉ o tempo de armazenamento do relatório de alarme na lista de alarmes do EMS. Tipo de dados: Cadeia de caracteres
Tipo de alarme	Categoria de alarme. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation	Detalhes sobre o limite cruzado. Tipo de dados: Objeto "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }
ThresholdThresholdInformation.Direction	Direção de cruzamento do limite. Valores válidos: PARA BAIXO PARA CIMA Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.granularity	Granularidade na qual o indicador é avaliado para cruzamento de limite. Por exemplo, 5 MINUTOS . Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorName	Nome do indicador que cruza o limite de alarme. Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite cruzado. Tipo de dados: Cadeia de caracteres
ThresholdInformation.observadoValue	Número que identifica o indicador que cruza o limite. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation.thresholdCrossingDescription	Mais detalhes de limite do alarme de cruzamento de limite. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdId	Identificador exclusivo do limite que causou o alarme. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdRef	URL do objeto de limite. Tipo de dados: Cadeia de caracteres
ExternalAlarmId	Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: Cadeia de caracteres
href	URL do recurso . Tipo de dados: Cadeia de caracteres
id	Identificador exclusivo para o sistema identificar e processar a carga do alarme como um evento. Dados Tipo: Cadeia de caracteres
PercetivdoSeveridade	Gravidade do alarme. Valores válidos: LIMPAR CRÍTICO PRINCIPAL SECUNDÁRIO AVISO Tipo de dados: Cadeia de caracteres
PlannedOutageIndication	Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: Cadeia de caracteres
ProbableCause	Situação mais provável para acionar o alarme. Use com alarmTypepara qualificar o alarme. Tipo de dados: Cadeia de caracteres
RepairActions Propostas	Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: Cadeia de caracteres
Serviçoafetado	Sinalizador que indica se o alarme afeta o serviço. Valores válidos: Verdadeiro: O alarme afeta o desempenho ou a disponibilidade do serviço. Falso: O alarme não afeta o serviço. Padrão: falso Tipo de dados: Booliano
SourceSystemId	ID da instância do alarme de origem. Tipo de dados: Cadeia de caracteres
Proble específico	Problema específico que aciona o alarme. Use com probableCausetparâmetro para qualificar o alarme. Tipo de dados: Cadeia de caracteres
estado	Estado do alarme. Valores válidos: Erro Ignorado Pronto Processado Se um valor inválido for fornecido, o estado será definido como Pronto . Se o estado for Pronto Um alerta é criado na tabela Alerta [em_alert] e o estado se torna Processado . Se o estado for Processado , Ignorado ou Erro nenhum alerta foi criado. Valor padrão: Pronto Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera todos os alarmes.

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

Corpo da resposta.

[
   {
      "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 de Gestão de alarmes aberta - OBTER /sn_ind_tmf642/alarm_mgmt/alarm/

Recupera um registro de alarme especificado da tabela Eventos [em_event] ou Alerta [em_alert].

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho

Nome	Descrição
id	Identificador exclusivo do registro a ser recuperado. Tipo de dados: Cadeia de caracteres Tabela: No campo Chave da mensagem da tabela Eventos [em_event].

Tabela 8. Parâmetros de consulta

Nome	Descrição
campos	Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos: AlarmedObject AlarmRaisedTime Tipo de alarme CrossedThresholdInformation ExternalAlarmId id PercetivdoSeveridade ProbableCause origem SourceSystemId estado tipo Valor padrão: Todos os campos Tipo de dados: Cadeia de caracteres

Tabela 9. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
Nenhum(a)

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 10. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.

Tabela 11. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 12. Códigos de status

Código do status	Descrição
200	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir. Parâmetro de caminho inválido. URI inválido.
404	Registro não encontrado. Um registro associado ao ID especificado não foi encontrado na tabela Evento [em_event] ou Alerta [em_alert].

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
AffectedService	Lista de um ou mais serviços afetados pelo alarme. Tipo de dados: Matriz de objetos "affectedService":[ { "href": "String", "id": "String" }, ]
AffectedService.href	Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: Cadeia de caracteres
affectedService.id	Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: Cadeia de caracteres
AlarmDetails	Detalhes adicionais sobre o alarme. Tipo de dados: Cadeia de caracteres
AlarmedObject	Detalhes do objeto de alarme. Tipo de dados: Objeto "alarmedObject": { "href": "String", "id": "String" }
alarmedObject.id	Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: Cadeia de caracteres
AlarmedObject.href	Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: Cadeia de caracteres
AlarmedObjectType	Tipo ou classe de objeto associado ao evento. Tipo de dados: Cadeia de caracteres
AlarmRaisedTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: Cadeia de caracteres
RelaringTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente de alarmRaisedTimevalor. Por exemplo, se um sistema de gestão de elemento (EMS) manter a lista de alarmes: . alarmRaisedTimeÉ o tempo de detecção do alarme pelo elemento de rede (NE). . alarmReportingTimeÉ o tempo de armazenamento do relatório de alarme na lista de alarmes do EMS. Tipo de dados: Cadeia de caracteres
Tipo de alarme	Categoria de alarme. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation	Detalhes sobre o limite cruzado. Tipo de dados: Objeto "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }
ThresholdThresholdInformation.Direction	Direção de cruzamento do limite. Valores válidos: PARA BAIXO PARA CIMA Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.granularity	Granularidade na qual o indicador é avaliado para cruzamento de limite. Por exemplo, 5 MINUTOS . Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorName	Nome do indicador que cruza o limite de alarme. Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite cruzado. Tipo de dados: Cadeia de caracteres
ThresholdInformation.observadoValue	Número que identifica o indicador que cruza o limite. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation.thresholdCrossingDescription	Mais detalhes de limite do alarme de cruzamento de limite. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdId	Identificador exclusivo do limite que causou o alarme. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdRef	URL do objeto de limite. Tipo de dados: Cadeia de caracteres
ExternalAlarmId	Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: Cadeia de caracteres
href	URL de o recurso . Tipo de dados: Cadeia de caracteres
id	Identificador exclusivo para o sistema identificar e processar a carga do alarme como um evento. Tipo de dados: Cadeia de caracteres
PercetivdoSeveridade	Gravidade do alarme. Valores válidos: LIMPAR CRÍTICO PRINCIPAL SECUNDÁRIO AVISO Tipo de dados: Cadeia de caracteres
PlannedOutageIndication	Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: Cadeia de caracteres
ProbableCause	Situação mais provável para acionar o alarme. Use com alarmTypepara qualificar o alarme. Tipo de dados: Cadeia de caracteres
RepairActions Propostas	Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: Cadeia de caracteres
Serviçoafetado	Sinalizador que indica se o alarme afeta o serviço. Valores válidos: Verdadeiro: O alarme afeta o desempenho ou a disponibilidade do serviço. Falso: O alarme não afeta o serviço. Padrão: falso Tipo de dados: Booliano
SourceSystemId	ID da instância do alarme de origem. Tipo de dados: Cadeia de caracteres
Proble específico	Problema específico que aciona o alarme. Use com probableCausetparâmetro para qualificar o alarme. Tipo de dados: Cadeia de caracteres
estado	Estado do alarme. Valores válidos: Erro Ignorado Pronto Processado Se um valor inválido for fornecido, o estado será definido como Pronto . Se o estado for Pronto Um alerta é criado na tabela Alerta [em_alert] e o estado se torna Processado . Se o estado for Processado , Ignorado ou Erro nenhum alerta foi criado. Valor padrão: Pronto Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo recupera um alarme.

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

Corpo da resposta.

{
   "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 aberta da Gestão de alarmes – PATCH /sn_ind_tmf642/alarm_mgmt/alarm/

Atualiza um alarme especificado e qualquer alerta associado.

Este endpoint grava o corpo da resposta no Informações adicionais Campo do registro de evento na tabela Eventos [em_event].

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho

Nome	Descrição
id	Identificador exclusivo do registro a ser atualizado. Tipo de dados: Cadeia de caracteres Tabela: No campo Chave da mensagem da tabela Eventos [em_event].

Tabela 14. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 15. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
AffectedService	Lista de um ou mais serviços afetados pelo alarme. Tipo de dados: Matriz de objetos "affectedService":[ { "href": "String", "id": "String" }, ]
AffectedService.href	Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: Cadeia de caracteres
affectedService.id	Obrigatório. Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: Cadeia de caracteres
AlarmChangedTime	Indica a última data e hora em que o alarme mudou no sistema proprietário do alarme. Qualquer mudança no alarme atualiza este valor, seja vindo do recurso alarmado ou acionada por uma mudança do cliente. Tipo de dados: Cadeia de caracteres
AlarmDetails	Detalhes adicionais sobre o alarme. Tipo de dados: Cadeia de caracteres
AlarmEscalation	Sinalizador que indica uma escalação na gravidade do alarme. Valores válidos: Verdadeiro: Há uma escalação na gravidade do alarme. Falso: A gravidade do alarme é igual ou inferior. Padrão: falso Tipo de dados: Booliano
CrossedThresholdInformation	Detalhes sobre o limite cruzado. Tipo de dados: Objeto "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }
ThresholdThresholdInformation.Direction	Direção de cruzamento do limite. Valores válidos: PARA BAIXO PARA CIMA Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.granularity	Granularidade na qual o indicador é avaliado para cruzamento de limite. Por exemplo, 5 MINUTOS . Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorName	Nome do indicador que cruza o limite de alarme. Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite cruzado. Tipo de dados: Cadeia de caracteres
ThresholdInformation.observadoValue	Número que identifica o indicador que cruza o limite. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation.thresholdCrossingDescription	Mais detalhes de limite do alarme de cruzamento de limite. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdId	Obrigatório. Identificador exclusivo do limite que causou o alarme. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdRef	URL do objeto de limite. Tipo de dados: Cadeia de caracteres
href	Referência de URL para o alarme. Tipo de dados: Cadeia de caracteres
PercetivdoSeveridade	Obrigatório. Gravidade do alarme. Valores válidos: LIMPAR CRÍTICO PRINCIPAL SECUNDÁRIO AVISO Tipo de dados: Cadeia de caracteres
PlannedOutageIndication	Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: Cadeia de caracteres
ProbableCause	Obrigatório. Situação mais provável para acionar o alarme. Use com alarmTypepara qualificar o alarme. Tipo de dados: Cadeia de caracteres
RepairActions Propostas	Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: Cadeia de caracteres
Serviçoafetado	Sinalizador que indica se o alarme afeta o serviço. Valores válidos: Verdadeiro: O alarme afeta o desempenho ou a disponibilidade do serviço. Falso: O alarme não afeta o serviço. Padrão: falso Tipo de dados: Booliano
Proble específico	Problema específico que aciona o alarme. Use com probableCausetparâmetro para qualificar o alarme. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 16. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 17. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 18. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação incorreta. Possíveis motivos: Carga inválida. ID de alarme obrigatório ausente. Carga inválida. Campo obrigatório ausente: <field name>. Carga inválida. Objeto obrigatório ausente. Evento não criado, falha. Não é possível limpar o evento. Não é possível atualizar o evento. O evento não existe.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
AlarmChangedTime	Data e hora em que o alarme mudou em GMT no sistema proprietário do alarme. Este valor é atualizado quando ocorrem mudanças no alarme do recurso alarmado ou uma mudança de uma atualização do cliente aciona o alarme. Este valor é necessário na resposta. Tipo de dados: Cadeia de caracteres
href	Referência de URL para o alarme. Tipo de dados: Cadeia de caracteres
id	Identificador exclusivo do alarme. Valor determinado pelo sistema proprietário do alarme. Tipo de dados: Cadeia de caracteres

Solicitação de curl

Neste exemplo, a gravidade é reduzida a MENOR.

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'

Corpo da resposta.

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

API aberta da Gestão de alarmes – POST /sn_ind_tmf642/alarm_mgmt/alarm

Cria um registro de alarme na tabela Eventos [em_event].

Quando o registro de alarme é criado, um ID para o alarme é adicionado em Message keycampo.

Um registro de alerta também pode ser criado com base em Regras de gestão de alertas .

Este endpoint grava o corpo da resposta no Informações adicionais Campo do registro de evento na tabela Eventos [em_event].

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm

Parâmetros de solicitação compatíveis

Tabela 19. Parâmetros de caminho

Nome	Descrição
Nenhum(a)

Tabela 20. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 21. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
AffectedService	Lista de um ou mais serviços afetados pelo alarme. Tipo de dados: Matriz de objetos "affectedService":[ { "href": "String", "id": "String" }, ]
AffectedService.href	Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: Cadeia de caracteres
affectedService.id	Obrigatório. Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: Cadeia de caracteres
AlarmDetails	Detalhes adicionais sobre o alarme. Tipo de dados: Cadeia de caracteres
AlarmedObject	Obrigatório. Detalhes do objeto de alarme. "alarmedObject": { "href": "String", "id": "String" } Tipo de dados: Objeto
alarmedObject.id	Obrigatório. Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: Cadeia de caracteres
AlarmedObject.href	Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: Cadeia de caracteres
AlarmedObjectType	Tipo ou classe de objeto associado ao evento. Tipo de dados: Cadeia de caracteres
AlarmRaisedTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: Cadeia de caracteres
RelaringTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente de alarmRaisedTimevalor. Por exemplo, se um sistema de gestão de elemento (EMS) manter a lista de alarmes: . alarmRaisedTimeÉ o tempo de detecção do alarme pelo elemento de rede (NE). . alarmReportingTimeÉ o tempo de armazenamento do relatório de alarme na lista de alarmes do EMS. Tipo de dados: Cadeia de caracteres
Tipo de alarme	Obrigatório. Categoria de alarme. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation	Detalhes sobre o limite cruzado. Tipo de dados: Objeto "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }
ThresholdThresholdInformation.Direction	Direção de cruzamento do limite. Valores válidos: PARA BAIXO PARA CIMA Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.granularity	Granularidade na qual o indicador é avaliado para cruzamento de limite. Por exemplo, 5 MINUTOS . Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorName	Nome do indicador que cruza o limite de alarme. Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite cruzado. Tipo de dados: Cadeia de caracteres
ThresholdInformation.observadoValue	Número que identifica o indicador que cruza o limite. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation.thresholdCrossingDescription	Mais detalhes de limite do alarme de cruzamento de limite. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdId	Obrigatório. Identificador exclusivo do limite que causou o alarme. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdRef	URL do objeto de limite. Tipo de dados: Cadeia de caracteres
ExternalAlarmId	Obrigatório. Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: Cadeia de caracteres
id	Identificador exclusivo para o sistema identificar e processar a carga do alarme como um evento. Este valor deve ficar em branco se usado na carga. O sistema gera esse ID exclusivo para o evento e o envia como parte da carga de resposta. Tipo de dados: Cadeia de caracteres
PercetivdoSeveridade	Obrigatório. Gravidade do alarme. Valores válidos: LIMPAR CRÍTICO PRINCIPAL SECUNDÁRIO AVISO Tipo de dados: Cadeia de caracteres
PlannedOutageIndication	Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: Cadeia de caracteres
ProbableCause	Obrigatório. Situação mais provável para acionar o alarme. Use com alarmTypepara qualificar o alarme. Tipo de dados: Cadeia de caracteres
RepairActions Propostas	Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: Cadeia de caracteres
Serviçoafetado	Sinalizador que indica se o alarme afeta o serviço. Valores válidos: Verdadeiro: O alarme afeta o desempenho ou a disponibilidade do serviço. Falso: O alarme não afeta o serviço. Padrão: falso Tipo de dados: Booliano
SourceSystemId	Obrigatório. ID da instância do alarme de origem. Tipo de dados: Cadeia de caracteres
Proble específico	Problema específico que aciona o alarme. Use com probableCausetparâmetro para qualificar o alarme. Tipo de dados: Cadeia de caracteres
estado	Estado do alarme. Valores válidos: Erro Ignorado Pronto Processado Se um valor inválido for fornecido, o estado será definido como Pronto . Se o estado for Pronto Um alerta é criado na tabela Alerta [em_alert] e o estado se torna Processado . Se o estado for Processado , Ignorado ou Erro nenhum alerta foi criado. Valor padrão: Pronto Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 22. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 23. Cabeçalhos de resposta

Cabeçalho	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 24. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação incorreta. Possíveis motivos: Carga inválida. ID de alarme obrigatório ausente. Carga inválida. Campo obrigatório ausente: <field name>. Carga inválida. Objeto obrigatório ausente. Evento não criado, falha. Não é possível limpar o evento. Não é possível atualizar o evento. O evento não existe.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
AffectedService	Lista de um ou mais serviços afetados pelo alarme. Tipo de dados: Matriz de objetos "affectedService":[ { "href": "String", "id": "String" }, ]
AffectedService.href	Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: Cadeia de caracteres
affectedService.id	Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: Cadeia de caracteres
AlarmDetails	Detalhes adicionais sobre o alarme. Tipo de dados: Cadeia de caracteres
AlarmedObject	Detalhes do objeto de alarme. "alarmedObject": { "href": "String", "id": "String" } Tipo de dados: Objeto
AlarmedObject.id	Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: Cadeia de caracteres
AlarmedObject.href	Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: Cadeia de caracteres
AlarmedObjectType	Tipo ou classe de objeto associado ao evento. Tipo de dados: Cadeia de caracteres
AlarmRaisedTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: Cadeia de caracteres
RelaringTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente de alarmRaisedTimevalor. Por exemplo, se um sistema de gestão de elemento (EMS) manter a lista de alarmes: . alarmRaisedTimeÉ o tempo de detecção do alarme pelo elemento de rede (NE). . alarmReportingTimeÉ o tempo de armazenamento do relatório de alarme na lista de alarmes do EMS. Tipo de dados: Cadeia de caracteres
Tipo de alarme	Categoria de alarme. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation	Detalhes sobre o limite cruzado. Tipo de dados: Objeto "crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }
ThresholdThresholdInformation.Direction	Direção de cruzamento do limite. Valores válidos: PARA BAIXO PARA CIMA Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.granularity	Granularidade na qual o indicador é avaliado para cruzamento de limite. Por exemplo, 5 MINUTOS . Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorName	Nome do indicador que cruza o limite de alarme. Tipo de dados: Cadeia de caracteres
crossedThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite cruzado. Tipo de dados: Cadeia de caracteres
ThresholdInformation.observadoValue	Número que identifica o indicador que cruza o limite. Tipo de dados: Cadeia de caracteres
CrossedThresholdInformation.thresholdCrossingDescription	Mais detalhes de limite do alarme de cruzamento de limite. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdId	Identificador exclusivo do limite que causou o alarme. Tipo de dados: Cadeia de caracteres
ThresholdThresholdInformation.thresholdRef	URL do objeto de limite. Tipo de dados: Cadeia de caracteres
ExternalAlarmId	Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: Cadeia de caracteres
href	URL do recurso. Tipo de dados: Cadeia de caracteres
id	Identificador exclusivo para o sistema identificar e processar a carga do alarme como um evento. Tipo de dados: Cadeia de caracteres
PercetivdoSeveridade	Gravidade do alarme. Valores válidos: LIMPAR CRÍTICO PRINCIPAL SECUNDÁRIO AVISO Tipo de dados: Cadeia de caracteres
PlannedOutageIndication	Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: Cadeia de caracteres
ProbableCause	Situação mais provável para acionar o alarme. Use com alarmTypepara qualificar o alarme. Tipo de dados: Cadeia de caracteres
RepairActions Propostas	Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: Cadeia de caracteres
Serviçoafetado	Sinalizador que indica se o alarme afeta o serviço. Valores válidos: Verdadeiro: O alarme afeta o desempenho ou a disponibilidade do serviço. Falso: O alarme não afeta o serviço. Padrão: falso Tipo de dados: Booliano
SourceSystemId	ID da instância do alarme de origem. Tipo de dados: Cadeia de caracteres
Proble específico	Problema específico que aciona o alarme. Use com probableCausetparâmetro para qualificar o alarme. Tipo de dados: Cadeia de caracteres
estado	Estado do alarme. Valores válidos: Erro Ignorado Pronto Processado Se um valor inválido for fornecido, o estado será definido como Pronto . Se o estado for Pronto Um alerta é criado na tabela Alerta [em_alert] e o estado se torna Processado . Se o estado for Processado , Ignorado ou Erro nenhum alerta foi criado. Valor padrão: Pronto Tipo de dados: Cadeia de caracteres

Solicitação de curl

Este exemplo cria um 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'

Corpo da resposta.

{
     "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 de Gestão de alarmes em aberto – POST /sn_ind_tmf642/alarm_mgmt/alarm/

Limpa um alarme especificado e fecha qualquer alerta associado.

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho

Nome	Descrição
id	Identificador exclusivo do alarme a ser limpo. Tipo de dados: Cadeia de caracteres Tabela: No campo Chave da mensagem da tabela Eventos [em_events].

Tabela 26. Parâmetros de consulta

Nome	Descrição
Nenhum(a)

Tabela 27. Solicitar parâmetros do corpo (JSON)

Nome	Descrição
AlarmLimpeDeLimpedTime	Data e hora em que o alarme é limpo na origem. Tipo de dados: Cadeia de caracteres Tabela: No campo Hora do evento da tabela Eventos [em_events].
ClearSystemId	Obrigatório. Nome da instância da qual alarmCleareda operação foi invocada. Tipo de dados: Cadeia de caracteres
ClearUserId	Obrigatório. ID exclusivo do usuário que invocou o. alarmClearedoperação. Tipo de dados: Cadeia de caracteres

Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

Tabela 28. Cabeçalhos da solicitação

Cabeçalho	Descrição
Aceitar	Formato de dados do corpo da resposta. Oferece suporte somente a application/json.
Tipo de conteúdo	Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.

Tabela 29. Cabeçalhos de resposta

Nome	Descrição
Nenhum(a)

Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

Tabela 30. Códigos de status

Código do status	Descrição
201	Bem-sucedido. A solicitação foi processada com sucesso.
400	Solicitação incorreta. Possíveis motivos: Carga inválida. ID de alarme obrigatório ausente. Carga inválida. Campo obrigatório ausente: <field name>. Carga inválida. Objeto obrigatório ausente. Evento não criado, falha. Não é possível limpar o evento. Não é possível atualizar o evento. O evento não existe.

Parâmetros do corpo da resposta (JSON)

Nome	Descrição
AlarmLimpeDeLimpedTime	Data e hora em que o alarme é limpo na origem. Tipo de dados: Cadeia de caracteres Tabela: No campo Hora do evento da tabela Eventos [em_events].
ClearSystemId	Nome da instância da qual alarmCleareda operação foi invocada. Tipo de dados: Cadeia de caracteres
ClearUserId	ID exclusivo do usuário que invocou o. alarmClearedoperação. Tipo de dados: Cadeia de caracteres
href	URL do alarme. Tipo de dados: Cadeia de caracteres
id	ID exclusivo. Tipo de dados: Cadeia de caracteres Tabela: No campo Chave da mensagem do registro na tabela Eventos [em_events].

Solicitação de curl

Este exemplo limpa um 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'

Corpo da resposta.

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