Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Ordem
Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue
Card
labelSolicitação de Serviço
Deck of Cards
startHiddenfalse
id0
effectTypefade
loopCardstrue
Card
id0
labelInclusã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..

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
locationLogic-Define se é para bem ou localizaçãoCondicionalTQB_TIPOSS
originString20Origem de RegistroSimTQB_ORIGEM
equipmentString16Código do Bem/LocalizaçãoSimTQB_CODBEM
descriptionString999Descrição da SolicitaçãoSimTQB_DESCSS
costCenterString20Código do Centro de Custo da S.S.NãoTQB_CCUSTO
counterNumeric09Primeiro Contador do EquipamentoCondicionalTQB_POSCON
secondCounterNumeric09Segundo Contador do EquipamentoCondicionalTQB_POSCO2
telephoneExtensionString10RamalCondicionalTQB_RAMAL
serviceTypeString06Código do Serviço da S.S.NãoTQB_CDSERV
priorityString01PrioridadeNãoTQB_PRIORI

Exemplo de uma requisição básica:

Header

Bloco de código
languagejs
firstline1
titleExemplo Header
curl --request POST \
--url http://localhost:8090/rest/mntsrws/api/v1/request \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: MNT' \


Body

Bloco de código
languagejs
themeEclipse
titleRaw
{
	"equipment":"001",
	"dateTime":"20220419 13:00",
	"description":"Não esta refrigerando",
	"serviceType": "000001",
	"telephoneExtension": "569",
	"counter":2300,
	"secondCounter":550,
	"location":true
}
Nota
titleAtençã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
id1
labelDistribuiçã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.:

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
executorString25Define se é para bem ou localizaçãoCondicionalTQB_CDEXEC
serviceTypeString20Origem de RegistroSimTQB_CDSERV


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

Header

Bloco de código
languagejs
firstline1
titleExemplo de Header
curl --request PUT \
--url http://localhost:8090/rest/mntsrws/api/v1/request/000298/distribute \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: MNT' \


Body

Bloco de código
languagejs
themeEclipse
titleRaw
{   
    "executor":"000000",
    "serviceType":"000001"
}
Card
id1
labelInclusã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.:

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
locationLogic-Define se é para bem ou localizaçãoCondicionalTJ_TIPOOS
originString20Origem de RegistroSimTQB_ORIGEM
equipmentString16Código do Bem/LocalizaçãoSimTJ_CODBEM
costCenterString20Código do Centro de Custo da O.S.SimTJ_CCUSTO
startDateString08(data) + 05(hora)Data e Hora da abertura da O.S.( 20220419 13:00 )SimTJ_DTORIGI / TJ_HOMPINI / TJ_HORACO1 / TJ_HORACO2
service  String20Código do serviço da O.S.SimTJ_SERVICO
situationNumeric09Situação da O.S. ( P = Pendente / L = Liberada )SimTJ_SITUACA
counterNumeric09Primeiro Contador do EquipamentoCondicionalTJ_POSCON
secondCounterNumeric09Segundo Contador do EquipamentoCondicionalTJ_POSCO2
workCenterNumeric09Código do Centro de TrabalhoNãoTJ_CENTRAB
sequenceString10Sequência da ManutençãoNãoTJ_SEQRELA
downTimeString06Data e Hora de Para inicio do bem da O.S.( 20220430 11:00 )NãoTJ_DTPRINI / TJ_HOPRINI
inputs array999Array de Insumos previstos da O.S.Não-

Inputs

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

CampoTipoTamanhoDescriçãoObrigatórioCampo Referência
operationString01C = Inclusão do InsumoSim-
taskString06Código da TarefaSimTL_TAREFA
typeString01Tipo de InsumoSimTL_TIPOREG
codeString30Código do InsumoSimTL_CODIGO
unityString02Unidade do InsumoSimTL_UNIDADE
amountNumeric09Quantidade do InsumoSimTL_QUANTID
isDoneLogic-Define se é Insumo previsto ou realizadoSim-
dateString08(data) + 05(hora)Data e Hora inicio previsto para o insumoSimTL_DTINICI / TL_HOINICI
destinyString01Destino do insumoCondicionalTL_DESTINO
resourceAmountNumeric03Quantidade do recursoCondicionalTL_QUANREC
warehouseString06AlmoxarifadoCondicionalTL_LOCAL
noteString             10Observações (MEMO)Condicional          TL_OBSERVA

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


Header

