v1Referência da APIRelatórios

Relatório de paragens

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.

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/stops

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

curl -X POST "https://example.com/v1/reports/stops" \  -H "Content-Type: application/json" \  -d '{}'
{  "totalCount": 100,  "totalPages": 10,  "currentPage": 1,  "stops": [    {      "classification": {        "component": {          "id": "3f36ce0c-5407-49f8-805e-d60e1961a8f2",          "name": "a simple component"        },        "createdAt": "2025-11-01T00:00:00",        "description": "a simple description",        "generalCause": {          "id": "a0bb4fb8-3279-4817-b628-b5102113d5a6",          "name": "a simple general cause"        },        "id": 1,        "specificCause": {          "id": "e4b38430-d83b-48be-838c-ebf4488d7df5",          "name": "a simple specific cause"        },        "updatedAt": "2025-11-01T00:00:00"      },      "company": {        "id": 1,        "name": "a simple company"      },      "machine": {        "id": 1,        "name": "a simple machine"      },      "shift": {        "endTime": "2025-11-10T00:00:00",        "id": 1,        "isActive": true,        "name": "morning",        "startTime": "2025-11-01T00:00:00"      },      "stop": {        "createdAt": "2025-11-01T00:00:00",        "deletedAt": "2025-11-10T00:00:00",        "durationInMinutes": 30,        "endTime": "2025-11-10T00:00:00",        "id": 1,        "isIncludedInAvailability": true,        "isIncludedInStops": true,        "isManual": true,        "isProgrammed": true,        "startTime": "2025-11-01T00:00:00",        "updatedAt": "2025-11-01T00:00:00"      }    }  ]}

Relatório de métricas POST

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.

Listar turnos GET

Lista os seus turnos que se sobrepõem a um intervalo de tempo, passados ou futuros, para encontrar o `id` que `POST /v1/shifts/{shift_id}/operator` e `POST /v1/shifts/{shift_id}/defects` recebem. Um turno é devolvido quando alguma parte dele fica entre `from` e `to`: termina depois de `from` e começa antes de `to`. Assim, um turno da noite das 22:00 às 06:00 aparece num intervalo que cubra qualquer um dos dois dias. O intervalo pode abranger no máximo **31 dias**; percorra os períodos mais longos com intervalos consecutivos. Os turnos são devolvidos ordenados por `start` e depois por máquina. Restrinja a lista com `machineId`, repetido para várias máquinas: ``` GET /v1/shifts?from=2026-10-12T00:00:00Z&to=2026-10-13T00:00:00Z&machineId=12 ``` Os turnos excluídos das métricas também são listados, com `isConsidered: false`.