1. Raiz
PluginDicom
  • Módulo predefinido
    • Raiz
      • Echo
        • Echo
        • Echo Dicom
      • Users
        • GET LIST
        • Register
        • Update
        • Delete
      • Login
        • First Access
        • Login inválido
        • Login válido
      • DICOM Configurations
        • Salvar config HIS
        • Salvar config avançada
        • Salvar config PACS
        • List ALL
      • Audit
        • Criar log
        • audit_metrics
        • Buscar logs
        • Buscar logs paginado
        • Buscar logs sem autenticação
        • Buscar logs usando filtro de data
        • Buscar logs usando filtro de status
        • Buscar logs usando ordenação
      • Logs
        • Buscar logs paginado
        • Buscar logs como admin
        • Buscar logs como user
        • Buscar logs sem autenticação
      • Recovery Password
        • First Access
        • Reset Password send email
        • valid code generate token for new pass
        • New pass send with com token
      • Dicom tags
        • Post Tags
          • Criar TAG válida
          • Tag Cod Invalid
          • Invalid Sem Campos Obrigatorios
          • Restaurar Tags
        • Get Tags
          • Tags por parâmetro
          • Buscar todas as Tags
        • Put Tags
          • Atualizar múltiplas Tags
          • Atualizar Tag única
      • HIS
        • Buscar worklist
        • Buscar worklist com filtro de data
        • Buscar todos os itens de worklist
      • Study
        • Pacs import
          • Iniciar importação
          • Consultar importações
          • buscar imagem em job criado
        • Get Study by study instance uid
        • Send Images to Pacs
        • Send Pdf to Pacs
        • Get study from pacs
      • webhooks
        • Create
        • Listar
        • teste
        • deletar
        • Update Webhook
      • Study Metrics
        • Get By Month
        • Get By Date Month
        • Get By Week
      • Health
        • Check health
      • Api Tokens
        • GET
          • listar todos os tokens
          • filtrar por nome
        • PUT
          • Atualizar api token
        • PATCH
          • Revoke
          • Renew
        • POST
          • Criar Token
      • Register
        • Registro por número de série
      • dcm
        • upload-dcm
      • Register
        • Register with serial number
      • Config Alert Email
        • Criar configuração
        • Listar configurações
        • Buscar por ID
        • Histórico de envios
        • Atualizar configuração
        • Remover configuração
      • event type
    • Esquemas
      • Users
        • User Register
        • Update
        • GET User Entity
      • TbApiToken
      • TbAudit
      • TbDicomConfigs
      • TbDicomTags
      • TbLogs
      • TbPermission
      • TbResetcodes
      • TbStudyProcessed
      • TbUsers
      • TbWebhooks
  • Worklist
    • Criar worklist
      POST
  1. Raiz

Config Alert Email

Base URL: http://localhost:4516
Autenticação: Bearer Token (JWT)
Permissão requerida: admin ou support

POST /alert-email#

Cria uma nova configuração de alerta por email.
Headers
KeyValue
AuthorizationBearer {token}
Content-Typeapplication/json
Request Body
CampoTipoObrigatórioDescrição
emailstringSimEmail de destino do alerta
idEventTypeintegerSimID do tipo de evento (tb_event_type)
maxErrorCountintegerSimQuantidade mínima de erros para disparar (≥ 1)
errorCountAtIntervalintegerSimJanela de tempo em minutos (≥ 1)
{
  "email": "infra@hospital.com",
  "idEventType": 13,
  "maxErrorCount": 3,
  "errorCountAtInterval": 60
}
Responses
StatusDescrição
201Criado com sucesso
400Dados inválidos (retorna detalhes por campo)
401Não autenticado
403Sem permissão
409Email já cadastrado

GET /alert-email#

Lista todas as configurações ativas.
Headers
KeyValue
AuthorizationBearer {token}
Responses
StatusDescrição
200Lista de configurações
401Não autenticado
403Sem permissão

GET /alert-email/{id}#

Busca uma configuração pelo ID.
Path Params
ParamTipoDescrição
idintegerID da configuração
Responses
StatusDescrição
200Configuração encontrada
401Não autenticado
403Sem permissão
404Não encontrado

PUT /alert-email/{id}#

Atualiza uma configuração existente.
Path Params
ParamTipoDescrição
idintegerID da configuração
Headers
KeyValue
AuthorizationBearer {token}
Content-Typeapplication/json
Request Body
CampoTipoObrigatórioDescrição
emailstringSimEmail de destino do alerta
idEventTypeintegerSimID do tipo de evento (tb_event_type)
maxErrorCountintegerSimQuantidade mínima de erros para disparar (≥ 1)
errorCountAtIntervalintegerSimJanela de tempo em minutos (≥ 1)
Responses
StatusDescrição
200Atualizado com sucesso
400Dados inválidos
401Não autenticado
403Sem permissão
404Não encontrado
409Email já usado por outra configuração

DELETE /alert-email/{id}#

Remove uma configuração (soft delete).
Path Params
ParamTipoDescrição
idintegerID da configuração
Responses
StatusDescrição
204Removido com sucesso
401Não autenticado
403Sem permissão
404Não encontrado

GET /alert-email/{id}/history#

Retorna o histórico de envios de uma configuração.
Path Params
ParamTipoDescrição
idintegerID da configuração
Responses
StatusDescrição
200Lista de histórico
401Não autenticado
403Sem permissão

Schemas#

ConfigAlertEmailOutDTO#

CampoTipoDescrição
idintegerID da configuração
emailstringEmail de destino
idEventTypeintegerID do tipo de evento
eventTypeNamestringNome do tipo de evento
maxErrorCountintegerLimite de erros
errorCountAtIntervalintegerJanela em minutos
countErrorsintegerContador atual de erros
createdAtdatetimeData de criação
updatedAtdatetimeData de atualização

AlertEmailHistoryOutDTO#

CampoTipoDescrição
idintegerID do registro
idConfigAlertEmailintegerID da configuração
idEventTypeintegerID do tipo de evento
eventTypeNamestringNome do tipo de evento
sentAtdatetimeData/hora do envio
Modificado em 2026-05-19 13:59:51
Página anterior
Register with serial number
Próxima página
Criar configuração
Built with