getPageById

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

Описание

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

Pages.getPageById(

id, langCode

);

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

Схема

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

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

Примеры

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

const response = await Pages.getPageById(1);

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

const response = await Pages.getPageById(1, 'en_US');

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

{
  "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
  }
}

Схема ответа

Схема: IPagesEntity

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

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

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

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

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

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

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

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

"common_page"

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

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

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

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

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

template: any
Объект шаблона.

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

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

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

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

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

---