Páginas filhas
  • DICIONÁRIO DE ENTIDADE


CONTEÚDO

  1. Visão Geral
  2. URL
  3. 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çãoDescrição
idIdentificador (Chave Primária)
codeCó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
descriptionDescrição
abbreviatedDescriptionDescrição Abreviada
tableStatusStatus da tabela. A = Ativo / I = Inativo
scheduleFlag para definir se o Dicionário vai ser sincronizado via Schedule ou não. S = Sim / N = Não
registeredDefine se é um dicionário cadastrado ou sincronizado. Passar por padrão N.
fgFixedTableDefine se é uma tabela fixa do sistema. Passar por padrão N.


Atributos - Detalhe

NomeDescrição
idIdentificador (Chave Primária)
nameNome da coluna
descriptionDescrição
dataTypeTipo do Dado. Valores válidos V - VARCHAR / N - NUMERIC / D - DATE / B - BOOLEAN / T - TIMESTAMP / H - TIME / P - BYTEA
sizeTamanho da coluna
decimalsQuantidade de casas decimais
fgPKFlag para dizer se é Chave Primária. S = Sim / N = Não
fgFKFlag para dizer se possui Chave Estrangeira. S = Sim / N = Não
showConsultFlag para dizer se a coluna será exibida nas consultas. S = Sim / N = Não
columnReferenceErpFlag para dizer se essa chave primária é a que será enviada ao ERP. S = Sim / N = Não
instanceFlag para dizer se a coluna é uma instância
headerIdentificador do Header
fgMultKeysFlag para dizer se tem várias referências. S = Sim / N = Não
fgFilterFlag para dizer se filtra outra coluna. S = Sim / N = Não


Atributos - Chave Estrangeira

NomeDescrição
idIdentificador (Chave Primária)
detailIdentificador da Entidade Detalhe
detailReferencesIdentificador da Entidade Detalhe Referencia.
detailReferencesDescriptionIdentificador da Descrição da Entidade Detalhe que vai ser usada para exibição e tabelas e apontamentos
columnFKNome da Coluna Chave Estrangeira
columnReferencesNome da Coluna de Referencia 
columnReferencesDescriptionNome da Coluna de Referencia descrição
tableReferencesTabela de referencia