Histórico da Página

...

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

Card

label	Solcitação de Serviço

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

Card

id	0
label	Inclusão de Solicitação de Serviço

Método: /mntsrws/api/v1/request

Tipo: POST

Inclui uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma Solicitação de Serviço;
Preencher os todos os campos obrigatórios para gerar uma Solicitação de Serviço:

Body

Campos que compõe a requisição de inclusão da S.S..

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
location	Logic	-	Define se é para bem ou localização	Condicional	TQB_TIPOSS
origin	String	20	Origem de Registro	Sim	TQB_ORIGEM
equipment	String	16	Código do Bem/Localização	Sim	TQB_CODBEM
description	String	999	Descrição da Solicitação	Sim	TQB_DESCSS
costCenter	String	20	Código do Centro de Custo da S.S.	Não	TQB_CCUSTO
counter	Numeric	09	Primeiro Contador do Equipamento	Condicional	TQB_POSCON
secondCounter	Numeric	09	Segundo Contador do Equipamento	Condicional	TQB_POSCO2
telephoneExtension	String	10	Ramal	Condicional	TQB_RAMAL
serviceType	String	06	Código do Serviço da S.S.	Não	TQB_CDSERV
priority	String	01	Prioridade	Não	TQB_PRIORI

Exemplo de uma requisição básica:

Bloco de código

language	js
theme	Eclipse
title	Raw

{
	"equipment":"001",
	"dateTime":"20220419 13:00",
	"description":"Não esta refrigerando",
	"serviceType": "000001",
	"telephoneExtension": "569",
	"counter":2300,
	"secondCounter":550,
	"location":true
}

Nota

title	Atenção

O campo dateTime deverá conter um espaço entre a data e hora("dateTime":"20220430 11:00").
Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, caso a S.S. for inclusa para uma Localização, será necessário adicionar "location":true no body.

Card

id	1
label	Distribuição de Solicitação de Serviço

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Distribui uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma S.S.;
Preencher os campos obrigatórios para distribuir a S.S.;
No value deverá ser informado o número da Solicitação de serviço: /mntsrws/api/v1/request/000298/distribute, que no caso do exemplo foi utilizado como 000298.

Body

Lista dos campos disponíveis no método de inclusão de O.S.:

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
executor	String	25	Define se é para bem ou localização	Condicional	TQB_CDEXEC
serviceType	String	20	Origem de Registro	Sim	TQB_CDSERV

Exemplo de distribuição de uma S.S.:

Bloco de código

language	js
theme	Eclipse
title	Raw

{   
    "executor":"000000",
    "serviceType":"000001"
}

Card

id	1
label	Inclusão de O.S. a partir de uma Solicitação de Serviço

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Inclui uma O.S. a partir de uma Solicitação de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma O.S. para a Solicitação de Serviço já existente;
Preencher os campos obrigatórios para gerar a O.S.;
No value deverá ser informado o número da Solicitação de serviço: /mntsrws/api/v1/request/000298/order, que no caso do exemplo foi utilizado como 000298.

Body

Lista dos campos disponíveis no método de inclusão de O.S.:

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
location	Logic	-	Define se é para bem ou localização	Condicional	TJ_TIPOOS
origin	String	20	Origem de Registro	Sim	TQB_ORIGEM
equipment	String	16	Código do Bem/Localização	Sim	TJ_CODBEM
costCenter	String	20	Código do Centro de Custo da O.S.	Sim	TJ_CCUSTO
startDate	String	08(data) + 05(hora)	Data e Hora da abertura da O.S.( 20220419 13:00 )	Sim	TJ_DTORIGI / TJ_HOMPINI / TJ_HORACO1 / TJ_HORACO2
service	String	20	Código do serviço da O.S.	Sim	TJ_SERVICO
situation	Numeric	09	Situação da O.S. ( P = Pendente / L = Liberada )	Sim	TJ_SITUACA
counter	Numeric	09	Primeiro Contador do Equipamento	Condicional	TJ_POSCON
secondCounter	Numeric	09	Segundo Contador do Equipamento	Condicional	TJ_POSCO2
workCenter	Numeric	09	Código do Centro de Trabalho	Não	TJ_CENTRAB
sequence	String	10	Sequência da Manutenção	Não	TJ_SEQRELA
downTime	String	06	Data e Hora de Para inicio do bem da O.S.( 20220430 11:00 )	Não	TJ_DTPRINI / TJ_HOPRINI
inputs	array	999	Array de Insumos previstos da O.S.	Não	-

