Публичный Web API: Описание спецификации

Операция	HTTP-запрос	Описание
POST	/pub/v1/app/{namespace}/{code}/{id}/update	Изменение элемента приложения
POST	/pub/v1/app/{namespace}/{code}/import	Импорт данных из файла
GET	/pub/v1/app/list	Получение списка приложений
GET	/pub/v1/app/{namespace}/{code}/list	Получение списка элементов приложения
POST	/pub/v1/app/{namespace}/{code}/list	Получение списка элементов приложения
POST	/pub/v1/app/{namespace}/{code}/import/status	Получение статуса импорта
GET	/pub/v1/app/{namespace}/{code}/settings/status	Получение статуса приложения
GET	/pub/v1/app/{namespace}/{code}/{id}/get	Получение элемента приложения по идентификатору
POST	/pub/v1/app/{namespace}/{code}/{id}/get	Получение элемента приложения по идентификатору
POST	/pub/v1/app/{namespace}/{code}/create	Создание элемента приложения
POST	/pub/v1/app/{namespace}/{code}/{id}/set-status	Установка статуса элемента приложения

Операция	HTTP-запрос	Описание
POST	/pub/v1/bpm/template/{namespace}/{code}/run	Запуск процесса по разделу и коду
GET	/pub/v1/bpm/instance/bytemplate/{namespace}/{code}/list	Получение списка экземпляров процесса
POST	/pub/v1/bpm/instance/bytemplate/{namespace}/{code}/list	Получение списка экземпляров процесса
GET	/pub/v1/bpm/instance/bytemplateid/{id}/list	Получение списка экземпляров процесса
POST	/pub/v1/bpm/instance/bytemplateid/{id}/list	Получение списка экземпляров процесса
GET	/pub/v1/bpm/instance/bytarget/list	Получение списка экземпляров процесса для цели
POST	/pub/v1/bpm/instance/bytarget/list	Получение списка экземпляров процесса для цели
GET	/pub/v1/bpm/instance/{id}/get	Получение экземпляра процесса по идентификатору
POST	/pub/v1/bpm/instance/{id}/get	Получение экземпляра процесса по идентификатору
POST	/pub/v1/bpm/restore-point/{id}/restore	Продолжение делегированного действия по идентификатору

Операция	HTTP-запрос	Описание
POST	/pub/v1/disk/file/upload	Загрузка временного файла
POST	/pub/v1/disk/directory/{id}/upload	Загрузка файла в директорию
POST	/pub/v1/disk/uploads/from-link	Массовая загрузка файлов по ссылкам
POST	/pub/v1/disk/files	Массовая инициализация файлов
POST	/pub/v1/disk/links/upload	Массовое получение ссылок на загрузку файлов
POST	/pub/v1/disk/links/download	Массовое получение ссылок на скачивание файлов
PATCH	/pub/v1/disk/files/deleted	Массовое удаление файлов
POST	/pub/v1/disk/file/move	Перемещение файла в директорию
GET	/pub/v1/disk/directory/{id}	Получение информации о директории по идентификатору
GET	/pub/v1/disk/file/{id}	Получение информации о файле по идентификатору
GET	/pub/v1/disk/directory/list	Получение списка директорий
POST	/pub/v1/disk/directory/list	Получение списка директорий
POST	/pub/v1/disk/file/{id}/get-link	Получение ссылки на скачивание файла по идентификатору файла
GET	/pub/v1/disk/file/{id}/get-link	Получение ссылки на скачивание файла по идентификатору файла
POST	/pub/v1/disk/directory	Создание директории

Операция	HTTP-запрос	Описание
GET	/pub/v1/user/list	Получение списка пользователей
POST	/pub/v1/user/list	Получение списка пользователей

