API aberta da Gestão de alarmes

Versão de lançamento: Washingtondc

Atualizado 1 de fev. de 2024

29 min. de leitura

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

A API aberta de gestão de alarmes de telecomunicações (sn_ind_tmf642) é uma implementação ServiceNow® da especificação da API aberta do TM Fórum. Esta API é baseada na especificação REST da API de gestão de alarmes TMF642, versão 20, abril de 2020.

O usuário que faz a chamada deve ter para acessar o endpoint sn_ind_tmf642.alarm_mgmt_integration.

Esta API é fornecida no namespace sn_ind_tmf642.

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

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

A API aberta da Gestão de alarmes tem conformidade certificada pelo TM Fórum.

Logotipo de conformidade com o TMF

API aberta de gestão de alarmes – GET /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

Tabela 2. Parâmetros de consulta
Nome	Descrição
AlarmRaiseTime	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 AlarmRaiseTime AlarmType CrossThresholdInformation externalAlarmId id SeveridadePercebida Provável Causa origem sourceSystemId state 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. Localizado no campo Chave de mensagem na tabela Eventos [em_event]. Tipo de dados: cadeia de caracteres
limite	Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 1000 Máximo: 2000 Tipo de dados: número
deslocamento	Índice inicial no qual iniciar a recuperação de registros. Use este valor para paginar a recuperação do registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número
Provável Causa	Causa provável 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
state	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. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
Nenhum

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

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

Códigos de status

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

Tabela 6. Códigos de status
Código de status	Descrição
200	Solicitação processada com êxito. 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
serviçoafetado	Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz `"affectedService":[ { "href": "String", "id": "String" }, ]`
afetadoServiço.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
detalhes do alarme	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
AlarmRaiseTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres
AlarmReportingTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elemento (EMS) mantém a lista de alarmes: O alarmRaisedTime é a hora da detecção do alarme pelo elemento de rede (NE). O alarmReportingTime é a hora do relatório de alarme de armazenamento na lista de alarmes do EMS. Tipo de dados: cadeia de caracteres
AlarmType	Categoria do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation	Detalhes sobre o limite ultrapassado. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Tipo de dados: objeto
CrossThresholdInformation.direction	Direção de cruzamento do limite. Valores possíveis: PARA CIMA PARA BAIXO Tipo de dados: cadeia de caracteres
CrossLimiteInformações.Granularidade	Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, `5MINUTES`. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.IndicatorName	Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.observedValue	Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdCrossingDescription	Mais detalhes do limite do alarme de cruzamento de limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdId	Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.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 para identificar e processar a carga do alarme como um evento. Tipo de dados : cadeia de caracteres
SeveridadePercebida	Severidade do alarme. Valores possíveis: LIMPAR CRÍTICO PRINCIPAL BAIXA 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
Provável Causa	Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres
propostoRepairActions	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çoAfetando	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 de instância do alarme de origem. Tipo de dados: cadeia de caracteres
específicoProblema	Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres
state	Estado do alarme. Valores válidos: Pronto Processado Ignorado Erro Se um valor inválido for fornecido, o estado será definido como `Pronto`. Se o estado for `Pronto`, um alerta será criado na tabela Alerta [em_alert] e o estado se tornará `Processado`. Se o estado for `Processado`, `Ignorado`ou `Erro`, nenhum alerta será 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 aberta da Gestão de alarmes – GET /sn_ind_tmf642/alarm_mgmt/alarm/{id}

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/{id}

Parâmetros de solicitação compatíveis

Tabela 7. Parâmetros de caminho
Nome	Descrição
id	Identificador exclusivo do registro a ser recuperado. Localizado no campo Chave de mensagem na tabela Eventos [em_event]. Tipo de dados: cadeia de caracteres

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 AlarmRaiseTime AlarmType CrossThresholdInformation externalAlarmId id SeveridadePercebida Provável Causa origem sourceSystemId state tipo Valor padrão: todos os campos Tipo de dados: cadeia de caracteres

Tabela 9. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
Nenhum

Cabeçalhos

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

Códigos de status

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

Tabela 12. Códigos de status
Código de 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
serviçoafetado	Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz `"affectedService":[ { "href": "String", "id": "String" }, ]`
afetadoServiço.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
detalhes do alarme	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
AlarmRaiseTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres
AlarmReportingTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elemento (EMS) mantém a lista de alarmes: O alarmRaisedTime é a hora da detecção do alarme pelo elemento de rede (NE). O alarmReportingTime é a hora do relatório de alarme de armazenamento na lista de alarmes do EMS. Tipo de dados: cadeia de caracteres
AlarmType	Categoria do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation	Detalhes sobre o limite ultrapassado. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Tipo de dados: objeto
CrossThresholdInformation.direction	Direção de cruzamento do limite. Valores possíveis: PARA CIMA PARA BAIXO Tipo de dados: cadeia de caracteres
CrossLimiteInformações.Granularidade	Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, `5MINUTES`. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.IndicatorName	Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.observedValue	Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdCrossingDescription	Mais detalhes do limite do alarme de cruzamento de limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdId	Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.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 para identificar e processar a carga do alarme como um evento. Tipo de dados: cadeia de caracteres
SeveridadePercebida	Severidade do alarme. Valores possíveis: LIMPAR CRÍTICO PRINCIPAL BAIXA 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
Provável Causa	Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres
propostoRepairActions	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çoAfetando	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 de instância do alarme de origem. Tipo de dados: cadeia de caracteres
específicoProblema	Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres
state	Estado do alarme. Valores válidos: Pronto Processado Ignorado Erro Se um valor inválido for fornecido, o estado será definido como `Pronto`. Se o estado for `Pronto`, um alerta será criado na tabela Alerta [em_alert] e o estado se tornará `Processado`. Se o estado for `Processado`, `Ignorado`ou `Erro`, nenhum alerta será 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/{id}

Atualiza um alarme especificado e qualquer alerta associado.

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

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}

Parâmetros de solicitação compatíveis

Tabela 13. Parâmetros de caminho
Nome	Descrição
id	Identificador exclusivo do registro a ser atualizado. Localizado no campo Chave de mensagem na tabela Eventos [em_event]. Tipo de dados: cadeia de caracteres

Tabela 14. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 15. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
serviçoafetado	Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz `"affectedService":[ { "href": "String", "id": "String" }, ]`
afetadoServiço.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 foi alterado no sistema responsável pelo alarme. Qualquer mudança no alarme atualiza este valor, seja do recurso com alarme ou acionado por uma mudança do cliente. Tipo de dados: cadeia de caracteres
detalhes do alarme	Detalhes adicionais sobre o alarme. Tipo de dados: cadeia de caracteres
escalaçãoalarme	Sinalizador que indica uma escalação na severidade do alarme. Valores válidos: verdadeiro: há uma escalação na severidade do alarme. falso: a severidade do alarme é igual ou inferior. Padrão: falso Tipo de dados: booliano
CrossThresholdInformation	Detalhes sobre o limite ultrapassado. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Tipo de dados: objeto
CrossThresholdInformation.direction	Direção de cruzamento do limite. Valores possíveis: PARA CIMA PARA BAIXO Tipo de dados: cadeia de caracteres
CrossLimiteInformações.Granularidade	Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, `5MINUTES`. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.IndicatorName	Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.observedValue	Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdCrossingDescription	Mais detalhes do limite do alarme de cruzamento de limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdId	Obrigatório. Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.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
SeveridadePercebida	Obrigatório. Severidade do alarme. Valores possíveis: LIMPAR CRÍTICO PRINCIPAL BAIXA 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
Provável Causa	Obrigatório. Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres
propostoRepairActions	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çoAfetando	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
específicoProblema	Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

Códigos de status

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

Tabela 18. Códigos de status
Código de 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, com 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 foi alterado em GMT no sistema responsável pelo alarme. Este valor está no formato GlideDateTime e está no campo Time of event de um registro na tabela Eventos [em_events]. Este valor é atualizado quando ocorrem mudanças no alarme do recurso com alarme 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 que possui o alarme. Tipo de dados: cadeia de caracteres

Solicitação de cURL

Neste exemplo, a severidade foi reduzida para BAIXA.

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 do alarme é criado, um ID para o alarme é adicionado ao campo Message key.

Um registro de alerta também pode ser criado com base nas regras de gerenciamento de alertas.

Este endpoint grava o corpo da resposta no campo Informações adicionais do registro do 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

