getAllForms

Получить все объекты форм

Forms.getAllForms(langCode, offset, limit)

const value = await Forms.getAllForms()

Схема

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

offset число
Параметр для постраничной навигации. По умолчанию 0
пример: 0

limit число
Параметр для постраничной навигации. По умолчанию 30
пример: 30

Этот метод извлекает все объекты форм из API. Он возвращает Promise, который разрешается в массив объектов FormEntity.

Пример возвращаемого значения:

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

Схема

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

attributeSetId: число
идентификатор используемого набора атрибутов

processingType: строка
тип обработки формы
пример: email

localizeInfos: FormLocalizeInfos
название формы с локализацией
Enum: [ db, email, script ] пример:

{
  "en_US": {
    "title": "Моя форма",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  }
}

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

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

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

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

position: строка
Тип формы
пример: 'data'

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

[
  {
    "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"
    }
  }
]