|
Parâmetro |
Tipo |
Descrição |
Exemplo |
|---|---|---|---|
|
object |
Definição de atributo de entidade personalizada. |
||
| Name |
string |
Identificador do atributo. Pode conter letras, dígitos e sublinhados. Deve começar com uma letra ou dígito e ter até 64 caracteres. |
apiCode |
| DisplayName |
string |
Nome de exibição. Pode ter até 32 caracteres. |
API code |
| Type |
string |
Tipo de atributo. Os tipos suportados incluem STRING, TEXT, INT, FLOAT, BOOLEAN, DATE, ARRAY, ENUM e JSON. |
STRING |
| IsOptional |
boolean |
Indica se o valor é opcional. O valor padrão é true. Importante A validação ocorre ao criar uma entidade. Se este valor for false e nenhum valor for fornecido durante a criação, a validação falhará e um erro será retornado. |
true |
| SearchFilterEnabled |
boolean |
Indica se o atributo pode ser usado como um filtro na página de pesquisa. O valor padrão é false.\n\nApenas atributos do tipo STRING, DATE, ENUM, ARRAY, INT ou BOOLEAN suportam esta configuração. |
false |
| DisplayEnabled |
boolean |
Indica se o atributo aparece na página de detalhes. O valor padrão é true. |
true |
| AllowedValues |
array |
Valores de enumeração. Obrigatório quando Type é ENUM. |
|
|
string |
Valor permitido. |
LABEL_1 |
|
| Description |
string |
Descrição do atributo. |
Hierarchy description |