Atributos

Os atributos estruturam a forma como seus dados serão armazenados. Cada atributo pode ter tipos, tamanhos ou regras diferenciadas.

Nesse tópico você aprenderá sobre os diversos tipos, tamanhos e características dos atributos de entidade.

Chave Primária

A chave primária de uma entidade é o identificador único dos seus registros e é gerenciado automaticamente pela plataforma.

🚧

Não Altere a Chave Primária!

A chave primária é criada automaticamente pela plataforma e não pode ou deve ser modificado.

Nome do Atributo (name)

Através do nome do atributo você poderá localizar o seu registro em uma consulta. O nome do atributo possui algumas características e regras que devem ser seguidas:

  • não é case-sensitive, e deve ser criado inteiro em letras maiúsculas;
  • não pode começar com números ou símbolos;
  • não deve conter caracteres especiais;

Recomendamos o uso de alguns padrões na criação do nome do atributo para facilitar a depuração, prefixando os nomes com:

  • DS_ para campos de texto;
  • ID_ para campos de identificadores;
  • TX_ para campos de texto sem limite;
  • NR_ para campos de número inteiro;
  • VL_ para campos decimais;
  • DT_ para campos de data e/ou data e hora;

Apelido (alias)

É através do atributo alias que seus dados devem ser trafegado em requisições e serviços REST. Por esse motivo ele deve ser simples e semântico. O alias possui algumas características e regras que devem ser seguidas:

  • case-sensitive;
  • o uso de camel-case é recomendado nesse caso;
  • não pode começar com números ou símbolos;
  • não deve conter caracteres especiais ou espaço em branco;

Tipo (type)

Um campo pode ser definido entre 8 tipos diferentes, e é o que define a característica dos dados a serem persistidos através dele.

  • String
  • Char
  • Date ou Datetime
  • Integer ou Long
  • Numeric
  • Binary

- String (Alfa-Numéricos)

Os campos do tipo String são campos alfa-numéricos que suportam entre 1 e 4000 caracteres.

É possível extender um campo de String para limite indefinido usando o tamanho -1.

- Char (flag)

Os campos do tipo Char são campos de tamanho fixo para uso em listas suspensas de opções fixas ou caixas de seleção.

Recomendamos utilizar a lista de opções para adicionar as opções fixas para o campo. Veja abaixo um exemplo:

Tipo de campo char para opções fixasTipo de campo char para opções fixas

Tipo de campo char para opções fixas

- Date ou Datetime (Data e Hora)

Os campos de data e data/hora são campos para gravar dados de tempo e/ou momento como por exemplo uma Data de Nascimento ou a data e hora de início de algum Evento.

Campos de data já tem alguns atributos pré-configurados e não necessitam de muita parametrização.

- Integer ou Long (Número Inteiro)

Os campos de número inteiro devem ser utilizados para gravar dados numéricos como Quantidade, ou por exemplo um valor sequencial, como a Ordem.

Campos de número inteiro já tem alguns atributos pré-configurados e não necessitam de muita parametrização.

- Numeric (Decimal)

Os campos decimais devem ser utilizados para gravar dados de Valor, como Preços ou Peso que necessitam de casas decimais.

Os 2 campos, tamanho e escala permitem a customização desses valores. O tamanho é a quantidade máxima de algarismos (contando os decimais) e a escala é a quantidade máxima de casas decimais permitidas.

- Binary (Dados Binários)

Os campos do tipo Binary são gravados em formato de "byte" e retornados da mesma forma. Em geral eles não são legíveis e devem ser usados apenas para guardar dados criptografados.

Updated 4 years ago

Atributos


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.