Ana içeriğe geç

getPageById

Bir sayfa ile ilişkili formlar, bloklar, menüler hakkında bilgi içeren tek bir sayfa nesnesi almak.

Açıklama​

Bu yöntem, API'den bir tanımlayıcı (id) temelinde tek bir sayfa nesnesi alır. Sayfa nesnesi IPagesEntity olarak döner ve dönen sayfanın türüne bağlı olarak belirli bir nesne içerir.

Pages.getPageById(

id*, langCode

);

Parametreler şeması​

Şema

id(zorunlu): number
Alınacak sayfanın benzersiz tanımlayıcısı
örnek: 1

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

Örnekler​

Minimal örnek​

const response = await Pages.getPageById(1);

Özelliklerle örnek​

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

Örnek yanıt​

{
  "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": "bazı metin",
      "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": 9,
      "formIdentifier": "full_form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": true,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "nestedEntityIdentifiers": []
    },
    {
      "id": 3,
      "formIdentifier": "file_form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "nestedEntityIdentifiers": []
    },
    {
      "id": 2,
      "formIdentifier": "test-form",
      "moduleIdentifier": "content",
      "isGlobal": false,
      "isClosed": false,
      "isModerate": false,
      "viewOnlyMyData": false,
      "commentOnlyMyData": false,
      "entityIdentifiers": [
        {
          "id": "blog",
          "isNested": false
        }
      ],
      "nestedEntityIdentifiers": []
    }
  ],
  "isSync": true,
  "template": {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Şablon",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
}

Yanıt şeması​

Şema: IPagesEntity

id: number
Nesnenin tanımlayıcısı.
örnek: 8

parentId: number | null
Ebeveyn sayfanın id'si, eğer null içeriyorsa, o zaman üst düzey sayfadır.
örnek: 10

pageUrl: string
Benzersiz sayfa URL'si.
örnek: "blog"

depth: number
EbeveynId'ye göre sayfa iç içe geçme derinliği.
örnek: 10

localizeInfos: ILocalizeInfo
Sayfanın adı, yerelleştirme dikkate alınarak.
örnek:

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

isVisible: boolean
Sayfa görünürlüğü belirtisi.
örnek: true

type: Types
Sayfa türü.
örnek: "common_page"

templateIdentifier: string | null
Bağlı şablonun kullanıcı id'si.
örnek: "template"

attributeSetIdentifier: string | null
Öznitelik seti id'si.
örnek: "page"

attributeValues: AttributeType
Dizideki öznitelik değerleri (kullanıcı öznitelik id'si: öznitelik değeri çifti olarak temsil edilir).
örnek:

{
  "text": {
    "type": "string",
    "value": "bazı metin",
    "position": 0,
    "additionalFields": []
  }
}

isSync: boolean
Sayfa dizinleme belirtisi.
örnek: true

template: any
Şablon nesnesi.
örnek:

position: number
Sıralama için öğe numarası.
örnek: 2

config: any
Katalog sayfaları için çıktı ayarları.
örnek:

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

products: number
Sayfaya bağlı ürün sayısı.
örnek: 0

childrenCount: number
Çocuk sayısı.
örnek: 1

blocks: any
bloklar.
örnek:

{
  "id": 4,
  "attributeSetIdentifier": null,
  "title": "Şablon",
  "generalTypeId": 4,
  "identifier": "template",
  "version": 0,
  "generalTypeName": "catalog_page",
  "attributeValues": {},
  "position": 1
}