getPageById

Obteniendo un único objeto de página con información sobre formularios, bloques, menús adjuntos a la página

Pages.getPageById(id, langCode)

const value = await Pages.getPageById(1);

Esquema

id:*
Identificador del objeto de página
ejemplo: 1

langCode:
código de idioma
ejemplo: en_US

Este método recupera un único objeto de página basado en su identificador (id) de la API. Devuelve una Promesa que se resuelve en el objeto de página, con el objeto específico dependiendo del tipo de página que se esté devolviendo.

Ejemplo de retorno:

{
  "id": 1,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Blog",
    "menuTitle": "Blog",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "forms": [],
  "blocks": [],
  "type": "forUsualPage",
  "templateIdentifier": "template",
  "attributeValues": {
    "text": {
      "type": "string",
      "value": "some text",
      "position": 0
    }
  },
  "isSync": true
}

Esquema

id: number
identificador del objeto
ejemplo: 1764

parentId number
identificador de la página padre, si es nulo, es una página de nivel superior
ejemplo: null

pageUrl string
URL única de la página

depth number
profundidad de anidación de la página en relación con parentId
ejemplo: 3

localizeInfos: Record<string, any>
descripción en json del objeto de datos principal de la página teniendo en cuenta el idioma "en_US" (por ejemplo)
ejemplo:

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Contenido para el catálogo",
    "htmlContent": "<b>Contenido para el catálogo</b>",
    "menuTitle": "Catálogo"
  }
}

isVisible: boolean
indicador de visibilidad de la página
ejemplo: true

position: number
número de posición (para ordenamiento)
ejemplo: 192

type string
tipo de página:
ejemplo: forNewsPage
Enum: [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

templateIdentifier: string
identificador personalizado de la plantilla asociada
ejemplo: my-template

attributeSetId: number
identificador del conjunto de atributos
ejemplo: 7

forms
Array de valores identificadores de objeto FormEntity vinculados a la página (opcional)

blocks
Array de valores identificadores de objeto BlockEntity vinculados a la página (opcional)

isSync: boolean
indicador de indexación de la página (true o false)
ejemplo: false

products number
número de productos asociados con la página
ejemplo: 0