Histórico da Página

...

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

Card

label	Solicitaçã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

A api de ordem de serviço contempla a visualização, inclusão, alteração, cancelamento e finalização de uma ordem de serviço.

Chaves da ordem de serviço (objeto principal)

Chaves dos contadores (objeto counter)

Deck of Cards

id	operation

Card

id	1
label	Detalhes da Ordem de Serviço

Método: http://enderecoserver:portarest/rest/mntorder/order/value

Tipo: GET

Exibe as informações detalhadas referentes à O.S pesquisada;

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

Consultar se existe a Ordem de Serviço pesquisada;
Pesquisar e preencher os campos referentes à O.S e suas amarrações;

Em enderecoserver:portarest/ deverá ser informado o endereço do servidor Rest e sua Porta;

Ex: http://localhost:8080/

No value deverá ser informado o número da Ordem de serviço: http://localhost:8080/rest/mntorder/order/000722, que no caso do exemplo foi utilizado como 000722.

Somente serão exibidos os campos marcados como Usado no configurador

Deck of Cards

id	order

Card

id	0
label	Ordem de Serviço

Lista dos campos referentes à Ordem de Serviço (Tabela STJ).

Campo	Tipo	Tamanho	Descrição
TJ_ORDEM	String	06	Numero da Ordem Serviço
TJ_PLANO	String	06	Numero do Plano de Manut.
TJ_DTORIGI	String	08	Data Original Ordem Serv.
TJ_TIPOOS	String	01	Tipo da Ordem de Serviço
TJ_CODBEM	String	16	Código do Bem
TJ_NOMBEM	String	20	Nome do Bem
TJ_SERVICO	String	06	Código do Serviço
TJ_NOMSERV	String	20	Nome do Serviço
TJ_SEQRELA	String	03	Sequencia da Manutenção
TJ_TIPO	String	03	Código do Tipo de Manut.
TJ_NOMTIPO	String	20	Nome do Tipo Manutenção
TJ_CODAREA	String	06	Código da Área de Manut.
TJ_NOMAREA	String	20	Nome da Área de Manutenção
TJ_CCUSTO	String	09	Código do Centro de Custo
TJ_NOMCUST	String	20	Nome do centro de Custo
TJ_POSCONT	Numeric	09	Posição do Contador
TJ_HORACO1	String	05	Hora leitura cont. 1
TJ_CUSTMDO	Numeric	09	Custo Total Mao de Obra
TJ_CUSTMAT	Numeric	09	Custo Materiais de Troca
TJ_CUSTMAA	Numeric	09	Custo de Materiais Apoio
TJ_CUSTMAS	Numeric	09	Custo Mater. Substituição
TJ_CUSTTER	Numeric	09	Custo de Terceiros
TJ_DTULTMA	String	08	Data da Ultima Manutenção
TJ_COULTMA	Numeric	12	Contador na Ultima Manut.
TJ_DTPPINI	String	08	Data Inicio Parada Prev.
TJ_HOPPINI	String	05	Hora Inicio Parada Prev.
TJ_DTPPFIM	String	08	Data Fim Parada Prevista
TJ_HOPPFIM	String	05	Hora Fim Parada Prevista
TJ_DTPRINI	String	08	Data Inicio Parada Real
TJ_HOPRINI	String	05	Hora Inicio Parada Real
TJ_DTPRFIM	String	08	Data Fim de Parada Real
TJ_HOPRFIM	String	05	Hora Fim de Parada Real
TJ_DTMPINI	String	08	Data Inicio Manut. Prev.
TJ_HOMPINI	String	05	Hora Inicio Manut. Prev.
TJ_DTMPFIM	String	08	Data Fim Manut. Prev.
TJ_HOMPFIM	String	05	Hora Fim Manut. Prev
TJ_DTMRINI	String	08	Data Inicio Manut. Real
TJ_HOMRINI	String	05	Hora Inicio Manut. Real
TJ_DTMRFIM	String	08	Data Fim de Manut. Real
TJ_HOMRFIM	String	05	Hora Fim de Manut. Real
TJ_COULTM2	Numeric	09	Contador na Ultima Manut.
TJ_POSCON2	Numeric	09	Posição do 2. Contador
TJ_TERMINO	String	01	Indica Termino da O.S.
TJ_USUARIO	String	25	Usuário Ultima Alteração
TJ_PRIORID	String	03	Prioridade da Manutenção
TJ_HORACO2	String	05	Hora leitura cont. 2
TJ_SITUACA	String	01	Situação da Ordem Serviço
TJ_CENTRAB	String	06	Centro de Trabalho
TJ_NOMTRAB	String	20	Nome do centro de trabalho
TJ_TIPORET	String	01	Indicação Tipo Retorno
TJ_ORDEPAI	String	06	Numero da Ordem do Pai
TJ_BEMPAI	String	16	Código do Bem Pai
TJ_NOMEPAI	String	20	Nome do bem Pai
TJ_SUBSTIT	String	100	Substituição de O.S.
TJ_OBSERVA	String	10	Observação
TJ_SOLICI	String	06	Solicitação Serv. Origem
TJ_IRREGU	String	03	Código da Irregularidade
TJ_NIRREGU	String	40	Irregularidade
TJ_TERCEIR	String	01	Enviado para Terceiro
TJ_QTDREP	Numeric	09	Quantidade Reprogramação
TJ_MOTREPR	String	04	Motivo da Reprogramação
TJ_CUSTFER	Numeric	09	Custo de Ferramentas
TJ_OSORIG	String	06	O.S. Orig.
TJ_AS	String	27	Nr. A.S.
TJ_PROJETO	String	22	Numero do projeto
TJ_OBRA	String	03	Obra

