Перейти к основному контенту

getAttributes

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

Описание

  • В дополнение к возврату списка объектов наборов атрибутов, метод также предоставляет общее количество этих объектов. Это особенно полезно для пагинации, отчетности и аналитики, позволяя разработчикам и администраторам понимать объем и масштаб управляемых наборов атрибутов.

  • Эта функциональность необходима для приложений, где требуется динамическое моделирование данных. Например, платформы электронной коммерции могут использовать наборы атрибутов для определения различных категорий продуктов, каждая из которых имеет свой уникальный набор атрибутов, таких как размер, цвет, материал и т. д. Это также может использоваться в системах управления пользователями, где разные роли пользователей имеют различные требования к атрибутам.

  • Метод, вероятно, разработан для бесшовной интеграции с другими компонентами системы, позволяя гибко манипулировать данными и представлять их. Это может включать фильтрацию, сортировку или преобразование наборов атрибутов на основе конкретных критериев или бизнес-логики.

AttributesSets.getAttributes(

langCode, offset, limit, typeId, sortBy

);

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

Схема

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

offset: number
параметр смещения для выбора записей. По умолчанию: 0
пример: 0

limit: number
параметр, ограничивающий выбор записей. По умолчанию: 30
пример: 30

typeId: number
идентификатор типа набора атрибутов. По умолчанию: null
пример: NaN

sortBy: string
идентификатор типа набора атрибутов. По умолчанию: "id"
пример: "id"

Примеры

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

const response = await AttributesSets.getAttributes();

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

const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');

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

{
"total": 16,
"items": [
{
"id": 27,
"updatedDate": "2025-02-26T17:18:11.275Z",
"version": 0,
"identifier": "admins",
"typeId": 1,
"title": "Администраторы",
"schema": {
"admin-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "admin-text",
"localizeInfos": {
"title": "Текст администраторов"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 1,
"type": "дляАдминистраторов"
},
"position": 1
},
{
"id": 22,
"updatedDate": "2025-03-23T12:23:56.420Z",
"version": 0,
"identifier": "block",
"typeId": 2,
"title": "Блок",
"schema": {
"block-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "block-text",
"localizeInfos": {
"title": "Текст блока"
}
},
"interval": {
"id": 2,
"type": "timeInterval",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "interval",
"localizeInfos": {
"title": "Интервал",
"intervals": [
{
"id": "c6466cd8-c55d-4583-97c5-42b684210f12",
"range": [],
"external": [],
"fullMonth": 2,
"intervals": [
{
"id": "ab0e3e90-8153-4679-aea4-198c5022f8d4",
"end": {
"hours": 19,
"minutes": 0
},
"start": {
"hours": 9,
"minutes": 0
},
"period": 60
}
],
"inEveryMonth": true,
"selectedYear": 2025
}
]
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 2,
"type": "дляБлоков"
},
"position": 2
},
{
"id": 17,
"updatedDate": "2025-02-26T16:25:01.688Z",
"version": 0,
"identifier": "page",
"typeId": 4,
"title": "Страница",
"schema": {
"text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "text",
"localizeInfos": {
"title": "текст"
}
},
"number": {
"id": 2,
"type": "integer",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "number",
"localizeInfos": {
"title": "Номер"
}
},
"real": {
"id": 3,
"type": "real",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "real",
"localizeInfos": {
"title": "Реальный"
}
},
"float": {
"id": 4,
"type": "float",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "float",
"localizeInfos": {
"title": "Число с плавающей запятой"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 4,
"type": "дляСтраниц"
},
"position": 3
},
"..."
]
}

Схема ответа

Схема: IAttributesSetsResponse

total: number
Общее количество элементов.
пример: 100

items: IAttributeSetsEntity[]
Массив IAttributeSetsEntity, содержащий сущности наборов атрибутов.
пример:

[
{
"id": 1,
"identifier": "set1"
},
{
"id": 2,
"identifier": "set2"
}
]