getSingleAttributeByMarkerSet

Obteniendo un atributo con datos del conjunto de atributos.

Descripción

Este método devuelve un solo atributo con datos de los conjuntos de atributos. Devuelve una Promesa que se resuelve en un objeto IAttributesSetsEntity.

.getSingleAttributeByMarkerSet(

, ,

);

Esquema de parámetros

Esquema

setMarker(requerido): string
Identificador de texto (marcador) del conjunto de atributos
ejemplo: "productAttributes"

attributeMarker(requerido): string
Identificador de texto (marcador) del atributo en el conjunto
ejemplo: "color"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con el atributo langCode

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: IAttributesSetsEntity

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

value: unknown
Valor del atributo, normalizado de la misma manera que el valor de un atributo de entidad: number | null para tipos numéricos, el objeto de archivo en sí para un image/file de un solo archivo, null cuando el atributo no tiene valor.

initialValue: unknown
Valor inicial del atributo.

marker: string
Identificador textual del atributo (marcador).
ejemplo: "color", "size", "etc"

position: number
Número de posición para ordenar.
ejemplo: 1

listTitles: IListTitle[]
Array de valores (con datos extendidos) para atributos de lista y radioButton; array vacío para tipos no listados.
ejemplo:

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

listTitles.title: string
El título o nombre asociado con el elemento de la lista.
ejemplo: "Nombre del Elemento"

listTitles.value: number | string
El valor del elemento de la lista, que puede ser un número o una cadena dependiendo del contexto.
ejemplo: 42

listTitles.position: string | number | null
La posición del elemento de la lista, que puede representarse como una cadena, número o null si no es aplicable.
ejemplo: 1

listTitles.extended: object
Un objeto que contiene propiedades adicionales o metadatos relacionados con el elemento de la lista. Esto podría incluir cualquier detalle extra que amplíe la información básica.

listTitles.extended.value: string | null
El valor extendido, que puede ser una cadena o null.
ejemplo: "extra_value"

listTitles.extended.type: string | null
El tipo del valor extendido, que puede ser una cadena o null.
ejemplo: "color"

validators: IAttributeValidators
Conjunto de validadores para la validación; objeto vacío cuando no se configuran validadores.
ejemplo:

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

validators.requiredValidator: object | boolean
El campo debe ser completado. Forma: { strict: boolean }.
ejemplo:

{ strict: true }

validators.trimValidator: object | boolean
Se eliminan los espacios en blanco al principio y al final del valor. Se almacena como un objeto vacío cuando el interruptor está activado.
ejemplo:

{}

validators.stringInspectionValidator: object
Restricciones de longitud para campos de cadena.
ejemplo:

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

validators.urlInspectionValidator: object | boolean
El valor debe parecerse a una URL. Se almacena como true o como un objeto.
ejemplo:

true

validators.emailInspectionValidator: object | boolean
El valor debe parecerse a una dirección de correo electrónico. Se almacena como true o como un objeto.
ejemplo:

true

validators.checkForNumberValidator: object
El valor debe ser un número, opcionalmente un entero dentro de los límites. 0 desactiva un límite.
ejemplo:

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

validators.roundingNumberValidator: object
Redondea el número antes de almacenarlo.
ejemplo:

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

validators.booleanValidator: object
El valor debe ser igual a uno de los dos valores declarados.
ejemplo:

{ trueValue: 1, falseValue: 0 }

validators.comparisonValidator: object
Compara el valor con otro atributo o con una constante.
ejemplo:

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

validators.regExpValidator: object
El valor debe coincidir con una expresión regular; invert rechaza coincidencias en su lugar.
ejemplo:

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

validators.fieldMaskValidator: object
El valor debe coincidir con una máscara de entrada (9 dígito, A letra mayúscula, a letra minúscula, * cualquier, $ uno de ()+-).
ejemplo:

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

validators.checkForAGivenList: object
El valor debe estar en la lista, o fuera de ella cuando notValue es verdadero.
ejemplo:

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

validators.defaultValueValidator: object
Valor sustituido cuando el campo se deja vacío.
ejemplo:

{ fieldDefaultValue: 'USD' }

validators.sizeInPixelsValidator: object
Límites de imagen en píxeles; ejecutado por el panel de administración.
ejemplo:

{ maxX: 1920, maxY: 1080 }

validators.checkingFilesValidator: object
Límites de tamaño de archivo y extensiones permitidas; ejecutado por el panel de administración.
ejemplo:

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

validators.minMaxDateValidator: object
Límites de fecha; ejecutado por el panel de administración.
ejemplo:

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

validators.valueValidator: object
El control de "valor predeterminado" del panel; escribe defaultValueValidator, y este nombre se mantiene porque la API lo acepta y lo almacena.
ejemplo:

{ fieldDefaultValue: 'USD' }

validators.checkForLettersValidator: object
Verificación solo de letras por patrón; ejecutado por el panel de administración.
ejemplo:

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

localizeInfos: IAttributeLocalizeInfo
El nombre de la plantilla, teniendo en cuenta la localización.
ejemplo:

{
  "title": "My attribute"
}

additionalFields: Record<string, IAttributesSetsEntity>
Atributos secundarios anidados indexados por marcador; objeto vacío cuando no hay ninguno.

---