Summary

Descrição#

Retorna os estados das máquinas em relação ao tempo, como se fossem sua fotografia.

Exemplo:

[
    {
        "serial": "ABCDEF12",
        "timestamp": "2021-03-04T11:50:55.000Z",
        "tag_id": "100",
        "tag": "Status (Description)",
        "value": "ACTIVE NOT CUTTING",
        "old_value": "ACTIVE NOT CUTTING",
        "changed": false,
        "old_value_elapsed_time": 0
    },
    {
        "serial": "ABCDEF12",
        "timestamp": "2021-03-04T11:50:55.000Z",
        "tag_id": "110",
        "tag": "Execution Mode (Automatic / Manual)",
        "value": "AUTOMATIC",
        "old_value": "AUTOMATIC",
        "changed": false,
        "old_value_elapsed_time": 5014
    },
    {
        "serial": "ABCDEF12",
        "timestamp": "2021-03-04T11:50:55.000Z",
        "tag_id": "300",
        "tag": "Spindle Speed",
        "value": "0.000000",
        "old_value": "0.000000",
        "changed": false,
        "old_value_elapsed_time": 0
    },
]

URL#

URL autenticada
URL direta

/api/v1/:userKey/:apiKey/summary[?: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
changedonly	Filtra o resultado para exibir apenas os registros com a chave changed = true		Não
tagid	Filtra apenas os resultados onde a chave tag_id for igual ao valor informado. Pode informar uma ou mais tags. Deve-se separar várias tags usando-se vírgula. Consulta a rota Reference Table para detalhes.	tagid=99,700	Não

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 os resumos de todas as máquinas entre 08h00 e 09h00 (UTC) do dia 03/01/2021
/summary?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
/summary?start_time=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
/summary?start_time=2021-03-01T08:00:00Z&end_time=2021-03-01T09:00:00Z&serial=ABCDE12,HGHRR12

// Obtendo apenas os registros com changed = true da consulta anterior
// Filtrando os resultados da consulta anterior para somente duas máquinas
/summary?start_time=2021-03-01T08:00:00Z&end_time=2021-03-01T09:00:00Z&serial=ABCDE12,HGHRR12&changedonly

// Usando um modificador de data/hora para consultar a última hora
/summary?lasthour&serial=ABCDE12,HGHRR12&changedonly