CONTEÚDO
- Visão Geral
- URL
- JSON
01. VISÃO GERAL
Esse documento tem como objetivo mostrar o JSON responsavel pela integração do cadastro do Dicionário de Entidade. Para mais informações sobre o funcionamento das integrações no TOTVS Pesagem, acessar Configuração e funcionamento da integração no TOTVS Pesagem.
O Dicionário de Entidade é utilizando quando não temos um cadastro padrão que é necessário para integração da pesagem ou apontamento necessário na pesagem. Então construimos essa entidade e a partir dela geramos a tabela no banco de dados do TOTVS Pesagem para sincronizar os registros utilizando a API de Sincronização de Dados.
02. URL
Na API de Dicionário de Entidade, por padrão, o TOTVS Pesagem, aguarda as seguinte URL para fazer a chamada da API GET: http://ip:porta/contexto/v1/entityHeader
03. JSON
Exemplo do JSON com um Diocionário de Entidade:
{
"hasNext": false,
"items": [
{
"id": "7608004480100483727",
"code": "LOTE",
"description": "LOTE",
"abbreviatedDescription": "LOTE",
"tableStatus": "A",
"schedule": "S",
"registered": "S",
"listDetails": [
{
"id": "4865993834490952111",
"name": "NUMERO",
"description": "NUMERO",
"dataType": "N",
"size": 50,
"decimals": 0,
"fgNull": "N",
"fgPK": "S",
"fgFK": "N",
"showConsult": "S",
"columnReferenceErp": "S",
"instance": "N",
"header": "7608004480100483727",
"foreignKey": {},
"fgMultKeys": "N",
"fgFilter": "N",
"sequence": 1,
"filters": []
},
{
"id": "4663114756666024201",
"name": "DESCRICAO",
"description": "DESCRICAO",
"dataType": "V",
"size": 100,
"decimals": 0,
"fgNull": "N",
"fgPK": "N",
"fgFK": "N",
"showConsult": "S",
"columnReferenceErp": "N",
"instance": "N",
"header": "7608004480100483727",
"foreignKey": {},
"fgMultKeys": "N",
"fgFilter": "N",
"sequence": 2,
"filters": []
},
{
"id": "7056177856179798086",
"name": "LOCAL",
"description": "LOCAL",
"dataType": "V",
"size": 50,
"decimals": 0,
"fgNull": "N",
"fgPK": "N",
"fgFK": "S",
"showConsult": "S",
"columnReferenceErp": "N",
"instance": "N",
"header": "7608004480100483727",
"foreignKey": {
"id": "5299443960726882591",
"detail": "7056177856179798086",
"detailReferences": "7531624550650315811",
"detailReferencesDescription": "6378905804970294281",
"columnFK": "LOCAL",
"columnReferences": "ID",
"columnReferencesDescription": "NOME",
"tableReferences": "LOCAL"
},
"fgMultKeys": "N",
"fgFilter": "N",
"filters": []
}
],
"fgFixedTable": "N"
}
],
"length": 1
}
Atributos - Header
Ação | Descrição |
---|---|
id | Identificador (Chave Primária) |
code | Código - Seria o nome da Tabela. As tabelas que são criadas no TOTVS Pesagem pelo Dicionário tem por padrão o ENT_"Code". Ex.: ENT_LOTE |
description | Descrição |
abbreviatedDescription | Descrição Abreviada |
tableStatus | Status da tabela. A = Ativo / I = Inativo |
schedule | Flag para definir se o Dicionário vai ser sincronizado via Schedule ou não. S = Sim / N = Não |
registered | Define se é um dicionário cadastrado ou sincronizado. Passar por padrão N. |
fgFixedTable | Define se é uma tabela fixa do sistema. Passar por padrão N. |
Atributos - Detalhe
Nome | Descrição |
id | Identificador (Chave Primária) |
name | Nome da coluna |
description | Descrição |
dataType | Tipo do Dado. Valores válidos V - VARCHAR / N - NUMERIC / D - DATE / B - BOOLEAN / T - TIMESTAMP / H - TIME / P - BYTEA |
size | Tamanho da coluna |
decimals | Quantidade de casas decimais |
fgPK | Flag para dizer se é Chave Primária. S = Sim / N = Não |
fgFK | Flag para dizer se possui Chave Estrangeira. S = Sim / N = Não |
showConsult | Flag para dizer se a coluna será exibida nas consultas. S = Sim / N = Não |
columnReferenceErp | Flag para dizer se essa chave primária é a que será enviada ao ERP. S = Sim / N = Não |
instance | Flag para dizer se a coluna é uma instância |
header | Identificador do Header |
fgMultKeys | Flag para dizer se tem várias referências. S = Sim / N = Não |
fgFilter | Flag para dizer se filtra outra coluna. S = Sim / N = Não |
Atributos - Chave Estrangeira
Nome | Descrição |
---|---|
id | Identificador (Chave Primária) |
detail | Identificador da Entidade Detalhe |
detailReferences | Identificador da Entidade Detalhe Referencia. |
detailReferencesDescription | Identificador da Descrição da Entidade Detalhe que vai ser usada para exibição e tabelas e apontamentos |
columnFK | Nome da Coluna Chave Estrangeira |
columnReferences | Nome da Coluna de Referencia |
columnReferencesDescription | Nome da Coluna de Referencia descrição |
tableReferences | Tabela de referencia |