Inputs

Lista dos campos que estão disponíveis para serem utilizados dentro do inputs:

Campo	Tipo	Tamanho	Descrição	Obrigatório	Campo Referência
operation	String	01	C = Inclusão do Insumo	Sim	-
task	String	06	Código da Tarefa	Sim	TL_TAREFA
type	String	01	Tipo de Insumo	Sim	TL_TIPOREG
code	String	30	Código do Insumo	Sim	TL_CODIGO
unity	String	02	Unidade do Insumo	Sim	TL_UNIDADE
amount	Numeric	09	Quantidade do Insumo	Sim	TL_QUANTID
isDone	Logic	-	Define se é Insumo previsto ou realizado	Sim	-
date	String	08(data) + 05(hora)	Data e Hora inicio previsto para o insumo	Sim	TL_DTINICI / TL_HOINICI
destiny	String	01	Destino do insumo	Condicional	TL_DESTINO
resourceAmount	Numeric	03	Quantidade do recurso	Condicional	TL_QUANREC
warehouse	String	06	Almoxarifado	Condicional	TL_LOCAL
note	String	10	Observações (MEMO)	Condicional	TL_OBSERVA

Exemplo de inclusão de uma O.S. sem informar insumo:

Bloco de código

language	js
theme	Eclipse
title	Raw

{   
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "099",
    "startDate":"20200101 14:00"
}

Exemplo de inclusão de uma O.S. informando um insumo do tipo produto:

Bloco de código

language	js
theme	Eclipse
title	Raw

{  
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "099",
    "startDate":"20200101 14:00",
    "inputs":[  
      {  
         "operation":"C",
         "task":"0",
         "destiny":"A",
         "code":"PRODGEN",
         "type":"P",
         "warehouse":"01",
         "date":"20180701 09:00",
         "amount":3,
         "isDone":false,
         "unity":"UN"
      }
    ]
}

Nota

title	Atenção

O campo date deverá conter um espaço entre a data e hora("date":"20220430 11:00");
Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, caso o insumo da O.S. a ser incluída for do tipo Produto, será necessário adicionar destiny ao body.

Card

label	Abastecimento

Deck of Cards

id	0
effectType	fade
loopCards	true

Card

id	0
label	Inclusão de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: POST

Inclui um Abastecimento.

Ao executar a chamada do webservice o método irá:

Incluir um abastecimento;
Preencher os todos os campos obrigatórios para gerar um abastecimento:

Body

Campos que compõe a requisição de um abastecimento.

Campo	Tipo	Tamanho	Descrição	Obrigatório
TQN_PLACA	String	8	Placa do Veículo	Sim
TQN_FROTA	String	16	Código do Veículo	Sim
TQN_CODCOM	String	03	Código do Combustível	Sim
TQN_POSTO	String	14	Código do posto	Sim
TQN_LOJA	String	14	Código do loja	Sim
TQN_CNPJ	String	14	CNPJ do posto	Não
TQN_DTABAS	Date	08	Data do abastecimento	Sim
TQN_HRABAS	String	05	Hora da abastecimento	Sim
TQN_TANQUE	String	02	tanque do posto	Sim
TQN_BOMBA	String	03	bomba do posto	Sim
TQN_QUANT	Numeric	09	quantidade abastecida	Sim
TQN_VALUNI	Numeric	09	valor unitário do combustível	Sim
TQN_VALTOT	Numeric	15	valor total do combustível	Sim
TQN_HODOM	Numeric	09	Contador do equipamento	Condicional
TQN_POSCO2	Numeric	09	Segundo Contador do equipamento	Condicional
TQN_CODMOT	String	06	Código do motorista	Condicional
TQN_NOTFIS	String	09	Código da nota fiscal	Condicional
TQN_CODVIA	String	06	Código da viagem	Condicional
TQN_ESCALA	String	08	Código da escala	Condicional

Exemplo de um abastecimento padrão:

Bloco de código

language	js
theme	Eclipse
title	Raw

