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

postFormsData

Создание объекта данных формы для сохранения информации.

Описание​

Этот метод возвращает созданный объект FormDataEntity. Если вы хотите изменить язык, просто передайте его в качестве второго аргумента.

Методы с POST-запросом принимают в качестве тела запроса объект с полем данных формы, которое соответствует типу отправляемой информации. Ниже приведены примеры объектов данных формы для различных типов данных.

FormData.postFormsData(

body, langCode

);

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

Схема (body)

body(обязательно): объект
Тело запроса
пример:

{
  "formIdentifier": "form",
  "formData": [
    {
      "marker": "name",
      "type": "string",
      "value": "Jack"
    }
  ]
}

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

body.formIdentifier: строка
Идентификатор формы
пример: "contact-form"

body.formData: строка
**
пример:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Jack"
  }
]

body.formData.marker: строка
Маркер атрибута формы
пример: "name"

body.formData.type: строка
Тип атрибута формы
пример: "string"

body.formData.value: строка
Значение атрибута формы
пример: "Jack"

Примеры​

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

const body = {
"formIdentifier": "contact_us",
"formData": [
{
"marker": "last_name",
"type": "string"
"value": "Andrey"
}
]
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "string", "number", "float"​

const body = {
  "marker": "last_name",
  "type": "string",
  "value": "Username"
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "date", "dateTime", "time"​

const body = {
  "marker": "birthday",
  "type": "date",
  "value": {
    "fullDate": "2024-05-07T21:02:00.000Z",
    "formattedValue": "08-05-2024 00:02",
    "formatString": "DD-MM-YYYY HH:mm"
  }
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "text"​

const body = {
  "marker": "about",
  "type": "text",
  "value": {
    "htmlValue": "<p>Привет, мир</p>",
    "plainValue": "",
    "params": {
      "isEditorDisabled": false,
      "isImageCompressed": true
    }
  }
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "textWithHeader"​

const body = {
  "marker": "about",
  "type": "textWithHeader",
  "value": {
    "header": "Заголовок",
    "htmlValue": "<p>Привет, мир</p>",
    "plainValue": "",
    "params": {
      "isEditorDisabled": false,
      "isImageCompressed": true
    }
  }
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "image" или "groupOfImages"​

const body = {
  "marker": "avatar",
  "type": "image",
  "value": [
    {
      "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "size": 392585,
      "previewLink": "",
      "params": {
        "isImageCompressed": true
      }
    }
  ]
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "files"​

const body = {
  "marker": "picture",
  "type": "file",
  "value": [
    {
      "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "size": 392585
    }
  ]
};

const response = await FormData.postFormsData(body);

Пример с простым типом атрибута "radioButton" или "list"​

const body = {
  "marker": "selector",
  "type": "list",
  "value": [
    {
      "title": "красный",
      "value": "1",
      "extended": {
        "value": "red",
        "type": "string"
      }
    }
  ]
};

const response = await FormData.postFormsData(body);

Пример с типом атрибута "entity" (вложенный список)​

const body = {
  "formIdentifier": "entity_form",
  "formData": {
    "en_US": [
      {
        "marker": "entity-marker",
        "type": "entity",
        "value": [25, 32, 24]
      }
    ]
  }
};

const response = await FormData.postFormsData(body);

Значение - числовые идентификаторы для страниц и строковые идентификаторы для продуктов. Идентификаторы для продуктов должны включать префикс 'p-', например, 'p-1-', 'p-2-', и т.д. p-[parentId]-[productId]

Пример с типом атрибута "timeInterval"​

const body = {
  "formIdentifier": "reg",
  "formData": {
    "en_US": [
      {
        "marker": "interval",
        "type": "timeInterval",
        "value": [
          [
            "2025-02-11T16:00:00:000Z",
            "2025-02-13T16:00:00:000Z",
          ]
        ]
      }
    ]
  }
};

const response = await FormData.postFormsData(body);

значение — массив массивов интервалов в формате ISO 8601. например 2025-02-11T16:00:00:000Z

2025 — год; 02 — месяц; 11 — день месяца; T — разделитель между датой и временем; 16:00:00 — время в формате часы:минуты:секунды; 000Z — миллисекунды и указание часового пояса. Z означает, что время указано в формате UTC.

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

{
  "formData": {
    "formIdentifier": "test-form",
    "time": "2025-07-21T09:40:06.587Z",
    "formData": [
      {
        "marker": "name",
        "type": "string",
        "value": "Test"
      }
    ],
    "id": 286
  },
  "actionMessage": ""
}

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

Схема: IFormDataEntity

formIdentifier: строка
Идентификатор страницы.
пример: "contact_form"

time: Дата | строка
Идентификатор формы.
пример:

"2023-10-01T12:00:00Z"

formData: FormDataType[]
Данные формы.
пример:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Test"
  }
]

id: число
Уникальный идентификатор страницы формы.
пример: 12345

actionMessage: строка | null
Сообщение о действии для данных формы.
пример: "Форма успешно отправлена"

attributeSetIdentifier: строка | null
Текстовый идентификатор (маркер) используемого набора атрибутов.
пример: "product_attributes"