Bloco de código

language	js
theme	Eclipse
title	Json

	"order": {
        "TJ_ORDEM  ": "000722",
        "TJ_PLANO  ": "000000",
        "TJ_DTORIGI": "20231207",
        "TJ_TIPOOS ": "B",
        "TJ_CODBEM ": "BEM MNT 010     ",
        "TJ_NOMBEM ": "BEM MNT 010",
        "TJ_SERVICO": "CORPAD",
        "TJ_NOMSERV": "CORRETIVA PADRAO",
        "TJ_SEQRELA": "0  ",
        "TJ_TIPO   ": "COR",
        "TJ_NOMTIPO": "CORRETIVA",
        "TJ_CODAREA": "BOR   ",
        "TJ_NOMAREA": "BORRACHARIA",
        "TJ_CCUSTO ": "MNT000003",
        "TJ_NOMCUST": "",
        "TJ_POSCONT": 0,
        "TJ_HORACO1": "     ",
        "TJ_CUSTMDO": 0,
        "TJ_CUSTMAT": 0,
        "TJ_CUSTMAA": 0,
        "TJ_CUSTMAS": 0,
        "TJ_CUSTTER": 0,
        "TJ_DTULTMA": "        ",
        "TJ_COULTMA": 0,
        "TJ_DTPPINI": "        ",
        "TJ_HOPPINI": "     ",
        "TJ_DTPPFIM": "        ",
        "TJ_HOPPFIM": "     ",
        "TJ_DTPRINI": "        ",
        "TJ_HOPRINI": "     ",
        "TJ_DTPRFIM": "        ",
        "TJ_HOPRFIM": "     ",
        "TJ_DTMPINI": "20231207",
        "TJ_HOMPINI": "09:29",
        "TJ_DTMPFIM": "20231207",
        "TJ_HOMPFIM": "10:29",
        "TJ_DTMRINI": "        ",
        "TJ_HOMRINI": "     ",
        "TJ_DTMRFIM": "        ",
        "TJ_HOMRFIM": "     ",
        "TJ_COULTM2": 0,
        "TJ_POSCON2": 0,
        "TJ_TERMINO": "N",
        "TJ_USUARIO": "Administrador            ",
        "TJ_PRIORID": "ZZZ",
        "TJ_HORACO2": "  :  ",
        "TJ_SITUACA": "L",
        "TJ_CENTRAB": "      ",
        "TJ_NOMTRAB": "",
        "TJ_TIPORET": "S",
        "TJ_ORDEPAI": "      ",
        "TJ_BEMPAI ": "                ",
        "TJ_NOMEPAI": "",
        "TJ_SUBSTIT": "                                                                                                    ",
        "TJ_OBSERVA": "                                                  ",
        "TJ_SOLICI ": "      ",
        "TJ_IRREGU ": "   ",
        "TJ_NIRREGU": "",
        "TJ_TERCEIR": "1",
        "TJ_QTDREP ": 0,
        "TJ_MOTREPR": "    ",
        "TJ_CUSTFER": 0,
        "TJ_OSORIG ": "      ",
        "TJ_AS     ": "                           ",
        "TJ_PROJETO": "                      ",
        "TJ_OBRA   ": "   "
    }