{
   "TQN_PLACA":"MNT-1234",
   "TQN_FROTA":"VEI-S10",
   "TQN_CODCOM":"MNT",
   "TQN_POSTO":"MNTPOS",
   "TQN_LOJA":"01",
   "TQN_CNPJ":"34236121000159",
   "TQN_DTABAS":"20230220",
   "TQN_HRABAS":"12:10",
   "TQN_TANQUE":"01",
   "TQN_BOMBA":"01",
   "TQN_QUANT":5,
   "TQN_VALUNI":4,
   "TQN_VALTOT":20
   
}

Nota

title	Atenção

Campos condicionais, são campos que se tornam obrigatórios em determinadas situações, por exemplo, um bem com contador, necessariamente precisa do campo "TQN_HODOM" preenchido, Exemplo: "TQN_HODOM": 50.

Card

label	Alteração de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: PUT

Altera um Abastecimento.

Ao executar a chamada do webservice o método irá:

Alterar um abastecimento já existente;
Preencher os todos os campos obrigatórios para gerar um abastecimento:

Body

Campos que compõe a alteração de um abastecimento.

Campo	Tipo	Tamanho	Descrição	Obrigatório
TQN_FROTA	String	16	Código do Veículo	Sim
TQN_DTABAS	String	08	Data do abastecimento	Sim
TQN_HRABAS	String	05	Hora da abastecimento	Sim

Bloco de código

language	js
theme	Eclipse
title	Raw

{
   "TQN_FROTA":"VEI-S10",
   "TQN_DTABAS":"20230320",
   "TQN_HRABAS":"12:10"
}

Card

label	Deleção de Abastecimento

Método: mntFuelUp/api/v1/fuelup

Tipo: DELETE

Excluí um Abastecimento.

Ao executar a chamada do webservice o método irá:

Excluir um abastecimento já existente;
Preencher os todos os campos obrigatórios para gerar um abastecimento:

Body

Campos que compõe a alteração de um abastecimento.

Campo	Tipo	Tamanho	Descrição	Obrigatório
TQN_FROTA	String	16	Código do Veículo	Sim
TQN_DTABAS	String	08	Data do abastecimento	Sim
TQN_HRABAS	String	05	Hora da abastecimento	Sim

Bloco de código

language	js
theme	Eclipse
title	Raw

{
   "TQN_FROTA":"VEI-S10",
   "TQN_DTABAS":"20230320",
   "TQN_HRABAS":"12:10"
 }

Card

id	OS
label	Ordem de Serviço

Deck of Cards

id	operation

Card

id	create
label	Inclusão

Método: mntng/create

Tipo: POST

Inclui uma Ordem de Serviço.

Ao executar a chamada do webservice o método irá:

Incluir uma ordem de serviço;
Preencher os todos os campos obrigatórios para gerar uma ordem de serviço:

Body

A seguir é apresentado um exemplo do conteúdo da requisição.

Bloco de código

language	js

{  
   "equipment":"AC006",
   "operation":"C"
   "service":"CORELE",
   "startDate":"20230623 08:30",
   "plan":"000000",
   "endDate":"20230623 08:30",
   "type":"C",
   "observation":"teste",
    "counter":[
      {  
         "datetime":"20230623 08:30",
         "value":100
      },
      {  
         "datetime":"20230623 08:30",
         "value":200
      }
   ],
    "inputs":[ {  
         "sublot":"",{
         "locationoperation":"C",
         "task":"0",
         "serialNumber":"",
         "destiny":"A",
         "code":"15.15029",
         "type":"P",
         "warehouse":"01",  
         "date":"20230623 08:30",
         "amount":3,
         "isDone":true,
         "unity":"L"
      }
   ],
   "checklist":[
      {
         "isDone":true,
         "task":"ELE",
         "step":"000001"
      },
      {
         "isDone":false,
         "task":"ELE",
         "step":"000012"
      }]
   ]
}

Card

id	update
label	Alteração

Método: mntng/update

Tipo: POST

Altera uma Ordem de Serviço.

Body

A seguir é apresentado um exemplo do conteúdo da requisição.

Bloco de código

language	js

{
   "code":"000070",
   "plan":"000003",
   "service":"PREGEN",
   "sequence":"1",
   "startDate":"20230602 08:00",
   "endDate":"20230602 08:00",
   "equipment":"MAQ-0096",
   "type":"P",
   "observation":"",
   "checklist":[
      
   ],
   "inputs":[
      {
         "operation":"U",
         "isDone":true,
         "sequence":"1  ",
         "keytask":"0",
         "keycode":"000001",
         "task":"ELE",
         "code":"000001",
         "type":"M"
      }
   ]
}

Card

id	finish
label	Finalização

Método: mntng/finish

Tipo: POST

Finaliza uma Ordem de Serviço.

Body

Bloco de código

language	js

{
   "startDate":"20230501 08:30",
   "observation":"",
   "plan":"000000",
   "order":"013610",
   "endDate":"20230501 09:30",
   "fault":"001"
}

Card

id	cancel
label	Cancelamento

Método: mntng/cancel

Tipo: POST

Cancela uma Ordem de Serviço.

Body

A seguir é apresentado um exemplo do conteúdo da requisição.

Bloco de código

language	js

{  
 "plan":"000000",
 "order":"013921",
 "message":"ordem aberta indevidamente",
}

Card

id	detail
label	Detalhes dos campos

Chaves da ordem de serviço (objeto principal)

Campo	Descrição	Tipo
code	Código da ordem. Não é obrigatória apenas na inclusão.	string
plan	Código do plano. Não é obrigatória apenas na inclusão.	string
startDate	Data e hora inicial. Chave obrigatória.	string
endDate	Data e hora final. Chave obrigatória.	string
equipment	Código do equipamento. Chave obrigatória.	string
type	Indica o tipo da ordem. Chave obrigatória. C=Corretiva P=Preventiva	string
observation	Descrição. Chave obrigatória.	string
counter	Contadores. Chave não obrigatória.	array de objetos
checklist	Etapas. Chave obrigatória. Caso não houver etapas é necessário enviar um array vazio.	array de objetos
inputs	Insumos. Chave obrigatória. Caso não houver insumos é necessário enviar um array vazio.	array de objetos

Chaves dos contadores (objeto counter)

Chave	Descrição
datetime	Data e hora do contador
value	Valor do contador

Informações
Os valores do primeiro objeto do array "counter" são considerados para o primeiro contador, assim como os valores do segundo objeto, caso existir serão considerados para o segundo contador.

Chaves das etapas (objeto checklist)

Chave	Descrição
task	Código da tarefa.
step	Código da etapa.
isDone	Se a etapa está executada (true) ou prevista (false)

Chaves dos insumos (objeto inputs)

Chave	Descrição	Tipo
operation	Tipo da operação. Chave obrigatória: C=Create; U=Update; D=Delete.	string
isDone	Indica se o insumo é realizado. Chave obrigatória.	boolean
sequence	Sequência do insumo já aplicado. Chave não obrigatória apenas na operação create.	string
task	Código da tarefa. Chave obrigatória na operação create. Chave utilizada na operação update para alteração da tarefa.
keyTask	Código da tarefa. Chave não obrigatória apenas na operação create. Esta chave é utilizada para a busca do insumo nas operações update e delete.	string
code	Código do insumo. Chave obrigatória na operação create. Chave utilizada na operação update para alteração da tarefa.
keyCode	Chave código do insumo. Chave não obrigatória apenas na operação create. Esta chave é utilizada para a busca do insumo nas operações update e delete.	string
type	Tipo do insumo. Chave obrigatória	string
unity	Unidade. Corresponde ao campo TL_UNIDADE do insumo.	string
destiny	Destino. Chave obrigatória. A=Apoio; T=Troca; S=Substituição.	string
resourceAmount	Quantidade de recurso. Corresponde ao campo TL_QUANREC	string
startDate	Data e hora inicial.	string
endDate	Data e hora final.

...

Árvore de páginas

Versões comparadas

Versão antiga 51

Nova versão 52

Chave

Método: /mntsrws/api/v1/request

Tipo: POST

Body

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Método: /mntsrws/api/v1/request/{value}/{operation}

Tipo: PUT

Inputs

Método: mntFuelUp/api/v1/fuelup

Tipo: POST

Body

Método: mntFuelUp/api/v1/fuelup

Tipo: PUT

Body

Método: mntFuelUp/api/v1/fuelup

Tipo: DELETE

Body

Método: mntng/create

Tipo: POST

Body

Método: mntng/update

Tipo: POST

Body

Método: mntng/finish

Tipo: POST

Body

Método: mntng/cancel

Tipo: POST

Body