getBlocksByPageUrl

Получение объектов для связанного блока по URL страницы.

Описание

Получите объекты PositionBlock для связанной формы по URL. Возвращает Promise, который разрешается в массив объектов IPositionBlock.

Pages.getBlocksByPageUrl(

url, langCode

);

Схема параметров

Схема

url(обязательно): string
URL страницы
пример: "about"

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

const response = await Pages.getFormsByPageUrl('shop');

Пример с атрибутами

const response = await Pages.getFormsByPageUrl('shop', 'en_US');

Пример ответа

[
  {
    "id": 1,
    "attributeSetIdentifier": null,
    "localizeInfos": {
      "title": "Блок продукта"
    },
    "version": 0,
    "position": 1,
    "identifier": "product_block",
    "type": "product_block",
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": false,
    "attributeValues": {},
    "countElementsPerRow": 1,
    "quantity": 1
  },
  {
    "id": 4,
    "attributeSetIdentifier": "block",
    "localizeInfos": {
      "title": "тест"
    },
    "version": 8,
    "position": 2,
    "identifier": "test",
    "type": "common_block",
    "templateIdentifier": null,
    "isVisible": true,
    "isSync": true,
    "attributeValues": {
      "block-text": {
        "type": "string",
        "value": "некоторый текст",
        "position": 0,
        "additionalFields": []
      },
      "interval": {
        "type": "timeInterval",
        "value": [
          {
            "values": [
              {
                "id": "bbc82c9f-1bc4-4c86-b83c-c062016eb7cb",
                "dates": [
                  "2025-04-14T00:00:00.000Z",
                  "2025-04-14T00:00:00.000Z"
                ],
                "times": [
                  [
                    {
                      "hours": 9,
                      "minutes": 0
                    },
                    {
                      "hours": 10,
                      "minutes": 0
                    }
                  ],
                  [
                    {
                      "hours": 10,
                      "minutes": 0
                    },
                    {
                      "hours": 11,
                      "minutes": 0
                    }
                  ],
                  [
                    {
                      "hours": 11,
                      "minutes": 0
                    },
                    {
                      "hours": 12,
                      "minutes": 0
                    }
                  ],
                  "..."
                ],
                "intervals": [],
                "exceptions": [],
                "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12",
                "inEveryWeek": true,
                "inEveryMonth": true,
                "timeIntervals": [
                  [
                    "2025-04-07T09:00:00.000Z",
                    "2025-04-07T10:00:00.000Z"
                  ],
                  [
                    "2025-04-07T10:00:00.000Z",
                    "2025-04-07T11:00:00.000Z"
                  ],
                  [
                    "2025-04-07T11:00:00.000Z",
                    "2025-04-07T12:00:00.000Z"
                  ],
                  "..."
                ]
              }
            ],
            "intervalId": "c6466cd8-c55d-4583-97c5-42b684210f12"
          }
        ],
        "position": 1,
        "additionalFields": []
      }
    }
  }
]

Схема ответа

Схема: IPositionBlock[]

id: number
Идентификатор объекта.
пример: 1

attributeSetIdentifier: string | null
Идентификатор набора атрибутов.
пример: "block"

localizeInfos: ILocalizeInfo
Название страницы с учетом локализации.

version: number
Номер версии объекта.
пример: 0

position: number
Позиция объекта.
пример: 1

identifier: string
Текстовый идентификатор для поля записи.
пример: "product_block"

type: Types
Тип страницы.
пример:

"product"

templateIdentifier: string | null
Идентификатор пользователя связанного шаблона.
пример: null

isVisible: boolean
Признак видимости страницы.
пример: true

isSync: boolean
Указание на индексацию страницы.
пример: false

attributeValues: AttributeType
Массив значений атрибутов из индекса (представленный в виде пары идентификатор пользователя атрибута: значение атрибута).
пример:

{
  "block-text": {
    "type": "string",
    "value": "некоторый текст",
    "position": 0,
    "additionalFields": []
  }
}

countElementsPerRow: number
Количество элементов, отображаемых в строке блока, если применимо.
пример: 3

quantity: number
Количество страниц в блоке.
пример: NaN

---