Registro 1008
Registro 1008 refere-se à consulta do espelho do programa em execução via requisição GET para o seguinte endpoint:
http://ip_servidor/1008/{os_id}
os_id: Identificador da OS
Esta documentação detalha os possíveis retornos da API.
🔎 Resumo Rápido
- Método:
GET - Endpoint:
http://ip_servidor/1008/{os_id} - Parâmetro obrigatório:
os_id - Resposta esperada: JSON com informações do status da máquina
1. Legenda dos dados de retorno do status da máquina
Códigos de Status da OS
| Código | Descrição |
|---|---|
| 0 | Cadastrado |
| 1 | Espera |
| 2 | Na Fila |
| 3 | Executando |
| 4 | Finalizado |
| 5 | Cancelado |
Códigos de Status do passo
| Código | Descrição |
|---|---|
| 1 | Espera |
| 2 | Executando |
| 3 | Finalizado |
| 4 | Cancelado |
| 5 | Pulado, Ignorado |
📦 Campos do retorno do JSON principal:
| Campo | Descrição | Tipo |
|---|---|---|
| codigo | Código da OS | string |
| status | Status da OS | inteiro |
| passos | Lista de passos da os | array de objetos (ver abaixo) |
Estrutura dos passos (dentro de passos):
| Campo | Descrição | Tipo |
|---|---|---|
| sequencia | Sequência do passo | inteiro |
| programa | Programa do passo | string |
| funcao | Código da Função | string |
| status | Status do passo | inteiro |
| inicio | Início da função | string (DD/MM/AAAA HH:mm:ss) |
| fim | Fim da função | string (DD/MM/AAAA HH:mm:ss) |
| parametro1 | Valor do parâmetro 1 | inteiro |
| parametro2 | Valor do parâmetro 2 | inteiro |
| parametro3 | Valor do parâmetro 3 | inteiro |
| parametro4 | Valor do parâmetro 4 | inteiro |
| parametro5 | Valor do parâmetro 5 | inteiro |
| parametro6 | Valor do parâmetro 6 | inteiro |
| parametro7 | Valor do parâmetro 7 | inteiro |
| parametro8 | Valor do parâmetro 8 | inteiro |
| parametro9 | Valor do parâmetro 9 | inteiro |
2. Respostas da API
🔄 Sucesso – HTTP 200
Se os dados forem entregues corretamente, será retornado o status code 200 com os dados do status da máquina.
{
"codigo": "1443581",
"status": 4,
"passos": [
{
"sequencia": 1,
"programa": "133",
"funcao": "27",
"status": 2,
"inicio": "10/02/2025 10:15:10",
"fim": "10/02/2025 10:18:45",
"parametro1": 1,
"parametro2": 2,
"parametro3": "",
"parametro4": "",
"parametro5": "",
"parametro6": "",
"parametro7": "",
"parametro8": "",
"parametro9": ""
},
]
}
❌ Erro de validação – HTTP 400
Se houver erros nos dados enviados, será retornado o status code 400 com a descrição do problema:
{
"erro": "Os não encontrada"
}