Documentação - POST /api/telemetry

Criada por Ivan Faria, Modificado em Thu, 16 Mai, 2024 às 3:22 PM por Ivan Faria

Descrição

Este endpoint permite o envio de dados de telemetria para serem salvos no repositório e no bucket S3.

Endpoint

POST /api/telemetry

Parâmetros da Solicitação

telemetryData:(obrigatório) Os dados de telemetria a serem enviados.
type: (obrigatório)O tipo de dados de telemetria.
serialNumber: (obrigatório) O número serial do dispositivo que está enviando os dados de telemetria.
OBS: Os outros campos como: date, s3Url, S3Key e content são preenchidos após a solicitação.

Exemplo de solicitação

{  
"id": 283, 
 "date": "2024-05-14T19:30:55.803+00:00",
  "telemetryData": "CRISTOFOLI BIOSSEGURANÇA\nNo SERIE VST54000000L000000\nSW: 1.03\nINICIO DO CICLO  HORA:13:45:37  DATA:14-03-2023\nCICLO No00164\n\nCICLO UNIVERSAL\nTEMPERATURA ESTERILIZACAO 1340\nTEMPO ESTERILIZACAO 10 min\nTEMPO SECAGEM 00 min\n\nFASE\t\t\tHORA\t\t\tT\t\t\tP\n\nAquecimento;\t\t13:54:28;\t95.5;\t 0.05\nAquecimento;\t\t13:56:59;\t109.7;\t 0.51\nAquecimento;\t\t13:58:19;\t98.0;\t 0.05\nAquecimento;\t\t14:01:04;\t109.7;\t 0.51\nAquecimento;\t\t14:02:40;\t98.8;\t 0.05\nAquecimento;\t\t14:05:52;\t82.8;\t-0.40\nAquecimento;\t\t14:21:28;\t126.9;\t 1.60\nAquecimento;\t\t14:31:25;\t135.6;\t 2.32\nEsterilizacao;\t\t14:31:25;\t135.6;\t 2.32\nEsterilizacao;\t\t14:35:24;\t135.6;\t 2.32\nEsterilizacao;\t\t14:39:25;\t135.6;\t 2.32\nEsterilizacao;\t\t14:41:25;\t135.5;\t 2.32\nDespressurizacao;\t14:41:25;\t135.5;\t 2.32\nDespressurizacao;\t14:49:25;\t133.1;\t 2.11\nDespressurizacao;\t15:41:25;\t117.0;\t 0.92\nDespressurizacao;\t15:45:25;\t115.8;\t 0.86\nDespressurizacao;\t15:49:25;\t114.7;\t 0.80\nDespressurizacao;\t16:01:25;\t111.4;\t 0.62\nDespressurizacao;\t16:05:25;\t110.3;\t 0.57\nSecagem;\t\t\t16:19:20;\t57.7;\t 0.02\n\nT= oC\nP= kgfcm2\n\nTEMPERATURA MAXIMA: 135.7\nTEMPERATURA MINIMA: 135.4\nPRESSAO MAXIMA:  2.33 kgf/cm2\nPRESSAO MINIMA:  2.30 kgf/cm2\nTEMPO AQUECIMENTO: 44 min 57 seg\nTEMPO DESPRESSURIZACAO: 95 min 46 seg\nTEMPO ESTERILIZACAO: 10 min 00 seg\nTEMPO SECAGEM: 02 min 09 seg\nTEMPO TOTAL: 02 hor 32 min 52 seg\n\nCICLO CONCLUIDO.",
  "serialNumber": "VST54000000L000000", 
 "type": "2", 
 "s3Url": "https://s3.us-east-1.amazonaws.com/cris-telemetry-data/Telemetry_VST54000000L000000_14-05-2024_16-32.txt", 
 "s3Key": "Telemetry_VST54000000L000000_14-05-2024_16-32.txt", 
 "content": null
}

Respostas

200 OK: A solicitação foi bem-sucedida e a telemetryData foi postado corretamente e pode ser visualizado no repositório e no bucket S3.
400 Bad Request: A solicitação contém parâmetros inválidos, ausentes ou os padrões do JSON não estão suportando o telemetryData.
401 Unauthorized: A API identifica que o usuário não tem a permissão de acessar a requisição.
500 Internal Server Error: Ocorreu um erro no servidor ao processar a solicitação.

Considerações

Cuidado com o uso de TAB, ENTER dependendo do uso, o padrão JSON não suporta, tente utilizar \t ou \n.
Em caso de verificação de arquivos acessar o bucket S3.
Caso o content esteja "null", fique tranquilo, o content aparece apenas na requisição GET deste endpoint.