...
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.
Segue exemplo abaixo:
Bloco de código | ||||
---|---|---|---|---|
| ||||
Code": { "type": "string", "description": "Código do País", "x-totvs": [ { "product": "Logix", "Field": "paises.cod_pais", "Required": true, "Type": "Char", "length": "3", "note": "some info about this...", "available": true, "canUpdate": false }, { "product": "RMS", "Field": "AA1CPAIS.PAIS_COD", "Required": true, "Type": "integer", "length": "6", "note": "some info about this...", "available": true, "canUpdate": false } ] }, |
Significado dos campos:
Nome do produto TOTVS do qual as outras informações se referem
Campo Obrigatório
Define se essa propriedade está ou não disponível
Campo Obrigatório
Define se essa propriedade pode ser atualizada
Campo Obrigatório
A qual tabela.campo o campo da mensagem se refere.
Caso no produto este campo possa estar em mais tabela, explicar o funcionamento.
Campo Obrigatório
Obrigatoriedade do campo, ou condições em que ele será obrigatório ou não.
Campo Obrigatório
Tipo do campo no produto. Importante declarar aqui o tipo do campo como é conhecido no produto.
Campo Obrigatório
Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.
Campo Obrigatório
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
...