getSingleAttributeByMarkerSet
Obteniendo un atributo con datos del conjunto de atributos.
Descripción
Este método devuelve un único atributo con datos de los conjuntos de atributos. Devuelve una Promesa que se resuelve en un objeto IAttributesSetsEntity.
AttributesSets.getSingleAttributeByMarkerSet(
setMarker*,
attributeMarker*,
langCode
);
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 atributo langCode
const response = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', 'en_US');
Ejemplo de respuesta
{
"type": "string",
"value": {},
"marker": "admin-text",
"position": 1,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "Texto de Admins"
},
"additionalFields": []
}
Esquema de respuesta
Esquema: IAttributesSetsEntity
type: AttributeType
Tipo de atributo.
ejemplo: "string", "text", "integer", "etc"
value: any
Valor del atributo, que puede ser de cualquier tipo.
marker: string
Identificador textual del atributo (marcador).
ejemplo: "color", "size", "etc"
position: number
Número de posición para ordenar.
ejemplo: 1
listTitles: IListTitle[] | Record<string, any>
Array de valores (con datos extendidos) para atributos de lista y radioButton.
ejemplo:
[
{
"title": "rojo",
"value": 1,
"position": 1,
"extendedValue": null,
"extendedValueType": null
},
{
"title": "amarillo",
"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: "valor_extra"
listTitles.extended.type: string | null
El tipo del valor extendido, que puede ser una cadena o null.
ejemplo: "color"
validators: Record<string, any>
Conjunto de validadores para la validación.
ejemplo:
{
"requiredValidator": {
"strict": true
},
"defaultValueValidator": {
"fieldDefaultValue": 11
}
}
localizeInfos: ILocalizeInfo
El nombre de la plantilla, teniendo en cuenta la localización.
ejemplo:
{
"title": "Mi atributo"
}
additionalFields: Record<string, any>
Campos adicionales para el atributo (opcional).