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

getFormsDataByMarker

Поиск данных формы по текстовому идентификатору (маркеру).

Описание

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

FormData.getFormsDataByMarker(

marker, langCode, offset, limit

);

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

Схема

marker(обязательный): string
Маркер формы
пример: "contact_form"

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

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

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

Примеры

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

const response = await FormData.getFormsDataByMarker('my-marker');

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

const response = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30);

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

{
"items": [
{
"id": 285,
"formIdentifier": "test-form",
"time": "2025-07-21T01:54:30.043Z",
"formData": [
{
"marker": "name",
"type": "string",
"value": "Test"
}
],
"attributeSetIdentifier": "form"
},
{
"id": 283,
"formIdentifier": "test-form",
"time": "2025-07-21T01:49:33.957Z",
"formData": [
{
"marker": "name",
"type": "string",
"value": "Test"
}
],
"attributeSetIdentifier": "form"
},
{
"id": 281,
"formIdentifier": "test-form",
"time": "2025-07-21T01:44:11.296Z",
"formData": [
{
"marker": "name",
"type": "string",
"value": "Test"
}
],
"attributeSetIdentifier": "form"
},
"..."
],
"total": 169
}

Схема ответа

Схема: IFormsDataEntity

items: IFormDataEntity[]
Массив объектов данных формы.
пример:

[
{
"id": 1,
"formIdentifier": "form",
"time": "2025-06-06T19:07:45.993Z",
"formData": {},
"attributeSetIdentifier": "form",
"actionMessage": "Строка сообщения действия"
}
]

total: number
Общее количество найденных записей.
пример: NaN