Logs
Esta categoria centraliza o acesso e controle dos registros (logs) gerados pelas antenas de tag veicular. Os logs contêm informações relevantes para diagnóstico, auditoria e acompanhamento do funcionamento da antena, incluindo eventos, erros e comunicações. Os endpoints permitem consultar, limpar e marcar como lidos os registros, seja por ID cadastrado ou por instância conectada.
1. Obter Logs (por Instância)
Descrição:
Retorna os registros de log de uma antena conectada via instância temporária. Isso é útil quando a antena ainda não foi cadastrada no sistema, permitindo diagnósticos imediatos após uma descoberta ou teste.
GET /api/v1/vehicleAntennas/instances/{id}/logs
Quando Usar:
Após conectar a antena pela primeira vez na rede.
Para verificar o comportamento do dispositivo antes do cadastro.
Durante testes de comunicação, configuração ou atualização de firmware.
Obter Logs da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção dos logs ocorrer com sucesso
Quando ocorrer erro
2. Marcar logs como lidos (por instância)
Descrição:
Marca os logs como lidos utilizando o ID da instância de conexão.
POST /api/v1/vehicleAntennas/instances/{id}/logs/read
Quando Usar:
Útil em cenários onde o controle de leitura de logs é feito por sessões ativas, como em dashboards técnicos ou aplicativos de manutenção.
Marcar como lido Logs da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a marcação dos logs ocorrer com sucesso
Quando ocorrer erro
3. Deletar todos os logs da antena (por Instância)
Descrição:
Remove todos os logs da antena com base na instância conectada.
DELETE /api/v1/vehicleAntennas/instances/{id}/logs
Quando Usar:
Use em rotinas automáticas de manutenção com conexão direta, quando não se deseja trabalhar com o ID cadastrado.
Deletar todos os logs da antena de tag veicular por Instância conectada
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da instância conectada
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a remoção dos logs ocorrer com sucesso
Quando ocorrer erro
4. Obter Logs (por ID)
Descrição:
Retorna os registros de log de uma antena já cadastrada no sistema, identificada pelo seu ID. Os logs podem incluir eventos operacionais, ações de usuários, falhas e outras ocorrências.
GET /api/v1/vehicleAntennas/{id}/logs
Quando Usar:
Para investigação de erros ou comportamentos inesperados.
Durante auditorias e revisões técnicas.
Para integração com sistemas de monitoramento de dispositivos.
Obter Logs da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a obtenção das informações ocorrer com sucesso
Quando ocorrer erro
5. Marcar logs como lidos (por ID)
Descrição:
Marca todos os logs da antena como lidos, utilizando o ID da antena.
POST /api/v1/vehicleAntennas/{id}/logs/read
Quando Usar:
Ideal para manter controle de leitura e evitar duplicidade de análise, especialmente em sistemas que processam logs de forma incremental.
Marcar como lido Logs da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a marcação dos logs ocorrer com sucesso
Quando ocorrer erro
6. Deletar todos os logs da antena (por ID)
Descrição:
Remove todos os logs registrados na antena identificada pelo ID.
DELETE /api/v1/vehicleAntennas/{id}/logs
Quando Usar:
Recomendado após backup dos logs ou durante procedimentos de manutenção preventiva para liberar espaço interno na antena.
Deletar todos os logs da antena de tag veicular
JWT Authorization header using the Bearer scheme.
Enter 'Bearer'[space] and then your token in the text input below.
Example: "Bearer 12345abcdef"
Id da antena de tag veicular
Nome da cultura específica usada para definir os formatos de dados (pt-BR, en-US)
en-USQuando a remoção dos logs ocorrer com sucesso
Quando ocorrer erro
Atualizado