Card

id	1
label	Insumos

Lista dos campos referentes aos Insumos da O.S. (Tabela STL).

Campo	Tipo	Tamanho	Descrição
TL_ORDEM	String	06	Ordem de Serviço
TL_PLANO	String	06	Plano de Manutenção
TL_SEQRELA	String	03	Sequencia do Retorno
TL_NOMSEQ	String	04	Tipo da Sequencia
TL_TAREFA	String	06	Código da Tarefa
TL_NOMTAR	String	20	Nome da tarefa
TL_TIPOREG	String	01	Código do Tipo de Insumo
TL_NOMTREG	String	11	Nome do tipo insumo
TL_CODIGO	String	30	Código do Detalhe
TL_NOMCODI	String	20	Nome do insumo
TL_USACALE	String	01	Usa calendário
TL_QUANREC	Numeric	03	Quantidade do Recurso
TL_QUANTID	Numeric	09	Quantidade Utilizada
TL_UNIDADE	String	02	Unidade Consumo Recurso
TL_CUSTO	Numeric	14	Custo do Recurso
TL_DESTINO	String	01	Destino do Produto
TL_DTINICI	String	08	Data Inicio do Retorno
TL_HOINICI	String	05	Hora Inicio do Retorno
TL_DTFIM	String	08	Data Fim do Retorno
TL_HOFIM	String	05	Hora Fim do Retorno
TL_PCTHREX	Numeric	06	Percentual Hora Extra
TL_NUMSEQ	String	06	Numero da Sequencia
TL_LOCAL	String	02	Código do Almoxarifado
TL_LOTECTL	String	10	Lote
TL_NUMLOTE	String	06	Sub-Lote
TL_DTVALID	String	08	Data de Validade do Lote
TL_LOCALIZ	String	15	Localização Física
TL_NUMSERI	String	20	Num de Serie do Produto
TL_ETAPA	String	06	Etapa do Insumo
TL_NOMETAP	String	20	Nome da Etapa
TL_GARANTI	String	01	Insumo Tem Garantia
TL_LOCAPLI	String	06	Local Aplicação do Insumo
TL_NOMLOCA	String	40	Nome Local Aplicação
TL_NUMSC	String	06	Numero da Solic.de Compra
TL_ITEMSC	String	04	Item da Solicitação
TL_OBSERVA	String	10	Observações do Retorno
TL_POSCONT	Numeric	09	Posição do Contador
TL_POSCON2	Numeric	09	Posição Segundo Contador
TL_NOTFIS	String	09	Numero da Nota Fiscal
TL_SERIE	String	03	Serie da Nota Fiscal
TL_FORNEC	String	06	Código do Fornecedor
TL_LOJA	String	02	Código da Loja
TL_NUMSA	String	06	Num. Solicitação Armazém
TL_ITEMSA	String	02	Item Solicitação Armazém
TL_SEQTARE	String	03	Sequencia da Tarefa
TL_PERMDOE	Numeric	06	Perc. MDO Executada
TL_CODAEN	String	08	Código AEN
TL_AS	String	01	Faturar ?

Bloco de código

