getPageById

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

Pages.getPageById(id, langCode)

const value = await Pages.getPageById(1);

Схема

id:*
Идентификатор объекта страницы
пример: 1

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

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

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

{
  "id": 1,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Блог",
    "menuTitle": "Блог",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "forUsualPage",
  "templateIdentifier": "template",
  "attributeValues": {
    "text": {
      "type": "string",
      "value": "некоторый текст",
      "position": 0
    }
  },
  "isSync": true
}

Схема

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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