getRootPages

Obteniendo todos los objetos de página de nivel superior (parentId = null)

Pages.getRootPages(langCode)

const value = await Pages.getRootPages()

Esquema

langCode: string
código de idioma
ejemplo: en_US

Este método recupera todos los objetos de página de nivel superior de la API. Devuelve una Promesa que se resuelve en un array de objetos de página de nivel superior o un array vacío [] si no hay datos.

Ejemplo de retorno:

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

Esquema

id: number
identificador del objeto
ejemplo: 1764

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

config Record<string, number>
configuraciones de salida para páginas de catálogo
ejemplo:

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

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 json del objeto de datos de la página principal teniendo en cuenta el idioma "en_US" (por ejemplo)
ejemplo:

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

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

products number
Número de productos vinculados a la página
ejemplo: 0

attributeSetId: number
identificador del conjunto de atributos
ejemplo: 7

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

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

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

templateIdentifier: string
Identificador personalizado de la plantilla vinculada
ejemplo: my-template

attributeValues: Record<string, string>
Array de valores de atributos del índice (presentados como un par de identificador de atributo personalizado: valor de atributo)
ejemplo:

{
  "en_US": {
    "marker": {
      "value": "",
      "type": "string"
    }
  }
}

position: number
número de posición para ordenación (opcional)
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 ]

childrenCount: number
número de páginas anidadas
ejemplo: 0