language	js
theme	Eclipse
title	Json

 "inputs": {
                "TL_ORDEM  ": "000722",
                "TL_PLANO  ": "000000",
                "TL_SEQRELA": "0  ",
                "TL_NOMSEQ ": "PLAN",
                "TL_TAREFA ": "0     ",
                "TL_NOMTAR ": "SEM ESPECIFICACAO DE TAREFA",
                "TL_TIPOREG": "M",
                "TL_NOMTREG": "FUNCIONARIO",
                "TL_CODIGO ": "1234                          ",
                "TL_NOMCODI": "FUNCIONARIO 1234",
                "TL_USACALE": "N",
                "TL_QUANREC": 0,
                "TL_QUANTID": 1,
                "TL_UNIDADE": "H ",
                "TL_CUSTO  ": 0,
                "TL_DESTINO": " ",
                "TL_DTINICI": "20231207",
                "TL_HOINICI": "09:29",
                "TL_DTFIM  ": "20231207",
                "TL_HOFIM  ": "10:29",
                "TL_PCTHREX": 0,
                "TL_NUMSEQ ": "      ",
                "TL_LOCAL  ": "  ",
                "TL_LOTECTL": "          ",
                "TL_NUMLOTE": "      ",
                "TL_DTVALID": "        ",
                "TL_LOCALIZ": "               ",
                "TL_NUMSERI": "                    ",
                "TL_ETAPA  ": "      ",
                "TL_NOMETAP": "",
                "TL_GARANTI": "N",
                "TL_LOCAPLI": "      ",
                "TL_NOMLOCA": "",
                "TL_NUMSC  ": "      ",
                "TL_ITEMSC ": "    ",
                "TL_OBSERVA": " ",
                "TL_POSCONT": 0,
                "TL_POSCON2": 0,
                "TL_NOTFIS ": "         ",
                "TL_SERIE  ": "   ",
                "TL_FORNEC ": "      ",
                "TL_LOJA   ": "  ",
                "TL_NUMSA  ": "      ",
                "TL_ITEMSA ": "  ",
                "TL_SEQTARE": "001",
                "TL_PERMDOE": 0,
                "TL_CODAEN ": "        ",
                "TL_AS     ": " "
            }

Card

id	2
label	Ocorrência do Insumo

Lista dos campos referentes às Ocorrências (Tabela STN).

Campo	Tipo	Tamanho	Descrição
TN_ORDEM	String	06	Ordem de Serviço
TN_PLANO	String	06	Plano de Manutenção
TN_TAREFA	String	06	Código da Tarefa
TN_NOMETAR	String	20	Descrição da Tarefa
TN_CODOCOR	String	06	Código da Ocorrência
TN_NOMOCOR	String	20	Descrição do Problema.
TN_CAUSA	String	06	Código da Causa
TN_NOMCAUS	String	20	Descrição da Causa
TN_SOLUCAO	String	06	Solução da Ocorrência
TN_NOMSOLU	String	20	Descrição da Solução
TN_DESCRIC	String	10	Descrição da Ocorrência

Bloco de código

