Messages and Alarms

Descrição#

Retorna uma lista de alarmes/mensagens das máquinas em um instante/intervalo no tempo.

Exemplo:

[
    {
        "serial": "TC4L2P7K",
        "timestamp": "2021-03-03T07:34:19.251Z",
        "description": "LOGIC ALARM (CNC MONITOR) - FAULT"
    },
    {
        "serial": "TC4L2P7K",
        "timestamp": "2021-03-03T09:45:32.233Z",
        "description": "MOTION ALARM (CNC MONITOR) - FAULT"
    }
]

note

O retorno é igual para ambos os caminhos

URL para alarmes#

URL autenticada
URL direta

/api/v1/:userKey/:apiKey/alarm[?:params]

URL para mensagens#

URL autenticada
URL direta

/api/v1/:userKey/:apiKey/message[?:params]

Parâmetros possíveis#

Parâmetro	Descrição	Exemplo	Obrigatório?
serial	Filtra o resultado para exibir apenas as máquinas desejadas. Pode receber uma ou mais máquinas. Separar os seriais usando vírgula (",")	serial=ABCDFE33,IJKLKM12	Não
start_time	Define a data/hora inicial dos dados no formato ISO 8601 (UTC). Deve acompanhar o parâmetro end_time	start_time=2021-03-01T08:00:00Z	Sim
end_time	Define a data/hora final dos dados no formato ISO 8601 (UTC). Deve acompanhar o parâmetro start_time	end_time=2021-03-01T09:00:00Z	Sim

Modificadores de data/hora#

Você pode substituir os parâmetros start_time/end_time por um modificador de data/hora (clique aqui para saber mais). Caso ambos estejam presentes, o primeiro par tem preferência.

Exemplo de consulta#

// buscando todos os alarmes na hora 08h00 (UTC) do dia 01/03/2021
/alarm?start_time=2021-03-01T08:00:00Z&end_time=2021-03-01T09:00:00Z

// Filtrando os resultados da consulta anterior para somente uma máquina
/alarm?consolidated=2021-03-01T08:00:00Z&end_time=2021-03-01T09:00:00Z&serial=ABCDE12

// Filtrando os resultados da consulta anterior para somente duas máquinas
/alarm?start_time=2021-03-01T08:00:00Z&end_time=2021-03-01T09:00:00Z&serial=ABCDE12,HGHRR12

// Usando um modificador de data/hora para consultar todos os alarmes do dia corrente
/alarm?today&serial=ABCDE12,HGHRR12