Bloco de código
languagejs
themefirstlineEclipse1
titleRawExemplo de Header
curl --request PUT \
--url http://localhost:8090/rest/mntsrws/api/v1/request/000298/order \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: MNT' \


Body

Bloco de código
languagejs
themeEclipse
titleRaw
{   
    "equipment":"CLIO",
    "service":"CORGEN",
    "situation": "L",
    "costCenter": "{   
    "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
languagejs
themeEclipse
titleRaw
{  
    "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
titleAtençã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
labelAbastecimento
Deck of Cards
id0
effectTypefade
loopCardstrue
Card
id0
labelInclusã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.

Header


Bloco de código
languagejs
firstline1
titleExemplo de Header
curl --request POST \
--url http://localhost:8090/rest/mntFuelUp/api/v1/fuelup \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: GFR' \

Body

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

CampoTipoTamanhoDescriçãoObrigatório
TQN_PLACAString8Placa do VeículoSim
TQN_FROTAString
CampoTipoTamanhoDescriçãoObrigatório
TQN_PLACAString8Placa do VeículoSim
TQN_FROTAString16Código do VeículoSim
TQN_CODCOMString03Código do CombustívelSim
TQN_POSTOString14Código do postoSim
TQN_LOJAString14Código do lojaSim
TQN_CNPJString14CNPJ do postoNão
TQN_DTABASDate08Data do abastecimentoSim
TQN_HRABASString05Hora da abastecimentoSim
TQN_TANQUEString02tanque do postoSim
TQN_BOMBAString03bomba do postoSim
TQN_QUANTNumeric09quantidade abastecidaSim
TQN_VALUNINumeric09valor unitário do combustívelSim
TQN_VALTOTNumeric15valor total do combustívelSim
TQN_HODOMNumeric09Contador do equipamentoCondicional
TQN_POSCO2Numeric09Segundo Contador do equipamentoCondicional
TQN_CODMOTString06Código do motoristaCondicional
TQN_NOTFISString09Código da nota fiscalCondicional
TQN_CODVIAString06Código da viagemCondicional
TQN_ESCALAString08Código da escalaCondicional


Exemplo de um abastecimento padrão:

Bloco de código
languagejs
themeEclipse
titleRaw
{
   "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
titleAtençã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.

Header


Card
labelAlteraçã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.

CampoTipoTamanhoDescriçãoObrigatório
TQN_FROTAString16Código do VeículoSim
TQN_DTABASString08Data do abastecimentoSim
TQN_HRABASString05Hora da abastecimentoSim
Bloco de código
languagejs
themefirstlineEclipse1
titleRaw
{
   "TQN_FROTA":"VEI-S10",
   "TQN_DTABAS":"20230320",
   "TQN_HRABAS":"12:10"
}
Card
labelDeleção de Abastecimento
Exemplo de Header
linenumberstrue
curl --request PUT \
--url http://localhost:8090/rest/mntFuelUp/api/v1/fuelup \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: GFR' \

Body

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

CampoTipo

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.

CampoTipoTamanhoDescriçãoObrigatório
TQN_FROTAString16Código do VeículoSim
TQN_DTABASString08Data do abastecimentoSim
TQN_HRABASString05Hora da abastecimentoSim
Bloco de código
languagejs
themeEclipse
titleRaw
{
   "TQN_FROTA":"VEI-S10",
    "TQN_DTABAS":"20230320",
   "TQN_HRABAS":"12:10"
 }
Card
idOS
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: 

Header


Bloco de código
languagejs
firstline1
titleExemplo de Header
linenumberstrue
curl --request DELETE \
--url http://localhost:8090/rest/mntFuelUp/api/v1/fuelup \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: GFR' \

Body

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

CampoTipoTamanhoDescriçãoObrigatório
TQN_FROTAString16Código do VeículoSim
TQN_DTABASString08Data do abastecimentoSim
TQN_HRABASString05Hora da abastecimentoSim
Bloco de código
languagejs
themeEclipse
titleRaw
{
   "TQN_FROTA":"VEI-S10",
   "TQN_DTABAS":"20230320",
   "TQN_HRABAS":"12:10"
 }
Serviço
Card
idOS
labelOrdem de Serviço
Deck of Cards
idoperation
Card
id1
labelDetalhes 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;
  • Consultar 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.

Header


Bloco de código
languagejs
firstline1
titleExemplo de Header
linenumberstrue
curl --request DELETE \
--url http://localhost:8090/rest/mntorder/order/000722 \
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: MNT' \
Deck of Cards
idorder
Card
id0
labelOrdem de Serviço

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

CampoTipoTamanhoDescrição
TJ_ORDEMString06Numero da Ordem Serviço  
TJ_PLANOString06Numero do Plano de Manut.
TJ_DTORIGIString08Data Original Ordem Serv.
TJ_TIPOOSString01Tipo da Ordem de Serviço 
TJ_CODBEMString16Código do Bem            
TJ_NOMBEMString20Nome do Bem
TJ_SERVICOString06Código do Serviço
TJ_NOMSERVString20Nome do Serviço          
TJ_SEQRELAString03Sequencia da Manutenção  
TJ_TIPOString03Código do Tipo de Manut. 
TJ_NOMTIPOString20Nome do Tipo Manutenção  
TJ_CODAREAString06Código da Área de Manut. 

TJ_NOMAREA

String20Nome da Área de Manutenção

TJ_CCUSTO

String09Código do Centro de Custo

TJ_NOMCUST

String20Nome do centro de Custo  

TJ_POSCONT

Numeric09Posição do Contador      

TJ_HORACO1

String05Hora leitura cont. 1     

TJ_CUSTMDO

Numeric09Custo Total Mao de Obra  

TJ_CUSTMAT

Numeric09Custo Materiais de Troca 

TJ_CUSTMAA

Numeric09Custo de Materiais Apoio  

TJ_CUSTMAS

Numeric09Custo Mater. Substituição

TJ_CUSTTER

Numeric09Custo de Terceiros       

TJ_DTULTMA

String08Data da Ultima Manutenção

TJ_COULTMA

Numeric12Contador na Ultima Manut.

TJ_DTPPINI

String08Data Inicio Parada Prev. 

TJ_HOPPINI

String05Hora Inicio Parada Prev. 

TJ_DTPPFIM

String08Data Fim Parada Prevista 

TJ_HOPPFIM

String05Hora Fim Parada Prevista 

TJ_DTPRINI

String08Data Inicio Parada Real  

TJ_HOPRINI

String05Hora Inicio Parada Real  

TJ_DTPRFIM

String08Data Fim de Parada Real  

TJ_HOPRFIM

String05Hora Fim de Parada Real  

TJ_DTMPINI

String08Data Inicio Manut. Prev. 

TJ_HOMPINI

String05Hora Inicio Manut. Prev. 

TJ_DTMPFIM

String08Data Fim Manut. Prev.    

TJ_HOMPFIM

String05Hora Fim Manut. Prev     

TJ_DTMRINI

String08Data Inicio Manut. Real  

TJ_HOMRINI

String05Hora Inicio Manut. Real  

TJ_DTMRFIM

String08Data Fim de Manut. Real  

TJ_HOMRFIM

String05Hora Fim de Manut. Real  

TJ_COULTM2

Numeric09Contador na Ultima Manut.

TJ_POSCON2

Numeric09Posição do 2. Contador   

TJ_TERMINO

String01Indica Termino da O.S.   

TJ_USUARIO

String25Usuário Ultima Alteração 

TJ_PRIORID

String03Prioridade da Manutenção 

TJ_HORACO2

String05Hora leitura cont. 2     

TJ_SITUACA

String01Situação da Ordem Serviço

TJ_CENTRAB

String06Centro de Trabalho       

TJ_NOMTRAB

String20Nome do centro de trabalho

TJ_TIPORET

String01Indicação Tipo Retorno   

TJ_ORDEPAI

String06Numero da Ordem do Pai   

TJ_BEMPAI

String16Código do Bem Pai        

TJ_NOMEPAI

String20Nome do bem Pai          

TJ_SUBSTIT

String100Substituição de O.S.     

TJ_OBSERVA

String10Observação               

TJ_SOLICI

String06Solicitação Serv. Origem  

TJ_IRREGU

String03Código da Irregularidade 

TJ_NIRREGU

String40Irregularidade           

TJ_TERCEIR

String01Enviado para Terceiro    

TJ_QTDREP

Numeric09Quantidade Reprogramação 

TJ_MOTREPR

String04Motivo da Reprogramação  

TJ_CUSTFER

Numeric09Custo de Ferramentas     

TJ_OSORIG

String06O.S. Orig.               

TJ_AS

String27Nr. A.S.                 

TJ_PROJETO

String22Numero do projeto        

TJ_OBRA

String03Obra                     
Bloco de código
languagejs
themeEclipse
titleJson
	"order": {

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.

Deck of Cards
idoperation
Card
id1
labelDetalhes 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
idorder
Card
id0
labelOrdem de Serviço

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

CampoTipoTamanhoDescrição
TJ_ORDEMString06Numero da Ordem Serviço  
TJ_PLANOString06Numero do Plano de Manut.
TJ_DTORIGIString08Data Original Ordem Serv.
TJ_TIPOOSString01Tipo da Ordem de Serviço 
TJ_CODBEMString16Código do Bem            
TJ_NOMBEMString20Nome do Bem
TJ_SERVICOString06Código do Serviço
TJ_NOMSERVString20Nome do Serviço          
TJ_SEQRELAString03Sequencia da Manutenção  
TJ_TIPOString03Código do Tipo de Manut. 
TJ_NOMTIPOString20Nome do Tipo Manutenção  
TJ_CODAREAString06Código da Área de Manut. 

TJ_NOMAREA

String20Nome da Área de Manutenção

TJ_CCUSTO

String09Código do Centro de Custo

TJ_NOMCUST

String20Nome do centro de Custo  

TJ_POSCONT

Numeric09Posição do Contador      

TJ_HORACO1

String05Hora leitura cont. 1     

TJ_CUSTMDO

Numeric09Custo Total Mao de Obra  

TJ_CUSTMAT

Numeric09Custo Materiais de Troca 

TJ_CUSTMAA

Numeric09Custo de Materiais Apoio  

TJ_CUSTMAS

Numeric09Custo Mater. Substituição

TJ_CUSTTER

Numeric09Custo de Terceiros       

TJ_DTULTMA

String08Data da Ultima Manutenção

TJ_COULTMA

Numeric12Contador na Ultima Manut.

TJ_DTPPINI

String08Data Inicio Parada Prev. 

TJ_HOPPINI

String05Hora Inicio Parada Prev. 

TJ_DTPPFIM

String08Data Fim Parada Prevista 

TJ_HOPPFIM

String05Hora Fim Parada Prevista 

TJ_DTPRINI

String08Data Inicio Parada Real  

TJ_HOPRINI

String05Hora Inicio Parada Real  

TJ_DTPRFIM

String08Data Fim de Parada Real  

TJ_HOPRFIM

String05Hora Fim de Parada Real  

TJ_DTMPINI

String08Data Inicio Manut. Prev. 

TJ_HOMPINI

String05Hora Inicio Manut. Prev. 

TJ_DTMPFIM

String08Data Fim Manut. Prev.    

TJ_HOMPFIM

String05Hora Fim Manut. Prev     

TJ_DTMRINI

String08Data Inicio Manut. Real  

TJ_HOMRINI

String05Hora Inicio Manut. Real  

TJ_DTMRFIM

String08Data Fim de Manut. Real  

TJ_HOMRFIM

String05Hora Fim de Manut. Real  

TJ_COULTM2

Numeric09Contador na Ultima Manut.

TJ_POSCON2

Numeric09Posição do 2. Contador   

TJ_TERMINO

String01Indica Termino da O.S.   

TJ_USUARIO

String25Usuário Ultima Alteração 

TJ_PRIORID

String03Prioridade da Manutenção 

TJ_HORACO2

String05Hora leitura cont. 2     

TJ_SITUACA

String01Situação da Ordem Serviço

TJ_CENTRAB

String06Centro de Trabalho       

TJ_NOMTRAB

String20Nome do centro de trabalho

TJ_TIPORET

String01Indicação Tipo Retorno   

TJ_ORDEPAI

String06Numero da Ordem do Pai   

TJ_BEMPAI

String16Código do Bem Pai        

TJ_NOMEPAI

String20Nome do bem Pai          

TJ_SUBSTIT

String100Substituição de O.S.     

TJ_OBSERVA

String10Observação               

TJ_SOLICI

String06Solicitação Serv. Origem  

TJ_IRREGU

String03Código da Irregularidade 

TJ_NIRREGU

String40Irregularidade           

TJ_TERCEIR

String01Enviado para Terceiro    

TJ_QTDREP

Numeric09Quantidade Reprogramação 

TJ_MOTREPR

String04Motivo da Reprogramação  

TJ_CUSTFER

Numeric09Custo de Ferramentas     

TJ_OSORIG

String06O.S. Orig.               

TJ_AS

String27Nr. A.S.                 

TJ_PROJETO

String22Numero do projeto        

TJ_OBRA

String03Obra                     
Bloco de código
languagejs
themeEclipse
titleJson
	"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_POSCONTORDEM  ": 0"000722",
        "TJ_HORACO1PLANO  ": "     000000",
        "TJ_CUSTMDODTORIGI": 0"20180620",
        "TJ_CUSTMATTIPOOS ": 0"B",
        "TJ_CUSTMAACODBEM ": 0"BEM MNT 010     ",
        "TJ_CUSTMASNOMBEM ": 0 "BEM MNT 010",
        "TJ_CUSTTERSERVICO": 0"CORPAD",
        "TJ_DTULTMANOMSERV": "        CORRETIVA PADRAO",
        "TJ_COULTMASEQRELA": "0  ",
        "TJ_DTPPINITIPO   ": "        COR",
        "TJ_HOPPININOMTIPO": "     CORRETIVA",
        "TJ_DTPPFIMCODAREA": "BOR        ",
        "TJ_HOPPFIMNOMAREA": "     BORRACHARIA",
        "TJ_DTPRINICCUSTO ": "        CC_MNTSO ",
        "TJ_HOPRININOMCUST": "CENTRO DE CUSTO CLASSE  MN",
        "TJ_DTPRFIMPOSCONT": "1000,
        "TJ_HORACO1": "09:00",
        "TJ_HOPRFIMCUSTMDO": " 0,
        "TJ_CUSTMAT": 0,
        "TJ_DTMPINICUSTMAA": 0,
        "20231207"TJ_CUSTMAS": 0,
        "TJ_HOMPINICUSTTER": "09:29"0,
        "TJ_DTMPFIMDTULTMA": "2023120720180101",
        "TJ_HOMPFIMCOULTMA": "10:29"0,
        "TJ_DTMRINIDTPPINI": "        ",
        "TJ_HOMRINIHOPPINI": "     ",
        "TJ_DTMRFIMDTPPFIM": "        ",
        "TJ_HOMRFIMHOPPFIM": "     ",
        "TJ_COULTM2DTPRINI": 0"20180620",
        "TJ_POSCON2HOPRINI": 0"08:00",
        "TJ_TERMINODTPRFIM": "N20180620",
        "TJ_USUARIOHOPRFIM": "Administrador09:00",
            ""TJ_DTMPINI": "20180620",
        "TJ_PRIORIDHOMPINI": "ZZZ16:57",
        "TJ_HORACO2DTMPFIM": "  :  20180620",
        "TJ_SITUACAHOMPFIM": "L16:57",
        "TJ_CENTRABDTMRINI": "      20180620",
        "TJ_NOMTRABHOMRINI": "08:00",
        "TJ_TIPORETDTMRFIM": "S20180620",
        "TJ_ORDEPAIHOMRFIM": "      09:00",
        "TJ_BEMPAI COULTM2": "0,
                ""TJ_POSCON2": 1000,
        "TJ_NOMEPAITERMINO": "N",
        "TJ_SUBSTITUSUARIO": "Administrador            ",
        "TJ_PRIORID": "ZZZ",
            "TJ_HORACO2": "08:00",
        "TJ_SITUACA": "L",
        "TJ_CENTRAB": "MNTSO",
        "TJ_NOMTRAB": "CENTRO TRABALHO CLASSE MNTSO",
        "TJ_TIPORET": "S",
        "TJ_ORDEPAI": "      ",
        "TJ_BEMPAI ": "                ",
        "TJ_OBSERVANOMEPAI": "",
        "TJ_SUBSTIT": "                                           ",
        "TJ_SOLICI ": "      ",
        "TJ_IRREGU ": "                                 ",
        "TJ_NIRREGUOBSERVA": "Ordem de Serviço aberta pelo Check List Nº000005.",
        "TJ_TERCEIRSOLICI ": "1      ",
        "TJ_QTDREPIRREGU ": 0"MNT",
        "TJ_MOTREPRNIRREGU": "IRREGULARIDADE PADRAO   MNT",
        "TJ_CUSTFERTERCEIR": 0"1",
        "TJ_OSORIGQTDREP ": "      "0,
        "TJ_AS     MOTREPR": "    ",
        "TJ_CUSTFER": 0,
        "TJ_OSORIG ": "      ",
        "TJ_AS     ": "                           ",
        "TJ_PROJETO": "                      ",
        "TJ_OBRA   ": "   "
    }
Card
id1
labelInsumos

Lista dos campos referentes à Ordem de Serviço aos Insumos da O.S. (Tabela STL).

CampoTipoTamanhoDescrição
TL_ORDEMString06Ordem de Serviço
TL_PLANOString06Plano de Manutenção
TL_SEQRELAString03Sequencia do Retorno
TL_NOMSEQString04Tipo da Sequencia
TL_TAREFAString06Código da Tarefa
TL_NOMTARString20Nome da tarefa
TL_TIPOREGString01Código do Tipo de Insumo
TL_NOMTREGString11Nome do tipo insumo
TL_CODIGOString30Código do Detalhe
TL_NOMCODIString20Nome do insumo
TL_USACALEString01Usa calendário
TL_QUANRECNumeric03Quantidade do Recurso

TL_QUANTID

Numeric09Quantidade Utilizada

TL_UNIDADE

String02Unidade Consumo Recurso  

TL_CUSTO

Numeric14Custo do Recurso

TL_DESTINO

String01Destino do Produto

TL_DTINICI

String08Data Inicio do Retorno

TL_HOINICI

String05Hora Inicio do Retorno

TL_DTFIM

String08Data Fim do Retorno

TL_HOFIM

String05Hora Fim do Retorno

TL_PCTHREX

Numeric06Percentual Hora Extra

TL_NUMSEQ

String06Numero da Sequencia

TL_LOCAL

String02Código do Almoxarifado

TL_LOTECTL

String10Lote

TL_NUMLOTE

String06Sub-Lote

TL_DTVALID

String08Data de Validade do Lote

TL_LOCALIZ

String15Localização Física

TL_NUMSERI

String20Num de Serie do Produto

TL_ETAPA

String06Etapa do Insumo

TL_NOMETAP

String20Nome da Etapa

TL_GARANTI

String01Insumo Tem Garantia

TL_LOCAPLI

String06Local Aplicação do Insumo

TL_NOMLOCA

String40Nome Local Aplicação

TL_NUMSC

String06Numero da Solic.de Compra

TL_ITEMSC

String04Item da Solicitação

TL_OBSERVA

String10Observações do Retorno

TL_POSCONT

Numeric09Posição do Contador

TL_POSCON2

Numeric09Posição Segundo Contador 

TL_NOTFIS

String09Numero da Nota Fiscal

TL_SERIE

String03Serie da Nota Fiscal

TL_FORNEC

String06Código do Fornecedor

TL_LOJA

String02Código da Loja

TL_NUMSA

String06Num. Solicitação Armazém

TL_ITEMSA

String02Item Solicitação Armazém

TL_SEQTARE

String03Sequencia da Tarefa

TL_PERMDOE

Numeric06Perc. MDO Executada

TL_CODAEN

String08Código AEN

TL_AS

String01Faturar ?
Bloco de código
languagejs
themeEclipse
titleJson
 "inputs": [
	{
    	"fields": {
           	"TL_ORDEM  ": "000722000723",
                "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 ": "      109110",
                "TL_LOCAL  ": "  01",
                "TL_LOTECTL": "          ",
                "TL_NUMLOTE": "      ",
                "TL_DTVALID": "        ",
                "TL_LOCALIZ": "               ",
                "TL_NUMSERI": "                    ",
                "TL_ETAPA  ": "ETA001",
      ",
                 "TL_NOMETAP": "ETAPA GENERICA 001",
                "TL_GARANTI": "N",
                "TL_LOCAPLI": "      ",
                "TL_NOMLOCA": "",
                "TL_NUMSC  ": "      ZC0037",
                "TL_ITEMSC ": "    0001",
                "TL_OBSERVA": "Observação do insumo",
                "TL_POSCONT": 0,
                "TL_POSCON2": 0,
                "TL_NOTFIS ": "         ",
                "TL_SERIE  ": "   ",
                "TL_FORNEC ": "      MNT021",
                "TL_LOJA   ": "  01",
                "TL_NUMSA  ": "      ",
                "TL_ITEMSA ": "  ",
                "TL_SEQTARE": "001",
                "TL_PERMDOE": 0,
                "TL_CODAEN ": "        ",
                "TL_AS     ": " "
            }}
	}
]
Card
id2
labelOcorrência Ocorrências do Insumo

Lista dos campos referentes à Ordem de Serviço às Ocorrências (Tabela STN).

CampoTipoTamanhoDescrição
TN_ORDEMString06Ordem de Serviço         
TN_PLANOString06Plano de Manutenção      
TN_TAREFAString06Código da Tarefa         
TN_NOMETARString20Descrição da Tarefa      
TN_CODOCORString06Código da Ocorrência     
TN_NOMOCORString20Descrição do Problema.   
TN_CAUSAString06Código da Causa          
TN_NOMCAUSString20Descrição da Causa       
TN_SOLUCAOString06Solução da Ocorrência    
TN_NOMSOLUString20Descrição da Solução     
TN_DESCRICString10Descrição da Ocorrência  
Bloco de código
languagejs
themeEclipse
titleJson
 "ocurrences": [
        {
        	{
		"TN_ORDEM  ": "000722",
            		"TN_PLANO  ": "000000",
            		"TN_TAREFA ": "0     ",
            		"TN_NOMETAR": "SEM ESPECIFICACAO DE TAREFA",
            		"TN_CODOCOR": "033006",
		"TN_NOMOCOR":            "TN_NOMOCOR": "OCORRENCIA "OCORRENCIA 033006",
            		"TN_CAUSA  ": "033001",
            		"TN_NOMCAUS": "OCORRENCIA 033001",
            		"TN_SOLUCAO": "MNT003",
            		"TN_NOMSOLU": "OCORRENCIA MNT 003",
            		"TN_DESCRIC": "Descrição da Ocorrência"
        }	}
 ]
Card
id3
labelSintomas

Lista dos campos referentes aos sintomas Sintomas (Tabela TTC).

CampoTipoTamanhoDescrição
TTC_CODBEMString16Código do Bem            
TTC_ORDEMString06Ordem de Serviço         
TTC_PLANOString06Plano de Manutenção      
TTC_DATAString08Data da O.S.             
TTC_CDSINTString06Código do Sintoma        
TTC_DESSINString20Descrição do Sintoma     
Bloco de código
languagejs
themeEclipse
titleJson
 "symptoms": [
        {   "TTC_CODBEM": "BEM MNT 010     ",
            "TTC_ORDEM ": "000722",
            "TTC_PLANO ": "000000",
            "TTC_DATA  ": "20231207",
            "TTC_CDSINT": "003   ",
            "TTC_DESSIN": "DESNIVEL NO EIXO"         
		}
Card
id4
labelChecklists

Lista dos campos referentes aos às Etapas Executadas - CheckLists (Tabela STNSTQ).

CampoTipoTamanhoDescrição
TQ_ORDEMString06Ordem de Serviço
TQ_PLANOString06Plano de Manutenção
TQ_TAREFAString06Tarefa da Manutenção
TQ_NOMTAREString20Nome da Tarefa
TQ_ETAPAString06Código da Etapa da Tarefa
TQ_NOMSITUString04Tipo da Etapa
TQ_NOMETAPString150Descrição da Etapa
TQ_CODFUNCString06Matricula do Funcionário
TQ_SEQETAString03Sequencia da Etapa
TQ_SEQTAREString03Sequencia da Tarefa
TQ_OBSERVAString10Observação da Etapa
Bloco de código
languagejs
themeEclipse
titleJson
"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": "      MNT001",
                "TQ_SEQETA ": "   ",
                "TQ_SEQTARE": "   ",
                "TQ_OBSERVA": "Observação de etapas"
            }
        }
Card
id5
labelResposta Respostas das checklists

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

CampoTipoTamanhoDescrição
TPQ_ORDEMString06Ordem de Serviço
TPQ_PLANOString06Plano de Manutenção
TPQ_TAREFAString06Tarefa da Manutenção
TPQ_ETAPAString20Etapa da tarefa manutenc.
TPQ_OPCAOString06Opção da Etapa
TPQ_RESPOSString04Resposta da Opção da Etapa
TPQ_ORDEMGString150Ordem Serviço Gerada     
TPQ_CODFUNString03Código do Funcionário    
TPQ_NOMEString03Nome do Funcionário      
TPQ_OBSERVString10Mensagem de Alerta       
Bloco de código
languagejs
themeEclipse
titleJson
"answers": [
    {
    	"TPQ_ORDEM ": "000723",
        "TPQ_PLANO ": "000000",
        "TPQ_TAREFA": "0     ",
        "TPQ_ETAPA ": "ETP-02",
        "TPQ_OPCAO ": "1              ",
        "TPQ_RESPOS": "  ",
        "TPQ_ORDEMG": "  ",
        "TPQ_CODFUN": "  MNT037",
        "TPQ_NOME  ": "FUNCIONARIO MNT 037",
        "TPQ_OBSERV": "Observação do CheckList"
    }
Card
id6
labelMotivo Motivos de Atraso

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

CampoTipoTamanhoDescrição
TPL_ORDEM String06Ordem de Serviço
TPL_CODMOTString04Codigo do Motivo
TPL_DESMOTString40Descricao Motivo
TPL_DTINICString08Data Inicio do Atraso
TPL_HOINICString05Hora Inicio do Atraso
TPL_DTFIM String08Data Termino do Atraso
TPL_HOFIM String05Hora Termino do Atraso
Bloco de código
languagejs
themeEclipse
titleJson
"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
idcreate2
labelInclusãoCancelamento da Ordem de Serviço

Método:

mntng/create

Tipo: POST

http://enderecoserver:portarest/rest/mntorder/order/cancel

Tipo: PUT

Utilizado para realizar o cancelamento de 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.

  • Consultar se existe a Ordem de Serviço pesquisada;
  • Verificar se a Ordem de Serviço atende aos requisitos para ser cancelada;
  • Realizar o cancelamento da Ordem de Serviço.


Em enderecoserver:portarest/ deverá ser informado o endereço do servidor Rest e sua Porta, ex: http://localhost:8080/

Header


Bloco de código
languagejs
{
   "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
idupdate
labelAlteraçã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
languagejs
{
   "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
idfinish
labelFinalização

Método: mntng/finish

Tipo: POST

Finaliza uma Ordem de Serviço.

Body

Bloco de código
languagejs
{
   "startDate":"20230501 08:30",
   "observation":"",
   "plan":"000000",
   "order":"013610",
   "endDate":"20230501 09:30",
   "fault":"001"
}
Card
idcancel
labelCancelamento

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
languagejs
{  
 "plan":"000000",
 "order":"013921",
 "message":"ordem aberta indevidamente",
}

Chaves dos contadores (objeto counter)

firstline1
titleExemplo de Header
linenumberstrue
curl --request DELETE \
--url http://localhost:8090/rest/mntorder/order/cancel\
--header 'Authorization: Basic YWRtaW46MTIzNA==' \
--header 'tenantId: T1,D MG 01' \
--header 'x-erp-module: MNT' \


Body

Campos que compõe o cancelamento de uma Ordem de Serviço.

CampoTipoTamanhoDescriçãoObrigatório
TJ_ORDEMString06Número da Ordem Serviço  Sim
TJ_PLANOString06Número do Plano de Manut.Sim
TJ_OBSERVAString10Observação               Sim
Bloco de código
languagejs
themeEclipse
titleJson
{
   "order":{
        "TJ_ORDEM":"000001",
        "TJ_PLANO":"000000",
        "TJ_OBSERVA":"Teste de cancelamento de O.S"

   }
}
Card
iddetail
labelDetalhes dos campos

Chaves da ordem de serviço (objeto principal)

Campo

Campo 

Descrição

Tipo
equipmentTJ_CODBEMCódigo do equipamento. Chave obrigatória na inclusão de ordens para bens.string
serviceTJ_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
endDateTJ_DTMPFIM, TJ_HOMPFIMData e hora final. Chave obrigatória.string
codeTJ_ORDEM

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

string
planTJ_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
typeNão possui

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

C=Corretiva

P=Preventiva

string
locationTJ_CODBEMCódigo da localização. Chave obrigatória na inclusão de ordens para localizações.
observationTJ_OBSERVADescrição.string
sequenceTJ_SEQRELASequência da ordem. Caso não existir será considerado '0'.
counterNão possuiContadores do bem. array de objetos
checklistNão possuiEtapas. array de objetos
inputsNão possui

Insumos. 

array de objetos
ChaveCampoDescrição
datetime

TP_DTLEITU

TP_HORA

Data e hora do contador

value

TP_POSCONTValor 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)

ChaveCampoDescrição
taskTQ_TAREFACódigo da tarefa.
stepTQ_ETAPACódigo da etapa.
isDoneTQ_OKSe 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)

ChaveCampoDescriçãoTipooperationNão possui

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

C=Create;

U=Update;

D=Delete.

stringisDoneNão possui

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

booleansequenceTL_SEQRELASequência do insumo já aplicado. Chave é obrigatória na alteração e exclusão.stringtaskTL_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.

keyTaskTL_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.

stringcodeTL_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.

keyCodeTL_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.

stringtypeTL_TIPOREGTipo do insumo. Chave obrigatóriastringunityTL_UNIDADEUnidade de consumo do recurso.stringdestinyTL_DESTINO

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

A=Apoio;

T=Troca;

S=Substituição.

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

TL_DTINICI

TL_HOINICI

Data e hora inicial. Chave obrigatória.stringendDate

TL_DTFIM

TL_DTINICI

Data e hora final. Chave obrigatóriastring

Informações adicionais: