getPageById

Récupérer un objet de page unique avec des informations sur les formulaires, les blocs, les menus attachés à la page

Pages.getPageById(id, langCode)

const value = await Pages.getPageById(1);

Schéma

id:*
Identifiant de l'objet de page
exemple : 1

langCode:
code de langue
exemple : en_US

Cette méthode récupère un objet de page unique basé sur son identifiant (id) depuis l'API. Elle renvoie une promesse qui se résout en l'objet de page, l'objet spécifique dépendant du type de page retourné.

Exemple de retour :

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

Schéma

id: number
identifiant de l'objet
exemple : 1764

parentId number
identifiant de la page parente, si null, c'est une page de niveau supérieur
exemple : null

pageUrl string
URL unique de la page

depth number
profondeur de la page par rapport à parentId
exemple : 3

localizeInfos: Record<string, any>
description json de l'objet de données principal de la page tenant compte de la langue "en_US" (par exemple)
exemple :

{
  "en_US": {
    "title": "Catalog",
    "plainContent": "Contenu pour le catalogue",
    "htmlContent": "<b>Contenu pour le catalogue</b>",
    "menuTitle": "Catalogue"
  }
}

isVisible: boolean
Indicateur de visibilité de la page
exemple : true

position: number
numéro de position (pour le tri)
exemple : 192

type string
type de page :
exemple : forNewsPage
Enum : [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]

templateIdentifier: string
identifiant personnalisé du modèle associé
exemple : my-template

attributeSetId: number
identifiant de l'ensemble d'attributs
exemple : 7

forms
Tableau des valeurs d'identifiant d'objet FormEntity liées à la page (optionnel)

blocks
Tableau des valeurs d'identifiant d'objet BlockEntity liées à la page (optionnel)

isSync: boolean
indicateur d'indexation de la page (true ou false)
exemple : false

products number
nombre de produits associés à la page
exemple : 0