language	js
theme	Eclipse
title	Json

 "ocurrences": [
        {
        	"TN_ORDEM  ": "000722",
            "TN_PLANO  ": "000000",
            "TN_TAREFA ": "0     ",
            "TN_NOMETAR": "SEM ESPECIFICACAO DE TAREFA",
            "TN_CODOCOR": "033006",
            "TN_NOMOCOR": "OCORRENCIA 033006",
            "TN_CAUSA  ": "033001",
            "TN_NOMCAUS": "OCORRENCIA 033001",
            "TN_SOLUCAO": "MNT003",
            "TN_NOMSOLU": "OCORRENCIA MNT 003",
            "TN_DESCRIC": ""
        }

Card

id	3
label	Sintomas

Lista dos campos referentes aos Sintomas (Tabela TTC).

Campo	Tipo	Tamanho	Descrição
TTC_CODBEM	String	16	Código do Bem
TTC_ORDEM	String	06	Ordem de Serviço
TTC_PLANO	String	06	Plano de Manutenção
TTC_DATA	String	08	Data da O.S.
TTC_CDSINT	String	06	Código do Sintoma
TTC_DESSIN	String	20	Descrição do Sintoma

Bloco de código

language	js
theme	Eclipse
title	Json

 "symptoms": [
        {   "TTC_CODBEM": "BEM MNT 010     ",
            "TTC_ORDEM ": "000722",
            "TTC_PLANO ": "000000",
            "TTC_DATA  ": "20231207",
            "TTC_CDSINT": "003   ",
            "TTC_DESSIN": "DESNIVEL NO EIXO"         
		}

Card

id	4
label	Checklists

Lista dos campos referentes aos CheckLists (Tabela STN).

Campo	Tipo	Tamanho	Descrição
TQ_ORDEM	String	06	Ordem de Serviço
TQ_PLANO	String	06	Plano de Manutenção
TQ_TAREFA	String	06	Tarefa da Manutenção
TQ_NOMTARE	String	20	Nome da Tarefa
TQ_ETAPA	String	06	Código da Etapa da Tarefa
TQ_NOMSITU	String	04	Tipo da Etapa
TQ_NOMETAP	String	150	Descrição da Etapa
TQ_CODFUNC	String	06	Matricula do Funcionário
TQ_SEQETA	String	03	Sequencia da Etapa
TQ_SEQTARE	String	03	Sequencia da Tarefa
TQ_OBSERVA	String	10	Observação da Etapa

Bloco de código

language	js
theme	Eclipse
title	Json

"checklists": [
        {
            "fields": {
                "TQ_ORDEM  ": "000722",
                "TQ_PLANO  ": "000000",
                "TQ_TAREFA ": "0     ",
                "TQ_NOMTARE": "SEM ESPECIFICACAO DE TAREFA",
                "TQ_ETAPA  ": "ETA001",
                "TQ_NOMSITU": "EXEC",
                "TQ_NOMETAP": "ETAPA GENERICA 001",
                "TQ_CODFUNC": "      ",
                "TQ_SEQETA ": "   ",
                "TQ_SEQTARE": "   ",
                "TQ_OBSERVA": " "
            }
        }

Card

id	5
label	Resposta das checklists

Lista dos campos referentes às Resposta das checklists(Tabela TPQ).

Campo	Tipo	Tamanho	Descrição
TPQ_ORDEM	String	06	Ordem de Serviço
TPQ_PLANO	String	06	Plano de Manutenção
TPQ_TAREFA	String	06	Tarefa da Manutenção
TPQ_ETAPA	String	20	Etapa da tarefa manutenc.
TPQ_OPCAO	String	06	Opção da Etapa
TPQ_RESPOS	String	04	Resposta da Opção da Etapa
TPQ_ORDEMG	String	150	Ordem Serviço Gerada
TPQ_CODFUN	String	03	Código do Funcionário
TPQ_NOME	String	03	Nome do Funcionário
TPQ_OBSERV	String	10	Mensagem de Alerta

Bloco de código

language	js
theme	Eclipse
title	Json

"answers": [
    {
    	"TPQ_ORDEM ": "000723",
        "TPQ_PLANO ": "000000",
        "TPQ_TAREFA": "0     ",
        "TPQ_ETAPA ": "ETP-02",
        "TPQ_OPCAO ": "1              ",
        "TPQ_RESPOS": "  ",
        "TPQ_ORDEMG": "  ",
        "TPQ_CODFUN": "  ",
        "TPQ_NOME  ": "  ",
        "TPQ_OBSERV": "  "
    }

Card

id	6
label	Motivo de Atraso

Lista dos campos referentes aos Motivos de Atraso(Tabela TPL).

Campo	Tipo	Tamanho	Descrição
TPL_ORDEM	String	06	Ordem de Serviço
TPL_CODMOT	String	04	Codigo do Motivo
TPL_DESMOT	String	40	Descricao Motivo
TPL_DTINIC	String	08	Data Inicio do Atraso
TPL_HOINIC	String	05	Hora Inicio do Atraso
TPL_DTFIM	String	08	Data Termino do Atraso
TPL_HOFIM	String	05	Hora Termino do Atraso

Bloco de código

language	js
theme	Eclipse
title	Json

"reasonsForDelay": [
        {
            "TPL_ORDEM ": "000722",
            "TPL_CODMOT": "02  ",
            "TPL_DESMOT": "MOTIVO GENERICO",
            "TPL_DTINIC": "20231209",
            "TPL_HOINIC": "07:00",
            "TPL_DTFIM ": "20231209",
            "TPL_HOFIM ": "08:00"
        }

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",
   "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":[
      {
         "operation":"C",
         "task":"0",
         "destiny":"A",
         "code":"COM000000000000000000000000011",
         "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",
		 "amount": 2
      }
   ]
}

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

Campo

Descrição

Tipo

equipment

TJ_CODBEM

Código do equipamento. Chave obrigatória na inclusão de ordens para bens.

string

service

TJ_SERVICO

Código do serviço. Chave obrigatória.

string

startDate

TJ_DTORIGI (na inclusão),

TJ_DTMPINI,

TJ_HOMPINI

Data e hora inicial. Chave obrigatória.

string

endDate

TJ_DTMPFIM, TJ_HOMPFIM

Data e hora final. Chave obrigatória.

string

code

TJ_ORDEM

Código da ordem de serviço. Chave obrigatória na alteração e exclusão.

string

plan

TJ_PLANO

Código do plano. Chave obrigatória na alteração e exclusão.

Informações
Para as ordens geradas, o código do plano para corretivas será '000000' e para preventivas '000001'.

string

type

Não possui

Indica o tipo da ordem. Chave obrigatória na inclusão.

C=Corretiva

P=Preventiva

string

location

TJ_CODBEM

Código da localização. Chave obrigatória na inclusão de ordens para localizações.

observation

TJ_OBSERVA

Descrição.

string

sequence

TJ_SEQRELA

Sequência da ordem. Caso não existir será considerado '0'.

counter

Não possui

Contadores do bem.

array de objetos

checklist

Não possui

Etapas.

array de objetos

inputs

Não possui

Insumos.

array de objetos

Chave

Campo

Descrição

datetime

TP_DTLEITU

TP_HORA

Data e hora do contador

value

TP_POSCONT

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

Campo

Descrição

task

TQ_TAREFA

Código da tarefa.

step

TQ_ETAPA

Código da etapa.

isDone

TQ_OK

Se a etapa está executada (true) ou prevista (false)

Aviso
Na alteração o objeto de etapas deve conter todas as etapas da ordem de serviço. As etapas gravadas da tabela STQ que não contemplarem o objeto serão excluídas.

Chaves dos insumos (objeto inputs)

Chave

Campo

Descrição

Tipo

operation

Não possui

Tipo da operação. Chave obrigatória (caso não existir será considerado uma inclusão):

C=Create;

U=Update;

D=Delete.

string

isDone

Não possui

Indica se o insumo é realizado. Chave obrigatória.

boolean

sequence

TL_SEQRELA

Sequência do insumo já aplicado. Chave é obrigatória na alteração e exclusão.

string

task

TL_TAREFA

Código da tarefa. Chave obrigatória (na inclusão caso não existir será considerado o valor '0').

Informações
O valor desta chave pode ser utilizada para alteração do campo caso necessário.

keyTask

TL_TAREFA

Código da tarefa. Chave obrigatória na alteração e exclusão.

Informações
O valor desta chave é utilizada para busca do insumo a ser alterado ou excluído.

string

code

TL_CODIGO

Código do insumo. Chave obrigatória na operação create. Chave utilizada na operação update para alteração da tarefa.

Informações
O valor desta chave pode ser utilizada para alteração do campo caso necessário.

keyCode

TL_CODIGO

Chave código do insumo. Chave obrigatória na alteração e exclusão.

Informações
O valor desta chave é utilizada para busca do insumo a ser alterado ou excluído.

string

type

TL_TIPOREG

Tipo do insumo. Chave obrigatória

string

unity

TL_UNIDADE

Unidade de consumo do recurso.

string

destiny

TL_DESTINO

Destino. Chave obrigatória para insumos do tipo produto.

A=Apoio;

T=Troca;

S=Substituição.

string

resourceAmount

TL_QUANREC

Quantidade de recurso. Chave obrigatória para insumos do tipo especialidade.

string

startDate

TL_DTINICI

TL_HOINICI

Data e hora inicial. Chave obrigatória.

string

endDate

TL_DTFIM

TL_DTINICI

Data e hora final. Chave obrigatória

string

Informações adicionais:

Integração via API; https://www.totvs.com/blog/inovacoes/integracao-via-api/
API reference Totvs; https://api.totvs.com.br/;
Caso esteja ocorrendo algum problema, verificar a seção de dúvidas frequentes, no link http://tdn.totvs.com/x/J4HpDw.

Árvore de páginas

Versões comparadas

Versão antiga 78

Nova versão 79

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: http://enderecoserver:portarest/rest/mntorder/order/value

Tipo: GET

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