getRootPages

Получение всех объектов страниц верхнего уровня (parentId = null)

Pages.getRootPages(langCode)

const value = await Pages.getRootPages()

Схема

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

Этот метод извлекает все объекты страниц верхнего уровня из API. Он возвращает Promise, который разрешается в массив объектов страниц верхнего уровня или в пустой массив [], если данных нет.

Пример возвращаемого значения:

[
  {
    "id": 8,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "blog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Блог",
      "menuTitle": "Блог",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 1,
    "isVisible": true,
    "products": 0,
    "childrenCount": 1,
    "type": "common_page",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "некоторый текст",
        "position": 0,
        "additionalFields": []
      },
      "number": {
        "type": "integer",
        "value": 0,
        "position": 1,
        "additionalFields": []
      },
      "real": {
        "type": "real",
        "value": "",
        "position": 2,
        "additionalFields": []
      },
      "float": {
        "type": "float",
        "value": 0,
        "position": 3,
        "additionalFields": []
      }
    },
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Шаблон",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  },
  {
    "id": 10,
    "config": {},
    "depth": 0,
    "parentId": null,
    "pageUrl": "catalog",
    "attributeSetIdentifier": "page",
    "localizeInfos": {
      "title": "Каталог",
      "menuTitle": "Каталог",
      "htmlContent": "",
      "plainContent": ""
    },
    "position": 2,
    "isVisible": true,
    "products": 3,
    "childrenCount": 0,
    "type": "catalog_page",
    "templateIdentifier": "template",
    "isSync": true,
    "attributeValues": {
      "text": {
        "type": "string",
        "value": "текст каталога",
        "position": 0,
        "additionalFields": []
      },
      "number": {
        "type": "integer",
        "value": 0,
        "position": 1,
        "additionalFields": []
      },
      "real": {
        "type": "real",
        "value": "",
        "position": 2,
        "additionalFields": []
      },
      "float": {
        "type": "float",
        "value": 0,
        "position": 3,
        "additionalFields": []
      }
    },
    "template": {
      "id": 4,
      "attributeSetIdentifier": null,
      "title": "Шаблон",
      "generalTypeId": 4,
      "identifier": "template",
      "version": 0,
      "generalTypeName": "catalog_page",
      "attributeValues": {},
      "position": 1
    }
  }
]

Схема

attributeSetIdentifier: строка
Идентификатор набора атрибутов.
пример: "page"

attributeValues: AttributeType
Массив значений атрибутов из индекса (представленный в виде пары идентификатор пользовательского атрибута: значение атрибута).
пример:

{
  "text": {
    "type": "string",
    "value": "некоторый текст",
    "position": 0,
    "additionalFields": []
  }
}

childrenCount: число
Количество дочерних элементов.
пример: 1

config: любой
Настройки вывода для страниц каталога.
пример:

{
  "rowsPerPage": 1,
  "productsPerRow": 1
}

depth: число
Глубина вложенности страницы относительно parentId.
пример: 10

id: число
Идентификатор объекта.
пример: 8

isSync: логическое
Указание на индексацию страницы.
пример: true

isVisible: логическое
Признак видимости страницы.
пример: true

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

{
  "title": "Блог",
  "menuTitle": "Блог",
  "htmlContent": "",
  "plainContent": ""
}

pageUrl: строка
Уникальный URL страницы.
пример: "blog"

parentId: число
Идентификатор родительской страницы, если он равен null, то это страница верхнего уровня.
пример: 10

position: число
Номер элемента (для сортировки).
пример: 2

products: число
Количество продуктов, связанных со страницей.
пример: 0

templateIdentifier: строка
Идентификатор связанного шаблона.
пример: "template"

type: Types
Тип страницы.
пример:

"common_page"

template: любой
Объект шаблона.
пример:

{
  "id": 4,
  "attributeSetIdentifier": null,
  "title": "Шаблон",
  "generalTypeId": 4,
  "identifier": "template",
  "version": 0,
  "generalTypeName": "catalog_page",
  "attributeValues": {},
  "position": 1
}

---