v1Referência da APIRelatórios

Relatório de métricas

Devolve o OEE, a disponibilidade, a qualidade e os minutos perdidos por máquina e turno.

Cada linha traz os indicadores do turno (tempo disponível, tempo de paragem separado por causa) juntamente com as métricas de produção derivadas: availability, effectiveness, quality, oee e netOee, além dos minutos perdidos por baixa velocidade e por baixa qualidade.

É um POST que só lê: basta o scope reports.read. É preferível a calcular o OEE a partir dos registos de produção: os limites dos turnos, a classificação das paragens e os fatores de contagem já estão aplicados.

Corpo do pedido

application/json

Definições de TypeScript

Utilize o tipo request body em TypeScript.

Corpo da resposta

application/json

application/json

Experimente em direto
POST
/v1/reports/metrics

Este endpoint requer autenticação. Cole um token na secção Autorização, mais abaixo.

curl -X POST "https://example.com/v1/reports/metrics" \  -H "Content-Type: application/json" \  -d '{}'
{  "totalCount": 100,  "totalPages": 10,  "currentPage": 1,  "metrics": [    {      "company": {        "id": 1,        "name": "company 1"      },      "machine": {        "id": 1,        "name": "machine 1"      },      "shift": {        "endTime": "2025-11-02T00:00:00",        "id": 1,        "isActive": true,        "name": "morning",        "startTime": "2025-11-01T00:00:00"      },      "shiftIndicators": {        "annotatedDowntime": 0,        "availability": 100,        "availableTime": 480,        "earlyStopTime": 0,        "indicatorId": 1,        "lateStartTime": 0,        "netAvailability": 100,        "noDataTime": 0,        "nonProgrammedDowntime": 0,        "otherStopsTime": 0,        "programmedDowntime": 0,        "unavailableTime": 0      },      "productionMetrics": {        "availability": 100,        "effectiveness": 100,        "minutesLostByLowQuality": 0,        "minutesLostByLowSpeed": 0,        "netAvailability": 100,        "netOee": 100,        "oee": 100,        "quality": 100      }    }  ]}

Adicionar um operador ao turno atual POST

Atribui um operador ao turno em curso na máquina no momento da chamada. Ambos os campos são obrigatórios: `operatorId` e `start`, o momento em que a atribuição começa. Use-o para o registo de entrada num terminal. Escreve no turno em curso e tem efeito imediato.

Relatório de paragens POST

Devolve as paragens individuais das máquinas com a sua duração, causa e classificação. É o detalhe por trás dos totais de tempo de paragem do relatório de métricas. `stopId` aceita a gramática de comparação completa, por isso é possível obter diretamente uma paragem específica ou um intervalo delas.