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(gerekli): 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": 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": "Ş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
Eğer null içeriyorsa, üst sayfanın id'si, o zaman üst düzey sayfadır.
örnek: 10

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

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

localizeInfos: ILocalizeInfo
Yerelleştirmeyi dikkate alarak sayfanın adı.
örnek:

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

isVisible: boolean
Sayfanın görünürlük durumu.
ö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
Özellikler kümesi id'si.
örnek: "page"

attributeValues: AttributeType
Kullanıcı özellik id'si: özellik değeri çiftleri olarak temsil edilen özellik değerleri dizisi.
örnek:

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

isSync: boolean
Sayfa dizinleme durumu.
örnek: true

template: object
Şablon nesnesi.

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

---