getSingleAttributeByMarkerSet

Получение одного атрибута с данными из набора атрибутов.

Описание

Этот метод возвращает один атрибут с данными из наборов атрибутов. Он возвращает Promise, который разрешается в объект IAttributesSetsEntity.

AttributesSets.getSingleAttributeByMarkerSet(

setMarker, attributeMarker, langCode

);

Схема параметров

Схема

setMarker(обязательный): string
Текстовый идентификатор (маркер) набора атрибутов
пример: "productAttributes"

attributeMarker(обязательный): string
Текстовый идентификатор (маркер) атрибута в наборе
пример: "color"

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

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

Пример с атрибутом langCode

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

Пример ответа

{
  "type": "string",
  "value": {},
  "marker": "admin-text",
  "position": 1,
  "listTitles": [],
  "validators": {},
  "localizeInfos": {
    "title": "Текст для администраторов"
  },
  "additionalFields": []
}

Схема ответа

Схема: IAttributesSetsEntity

type: AttributeType
Тип атрибута.
пример: "string", "text", "integer", "и т.д."

value: any
Значение атрибута, которое может быть любого типа.

marker: string
Текстовый идентификатор атрибута (маркер).
пример: "color", "size", "и т.д."

position: number
Номер позиции для сортировки.
пример: 1

listTitles: IListTitle[] | Record<string, any>
Массив значений (с расширенными данными) для атрибутов списка и radioButton.
пример:

[
  {
    "title": "красный",
    "value": 1,
    "position": 1,
    "extendedValue": null,
    "extendedValueType": null
  },
  {
    "title": "желтый",
    "value": 2,
    "position": 2,
    "extendedValue": null,
    "extendedValueType": null
  }
]

validators: Record<string, any>
Набор валидаторов для валидации.
пример:

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

localizeInfos: ILocalizeInfo
Название шаблона с учетом локализации.
пример:

{
  "title": "Мой атрибут"
}

additionalFields: Record<string, any>
Дополнительные поля для атрибута (необязательно).

settings: Record<string, any>
Дополнительные настройки атрибута (необязательно).

---