...
<tópico informações comuns não existe>
Clique aqui para obter mais informações sobre integração via transactions (EAI)o modelo de integração Transactions
No caso de JSON simplificado para API, trabalhamos apenas com o conteúdo da propriedade "Content", desconsiderando o header.
...
Nota | ||
---|---|---|
| ||
É obrigatório que, ao utilizar as duas integrações os dois modelos de integração disponíveis, o conteúdo definido para retorno da API seja o mesmo que o "Content" do protocolo transactions. |
Abaixo encontram-se as regras para definir uma mensagem padronizada.
...
...
...
Âncora | ||||
---|---|---|---|---|
|
Nesse tópico entraremos em maiores detalhes da propriedade x-totvs de dentro da info (cabeçalho). Caso queira entender sobre os outros campos da info do schema, visite nosso Guia de APIs e/ou verifique como a info foi descrita em outros schemas.
O objetivo do x-totvs da info é especificar quais produtos Totvs implementaram uma determinada mensagem, O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada mensagem, e trazer outras informações sobre a mesma.
Bloco de código | ||||
---|---|---|---|---|
| ||||
"info": { ... "x-totvs": { "messageDocumentation": { "name": "StockTurnOver", "description": "Baixa de estoque", "segment": "Construção e Projetos" }, "productInformation": [ { "product": "RM", "contact": "Bruno Barbosa de Souza", "note": "GDP Inovação Const. e Proj.", "adapter": "MovMovimentoData" }, { "product": "PROTHEUSProtheus", "contact": "Eduardo de Souza", "note": "GDP de Materiais", "adapter": "MATI241" }, { "product": "PIMS", "contact": "José Alberto da Silva", "note": "", "adapter": "" } ], "transactionDefinition": { "subType": "event", "businessContentType": { "$ref": "#/definitions/BusinessContentType", "type": "object" }, "returnContentType": { "$ref": "#/definitions/ReturnContentType", "type": "object" } } } } |
...
Contém nome, descrição e agrupador da mensagem (esse último definido através da propriedade segment)
Campo Obrigatório
Aviso |
---|
O campo "segment" deve ser preenchido de forma coerente com o que já está em uso nos outros schemas e APIs de nossa base (sem ao menos diferenciação de case). Para isso, visite o API Reference e verifique como o segmento que você quer adicionar está escrito. |
Clique aqui para verificar os valores disponíveis para a propriedade segment
Campo Obrigatório
...
valores disponíveis para a propriedade segment
Contém lista com nomes dos produtos em que essa mensagem foi implementada, qual o seu adapter correspondente e responsável.
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
Code": { "type": "string", "description": "Código do País", "x-totvs": [ { "product": "Logix", "Fieldfield": "paises.cod_pais", "Requiredrequired": true, "Type": "Char", "length": "3", "note": "some info...", "available": true, "canUpdate": false }, { "product": "RMS", "Fieldfield": "AA1CPAIS.PAIS_COD", "Requiredrequired": true, "Type": "integer", "length": "6", "note": "some info...", "available": true, "canUpdate": false } ] }, |
...
Produto a que se refere essa informação.
Exemplo | |
---|---|
product: “Protheus” ou | Exemploproduct: “protheus”“RM”ou |
Aviso |
---|
...
O campo "product" deve ser preenchido de forma coerente com o que já está em uso nos outros schemas de nossa base (sem ao menos diferenciação de case). Para isso, visite o API Reference e verifique como o produto que você quer adicionar está escrito. |
Campo Obrigatório
A qual tabela.campo o campo da mensagem se refere.
...