Endpoints de Logs
Logs registram todas as ações realizadas no sistema para fins de auditoria e rastreabilidade.
Todos os endpoints requerem autenticação.
Authorization: Bearer <token>Objeto Log
Seção intitulada “Objeto Log”{ "id": "550e8400-e29b-41d4-a716-446655440000", "entity_type": "CONTROL_POINT", "entity_id": "cp-uuid", "entity_name": "CP-001", "action": "turn_on", "user_id": "user-uuid", "timestamp": "2025-11-21T15:45:00Z"}Tipos de Entidade
Seção intitulada “Tipos de Entidade”| Tipo | Descrição |
|---|---|
AERATOR | Ações em aeradores |
SENSOR | Ações em sensores |
SYSTEM | Eventos do sistema |
CONTROL_POINT | Ações em pontos de controle |
GET /logs/farm/{farm_id}/control-points
Seção intitulada “GET /logs/farm/{farm_id}/control-points”Lista logs de todos os pontos de controle de uma fazenda específica.
Parâmetros de URL
Seção intitulada “Parâmetros de URL”| Parâmetro | Tipo | Descrição |
|---|---|---|
farm_id | UUID | ID da fazenda |
Requisição
Seção intitulada “Requisição”GET /api/v1/logs/farm/farm-uuid/control-pointsAuthorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”[ { "id": "log-uuid-1", "entity_type": "CONTROL_POINT", "entity_id": "cp-uuid-1", "entity_name": "CP-001", "action": "turn_on", "user_id": "user-uuid", "timestamp": "2025-11-21T15:45:00Z" }, { "id": "log-uuid-2", "entity_type": "CONTROL_POINT", "entity_id": "cp-uuid-2", "entity_name": "CP-002", "action": "turn_off", "user_id": null, "timestamp": "2025-11-21T16:00:00Z" }]Possíveis Erros
Seção intitulada “Possíveis Erros”| Status | Detalhe |
|---|---|
404 | Fazenda não encontrada |
403 | Não autorizado |
GET /logs/control-points/{control_point_id}
Seção intitulada “GET /logs/control-points/{control_point_id}”Lista logs de um ponto de controle específico.
Parâmetros de URL
Seção intitulada “Parâmetros de URL”| Parâmetro | Tipo | Descrição |
|---|---|---|
control_point_id | UUID | ID do ponto de controle |
Requisição
Seção intitulada “Requisição”GET /api/v1/logs/control-points/cp-uuidAuthorization: Bearer <token>Resposta 200 OK
Seção intitulada “Resposta 200 OK”[ { "id": "log-uuid", "entity_type": "CONTROL_POINT", "entity_id": "cp-uuid", "entity_name": "CP-001", "action": "turn_on", "user_id": "user-uuid", "timestamp": "2025-11-21T15:45:00Z" }]Possíveis Erros
Seção intitulada “Possíveis Erros”| Status | Detalhe |
|---|---|
404 | Ponto de controle não encontrado |
403 | Não autorizado |
Ações Comuns nos Logs
Seção intitulada “Ações Comuns nos Logs”| Ação | Descrição |
|---|---|
turn_on | Ligar dispositivo |
turn_off | Desligar dispositivo |
create | Criar recurso |
update | Atualizar recurso |
delete | Excluir recurso |
schedule_trigger | Agendamento executado |
alert_created | Alerta criado |
alert_resolved | Alerta resolvido |
Estrutura do Log
Seção intitulada “Estrutura do Log”| Campo | Tipo | Descrição |
|---|---|---|
id | UUID | Identificador único do log |
entity_type | enum | Tipo da entidade afetada |
entity_id | UUID | ID da entidade afetada |
entity_name | string | Nome da entidade (para referência) |
action | string | Ação realizada |
user_id | UUID/null | Usuário que executou (null = sistema) |
timestamp | datetime | Data/hora da ação |