Histórico da Página
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
Code": {
"type": "string",
"description": "Código do País",
"x-totvs": [
{
"product": "Logix",
"field": "paises.cod_pais",
"required": true,
"Typetype": "Char",
"length": "3",
"note": "some info...",
"available": true,
"canUpdate": false
},
{
"product": "RMS",
"field": "AA1CPAIS.PAIS_COD",
"required": true,
"Typetype": "integer",
"length": "6",
"note": "some info...",
"available": true,
"canUpdate": false
}
]
}, |
...
product
Produto a que se refere essa informação.
| ExemploExemplos |
|---|
product: “Protheus” ou product: “RM” |
| Aviso |
|---|
O campo "product" deve ser preenchido de forma coerente com o que já está em uso nos outros schemas de nossa base nosso repositório (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
...
field
A qual tabela .e campo do produto o campo da mensagem se refere.
Quando não for possível ou não for conveniente referenciar o campo, pode-se referenciar o atributo de um modelo conceitual ou intermediário.
Caso no produto este campo possa estar em mais tabela (ou modelo), explicar o funcionamento.
| ExemploExemplos |
|---|
Fieldfield: “clientes.cod_cliente” ou Fieldfield: “cliente.cod_cliente para Type=Customer ou fornecedor.cod_fornecedor para Type=Vendor” |
Campo Obrigatório
...
required
Obrigatoriedade do campo , caso no modelo de dados. Caso haja alguma condição deve ser descrito na seção no campo note.
| ExemploExemplos |
|---|
Requiredrequired: TruetrueRequired required: Falsefalse |
Campo Obrigatório
...
type
Tipo de dado do campo no produto. Importante declarar aqui o tipo de dado do campo como é conhecido no produto.
| ExemploExemplos |
|---|
type: ‘char’ type: ‘varchar’ type: ‘number’ type: ‘decimal’ type: ‘integer’ type: ‘boolean’ |
Campo Obrigatório
...
length
Tamanho do campo no produto, pode ser informado apenas o tamanho ou outro texto que descreva como este tamanho funciona.
| ExemploExemplos |
|---|
length: ‘20’ length: ‘8,2’ length: ’sempre implantado como 20, mas o cliente pode usar até 50’ |
Campo Obrigatório
...
note
Complemento de informações sobre o campo se for o caso, como por exemplo formato da informação, vínculo entre mensagens, escopo de dados (deve ser informado para campos que precisam respeitar uma relação específica de valores no produto, podendo ser informado aqui: 'lista fixa' ou 'valores da tabela [tabela.campo]').
| ExemploExemplos |
|---|
"note": "1=CEI;2=CNPJ;3=CPF;4=INCRA" "note": "Campo obrigatório para o processo fiscal/TAF." "note":"Segmento Principal" |
Caso na mensagem tenha sido definida lista fixa, informar aqui a relação dos valores da mensagem com os valores do produto .... ou qualquer outra informação importante para descrever a representação desta tag deste conteúdo no produto em questão.
Campo Opcional
...
Indica se o campo esta implementado para o produto, para a determinada mensagem. Recebe um valor Booleanobooleano:
| ExemploExemplos |
|---|
available: true available: false |
Campo Obrigatório
canUpdate
indica Indica se o valor do campo pode ser atualizado na tabela. Recebe um valor Booleanobooleano:
ExemploExemplos |
|---|
canUpdate: true canUpdate: false |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas