Перейти к основному контенту

getAllForms

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

Описание​

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

Forms.getAllForms(

langCode, offset, limit

);

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

Схема

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

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

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

Примеры​

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

const response = await Forms.getAllForms();

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

const response = await Forms.getAllForms('en_US', 0, 30);

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

[
  {
    "id": 9,
    "attributeSetId": 20,
    "type": "sing_in_up",
    "localizeInfos": {
      "title": "Регистрация",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 1,
    "identifier": "reg",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "string",
        "marker": "email_reg",
        "isLogin": true,
        "isSignUp": false,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {
          "emailInspectionValidator": true
        },
        "localizeInfos": {
          "title": "email"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      {
        "type": "string",
        "marker": "password_reg",
        "isLogin": null,
        "isSignUp": false,
        "position": 2,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {
          "requiredValidator": {
            "strict": true
          },
          "stringInspectionValidator": {
            "stringMax": 0,
            "stringMin": 0,
            "stringLength": 0
          }
        },
        "localizeInfos": {
          "title": "пароль"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      {
        "type": "string",
        "marker": "name_reg",
        "isLogin": null,
        "isSignUp": true,
        "position": 3,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "имя"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      "..."
    ]
  },
  {
    "id": 11,
    "attributeSetId": 28,
    "type": "data",
    "localizeInfos": {
      "title": "Расписание",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 2,
    "identifier": "schedule_form",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "timeInterval",
        "marker": "schedule",
        "isLogin": null,
        "isSignUp": null,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "Расписание",
          "intervals": [
            {
              "id": "f88c8793-798d-4fb1-9f8f-7b2013bcf04f",
              "range": [
                "2025-05-07T21:00:00.000Z",
                "2025-05-07T21:00:00.000Z"
              ],
              "external": [],
              "intervals": [
                {
                  "id": "47851bf0-1d39-422f-a155-3a6ba1d00a13",
                  "end": {
                    "hours": 12,
                    "minutes": 0
                  },
                  "start": {
                    "hours": 9,
                    "minutes": 0
                  },
                  "period": 60
                }
              ],
              "inEveryWeek": true,
              "inEveryMonth": true
            }
          ]
        },
        "additionalFields": [],
        "isNotificationEmail": null,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      }
    ]
  },
  {
    "id": 10,
    "attributeSetId": 16,
    "type": null,
    "localizeInfos": {
      "title": "Форма сбора ru_RU",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 3,
    "identifier": "collection_form",
    "processingType": "script",
    "templateId": null,
    "attributes": {}
  },
  "..."
]

Схема ответа​

Схема: IFormsEntity[]

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

attributeSetId: number | null
Идентификатор используемого набора атрибутов, или null, если не применимо.
пример: 1234

type: string | null
Тип формы.
пример: "contact"

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

{
  "key": "value"
}

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

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

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

processingType: string
Тип обработки формы.
пример: "async"

templateId: number | null
Идентификатор шаблона, используемого формой, или null, если шаблон не используется.
пример: 6789

attributes: IAttributes[] | Record<string, any>
Атрибуты формы, которые могут быть массивом объектов атрибутов или записью пар ключ-значение.
пример:

{
  "key": "value"
}