getFormsByPageUrl

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

Описание

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

Pages.getFormsByPageUrl(

url*, langCode

);

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

Схема

url:* string
URL страницы
пример: shop

langCode: string
код языка
пример: en_US

Примеры

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

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

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

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

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

[
  {
    "id": 1764,
    "version": 10,
    "identifier": "catalog",
    "attributeSetId": 0,
    "processingType": "email",
    "localizeInfos": {
      "title": "Моя форма",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "processingData": {},
    "position": 0,
    "attributes": [
      {
        "type": "list",
        "marker": "list_marker",
        "position": 2,
        "listTitles": [
          {
            "title": "красный",
            "value": 1,
            "position": 1,
            "extendedValue": null,
            "extendedValueType": null
          },
          {
            "title": "желтый",
            "value": 2,
            "position": 2,
            "extendedValue": null,
            "extendedValueType": null
          }
        ],
        "validators": {},
        "localizeInfos": {
          "title": "l1"
        }
      }
    ]
  }
]

Схема ответа

Схема: IPositionForm[]

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

version number
номер версии объекта
пример: 10

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

attributeSetId: number
идентификатор набора атрибутов
пример: 7

processingType: string
тип обработки формы
пример: email
Enum: [ db, email, script ]

localizeInfos: Record<string, any>
json-описание основного объекта данных страницы с учетом языка "en_US" (например)
пример:

{
  "en_US": {
    "title": "Каталог",
    "plainContent": "Содержимое для каталога",
    "htmlContent": "<b>Содержимое для каталога</b>",
    "menuTitle": "Каталог"
  }
}

processingData:
данные формы

attributes: Record<string, string>
массив значений атрибутов из используемого набора атрибутов для отображения формы (с учетом указанного языка)
пример:

[
  {
    "type": "list",
    "marker": "l1",
    "position": 2,
    "listTitles": [
      {
        "title": "красный",
        "value": 1,
        "position": 1,
        "extendedValue": null,
        "extendedValueType": null
      },
      {
        "title": "желтый",
        "value": 2,
        "position": 2,
        "extendedValue": null,
        "extendedValueType": null
      }
    ],
    "validators": {},
    "localizeInfos": {
      "title": "l1"
    }
  }
]

position: number
номер позиции для сортировки (необязательно)
пример: 192

---