Histórico da Página
...
- Seguir a especificação do formato: https://json-schema.org/specification.html
- Exemplos <Ancora>
- Seguir a definição de campos especificada aqui <link para definição de campos reformulada>
- Especificar propriedade X-Totvs, de acordo com regras especificadas aqui <Ancora> incluindo quais ERPs implementam aquela mensagem e os campos relacionados.
- Sempre que possível, utilizar padrões internacionais. Para saber se já existe uma mensagem de conta contábil, por exemplo, pesquise no Google usando "account xsd oasis repository".
- Mensagens criadas para atender uma exigência legal devem se ater estritamente ao que é definido pela legislação. Nestes casos, o nome da mensagem e dos campos podem ser em português, se a legislação exigir.
X-TOTVS
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:
Product
Nome do produto TOTVS do qual as outras informações se referem
Campo Obrigatório
Available
Define se essa propriedade está ou não disponível
Campo Obrigatório
CanUpdate
Define se essa propriedade pode ser atualizada
Campo Obrigatório
Field
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
Required
Obrigatoriedade do campo, ou condições em que ele será obrigatório ou não.
Campo Obrigatório
Type
Tipo do campo no produto. Importante declarar aqui o tipo do campo como é conhecido no produto.
Campo Obrigatório
Length
Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.
Campo Obrigatório
Note
Complemento de informações sobre o campo se for o caso.
Campo Opcional
Exemplos JsonSchema:
Json Schema da Mensagem Branch 2.001 : https://raw.githubusercontent.com/totvs/ttalk-standard-message/master/jsonschema/schemas/Branch_2_001.json
...