Aller au contenu principal

getPageById

Récupération d'un objet page unique avec des informations sur les formulaires, blocs, menus attachés à la page.

Description​

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

Pages.getPageById(

id, langCode

);

Schéma des paramètres​

Schéma

id(obligatoire) : number
L'identifiant unique de la page à récupérer
exemple : 1

langCode : string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await Pages.getPageById(1);

Exemple avec des attributs​

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

Exemple de réponse​

{
  "id": 8,
  "parentId": null,
  "pageUrl": "blog",
  "depth": 0,
  "localizeInfos": {
    "title": "Blog",
    "menuTitle": "Blog",
    "htmlContent": "",
    "plainContent": ""
  },
  "isVisible": true,
  "blocks": [],
  "type": "common_page",
  "templateIdentifier": "template",
  "attributeSetIdentifier": "page",
  "attributeValues": {
    "text": {
      "type": "string",
      "value": "some text",
      "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": []
    }
  },
  "moduleFormConfigs": [
    {
      "id": 3,
      "formIdentifier": "file_form",
      "moduleIdentifier": 4,
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "nestedEntityIdentifiers": []
    },
    {
      "id": 2,
      "formIdentifier": "test-form",
      "moduleIdentifier": 4,
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "nestedEntityIdentifiers": []
    }
  ],
  "isSync": true,
  "template": {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Template",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
}

Schéma de réponse​

Schéma : IPagesEntity

id : number
L'identifiant de l'objet.
exemple : 8

parentId : number | null
L'id de la page parente, s'il contient null, alors c'est la page de niveau supérieur.
exemple : 10

pageUrl : string
Url unique de la page.
exemple : "blog"

depth : number
Profondeur d'imbrication de la page par rapport à parentId.
exemple : 10

localizeInfos : ILocalizeInfo
Le nom de la page, en tenant compte de la localisation.
exemple :

{
  "title": "Blog",
  "menuTitle": "Blog",
  "htmlContent": "",
  "plainContent": ""
}

isVisible : boolean
Un indicateur de visibilité de la page.
exemple : true

type : Types
Type de page.
exemple :

"common_page"

templateIdentifier : string | null
Id utilisateur du modèle lié.
exemple : "template"

attributeSetIdentifier : string | null
Id de l'ensemble d'attributs.
exemple : "page"

attributeValues : AttributeType
Tableau des valeurs d'attributs de l'index (représenté comme une paire d'id d'attribut utilisateur : valeur d'attribut).
exemple :

{
  "text": {
    "type": "string",
    "value": "some text",
    "position": 0,
    "additionalFields": []
  }
}

isSync : boolean
Indication de l'indexation de la page.
exemple : true

template : object
Objet modèle.

position : number
Numéro de l'élément (pour le tri).
exemple : 2

config : any
Paramètres de sortie pour les pages de catalogue.
exemple :

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

products : number
Le nombre de produits liés à la page.
exemple : 0

childrenCount : number
Nombre d'enfants.
exemple : 1