Предварительно необходимо загрузить файл с данными на сервер. Это можно сделать с помощью endpoint'а /disk/file/upload.
Для импорта данных передается хэш-значение загруженного файла и формат данных (xlsx, csv).
Есть возможность указать необходимость запуска обработчиков событий создания элемента. По умолчанию обработчики игнорируются.
Если для текущего приложения уже выполняется импорт, то новый импорт запустить не получится.

Запрос

POST /pub/v1/app/{namespace}/{code}/import

Параметры пути (path)

Имя параметра Тип Описание Дополнительно
namespace string

Код Раздела

Обязательный
code string

Код Приложения Раздела

Обязательный

Тело запроса (body)

Тело запроса принимает ресурс  Импорт данных из файла - Request. Содержит следующие доступные для записи свойства:

{
    "fileHash": "uuid",
    "format": "string",
    "withEventHandlers": "boolean"
}

Свойства

Имя Тип Описание Дополнительно
fileHash uuid

Хэш файла с данными

Опционально.
format string

Формат

Опционально.
withEventHandlers boolean

Запустить обработчики событий

Опционально.

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP.

HTTP статус Описание Модель ответа
200 OK

Модель результата импорта.

Модель результата импорта (Импорт данных из файла)