API Приложений
- create – Создание элемента Приложения
- list – Получение списка элементов Приложения
- get – Получение элемента Приложения по идентификатору
- set-status – Установка статуса элемента
- update – Изменение элемента Приложения
API Пользователей
- list – Получить список пользователей по ФИО
API Бизнес-процессов
- list – Получить список экземпляров процесса для цели
- list – Получить список экземпляров процесса
- get – Получение экземпляра процесса по идентификатору
- run – Запуск процесса по идентификатору шаблона
API Файлов
- upload – Загрузка файла в папку
- get-link – Получение ссылки на скачивание файла по идентификатору файла
HTTP-коды ответов:
- 200 – запрос прошел успешно
- 400 – во время запроса произошла ошибка. Описание в теле ответа
- 403 – не удалось авторизоваться
- 404 – неверный адрес запроса
Описание методов
Создание элемента Приложения
Метод |
post |
Путь |
/app/{namespace}/{code}/create |
URL |
https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/create
|
Параметры запроса
{
context:object #Поля создаваемого элемента
}
Структура ответа
{
error:string #Текст ошибки если success == false
item:object #Объект
success:boolean #Признак успешного запроса
}
Получение списка элементов Приложения
Метод |
post |
Путь |
/app/{namespace}/{code}/list |
URL |
https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/list
|
Параметры запроса
{
active:boolean #Показывать только активные (не удаленные)
filter:object #Фильтрация
from:integer #Возвращать начиная с элемента
ids:array #Фильтрация по идентификаторам
size:integer #Количество возвращаемых элементов (максимум 100)
sortExpressions:array #Правила сортировки
statusCode:array #Показывать элементы определенных статусов
}
Структура ответа
{
error:string #Текст ошибки если success == false
result:
{
result:array #Найденные элементы
total:integer #Всего элементов
}
success:boolean #Признак успешного запроса
}
Получение элемента Приложения по идентификатору
Метод |
post |
Путь |
/app/{namespace}/{code}/{id}/get |
URL |
https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/{id}/get
|
Структура ответа
{
error:string #Текст ошибки если success == false
item:object #Объект
success:boolean #Признак успешного запроса
}
Установка статуса элемента
Метод |
post |
Путь |
/app/{namespace}/{code}/{id}/set-status |
URL |
https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/{id}/set-status
|
Параметры запроса
{
status: #Пареметры нового статуса
{
code:string #Код статуса
}
}
Структура ответа
{
error:string #Текст ошибки если success == false
item:object #Объект
success:boolean #Признак успешного запроса
}
Изменение элемента Приложения
Метод |
post |
Путь |
/app/{namespace}/{code}/{id}/update |
URL |
https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/{id}/update
|
Параметры запроса
{
context:object #Изменяемые значения
}
Структура ответа
{
error:string #Текст ошибки если success == false
item:object #Объект
success:boolean #Признак успешного запроса
}
Метод |
post |
Путь |
/user/list |
URL |
https://{company}.quickbpm.{zone}/api/v1/user/list |
Параметры запроса
{
active:boolean #Показывать только активные (не удаленные)
filter:object #Фильтрация (например {«tf»:{«fullname»: «Дугаев»})
from:integer #Возвращать начиная с элемента
ids:array #Фильтрация по идентификаторам
size:integer #Количество возвращаемых элементов (максимум 100)
sortExpressions:array #Правила сортировки
}
Структура ответа
{
error:string #Текст ошибки если success == false
result:
{
result:array #Найденные элементы
total:integer #Всего элементов
}
success:boolean #Признак успешного запроса
}
Получить список экземпляров процесса для цели
Метод |
post |
Путь |
/bpm/instance/bytarget/list |
URL |
https://{company}.quickbpm.{zone}/pub/v1/bpm/instance/bytarget/list |
Параметры запроса
{
active:boolean #Показывать только активные (не удаленные)
from:integer #Возвращать начиная с элемента
size:integer #Количество возвращаемых элементов (максимум 100)
sortExpressions:array #Правила сортировки
target:string #Внешний идентификатор объекта
}
Структура ответа
{
error:string #Текст ошибки если success == false
result:
{
result:array #Найденные элементы
total:integer #Всего элементов
}
success:boolean #Признак успешного запроса
}
Получить список экземпляров процесса
Метод |
post |
Путь |
/bpm/instance/bytemplateid/{id}/list |
URL |
https://{company}.quickbpm.{zone}/pub/v1/bpm/instance/bytemplateid/{id}/list
|
Параметры запроса
{
active:boolean #Показывать только активные (не удаленные)
filter:object #Фильтрация
from:integer #Возвращать начиная с элемента
ids:array #Фильтрация по идентификаторам
size:integer #Количество возвращаемых элементов (максимум 100)
sortExpressions:array #Правила сортировки
}
Структура ответа
{
error:string #Текст ошибки если success == false
result:
{
result:array #Найденные элементы
total:integer #Всего элементов
}
success:boolean #Признак успешного запроса
}
Получение экземпляра процесса по идентификатору
Метод |
post |
Путь |
/bpm/instance/{id}/get |
URL |
https://{company}.quickbpm.{zone}/pub/v1/bpm/instance/{id}/get
|
Структура ответа
{
data:object #Данные
error:string #Текст ошибки если success == false
success:boolean #Признак успешного запроса
}
Запуск процесса по идентификатору шаблона
Метод |
post |
Путь |
/bpm/template/{namespace}/{code}/run |
URL |
https://{company}.quickbpm.{zone}/pub/v1/bpm/template/{namespace}/{code}/run
|
Параметры запроса
{
context:object #Контекст Бизнес-процесса
}
Структура ответа
{
context:object #Контекст Бизнес-процесса
error:string #Текст ошибки если success == false
success:boolean #Признак успешного запроса
}
Загрузка файла в папку
Метод |
post |
Путь |
/disk/directory/{id}/upload |
URL |
https://{company}.quickbpm.{zone}/pub/v1/disk/directory/{id}/upload
|
Параметры запроса
{
file:array #Загружаемый файл
}
Структура ответа
{
error:string #Текст ошибки если success == false
file:
{
__createdAt:string #Дата создания
__createdBy:UUID #Идентификатор создателя
__deletedAt:string #Дата удаления
__id:UUID #Идентификатор объекта
__updatedAt:string #Дата последнего редактирования
__updatedBy:UUID #Идентифкатор редактора
comment:string #Комментарий
directory:UUID #Идентификатор
name:string #Имя файла в системе
originalName:string #Имя загруженного файла
size:integer #Размер
version:integer #Версия файла
}
success:boolean #Признак успешного запроса
}
Получение ссылки на скачивание файла по идентификатору файла
Метод |
post |
Путь |
/disk/file/{id}/get-link |
URL |
https://{company}.quickbpm.{zone}/pub/v1/disk/file/{id}/get-link
|
Структура ответа
{
Link:string #Ссылка
error:string #Текст ошибки если success == false
success:boolean #Признак успешного запроса
}