Операция	HTTP-запрос	Описание
POST	/pub/v1/scheme/groups/{id}/add-items	Добавление элементов оргструктуры в группу
GET	/pub/v1/scheme/groups/{id}/parent-groups	Получение списка групп, в которые входит выбранная группа
GET	/pub/v1/scheme/groups/{id}/positions	Получение списка должностей, которые включены в состав группы
GET	/pub/v1/scheme/groups/{id}/sub-groups	Получение списка подгрупп выбранной группы
GET	/pub/v1/scheme/groups/{id}/users	Получение списка пользователей, которые включены в состав группы
GET	/pub/v1/scheme/namespaces/{namespace}/groups	Получение списка схем групп
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/groups	Получение списка схем групп и ролей по приложению
POST	/pub/v1/scheme/groups/list	Получение списка схем групп согласно условиям фильтрации
GET	/pub/v1/scheme/groups/list	Получение списка схем групп согласно условиям фильтрации
GET	/pub/v1/scheme/modules	Получение списка схем модулей
GET	/pub/v1/scheme/namespaces/{namespace}/apps	Получение списка схем приложений
GET	/pub/v1/scheme/namespaces	Получение списка схем разделов
GET	/pub/v1/scheme/solutions	Получение списка схем решений
GET	/pub/v1/scheme/namespaces/{namespace}/pages	Получение списка схем страниц
GET	/pub/v1/scheme/namespaces/{namespace}/doctemplates	Получение списка схем шаблонов документов для раздела
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/doctemplates	Получение списка схем шаблонов документов приложения
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/processes	Получение списка схем шаблонов процесса по приложению
GET	/pub/v1/scheme/namespaces/{namespace}/processes	Получение списка схем шаблонов процессов
GET	/pub/v1/scheme/modules/{id}	Получение схемы модуля по идентификатору
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}	Получение схемы приложения по коду
GET	/pub/v1/scheme/namespaces/{namespace}	Получение схемы раздела по коду
GET	/pub/v1/scheme/solutions/{code}	Получение схемы решения по коду
GET	/pub/v1/scheme/pages/{id}	Получение схемы страницы по идентификатору
GET	/pub/v1/scheme/doctemplates/{id}	Получение схемы шаблона документа по идентификатору
GET	/pub/v1/scheme/namespaces/{namespace}/processes/{code}	Получение схемы шаблона процесса по коду
GET	/pub/v1/scheme/groups/{id}	Получение экземпляра схемы группы по идентификатору
PUT	/pub/v1/scheme/groups/{id}	Редактирование данных группы
POST	/pub/v1/scheme/namespaces/{namespace}/groups	Создание схемы группы
DELETE	/pub/v1/scheme/groups/{id}	Удаление группы
POST	/pub/v1/scheme/groups/{id}/remove-items	Удаление элементов оргструктуры из группы
GET	/pub/v1/scheme/modules/{id}/exportable	Экспортируемость модуля по идентификатору
GET	/pub/v1/scheme/namespaces/{namespace}/apps/{code}/exportable	Экспортируемость приложения по коду
GET	/pub/v1/scheme/namespaces/{code}/exportable	Экспортируемость раздела по коду
GET	/pub/v1/scheme/solutions/{code}/exportable	Экспортируемость решения по коду

Операция	HTTP-запрос	Описание
PUT	/pub/v1/integration/{code}/voip/bindings	Обновление сопоставлений внутренних номеров пользователям ELMA365 модуля телефонии
GET	/pub/v1/integration/{code}/voip/bindings	Получение сопоставлений внутренних номеров пользователям ELMA365, заданные для модуля телефонии

Операция	HTTP-запрос	Описание
POST	/pub/v1/contracts/{namespace}/{code}/{id}/update	Изменение элемента контракта
GET	/pub/v1/contracts/{namespace}/{code}/list	Получение списка элементов контракта
POST	/pub/v1/contracts/{namespace}/{code}/list	Получение списка элементов контракта
GET	/pub/v1/contracts/{namespace}/{code}/{id}/get	Получение элемента контракта по идентификатору
POST	/pub/v1/contracts/{namespace}/{code}/create	Создание элемента приложения по умолчанию для контракта

Операция	HTTP-запрос	Описание
GET	/pub/v1/reports/{namespace}/{code}/list	Получение списка элементов отчёта
POST	/pub/v1/reports/{namespace}/{code}/list	Получение списка элементов отчёта

Операция	HTTP-запрос	Описание
PATCH	/pub/v1/marketing/segment/{id}/subscribers/add	Добавление подписчиков в статический сегмент
GET	/pub/v1/marketing/segment/{id}	Получение сегмента по идентификатору
POST	/pub/v1/marketing/subscriber	Получение списка подписчиков
POST	/pub/v1/marketing/segment/{id}/subscribers	Получение списка подписчиков сегмента
POST	/pub/v1/marketing/segment	Получение списка сегментов
PUT	/pub/v1/marketing/segment	Создание статического сегмента подписчиков
PATCH	/pub/v1/marketing/segment/{id}/subscribers/remove	Удаление подписчиков из статического сегмента

Операция	HTTP-запрос	Описание
PUT	/pub/v1/nomenclature/{id}	Изменение дела
PUT	/pub/v1/nomenclature/directory/{id}	Изменение директории номенклатуры
GET	/pub/v1/nomenclature	Получение списка дел
GET	/pub/v1/nomenclature/directory	Получение списка директорий номенклатуры
POST	/pub/v1/nomenclature	Создание дела
POST	/pub/v1/nomenclature/directory	Создание директории номенклатуры

Операция	HTTP-запрос	Описание
GET	/pub/v1/storage/system/{key}	Получение данных по ключу из хранилища объекта System
GET	/pub/v1/storage/{namespace}/{code}/{key}	Получение данных по ключу из хранилища приложения
GET	/pub/v1/storage/{namespace}/{key}	Получение данных по ключу из хранилища раздела или модуля
POST	/pub/v1/storage/system/{key}	Сохранение данных по ключу в хранилище объекта System
POST	/pub/v1/storage/{namespace}/{code}/{key}	Сохранение данных по ключу в хранилище приложения
POST	/pub/v1/storage/{namespace}/{key}	Сохранение данных по ключу в хранилище раздела или модуля
DELETE	/pub/v1/storage/system/{key}	Удаление данных по ключу из хранилища объекта System
DELETE	/pub/v1/storage/{namespace}/{code}/{key}	Удаление данных по ключу из хранилища приложения
DELETE	/pub/v1/storage/{namespace}/{key}	Удаление данных по ключу из хранилища раздела или модуля

Публичный Web API

Работа с приложениями

Работа с бизнес-процессами

Работа с файлами

Работа с пользователями

Работа с метаданными

Работа с модулями

Работа с контрактами

Работа с отчетами

Работа с маркетингом

Работа с номенклатурой

Работа с хранилищем произвольных строковых данных