- Введение в Web API
- Авторизация
- Типы данных
- Импорт данных
- Работа с фильтрами
- Работа с фильтрами в отчетах
- Дополнительные атрибуты поля
- Дополнительные атрибуты краткого описания данных
- Частичная и жадная загрузка полей приложений
-
Публичный Web API
-
Работа с приложениями
- Изменение элемента приложения (POST)
- Импорт данных из файла (POST)
- Получение списка приложений (GET)
- Получение списка элементов приложения (GET)
- Получение списка элементов приложения (POST)
- Получение статуса импорта (POST)
- Получение статуса приложения (GET)
- Получение элемента приложения по идентификатору (GET)
- Получение элемента приложения по идентификатору (POST)
- Создание элемента приложения (POST)
- Установка статуса элемента приложения (POST)
-
Работа с бизнес-процессами
- Запуск процесса по разделу и коду (POST)
- Изменить контекст экземпляра процесса (PUT)
- Массовое обновление экземпляров процессов (POST)
- Массовое прерывание экземпляров процессов (POST)
- Обновить версию экземпляра процесса (POST)
- Получение списка экземпляров процесса (GET)
- Получение списка экземпляров процесса (POST)
- Получение списка экземпляров процесса (GET)
- Получение списка экземпляров процесса (POST)
- Получение списка экземпляров процесса для цели (GET)
- Получение списка экземпляров процесса для цели (POST)
- Получение экземпляра процесса по идентификатору (GET)
- Получение экземпляра процесса по идентификатору (POST)
- Прервать экземпляр процесса (POST)
- Продолжение делегированного действия по идентификатору (POST)
-
Работа с файлами
- Загрузка временного файла (POST)
- Загрузка файла в директорию (POST)
- Массовая загрузка файлов по ссылкам (POST)
- Массовая инициализация файлов (POST)
- Массовое получение ссылок на загрузку файлов (POST)
- Массовое получение ссылок на скачивание файлов (POST)
- Массовое удаление файлов (PATCH)
- Перемещение файла в директорию (POST)
- Поиск файлов (POST)
- Получение информации о директории по идентификатору (GET)
- Получение информации о файле по идентификатору (GET)
- Получение списка директорий (GET)
- Получение списка директорий (POST)
- Получение ссылки на скачивание файла по идентификатору файла (GET)
- Получение ссылки на скачивание файла по идентификатору файла (POST)
- Создание директории (POST)
- Работа с пользователями
-
Работа с метаданными
- Добавление элементов оргструктуры в группу (POST)
- Получение списка групп, в которые входит выбранная группа (GET)
- Получение списка должностей, которые включены в состав группы (GET)
- Получение списка подгрупп выбранной группы (GET)
- Получение списка пользователей, которые включены в состав группы (GET)
- Получение списка схем групп (GET)
- Получение списка схем групп и ролей по приложению (GET)
- Получение списка схем групп согласно условиям фильтрации (GET)
- Получение списка схем групп согласно условиям фильтрации (POST)
- Получение списка схем модулей (GET)
- Получение списка схем приложений (GET)
- Получение списка схем разделов (GET)
- Получение списка схем решений (GET)
- Получение списка схем страниц (GET)
- Получение списка схем шаблонов документов для раздела (GET)
- Получение списка схем шаблонов документов приложения (GET)
- Получение списка схем шаблонов процесса по приложению (GET)
- Получение списка схем шаблонов процессов (GET)
- Получение схемы модуля по идентификатору (GET)
- Получение схемы приложения по коду (GET)
- Получение схемы раздела по коду (GET)
- Получение схемы решения по коду (GET)
- Получение схемы страницы по идентификатору (GET)
- Получение схемы шаблона документа по идентификатору (GET)
- Получение схемы шаблона процесса по коду (GET)
- Получение экземпляра схемы группы по идентификатору (GET)
- Редактирование данных группы (PUT)
- Создание схемы группы (POST)
- Удаление группы (DELETE)
- Удаление элементов оргструктуры из группы (POST)
- Экспортируемость модуля по идентификатору (GET)
- Экспортируемость приложения по коду (GET)
- Экспортируемость раздела по коду (GET)
- Экспортируемость решения по коду (GET)
- Работа с модулями
- Работа с контрактами
- Работа с отчетами
-
Работа с маркетингом
- Добавление подписчиков в статический сегмент (PATCH)
- Получение сегмента по идентификатору (GET)
- Получение списка подписчиков (POST)
- Получение списка подписчиков сегмента (POST)
- Получение списка сегментов (POST)
- Создание статического сегмента подписчиков (PUT)
- Удаление подписчиков из статического сегмента (PATCH)
- Работа с номенклатурой
-
Работа с хранилищем произвольных строковых данных
- Получение данных по ключу из хранилища объекта System (GET)
- Получение данных по ключу из хранилища приложения (GET)
- Получение данных по ключу из хранилища раздела или модуля (GET)
- Сохранение данных по ключу в хранилище объекта System (POST)
- Сохранение данных по ключу в хранилище приложения (POST)
- Сохранение данных по ключу в хранилище раздела или модуля (POST)
- Удаление данных по ключу из хранилища объекта System (DELETE)
- Удаление данных по ключу из хранилища приложения (DELETE)
- Удаление данных по ключу из хранилища раздела или модуля (DELETE)
- Работа с листами согласования и ознакомления
- Работа с регистрациями
-
Работа с задачами
- Выполнение задачи (PUT)
- Изменение дат задачи (POST)
- Изменение процента выполнения задачи (POST)
- Переназначение задачи (POST)
- Получение задачи по идентификатору (GET)
- Получение списка входящих задач (GET)
- Получение списка входящих задач (POST)
- Получение списка выходов для задачи (GET)
- Получение списка задач (GET)
- Получение списка задач (POST)
- Получение списка задач пользователя (GET)
- Получение списка задач пользователя (POST)
- Получение списка задач раздела "Участвую" (GET)
- Получение списка задач раздела "Участвую" (POST)
- Получение списка исходящих задач (GET)
- Получение списка исходящих задач (POST)
-
Работа с сообщениями
- Получение списка каналов (GET)
- Получение списка комментариев к сообщению из канала (GET)
- Получение списка комментариев к сообщению из канала (POST)
- Получение списка комментариев к сообщению из ленты объекта (POST)
- Получение списка комментариев к сообщению из ленты объекта (GET)
- Получение списка сообщений из канала (GET)
- Получение списка сообщений из канала (POST)
- Получение списка сообщений из ленты объекта (GET)
- Получение списка сообщений из ленты объекта (POST)
- Создание комментария к сообщению в канале (POST)
- Создание комментария к сообщению в ленте объекта (POST)
- Создание нового сообщения в канале (POST)
- Создание нового сообщения в ленте объекта (POST)
-
Работа с приложениями
- Спецификация OpenAPI
Импорт данных из файла
Для импорта необходимо предварительно загрузить файл с данными на сервер. Это можно сделать с помощью 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 Модель результата импорта |
Модель результата импорта (Импорт данных из файла) |