Tabela 20. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 21. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
serviçoafetado	Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz `"affectedService":[ { "href": "String", "id": "String" }, ]`
afetadoServiço.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
detalhes do alarme	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
AlarmRaiseTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres
AlarmReportingTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elemento (EMS) mantém a lista de alarmes: O alarmRaisedTime é a hora da detecção do alarme pelo elemento de rede (NE). O alarmReportingTime é a hora do relatório de alarme de armazenamento na lista de alarmes do EMS. Tipo de dados: cadeia de caracteres
AlarmType	Obrigatório. Categoria do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation	Detalhes sobre o limite ultrapassado. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Tipo de dados: objeto
CrossThresholdInformation.direction	Direção de cruzamento do limite. Valores possíveis: PARA CIMA PARA BAIXO Tipo de dados: cadeia de caracteres
CrossLimiteInformações.Granularidade	Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, `5MINUTES`. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.IndicatorName	Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.observedValue	Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdCrossingDescription	Mais detalhes do limite do alarme de cruzamento de limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdId	Obrigatório. Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.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 para identificar e processar a carga do alarme como um evento. Este valor deve estar vazio se usado na carga útil. O sistema gera este ID exclusivo para o evento e o envia como parte da carga de resposta. Tipo de dados: cadeia de caracteres
SeveridadePercebida	Obrigatório. Severidade do alarme. Valores possíveis: LIMPAR CRÍTICO PRINCIPAL BAIXA 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
Provável Causa	Obrigatório. Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres
propostoRepairActions	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çoAfetando	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 de instância do alarme de origem. Tipo de dados: cadeia de caracteres
específicoProblema	Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres
state	Estado do alarme. Valores válidos: Pronto Processado Ignorado Erro Se um valor inválido for fornecido, o estado será definido como `Pronto`. Se o estado for `Pronto`, um alerta será criado na tabela Alerta [em_alert] e o estado se tornará `Processado`. Se o estado for `Processado`, `Ignorado`ou `Erro`, nenhum alerta será criado. Valor padrão: Pronto Tipo de dados: cadeia de caracteres

Cabeçalhos

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

Códigos de status

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

Tabela 24. Códigos de status
Código de 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, com 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
serviçoafetado	Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz `"affectedService":[ { "href": "String", "id": "String" }, ]`
afetadoServiço.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
detalhes do alarme	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
AlarmRaiseTime	Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres
AlarmReportingTime	Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elemento (EMS) mantém a lista de alarmes: O alarmRaisedTime é a hora da detecção do alarme pelo elemento de rede (NE). O alarmReportingTime é a hora do relatório de alarme de armazenamento na lista de alarmes do EMS. Tipo de dados: cadeia de caracteres
AlarmType	Categoria do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation	Detalhes sobre o limite ultrapassado. `"crossedThresholdInformation": { "direction": "String", "granularity": "String", "indicatorName": "String", "indicatorUnit": "String", "observedValue": "String", "thresholdCrossingDescription": "String", "thresholdId": "String", "thresholdRef": "String" }` Tipo de dados: objeto
CrossThresholdInformation.direction	Direção de cruzamento do limite. Valores possíveis: PARA CIMA PARA BAIXO Tipo de dados: cadeia de caracteres
CrossLimiteInformações.Granularidade	Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, `5MINUTES`. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.IndicatorName	Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.indicatorUnit	Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.observedValue	Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdCrossingDescription	Mais detalhes do limite do alarme de cruzamento de limite. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.thresholdId	Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres
CrossThresholdInformation.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 para identificar e processar a carga do alarme como um evento. Tipo de dados: cadeia de caracteres
SeveridadePercebida	Severidade do alarme. Valores possíveis: LIMPAR CRÍTICO PRINCIPAL BAIXA 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
Provável Causa	Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres
propostoRepairActions	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çoAfetando	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 de instância do alarme de origem. Tipo de dados: cadeia de caracteres
específicoProblema	Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres
state	Estado do alarme. Valores válidos: Pronto Processado Ignorado Erro Se um valor inválido for fornecido, o estado será definido como `Pronto`. Se o estado for `Pronto`, um alerta será criado na tabela Alerta [em_alert] e o estado se tornará `Processado`. Se o estado for `Processado`, `Ignorado`ou `Erro`, nenhum alerta será 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 aberta da Gestão de alarmes – POST /sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

Limpa um alarme especificado e fecha qualquer alerta associado.

Formato de URL

URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear

Parâmetros de solicitação compatíveis

Tabela 25. Parâmetros de caminho
Nome	Descrição
id	Identificador exclusivo do alarme a limpar. Localizado no campo Chave de mensagem na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres

Tabela 26. Parâmetros de consulta
Nome	Descrição
Nenhum

Tabela 27. Parâmetros do corpo da solicitação (JSON)
Nome	Descrição
AlarmClearedTime	Data e hora em que o alarme é apagado na origem. Este valor está no campo Time of event do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres
limparSystemId	Obrigatório. Nome da instância da qual a operação alarmCleared foi invocada. Tipo de dados: cadeia de caracteres
limparUserId	Obrigatório. ID exclusivo do usuário que invocou a operação alarmCleared. Este valor está no campo Source do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres

Cabeçalhos

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

Códigos de status

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

Tabela 30. Códigos de status
Código de 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, com 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
AlarmClearedTime	Data e hora em que o alarme é apagado na origem. Este valor está no campo Time of event do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres
limparSystemId	Nome da instância da qual a operação alarmCleared foi invocada. Tipo de dados: cadeia de caracteres
limparUserId	ID exclusivo do usuário que invocou a operação alarmCleared. Este valor está no campo Source do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres
href	URL do alarme. Tipo de dados: cadeia de caracteres
id	ID exclusivo no campo Message key de um registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres

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