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

getPageById

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

Pages.getPageById(id, langCode)

const value = await Pages.getPageById(1);
Схема

id(обязательный): число
Уникальный идентификатор страницы, которую нужно получить
пример: 1

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

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

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

{
  "id": 8,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Блог",
    "menuTitle": "Блог",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "common_page",
  "templateIdentifier": "template",
  "attributeSetIdentifier": "page",
  "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": []
    }
  },
  "isSync": true,
  "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
}