API aberta de tópico da Gestão de eventos
. Tópico Gestão de eventos aberto A API fornece um endpoint que permite enviar um tópico por meio do agente de mensagens e armazená-lo em um ServiceNow instância.
Usando esta API, você pode armazenar tópicos criados por meio do agente de mensagens no ServiceNow Tabela Tópico [topic].
Esta API é executada no sn-api-notif-mgmt namespace e requer a função sn_api_notif_mgmt.event_mgmt_integration.
Tópico da Gestão de eventos em aberto - POST /sn_api_notif_mgmt/topic
Cria um novo registro na tabela Tópico [sn_api_notif_mgmt_topic] e salva as informações do tópico passadas nesse registro.
Use este endpoint para sincronizar tópicos criados em seu middleware de barramento de mensagens com aqueles em seu ServiceNow instância.
Quando os tópicos são criados usando este endpoint, o campo user_created no registro de tópico associado é definido como falso e o campo de tipo está definido como saída .
Formato de URL
URL com controle de versão: /api/sn_api_notif_mgmt//topic
URL padrão: /api/sn_api_notif_mgmt/topic
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| api_version | Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente. Tipo de dados: Cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| ContentQuery | Filtro a ser aplicado à carga útil do evento. Esta consulta é um filtro de evento mais profundo que é usado para encontrar informações como gravidade do evento ou tipo de tíquete. Este parâmetro pode ser passado como uma consulta aninhada. Por exemplo, para a carga de evento de tíquete de problema a seguir, esta consulta se aplica aos atributos que estão em "evento" objeto da carga: Este parâmetro é compatível com as seguintes condições:
Por exemplo: Este campo é mapeado para o campo content_query no registro de tópico associado. Para obter informações adicionais, consulte TMF688 Event Management API Guia do usuário . Tipo de dados: Cadeia de caracteres |
| externalId | Identificador externo exclusivo para o tópico, como um GUID. Este campo é mapeado para o campo topic_id no registro de tópico associado. Tipo de dados: Cadeia de caracteres |
| HeaderQuery | Filtro a ser aplicado às propriedades do cabeçalho do evento. Esta consulta define o tipo de eventos a serem ouvidos para o tópico associado. Este parâmetro pode ser passado como uma consulta aninhada. Este parâmetro é compatível com as seguintes condições:
Por exemplo: Este campo é mapeado para o campo header_query no registro de tópico associado. Para obter informações adicionais, consulte TMF688 Event Management API Guia do usuário . Tipo de dados: Cadeia de caracteres |
| nome | Nome do tópico. Este campo é mapeado para o campo topic_name no registro de tópico associado. Tipo de dados: Cadeia de caracteres |
| namespace | Namespace do tópico. Vazio se não houver namespace associado. Este campo é mapeado para o campo Namespace no registro de tópico associado. 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 .
| 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. |
| 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 .
| Código do status | Descrição |
|---|---|
| 201 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | O ID externo do tópico aprovado já existe. Passe o ID externo do tópico exclusivo Indica que o ID externo aprovado já existe na tabela de tópicos. Passe a combinação exclusiva de nome do tópico, consulta de cabeçalho, consulta de conteúdo e namespace : Indica que a combinação de nome do tópico, namespace, consulta de cabeçalho e consulta de conteúdo já existe. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
Parâmetros do corpo da resposta
| Nome | Descrição |
|---|---|
| ContentQuery | Valor do campo content_query no registro de tópico criado. Tipo de dados: Cadeia de caracteres |
| externalId | Valor do campo topic_id no registro de tópico criado. Tipo de dados: Cadeia de caracteres |
| HeaderQuery | Valor do campo header_query no registro de tópico criado. Este campo é usado pela estrutura do seletor de tópicos para determinar quais mensagens de evento devem ser enviadas para um tópico. Tipo de dados: Cadeia de caracteres |
| id | Sys_id do registro de tópico criado. Tipo de dados: Cadeia de caracteres |
| nome | Nome do tópico. Tipo de dados: Cadeia de caracteres |
| namespace | Valor do campo Namespace no registro de tópico criado. Tipo de dados: Cadeia de caracteres |
Solicitação de curl
O exemplo de código a seguir mostra como chamar este endpoint.
curl "http://instance.servicenow.com/api/sn_api_notif_mgmt/topic" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'
--data
{
"name": "HighPriorityTroubleTicket",
"headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent",
"contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1",
"externalId": "ext001",
"namespace": "telecomEvents"
}Resposta:
{
"externalId": "ext001",
"name": "HighPriorityTroubleTicket",
"headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent",
"contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1",
"namespace": "telecomEvents",
"id": "7ee9850443c3f550461f99612bb8f223"
}