Ler uma notificação

Versão 4.0.23.6 (mais recente)

Lê uma notificação

O endpoint marca uma determinada notificação de alerta como lida pelo usuário, caso ainda não tenha sido lida. O modelo AlertNotification é atualizado para esse fim. Ele retorna a notificação como uma resposta.

Solicitação

PATCH /alert_notifications/{alert_notification_id}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
ID_de_notificação_alerta
string
ID de uma notificação

Resposta

200: ele atualiza que a notificação de alerta fornecida foi lida pelo usuário.

Tipo de dados
Descrição
(objeto)
ID da notificação
string
ID da notificação
alert_condition_id
string
ID do alerta
user_id
string
ID do usuário
is_read
booleano
Ler o estado da notificação
valor_do_campo
number
O valor do campo em que a condição de alerta está definida
valor_limite
number
O valor do limite que aciona a notificação de alerta
executado
string
A hora em que a consulta de alerta foi executada
alerta
MobilePayload (em inglês)
Contém os detalhes necessários para o payload de alertas de dispositivos móveis
Expandir a definição do MobilePayload...
title
string
Título do alerta
ID do alerta
string
ID do alerta
investigation_content_id
string
ID do conteúdo investigativo
painel_nome
string
Nome do painel em que o alerta foi definido
ID do painel
string
ID do painel em que o alerta foi definido
slug query_slug
string
Lesma da consulta que executa as consultas de alerta.

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação