Documentação da API de Paradas em Andamento

Descrição

Retorna informações sobre os registros de parado/rodando (em andamento ou concluído) de uma máquina específica ("RAMA 01" no exemplo) dentro de um período de tempo especificado, com possibilidade de filtrar por grupo e tipo de parada.

Endpoint

POST https://app.mify.com.br/api/v2/integration/external/machine/RAMA 01/get-running

Autenticação

x-api-key: 8h4t6248-38df-4470-8f56-831441a723dc

Parâmetros do Corpo (JSON)

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
start	string	Não	Data/hora de início no formato ISO 8601 (UTC)	"2025-03-01T03:00:00Z"
end	string	Não	Data/hora de término no formato ISO 8601 (UTC)	"2025-03-10T03:00:00Z"
group	string	Não	Filtro por grupo de parada	"MANUTENÇÃO"
type	string	Não	Filtro por tipo de parada	"MECÂNICA"

Exemplos de Requisição

curl --location 'https://app.mify.com.br/api/v2/integration/external/machine/RAMA 01/get-running' 
--header 'x-api-key: 8h4t6248-38df-4470-8f56-831441a723dc' 
--header 'Content-Type: application/json' 
--data '{
    "start": "2025-03-01T03:00:00Z",
    "end": "2025-03-10T03:00:00Z",
    "group": "MANUTENÇÃO",
    "type": "MECÂNICA"
}'

curl --location 'https://app.mify.com.br/api/v2/integration/external/machine/RAMA 01/get-running' 
--header 'x-api-key: 8h4t6248-38df-4470-8f56-831441a723dc' 
--header 'Content-Type: application/json' 
--data '{
    "start": "2025-03-01T03:00:00Z",
    "end": "2025-03-10T03:00:00Z"
}'

Resposta da Requisição

Estrutura da Resposta (JSON Array)

A resposta é um array de objetos referentes aos registros da máquina rodando/parada. Cada objeto possui a seguinte estrutura:

Campo	Tipo	Descrição
machine	string	Nome da máquina
start	string	Data/hora de início da parada (ISO 8601 UTC)
end	string | null	Data/hora de término da parada (ISO 8601 UTC)
durationMs	integer | null	Duração da parada (milissegundos)
event	0 | 1	Referente ao tipo de registro. (0: Parado, 1: Rodando)
group	string | null	Nome do grupo da parada
subGroup	string | null	Nome do subgrupo da parada
type	string | null	Nome do tipo de parada
subType	string | null	Nome do subtipo de parada
justification	string | null	Justificativa da parada (null se não informada)
programmed	string | null	Nome da parada programada
routine	string | null	Nome da parada de routine

Exemplo de Resposta

[
    {
        "machine": "RAMA 01",
        "start": "2025-03-05T12:31:04.569Z",
        "end": null,
        "durationMs": null,
        "event": 1,
        "justification": null,
        "group": null,
        "subGroup": null,
        "type": null,
        "subType": null,
        "programmed": null,
        "routine": null,
    },
    {
        "machine": "RAMA 01",
        "start": "2025-03-07T19:48:34.295Z",
        "end": "2025-03-07T19:57:14.789Z",
        "durationMs": 520493,
        "event": 0,
        "justification": "Conserto motor cilindro acumulador rama",
        "group": "MANUTENÇÃO",
        "subGroup": "MANUTENÇÃO",
        "type": "MECÂNICA",
        "subType": "MECÂNICA",
        "programmed": null,
        "routine": null,
    }
]

Observações Importantes

1. Os campos group, subGroup, type, subType, justification programmed e routine são nulos quando a parada não foi informada.
2. Caso seja um registro em andamento, end e durationMs serão nulos.
3. Paradas informadas sempre vão ter group + subGroup + type + subType ou programmed ou routine.