getPageByUrl

Получение одного объекта страницы с информацией о формах, блоках, меню, прикрепленных к странице по URL

Pages.getPageByUrl(url, langCode)

const value = await Pages.getPageByUrl('shop');

Схема

url:* строка
URL страницы
пример: shop

langCode: строка
код языка
пример: en_US

Этот метод извлекает один объект страницы на основе его URL (url) из API. Он возвращает Promise, который разрешается в объект страницы, при этом конкретный объект зависит от типа возвращаемой страницы.

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

{
  "id": 3,
  "parentId": 1,
  "pageUrl": "blog1",
  "depth": 1,
  "localizeInfos": {
    "title": "Блог 1",
    "menuTitle": "Блог 1",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "forUsualPage",
  "templateIdentifier": null,
  "attributeValues": {},
  "isSync": false
}

Схема

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

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

pageUrl строка
уникальный URL страницы

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

localizeInfos: Record<string, any>
json-описание основного объекта данных страницы с учетом языка "en_US" (например)
пример:

{
  "en_US": {
    "title": "Каталог",
    "plainContent": "Содержимое для каталога",
    "htmlContent": "<b>Содержимое для каталога</b>",
    "menuTitle": "Каталог"
  }
}

isVisible: булево
Флаг видимости страницы
пример: true

position: число
номер позиции (для сортировки)
пример: 192

type строка
тип страницы:
пример: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

templateIdentifier: строка
пользовательский идентификатор связанного шаблона
пример: my-template

attributeSetId: число
идентификатор набора атрибутов
пример: 7

forms
Массив значений идентификаторов объектов FormEntity, связанных со страницей (необязательно)

blocks
Массив значений идентификаторов объектов BlockEntity, связанных со страницей (необязательно)

isSync: булево
индикатор индексации страницы (true или false)
пример: false

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

.