Pular para o conteúdo principal

getPageById

Obtendo um único objeto de página com informações sobre formulários, blocos e menus anexados à página.

Descrição​

Este método recupera um único objeto de página com base em seu identificador (id) da API. Ele retorna uma Promise que resolve para o objeto de página IPagesEntity, com o objeto específico dependendo do tipo de página que está sendo retornada.

Páginas.getPageById(

id, langCode

);

Esquema de parâmetros​

Esquema

id(obrigatório): número
O identificador único da página a ser buscada
exemplo: 1

langCode: string
Códigodo idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos​

Exemplo mínimo​

const response = await Pages.getPageById(1);

Exemplo com atributos​

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

Exemplo de resposta​

{
  "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 resposta​

Esquema: IPagesEntity

id: número
O identificador do objeto.
exemplo: 8

parentId: número | null
O id da página pai, se contiver null, então é a página de nível superior.
exemplo: 10

pageUrl: string
URL única da página.
exemplo: "blog"

depth: número
Profundidade de aninhamento da página em relação ao parentId.
exemplo: 10

localizeInfos: ILocalizeInfo
O nome da página, levando em conta a localização.
exemplo:

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

isVisible: boolean
Um sinal de visibilidade da página.
exemplo: true

type: Types
Tipo de página.
exemplo:

"common_page"

templateIdentifier: string | null
Id do usuário do template vinculado.
exemplo: "template"

attributeSetIdentifier: string | null
Id do conjunto de atributos.
exemplo: "page"

attributeValues: AttributeType
Array de valores de atributos do índice (representado como um par de id de atributo do usuário: valor do atributo).
exemplo:

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

isSync: boolean
Indicação de indexação da página.
exemplo: true

template: objeto
Objeto de template.

position: número
Número do item (para ordenação).
exemplo: 2

config: qualquer
Configurações de saída para páginas de catálogo.
exemplo:

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

products: número
O número de produtos vinculados à página.
exemplo: 0

childrenCount: número
Contagem de filhos.
exemplo: 1