getSingleAttributeByMarkerSet

Obtendo um atributo com dados do conjunto de atributos.

Descrição

Este método retorna um único atributo com dados dos conjuntos de atributos. Ele retorna uma Promise que resolve para um objeto IAttributesSetsEntity.

.getSingleAttributeByMarkerSet(

, ,

);

Esquema de parâmetros

Esquema

setMarker(obrigatório): string
Identificador de texto (marcador) do conjunto de atributos
exemplo: "productAttributes"

attributeMarker(obrigatório): string
Identificador de texto (marcador) do atributo no conjunto
exemplo: "color"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1');

Exemplo com atributo langCode

const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', 'en_US');

Exemplo de resposta

{
  "type": "string",
  "value": null,
  "marker": "admin-text",
  "position": 1,
  "listTitles": [],
  "validators": {},
  "multiselect": false,
  "initialValue": null,
  "localizeInfos": {
    "title": "Admins text"
  },
  "additionalFields": {}
}

Esquema de resposta

Esquema: IAttributesSetsEntity

type: AttributeType
Tipo de atributo.
exemplo: "string", "text", "integer", "etc"

value: unknown
Valor do atributo, normalizado da mesma forma que um valor de atributo de entidade: number | null para tipos numéricos, o próprio objeto de arquivo para um único arquivo image/file, null quando o atributo não possui valor.

initialValue: unknown
Valor inicial do atributo.

marker: string
Identificador textual do atributo (marcador).
exemplo: "color", "size", "etc"

position: number
Número da posição para ordenação.
exemplo: 1

listTitles: IListTitle[]
Array de valores (com dados estendidos) para atributos de lista e radioButton; array vazio para tipos não listados.
exemplo:

[
  {
    "title": "red",
    "value": 1,
    "position": 1,
    "extendedValue": null,
    "extendedValueType": null
  },
  {
    "title": "yellow",
    "value": 2,
    "position": 2,
    "extendedValue": null,
    "extendedValueType": null
  }
]

listTitles.title: string
O título ou nome associado ao item da lista.
exemplo: "Nome do Item"

listTitles.value: number | string
O valor do item da lista, que pode ser um número ou uma string dependendo do contexto.
exemplo: 42

listTitles.position: string | number | null
A posição do item da lista, que pode ser representada como uma string, número ou null se não aplicável.
exemplo: 1

listTitles.extended: object
Um objeto contendo propriedades ou metadados adicionais relacionados ao item da lista. Isso pode incluir quaisquer detalhes extras que ampliem as informações básicas.

listTitles.extended.value: string | null
O valor estendido, que pode ser uma string ou null.
exemplo: "extra_value"

listTitles.extended.type: string | null
O tipo do valor estendido, que pode ser uma string ou null.
exemplo: "color"

validators: IAttributeValidators
Conjunto de validadores para validação; objeto vazio quando nenhum validador está configurado.
exemplo:

{
  "requiredValidator": {
    "strict": true
  },
  "defaultValueValidator": {
    "fieldDefaultValue": 11
  }
}

validators.requiredValidator: object | boolean
Campo deve ser preenchido. Forma: { strict: boolean }.
exemplo:

{ strict: true }

validators.trimValidator: object | boolean
Espaços em branco no início e no final são removidos do valor. Armazenado como um objeto vazio quando a alternância está ativada.
exemplo:

{}

validators.stringInspectionValidator: object
Restrições de comprimento para campos de string.
exemplo:

{ stringLength: 0, stringMin: 2, stringMax: 60 }

validators.urlInspectionValidator: object | boolean
O valor deve parecer uma URL. Armazenado como true ou como um objeto.
exemplo:

true

validators.emailInspectionValidator: object | boolean
O valor deve parecer um endereço de e-mail. Armazenado como true ou como um objeto.
exemplo:

true

validators.checkForNumberValidator: object
O valor deve ser um número, opcionalmente um inteiro dentro dos limites. 0 desativa um limite.
exemplo:

{ integerOnly: true, minValue: 1, maxValue: 10 }

validators.roundingNumberValidator: object
Arredonda o número antes de armazená-lo.
exemplo:

{ integerOnly: false, numberOfDecimals: 2, direction: 'round' }

validators.booleanValidator: object
O valor deve ser igual a um dos dois valores declarados.
exemplo:

{ trueValue: 1, falseValue: 0 }

validators.comparisonValidator: object
Compara o valor com outro atributo ou com uma constante.
exemplo:

{ compareAttribute: 'notChoosed', compareValue: '10', type: 'number', operator: 'equality' }

validators.regExpValidator: object
O valor deve corresponder a uma expressão regular; invert recusa correspondências em vez disso.
exemplo:

{ patternValue: '^[0-9]{5}$', invert: false, flags: ['i'] }

validators.fieldMaskValidator: object
O valor deve corresponder a uma máscara de entrada (9 dígito, A letra maiúscula, a letra minúscula, * qualquer, $ um de ()+-).
exemplo:

{ maskValue: '+9 (999) 999-99-99' }

validators.checkForAGivenList: object
O valor deve estar na lista, ou fora dela quando notValue é verdadeiro.
exemplo:

{ rangeValue: ['red', 'green'], notValue: false }

validators.defaultValueValidator: object
Valor substituído quando o campo é deixado vazio.
exemplo:

{ fieldDefaultValue: 'USD' }

validators.sizeInPixelsValidator: object
Limites de imagem em pixels; executado pelo painel de administração.
exemplo:

{ maxX: 1920, maxY: 1080 }

validators.checkingFilesValidator: object
Limites de tamanho de arquivo e extensões permitidas; executado pelo painel de administração.
exemplo:

{ minValue: 0, maxValue: 5, minUnits: 'kb', maxUnits: 'mb', extensions: ['pdf'] }

validators.minMaxDateValidator: object
Limites de data; executado pelo painel de administração.
exemplo:

{ minDateTimeValue: '2026-01-01', maxDateTimeValue: '2026-12-31' }

validators.valueValidator: object
O controle de "valor padrão" do painel; ele escreve defaultValueValidator, e esse nome é mantido porque a API o aceita e o armazena.
exemplo:

{ fieldDefaultValue: 'USD' }

validators.checkForLettersValidator: object
Verificação apenas de letras por padrão; executado pelo painel de administração.
exemplo:

{ patternValue: '^[A-Za-z ]+$' }

localizeInfos: IAttributeLocalizeInfo
O nome do template, levando em consideração a localização.
exemplo:

{
  "title": "My attribute"
}

additionalFields: Record<string, IAttributesSetsEntity>
Atributos sub-nested indexados por marcador; objeto vazio quando nenhum.

---