Экспорт данных заполнений формы

Описание

Выгружает данные о заполнениях формы в файл. Для получения результата нужно получить статус задачи и выгрузить итоговый файл.

Шаг 1. Создание задачи на экспорт

URL-адрес

Метод: POST

https://example.com/api/v1.1/forms/fills

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
id	int	1	Да, если не указан shortname	Идентификатор формы
shortname	string	"form_6Ven2v7O"	Да, если не указан id	Короткое имя формы
date_from	string	"2026-04-01"	Да	Начальная дата периода. Формат: YYYY-MM-DD
date_to	string	"2026-04-30"	Да	Конечная дата периода. Формат: YYYY-MM-DD
file_format	string	"csv"	Нет	Формат файла: csv или json
limit	int	1000	Нет	Максимальное количество записей. По умолчанию — без ограничения

Пример запроса

JSON

{
  "id": 1,
  "date_from": "2026-04-01",
  "date_to": "2026-04-30",
  "file_format": "csv"
}

XML

<xml>
  <id>1</id>
  <date_from>2026-04-01</date_from>
  <date_to>2026-04-30</date_to>
  <file_format>csv</file_format>
</xml>

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

JSON

{
  "data": {
    "task_id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <task_id>550e8400-e29b-41d4-a716-446655440000</task_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
data	object	Объект с данными ответа

Объект data

Параметр	Тип	Описание
task_id	string	Идентификатор асинхронной задачи для получения данных заполнений

Шаг 2. Проверка статуса задачи и получение ссылки

URL-адрес

Метод: POST

https://example.com/api/v1.1/tasks/status

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
task_id	string	"550e8400-e29b-41d4-a716-446655440000"	Да	Идентификатор задачи из шага 1

Пример запроса

JSON

{
  "task_id": "550e8400-e29b-41d4-a716-446655440000"
}

XML

<xml>
  <task_id>550e8400-e29b-41d4-a716-446655440000</task_id>
</xml>

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

JSON

{
  "data": {
    "status": "completed",
    "progress": 100,
    "result": {
      "form_id": 1,
      "total": 42,
      "url": "abCDefghIklMnop57498257/1_20002_form_export.zip"
    }
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <status>completed</status>
    <progress>100</progress>
    <result>
      <form_id>1</form_id>
      <total>42</total>
      <url>abCDefghIklMnop57498257/1_20002_form_export.zip</url>
    </result>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

Параметр	Тип	Описание
status	string	Статус задачи (completed — задача выполнена)
progress	int	Прогресс выполнения в процентах
result	object	Объект с результатами экспорта. См. result
error	int	Код ошибки
error_text	string	Текст ошибки

Объект result

Параметр	Тип	Описание
form_id	int	Идентификатор формы
total	int	Общее количество записей о заполнениях
url	string	Зашифрованный путь к файлу с данными

Шаг 3. Загрузка файла

Для загрузки файла необходимо отправить GET запрос по ссылке, составленной из базового URL платформы, префикса сущности и значения параметра url из ответа шага 2:

https://example.com/api/download/forms/ + значение url

Например:

https://example.com/api/download/forms/abCDefghIklMnop57498257/1_20002_form_export.zip

где:

• https://example.com — домен платформы
• api/download/forms/ — фиксированный префикс для выгрузки данных форм
• abCDefghIklMnop57498257/1_20002_form_export.zip — значение параметра url из ответа шага 2 (зашифрованный путь и имя файла)

Запрос должен содержать заголовок авторизации Authorization: Bearer <token>.