Histórico da Página

...

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

Sim

Card

id	0
label	Solicitação de Serviço - API's

Método: /mntng/service-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 dados necessário para gerar uma Solicitação de Serviço:
- Código do bem;
- Data da abertura da Solicitação de Serviço;
- Descrição do problema;

Authorization - Basic Auth

Ao executar a chamada do webservice, deverá ser configurado para Basic Auth utilizando usuário e -mail vinculado ao usuário senha do Protheus e senha.

Username <username>

Password <password>

Header

Campos que deverão ser adicionados no Header para possibilitar a inclusão de uma S.S..

Variável	Descrição	Obrigatório	Exemplo

enterprise

tenantId

Código da empresa + Código da Filial

Sim

branch

Filial

Sim

user

E-mail vinculado ao usuário Protheus

Sim

password

Senha criptografada base64

T3,M RJ 01

Nota

title	Importante

O valor inserido na variável tenantId não deverá possuir espaço entre a virgula;
No exemplo apresentado na tabela acima, T3 corresponde a uma empresa e M RJ 01 a uma filial.

Deck of Cards

startHidden	false
id	0
effectType	fade
loopCards	true

cpp

Card

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

Método: /ssmntgfr/create

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
equipment	String	16	Código do Bem/Localização	Sim	TQB_CODBEM
description	String	999	Descrição da Solicitação	Sim	TQB_DESCSS
dateTime	String	08(data) + 05(hora)	Data e Hora da abertura da S.S.( 20220419 13:00 )	Sim	TQB_DTABER / TQB_HOABER
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
executor	String	25	Código do Executante	Não	TQB_CDEXEC

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,
	"localtion":true
}

Content:

equipment: Código do bem ou localização para qual será aberta a S.S.;
dateTime: Data e hora da abertura da S.S.;
description: Descrição que será adicionada na S.S.;
serviceType: Código do serviço que será utilizado na S.S.;
telephoneExtension: Ramal;
counter: Posição do Contador 1;
secondCounter: Posição do Contador 2;
location: Define se a S.S. será para uma localização.

Aviso

title	Atenção!

Os itens equipment, dateTime e description são obrigatórios, os demais itens são condicionados ao bem e a necessidade de informar. Exemplo, se o bem possuir apenas um contador, o campo counter deverá ser adicionado ao body;
Os itens serviceType e telephoneExtension são itens opcionais para inclusão da S.S., ou seja, poderão ser adicionados ao header caso haja necessidade;
O item location só deverá ser adicionado ao body quando a S.S. que será inclusa for para uma localização.

Informações adicionais:

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	Inclusão de O.S. a partir de uma Solicitação de Serviço

Método: /ssmntgfr/create/{value}/order

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 numero da Solicitação de serviço: /ssmntgfr/create/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
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
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
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
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	999	Observação da O.S.	Não	TL_OBSERVA
location	String	15	Localização	Não	TL_LOCALIZ
serialnumber	String	20	Número de série do Produto	Não	TL_NUMSERI
lot	String	10	Lote	Não	TL_LOTECTL
sublot	String	06	Sub-Lote	Não	TL_NUMLOTE

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.

Informações adicionais:

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

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

Método: /mntng/service-request/

Tipo: POST

Authorization - Basic Auth

Header

Método: /ssmntgfr/create

Tipo: POST

Body

Método: /ssmntgfr/create/{value}/order

Tipo: PUT

Inputs