Методы RESTful Web Api
RESTful Web Api Comindware Business Application Platform представляет собой публичные методы REST API, которые универсальны и неизменны между версиями Comindware Business Application Platform.
Каждый метод имеет свой тип данных (модель или пример), который поясняет работу запроса, где:
- Alias — системное имя (уникальное текстовое имя объекта);
- Id — ИД (автоматически заполняемый уникальный идентификатор объекта).
| Account — Пользователь | ||||
|---|---|---|---|---|
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| GET | /webapi/Account | Получить данные всех пользователей. | Данные всех существующих пользователей. | |
| POST | /webapi/Account | Создать пользователя. | Данные пользователя. | ID пользователя. |
| PUT | /webapi/Account | Изменить данные пользователя. | Данные пользователя. | Статус. |
| DELETE |
/webapi/Account/ {accountId} |
Удалить пользователя. | ID пользователя. | Статус. |
| GET |
/webapi/Account/ {accountId} |
Получить данные пользователя. | ID пользователя. | Данные указанного пользователя. |
| AccountTemplate — Шаблон пользователя | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/ AccountTemplate/ {solutionAlias} |
Создать шаблон пользователя. | Системное имя бизнес-приложения и данные шаблона. | Системное имя шаблона пользователя. |
| PUT |
/webapi/ AccountTemplate/ {solutionAlias} |
Изменить шаблон пользователя. | Системное имя бизнес-приложения и данные шаблона. | Статус. |
| DELETE |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias} |
Удалить шаблон пользователя. | Системное имя бизнес-приложения и системное имя шаблона пользователя. | Статус. |
| GET |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias} |
Получить данные шаблона пользователя. | Системное имя бизнес-приложения и системное имя шаблона пользователя. | Данные указанного шаблона пользователя. |
| PUT |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias}/ Disable |
Архивировать. | Системное имя бизнес-приложения и системное имя шаблона пользователя. | Статус. |
| PUT |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias}/ Enable |
Разархивировать. | Системное имя бизнес-приложения и системное имя шаблона пользователя. | Статус. |
| PUT |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias}/ Exclude |
Удалить пользователей. | Системное имя бизнес-приложения, системное имя шаблона пользователя и ID пользователей. | Статус. |
| PUT |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias}/ Include |
Добавить пользователей. | Системное имя бизнес-приложения, системное имя шаблона пользователя и ID пользователей. | Статус. |
| GET |
/webapi/ AccountTemplate/ {solutionAlias}/ {accountTemplateAlias}/ ListIncluded |
Получить всех пользователей одного шаблона пользователя. | Системное имя бизнес-приложения и системное имя шаблона пользователя. | Данные всех пользователей указанного шаблона пользователя. |
| GET |
/webapi/ AccountTemplate/ List/{solutionAlias} |
Получить все шаблоны пользователя одного бизнес-приложения. | Системное имя бизнес-приложения. | Данные всех шаблонов пользователя указанного бизнес-приложения. |
| Attribute — Атрибут | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/Attribute/ {solutionAlias} |
Создать атрибут. | Системное имя бизнес-приложения, данные атрибута. | Системное имя атрибута. |
| PUT |
/webapi/Attribute/ {solutionAlias} |
Изменить атрибут. | Системное имя бизнес-приложения, данные атрибута. | Статус. |
| DELETE |
/webapi/Attribute/ {solutionAlias}/ {attributeGlobalAlias} |
Удалить атрибут. |
Системное имя бизнес-приложения, системное имя шаблона записи и системное имя атрибута. |
Статус. |
| GET |
/webapi/Attribute/ {solutionAlias}/ {attributeGlobalAlias} |
Получить данные атрибута. |
Системное имя бизнес-приложения, системное имя шаблона записи и системное имя атрибута. |
Данные указанного атрибута. |
| PUT |
/webapi/Attribute/ {solutionAlias}/ {attributeGlobalAlias}/ Disable |
Архивировать. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя атрибута. | Статус. |
| PUT |
/webapi/Attribute/ {solutionAlias}/ {attributeGlobalAlias}/ Enable |
Разархивировать. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя атрибута. | Статус. |
| GET |
/webapi/Attribute/List/ {templateGlobalAlias} |
Получить все атрибуты одного шаблона. | Системное имя бизнес-приложения и системное имя шаблона записи. | Данные всех существующих атрибутов указанного шаблона записи. |
| Backup — Резервное копирование | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| DELETE |
/webapi/Backup/ Configuration |
Удалить конфигурацию. | ID конфигурации. | Статус. |
| GET |
/webapi/Backup/ Configuration |
Получить все конфигурации. | Данные всех существующих конфигураций. | |
| POST |
/webapi/Backup/ Configuration |
Создать конфигурацию. | Данные конфигурации резервного копирования. | ID конфигурации. |
| PUT |
/webapi/Backup/ Configuration |
Изменить конфигурацию. | Данные конфигурации резервного копирования. | Статус. |
| GET |
/webapi/Backup/ Configuration/ {configurationId} |
Получить данные конфигурации по id. | ID конфигурации. | Данные указанной конфигурации. |
| POST |
/webapi/Backup/ CreateRestorePoint |
Извлечь базу данных. | Данные конфигурации пути для передачи базы данных. | Извлечение базы данных в указанную папку. |
| DELETE |
/webapi/Backup/ Session |
Удалить сессию по id. | ID сессии. | Статус. |
| POST |
/webapi/Backup/ Session |
Получить все сессии по фильтру. | Статус сессий, нижняя граница даты завершения, верхняя граница даты в очереди. | Данные всех сессий. |
| POST |
/webapi/Backup/ Session/ {configurationId} |
Создать сессию резервного копирования по указанной конфигурации. | ID конфигурации. | Данные сессии. |
| GET |
/webapi/Backup/ Session/ {sessionId} |
Получить данные сессии по id. | ID сессии. | Данные сессии. |
| PUT |
/webapi/Backup/ Session/ {sessionId} |
Завершить сессию по id. | ID сессии. | Данные сессии. |
| GET |
/webapi/Backup/ Session/ {sessionId}/Path |
Получить путь, где хранится сессия. | ID сессии. | Данные пути хранения указанной сессии. |
| BehaviourState — Управление активностями | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| GET |
/webapi/BehaviourState/ {solutionAlias} |
Получить все активности. | Системное имя бизнес-приложения. | Данные всех активностей указанного бизнес-приложения. |
| PUT |
/webapi/BehaviourState/ {solutionAlias} |
Включить/выключить активность. | Системное имя бизнес-приложение, данные активности. | Статус. |
| CaseTemplate — Шаблон кейса | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/CaseTemplate/ {solutionAlias} |
Создать шаблон кейса. | Системное имя бизнес-приложения и данные шаблона кейса. | Системное имя шаблона кейса. |
| PUT |
/webapi/CaseTemplate/ {solutionAlias} |
Изменить шаблон кейса. | Системное имя бизнес-приложения и данные шаблона кейса. | Статус. |
| DELETE |
/webapi/CaseTemplate/ {solutionAlias}/ {caseTemplateAlias} |
Удалить шаблон кейса. | Системное имя бизнес-приложения и системное имя шаблона кейса. | Статус. |
| GET |
/webapi/CaseTemplate/ {solutionAlias}/ {caseTemplateAlias} |
Получить данные шаблона кейса. | Системное имя бизнес-приложения и системное имя шаблона кейса. | Данные указанного шаблона кейса. |
| PUT |
/webapi/CaseTemplate/ {solutionAlias}/ {caseTemplateAlias}/ Disable |
Архивировать. | Системное имя бизнес-приложения и системное имя шаблона кейса. | Статус. |
| PUT |
/webapi/CaseTemplate/ {solutionAlias}/ {caseTemplateAlias}/ Enable |
Разархивировать. | Системное имя бизнес-приложения и системное имя шаблона кейса. | Статус. |
| GET |
/webapi/CaseTemplate/ List/{solutionAlias} |
Получить все шаблоны кейсов. | Системное имя бизнес-приложения. | Данные всех шаблонов кейса указанного бизнес-приложения. |
| Dataset — Список | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/Dataset/ {solutionAlias} |
Создать список. | Системное имя бизнес-приложения и данные списка. | Системное имя списка. |
| PUT |
/webapi/Dataset/ {solutionAlias} |
Изменить список. | Системное имя бизнес-приложения и данные списка. | Статус. |
| DELETE |
/webapi/Dataset/ {solutionAlias}/ {datasetGlobalAlias} |
Удалить список. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя списка. | Статус. |
| GET |
/webapi/Dataset/ {solutionAlias}/ {datasetGlobalAlias} |
Получить данные списка. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя списка. | Данные указанного списка. |
| GET |
/webapi/Dataset/ List/{templateGlobalAlias} |
Получить все списки. | Системное имя бизнес-приложения и системное имя шаблона записи. | Данные всех списков указанного шаблона записи. |
| Document — Документ | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST | /webapi/Document | Создать документ. | Данные документа. | ID документа. |
| PUT | /webapi/Document | Изменить документ. | Данные документа. | Статус. |
| DELETE |
/webapi/Document/ {documentId} |
Удалить документ. | ID документа. | Статус. |
| GET |
/webapi/Document/ {documentId} |
Получить данные документа. | ID документа. | Данные указанного документа. |
| GET |
/webapi/Document/ {documentId}/ Content |
Получить документ. | ID документа. | Ссылка для скачивания указанного документа. |
| POST |
/webapi/Document/ Content |
Создать документ. | Ссылка на документ. | ID документа. |
| POST |
/webapi/Document/ Revision/{documentId}/ Content |
Создать версию документа. | ID документа и ссылка на новую версию документа. | ID версии документа. |
| GET |
/webapi/Document/ Revision/{revisionId} |
Получить данные версии документа. | ID версии документа. | Данные указанной версии документа. |
| GET |
/webapi/Document/ Revision/{revisionId}/ Content |
Получить версию документа. | ID версии документа. | Ссылка для скачивания указанной версии документа. |
| DocumentExportTemplate — Шаблон экспорта | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/ DocumentExportTemplate/ {solutionAlias} |
Создать шаблон экспорта. | Системное имя бизнес-приложения и данные шаблона экспорта. | Системное имя шаблона экспорта. |
| PUT |
/webapi/ DocumentExportTemplate/ {solutionAlias} |
Изменить шаблон экспорта. | Системное имя бизнес-приложения и данные шаблона экспорта. | Статус. |
| DELETE |
/webapi/ DocumentExportTemplate/ {solutionAlias}/ {exportTemplate GlobalAlias} |
Удалить шаблон экспорта. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя шаблона экспорта. | Статус. |
| GET |
/webapi/ DocumentExportTemplate/ {solutionAlias}/ {exportTemplate GlobalAlias} |
Получить данные шаблона экспорта. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя шаблона экспорта. | Данные указанного шаблона экспорта. |
| GET |
/webapi/ DocumentExportTemplate/ List/ {templateGlobalAlias} |
Получить все шаблоны экспорта. | Системное имя бизнес-приложения и системное имя шаблона записи. | Данные всех шаблонов экспорта указанного шаблона записи. |
| Form — Форма | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/Form/ {solutionAlias} |
Создать форму. | Системное имя бизнес-приложения и данные формы. | Системное имя формы. |
| PUT |
/webapi/Form/ {solutionAlias} |
Изменить форму. | Системное имя бизнес-приложения и данные формы. | Статус. |
| DELETE |
/webapi/Form/ {solutionAlias}/ {formGlobalAlias} |
Удалить форму. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя формы. | Статус. |
| GET |
/webapi/Form/ {solutionAlias}/ {formGlobalAlias} |
Получить данные формы. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя формы. | Данные указанной формы. |
| GET |
/webapi/Form/ FormRules/ {solutionAlias}/ {formGlobalAlias} |
Получить данные о настроенных правилах для формы. | Системное имя бизнес-приложения, системное имя шаблона записи и системное имя формы. | Данные настроенных правил для указанной формы. |
| PUT |
/webapi/Form/ FormRules/ {solutionAlias}/ {formGlobalAlias} |
Установить правило для формы. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя формы и данные правил для формы. | Статус. |
| GET |
/webapi/Form/ List/ {templateGlobalAlias} |
Получить все формы. | Системное имя бизнес приложения и системное имя шаблона записи. | Данные всех форм указанного шаблона записи. |
| SolutionGitIntegration — Управление версиями | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/Git/ AddRemoteBranch |
Создать удаленный репозиторий. | Данные конфигурации бизнес-приложения. | Статус. |
| POST |
/webapi/Git/ Connect |
Инициализировать репозиторий. | Данные конфигурации репозитория. | Статус. |
| POST |
/webapi/Git/ GetRepositoryDetails |
Получить данные репозитория. | Данные конфигурации репозитория. | Статус. |
| GET |
/webapi/Git/ GetUserConfiguration |
Получить пользовательские настройки. | Пользовательские настройки реопзитория. | |
| GET |
/webapi/Git/ GetUserSolutionConfig |
Получить расширенные пользовательские настройки. | Расширенные пользовательские настройки репозитория. | |
| POST |
/webapi/Git/ ListBranches |
Получить все ветки. | Данные конфигурации репозитория. | Данные всех веток указанного репозитория. |
| GET |
/webapi/Git/ ListRepositories |
Получить все репозитории. | Данные всех репозиториев. | |
| POST |
/webapi/Git/ SaveUserCredentials |
Сохранить пользовательские настройки. | ||
| Heartbeat — Производительность | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| GET |
/webapi/Heartbeat/ Details |
Получить данные производительности. | Данные производительности. | |
| GET |
/webapi/Heartbeat/ IsAlive |
Получить статус сервиса. | Данные статуса сервиса. | |
| GET |
/webapi/Heartbeat/ ServerDetails |
Получить данные сервера. | Данные сервера. | |
| ProcessTemplate — Шаблон процесса | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/ ProcessTemplate/ {solutionAlias} |
Создать шаблон процесса. | Системное имя бизнес-приложения, данные шаблона процесса. | Системное имя шаблона процесса. |
| PUT |
/webapi/ ProcessTemplate/ {solutionAlias} |
Изменить шаблон процесса. | Системное имя бизнес-приложения, данные шаблона процесса. | Статус. |
| DELETE |
/webapi/ ProcessTemplate/ {solutionAlias}/ {processTemplateAlias} |
Удалить шаблон процесса. | Системное имя бизнес-приложения, системное имя шаблона процесса. | Статус. |
| GET |
/webapi/ ProcessTemplate/ {solutionAlias}/ {processTemplateAlias} |
Получить данные шаблона процесса. | Системное имя бизнес-приложения, системное имя шаблона процесса. | Данные указанного шаблона процесса. |
| PUT |
/webapi/ ProcessTemplate/ {solutionAlias}/ {processTemplateAlias}/ Disable |
Архивировать. | Системное имя бизнес-приложения, системное имя шаблона процесса. | Статус. |
| PUT |
/webapi/ ProcessTemplate/ {solutionAlias}/ {processTemplateAlias}/ Enable |
Разархивировать. | Системное имя бизнес-приложения, системное имя шаблона процесса. | Статус. |
| GET |
/webapi/ ProcessTemplate/ List/ {solutionAlias} |
Получить все шаблоны процесса. | Системное имя бизнес-приложения. | Данные всех шаблонов процесса указанного бизнес-приложения. |
| Record — Экземпляр записи | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| DELETE |
/webapi/Record/ {recordId} |
Удалить экземпляр записи. | ID экземпляра записи. | Статус. |
| GET |
/webapi/Record/ {recordId} |
Получить данные экземпляра записи. | ID экземпляра записи. | Данные указанного экземпляра записи. |
| PUT |
/webapi/Record/ {recordId} |
Изменить экземпляр записи. | ID экземпляра записи, данные экземпляра записи. | Статус. |
| POST |
/webapi/Record/ {recordId}/ {deepClone} |
Создать копию экземпляра записи. | ID экземпляра записи. | Данные записи. |
| PUT |
/webapi/Record/ {recordId}/ Disable |
Архивировать. | ID экземпляра записи. | Статус. |
| PUT |
/webapi/Record/ {recordId}/ Enable |
Разархивировать. | ID экземпляра записи. | Статус. |
| POST |
/webapi/Record/ {templateGlobalAlias} |
Создать экземпляр записи. | Системное имя бизнес-приложения, системное имя шаблона записи, данные экземпляра записи. | ID экземпляра записи. |
| Records — Экземпляры записи | ||||
| Метод |
Запрос |
Описание | Параметры на входе | Параметры на выходе |
| DELETE |
/webapi/Records |
Удалить экземпляры записи по id. | ID экземпляров записи. | Статус. |
| PUT | /webapi/Records | Изменить экземпляры записи. | Данные экземпляров записи. | Статус. |
| DELETE |
/webapi/Records/ {templateGlobalAlias} |
Удалить экземпляры записи. | Системное имя бизнес-приложения, системное имя шаблона записи. | Статус. |
| GET |
/webapi/Records/ {templateGlobalAlias} |
Получить все экземпляры записи. | Системное имя бизнес-приложения, системное имя шаблона записи. | Данные всех экземпляров записи указанного шаблона записи. |
| POST |
/webapi/Records/ {templateGlobalAlias} |
Создать экземпляры записи. | Системное имя бизнес-приложения, системное имя шаблона записи, данные экземпляров записи. | ID экземпляров записи. |
| GET |
/webapi/Records/ {templateGlobalAlias}/ Export |
Экспортировать все экземпляры записи. | Системное имя бизнес-приложения, системное имя шаблона записи. | Данные экспортированных экземпляров записи. |
| PUT |
/webapi/Records/ Disable |
Архивировать. | ID экземпляров записи. | Статус. |
| PUT |
/webapi/Records/ Enable |
Разархивировать. | ID экземпляров записи. | Статус. |
| POST |
/webapi/Records/ Export |
Экспортировать экземпляры записи по id. | ID экземпляров записи. | Данные экспортированных экземпляров записи. |
| POST |
/webapi/Records/ Import |
Импортировать экземпляры записи. | Параметры импорта. | Данные импортированных экземпляров записи. |
| RecordTemplate — Шаблон записи | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/ RecordTemplate/ {solutionAlias} |
Создать шаблон записи. | Системное имя бизнес-приложения, данные шаблона записи. | Системное имя шаблона записи. |
| PUT |
/webapi/ RecordTemplate/ {solutionAlias} |
Изменить шаблон записи. | Системное имя бизнес-приложения, данные шаблона записи. | Статус. |
| DELETE |
/webapi/ RecordTemplate/ {solutionAlias}/ {recordTemplateAlias} |
Удалить шаблон записи. | Системное имя бизнес-приложения, системное имя шаблона записи. | Статус. |
| GET |
/webapi/ RecordTemplate/ {solutionAlias}/ {recordTemplateAlias} |
Получить данные шаблона записи. | Системное имя бизнес-приложения, системное имя шаблона записи. | Данные указанного шаблона записи. |
| PUT |
/webapi/ RecordTemplate/ {solutionAlias}/ {recordTemplateAlias}/ Disable |
Архивировать. | Системное имя бизнес-приложения, системное имя шаблона записи. | Статус. |
| PUT |
/webapi/ RecordTemplate/ {solutionAlias}/ {recordTemplateAlias}/ Enable |
Разархивировать. | Системное имя бизнес-приложения, системное имя шаблона записи. | Статус. |
| GET |
/webapi/ RecordTemplate/ List {solutionAlias} |
Получить все шаблоны записи. | Системное имя бизнес-приложения. | Данные всех шаблонов записи указанного бизнес-приложения. |
| ReferenceData — Связанные данные | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| DELETE |
/webapi/ ReferenceData/ Delete |
Удалить объект по внешнему ключу. | Данные внешнего ключа. | ID объекта. |
| POST |
/webapi/ ReferenceData/ Get |
Получить объект по внешнему ключу. | Данные внешнего ключа. | Данные объекта. |
| PUT |
/webapi/ ReferenceData/ Put |
Изменить объект по внешнему ключу. | Данные внешнего ключа. | ID объекта. |
| Solution — Бизнес-приложение | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| GET |
/webapi/Solution |
Получить все бизнес-приложения. | Данные всех бизнес-приложений. | |
| POST | /webapi/Solution | Создать бизнес-приложение. | Данные бизнес-приложения. | Системное имя бизнес-приложения. |
| PUT | /webapi/Solution | Изменить бизнес-приложение. | Данные бизнес-приложения. | Статус. |
| DELETE |
/webapi/Solution/ {solutionAlias} |
Удалить бизнес-приложение. | Системное имя бизнес-приложения. | Статус. |
| GET |
/webapi/Solution/ {solutionAlias} |
Получить данные бизнес-приложения. | Системное имя бизнес-приложения. | Данные указанного бизнес-приложения. |
| Toolbar — Панель инструментов | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/Toolbar/ {solutionAlias} |
Создать панель инструментов. | Системное имя бизнес-приложения, данные панели инструментов. | Системное имя панели инструментов. |
| PUT |
/webapi/Toolbar/ {solutionAlias} |
Изменить панель инструментов. | Системное имя бизнес-приложения, данные панели инструментов. | Статус. |
| DELETE |
/webapi/Toolbar/ {solutionAlias}/ {toolbarGlobalAlias} |
Удалить панель инструментов. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя панели инструментов. | Статус. |
| GET |
/webapi/Toolbar/ {solutionAlias}/ {toolbarGlobalAlias} |
Получить данные панели инструментов. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя панели инструментов. | Данные указанной панели инструментов. |
| GET |
/webapi/Toolbar/ List/ {templateGlobalAlias} |
Получить все панели инструментов. | Системное имя бизнес-приложения, системное имя шаблона записи. | Данные всех панелей инструментов указанного шаблона записи. |
| Transfer — Трансфер (импорт, экспорт) | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| GET |
/webapi/Transfer/ {fileId}/ Validate |
Проверить настройки трансфера бизнес-приложения. | ID файла трасфера. | Данные настроек указанного трансфера бизнес-приложения. |
| GET |
/webapi/Transfer/ {solutionAlias} |
Экспортировать бизнес-приложение. | Системное имя бизнес-приложения. | Ссылка для скачивания экспортного файла указанного бизнес-приложения. |
| POST |
/webapi/Transfer/ {solutionAlias}/ {fileId}/ {publishAfterImport}/ {policy} |
Импортировать бизнес-приложение и опубликовать изменения. | Системное имя бизнес-приложения, ID файла трансфера. | Данные импорта. |
| POST |
/webapi/Transfer/ Upload |
Прикрепить документ для импорта данных в бизнес-приложение. | Ссылка на файл. | ID загруженного файла. |
| UserCommand — Операции | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| POST |
/webapi/ UserCommand/ {solutionAlias} |
Создать операцию. | Системное имя бизнес-приложения, данные операции. | Системное имя операции. |
| PUT |
/webapi/ UserCommand/ {solutionAlias} |
Изменить операцию. | Системное имя бизнес-приложения, данные операции. | Статус. |
| DELETE |
/webapi/ UserCommand/ {solutionAlias}/ {userCommand GlobalAlias} |
Удалить операцию. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя операции. | Статус. |
| GET |
/webapi/ UserCommand/ {solutionAlias}/ {userCommand GlobalAlias} |
Получить данные операции. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя операции. | Данные указанной операции. |
| PUT |
/webapi/ UserCommand/ {solutionAlias}/ {userCommand GlobalAlias}/ Disable |
Архивировать. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя операции. | Статус. |
| PUT |
/webapi/ UserCommand/ {solutionAlias}/ {userCommand GlobalAlias}/ Enable |
Разархивировать. | Системное имя бизнес-приложения, системное имя шаблона записи, системное имя операции. | Статус. |
| GET |
/webapi/ UserCommand/ List/ {templateGlobalAlias} |
Получить все операции. | Системное имя бизнес-приложения, системное имя шаблона записи. | Данные всех операций указанного бизнес-приложения. |
| WorkerEngine — Воркеры | ||||
| Метод | Запрос | Описание | Параметры на входе | Параметры на выходе |
| GET |
/webapi/ WorkerEngine/ GetConfiguration |
Получить все воркеры. | Данные всех воркеров. | |
| PUT |
/webapi/ WorkerEngine/ SetConfiguration |
Изменить воркеры. | Данные воркеров. | Статус. |
