...
Abaixo encontram-se as regras para definir uma mensagem padronizada.
O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada propriedade da 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": "PROTHEUS",
"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)
Clique aqui para verificar os valores disponíveis para a propriedade segment
Campo Obrigatório
Contém lista com nomes dos produtos em que essa mensagem foi implementada, qual o seu adapter correspondente e responsável.
Campo Obrigatório
Esse campo deve ser definido para ativar a integração dessa mensagem via transaction (EAI)
Ele contém a informação do subtype (event ou request), e quais objetos do schema correspondem ao businessContentType e returnContentType.
Ao ativá-lo dessa maneira, a propriedade "Header" será preenchida automaticamente pelo EAI, enquanto a propriedade "Content" será substituída pelo objeto configurado.
Clique aqui se existem dúvidas sobre integração via transaction
Campo Opcional
Corpo/Propriedades
O objetivo dessa propriedade é especificar quais produtos Totvs implementaram uma determinada propriedade da mensagem, e trazer informações específicas sobre aquele campo em um determinado produto.
...
Complemento de informações sobre o campo se for o caso.
Campo Opcional
Json Schema da Mensagem Branch 2.001 : https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_001.json
...