Audit
Autenticação
GET /logs) exige especificamente a role de admin.Métodos
GET /api/audit/logs - Listar Logs de Auditoria
| Descrição | |
|---|---|
| 200 | Logs de auditoria listados com sucesso. |
| 400 | Parâmetros de filtro inválidos. |
| 401 | Não autorizado (Token inválido ou ausente). |
| 403 | Acesso negado (Usuário não possui a role admin). |
| 500 | Erro interno no servidor. |
Parâmetros (Filtros)
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| startDate | Datetime | (Opcional) Filtra logs a partir desta data/hora (formato ISO). | 2025-08-01T00:00:00 |
| endDate | Datetime | (Opcional) Filtra logs até esta data/hora (formato ISO). | 2025-08-29T23:59:59 |
| userId | Long | (Opcional) Filtra logs por um ID de usuário específico. | 123 |
| status | String | (Opcional) Filtra por status da operação. Valores: SUCCESS, ERROR, ALERT. | SUCCESS |
| page | Integer | (Opcional) Número da página a ser retornada (inicia em 0). Padrão: 0. | 0 |
| size | Integer | (Opcional) Quantidade de itens por página. Padrão: 20. | 10 |
| sort | String | (Opcional) Campo para ordenação e direção. Padrão: createAt,desc. | createAt,asc |
Corpo da Requisição (Body)
Retorno (Saída)
content.{
"content": [
{
"id": 1,
"eventType": "login",
"ipAddress": "192.168.1.100",
"systemName": "DICOM_API",
"status": "SUCCESS",
"action": "Usuário autenticado com sucesso",
"lastStatus": 200,
"user": {
"id": 123,
"name": "John Doe",
"email": "john@example.com"
},
"createAt": "2025-08-29T10:30:00"
}
],
"pageable": {
"pageNumber": 0,
"pageSize": 20,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages": 1,
"totalElements": 1,
"last": true,
"size": 20,
"number": 0,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"numberOfElements": 1,
"first": true,
"empty": false
}
POST /api/audit/logs - Criar Log de Auditoria
Respostas (Status Codes)
| Status | Descrição |
|---|---|
| 201 | Log de auditoria criado com sucesso. |
| 400 | Dados inválidos para a criação do log. |
| 500 | Erro interno no servidor. |
Parâmetros
Corpo da Requisição (Body)
"eventType": "LOGIN",
"systemName": "ZS Plugin DICOM",
"status": "alert",
"action": "Usuário realizou login no sistema",
"lastStatus": 400,
"idUser": 2
}
| Campo | Tipo | Descrição |
|---|---|---|
| eventType | String | (Obrigatório) Tipo do evento auditado (ex: "login", "sincronizacao"). |
| status | String | (Obrigatório) Status do evento (SUCCESS, ERROR, ALERT). |
| action | String | (Obrigatório) Descrição da ação executada. |
| idUser | Integer | (Opcional) ID do usuário que executou a ação. |
| systemName | String | (Opcional) Nome do sistema de origem. |
| lastStatus | Integer | (Opcional) Último status code HTTP da operação. |
| ipAddress | String | (Opcional) Endereço IP de origem. Se não for enviado, a API preenche automaticamente. |
{
"eventType": "sincronizacao",
"status": "ERROR",
"action": "Falha ao sincronizar o worklist com o sistema HIS/RIS",
"idUser": 45,
"systemName": "PACS_INTEGRATION",
"lastStatus": 500,
"ipAddress": "172.18.0.1"
}
Retorno (Saída)
AuditOutDTO do log que foi criado.GET /api/audit/health - Verificação de Saúde
Respostas (Status Codes)
|
200 | Módulo operacional. |Parâmetros e Corpo
Retorno (Saída)
plain/text.Audit module operational
Modificado em 2026-01-27 14:17:31