Saltar al contenido principal

getPageById

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

Descripción​

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

Páginas.getPageById(

id, langCode

);

Esquema de parámetros​

Esquema

id(requerido): número
El identificador único de la página a ser recuperada
ejemplo: 1

langCode: cadena
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos​

Ejemplo mínimo​

const response = await Pages.getPageById(1);

Ejemplo con atributos​

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

Ejemplo de respuesta​

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

Esquema de respuesta​

Esquema: IPagesEntity

id: número
El identificador del objeto.
ejemplo: 8

parentId: número | null
El id de la página padre, si contiene null, entonces es la página de nivel superior.
ejemplo: 10

pageUrl: cadena
Url única de la página.
ejemplo: "blog"

depth: número
Profundidad de anidamiento de la página en relación con parentId.
ejemplo: 10

localizeInfos: ILocalizeInfo
El nombre de la página, teniendo en cuenta la localización.
ejemplo:

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

isVisible: booleano
Un signo de visibilidad de la página.
ejemplo: true

type: Tipos
Tipo de página.
ejemplo:

"common_page"

templateIdentifier: cadena | null
Id de usuario de la plantilla vinculada.
ejemplo: "template"

attributeSetIdentifier: cadena | null
Id del conjunto de atributos.
ejemplo: "page"

attributeValues: AttributeType
Array de valores de atributos del índice (representados como un par de id de atributo de usuario: valor de atributo).
ejemplo:

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

isSync: booleano
Indicación de la indexación de la página.
ejemplo: true

template: objeto
Objeto de plantilla.

position: número
Número de ítem (para ordenamiento).
ejemplo: 2

config: cualquier
Configuraciones de salida para páginas de catálogo.
ejemplo:

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

products: número
El número de productos vinculados a la página.
ejemplo: 0

childrenCount: número
Conteo de hijos.
ejemplo: 1