Методы Web API

Введение

Web API предоставляет общие RESTful-методы. Эти методы одинаковы для всех версий Comindware Platform.

В этом разделе представлен обзор методов Web API. Полную информацию см. в Swagger.

Доступ к Web API

Базовый URL-адрес для запросов Web API:
https://your-host/webapi/
Web API поддерживает запросы GET, PUT, POST, DELETE.
Методы Web API передают данные в форматах JSON и XML.

Использование Swagger

Swagger предоставляет подробную справку по методам API, включая описания запросов и ответов, а также модели данных с примерами значений.

Swagger позволяет выполнять запросы и просматривать ответы.

Интерфейс Swagger для Web API доступен по адресу:

https://your-host/docs/webapi

URL-адрес JSON-спецификации Web API:

https://your-host/swagger/WebApi/v1

Здесь your-host — доменное имя сервера Comindware Platform.

Интерфейс Swagger для метода Web API, создающего шаблон аккаунта

Определения

Методы Web API и документация Swagger используют следующие специфические имена для сущностей Comindware Platform:

activity — элемент диаграммы процесса
alias — системное имя
behaviour — сценарий, элемент диаграммы процесса
container — шаблон, приложение
dataset — таблица в шаблоне
global alias (глобальный псевдоним) — путь к объекту, состоящий из его типа, имени родительской системы и имени системы объекта
id — идентификатор объекта
inline — особый тип документа, который отображается на форме как текстовый блок и который можно редактировать в форме
list — массив
object (объект) — набор пар свойство/значение
property— атрибут
record— запись
revision — версия файла, прикреплённого к атрибуту
solution — приложение
scheme — диаграмма процесса
stream — файл, хранящийся в системе
template — шаблон
transfer — управление версиями приложения
trigger — сценарий
user command — кнопка
worker — системный сервис

Описание методов Web API

Аккаунт — отдельные аккаунты

GET	/webapi/Account
Описание	Получает все аккаунты.
Параметры	Не требуются.
Ответ	Массив объектов со свойствами аккаунтов.

POST	/webapi/Account
Описание	Создает аккаунт.
Параметры	Объект свойств аккаунта.
Ответ	Идентификатор аккаунта.

PUT	/webapi/Account
Описание	Изменяет свойства аккаунта.
Параметры	Объект свойств аккаунта.
Ответ	Объект статуса.

DELETE	/webapi/Account/{accountId}
Описание	Удаляет аккаунт.
Параметры	Идентификатор аккаунта.
Ответ	Объект статуса.

GET	/webapi/Account/{accountId}
Описание	Получает свойства аккаунта.
Параметры	Идентификатор аккаунта.
Ответ	Объект свойств аккаунта.

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
Описание	Отвязывает аккаунты от указанного шаблона аккаунта.
Параметры	Системное имя приложения, системное имя шаблона аккаунта, массив идентификаторов аккаунта.
Ответ	Объект статуса.

PUT	/webapi/AccountTemplate/{solutionAlias}/{accountTemplateAlias}/Include
Описание	Привязывает указанные аккаунты к указанному шаблону аккаунта.
Параметры	Системное имя приложения, системное имя шаблона аккаунта, массив идентификаторов аккаунта.
Ответ	Объект статуса.

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}
Описание	Удаляет атрибут.
Параметры	Системное имя приложения, глобальный псевдоним атрибута: `Attribute@templateSystemName.attributeSystemName`.
Ответ	Объект статуса.

GET	/webapi/Attribute/{solutionAlias}/{attributeGlobalAlias}
Описание	Получает свойства атрибута.
Параметры	Системное имя приложения, глобальный псевдоним атрибута: `Attribute@templateSystemName.attributeSystemName`.
Ответ	Объект свойств атрибута.

PUT	/webapi/Attribute/{solutionAlias}/{attributeGlobalAlias}/Disable
Описание	Архивирует атрибут.
Параметры	Системное имя приложения, глобальный псевдоним атрибута: `Attribute@templateSystemName.attributeSystemName`.
Ответ	Объект статуса.

PUT	/webapi/Attribute/{solutionAlias}/{attributeGlobalAlias}/Enable
Описание	Разархивирует атрибут.
Параметры	Системное имя приложения, глобальный псевдоним атрибута: `Attribute@templateSystemName.attributeSystemName`.
Ответ	Объект статуса.

GET	/webapi/Attribute/List/{templateGlobalAlias}
Описание	Получает все атрибуты указанного шаблона.
Параметры	Глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов с атрибутивными свойствами.

Backup — резервное копирование конфигураций и сессий

DELETE	/webapi/Backup/Configuration
Описание	Удаляет указанные конфигурации резервного копирования.
Параметры	Массив идентификаторов конфигурации резервного копирования.
Ответ	Объект статуса.

GET	/webapi/Backup/Configuration
Описание	Получает все конфигурации резервного копирования.
Параметры	Не требуются.
Ответ	Массив резервных объектов конфигурации.

POST	/webapi/Backup/Configuration
Описание	Создает конфигурацию резервного копирования.
Параметры	Резервный объект конфигурации.
Ответ	Идентификатор конфигурации резервного копирования.

PUT	/webapi/Backup/Configuration
Описание	Изменяет конфигурацию резервного копирования.
Параметры	Резервный объект конфигурации.
Ответ	Объект статуса.

GET	/webapi/Backup/Configuration/{configurationId}
Описание	Получает конфигурацию резервного копирования.
Параметры	Идентификатор конфигурации резервного копирования.
Ответ	Резервный объект конфигурации.

DELETE	/webapi/Backup/Session
Описание	Удаляет указанные сеансы резервного копирования.
Параметры	Массив идентификаторов сеансов резервного копирования.
Ответ	Объект статуса.

POST	/webapi/Backup/Session
Описание	Возвращает сеансы резервного копирования, соответствующие указанному фильтру.
Параметры	Объект с фильтром сеанса резервного копирования.
Ответ	Массив объектов со сведениями о сеансах резервного копирования.

POST	/webapi/Backup/Session/{configurationId}
Описание	Инициирует сеанс резервного копирования с использованием указанной конфигурации.
Параметры	Идентификатор конфигурации резервного копирования.
Ответ	Объект со сведениями о сеансе резервного копирования.

GET	/webapi/Backup/Session/{sessionId}
Описание	Получает сеанс резервного копирования.
Параметры	Идентификатор сеанса резервного копирования.
Ответ	Объект со сведениями о сеансе резервного копирования.

PUT	/webapi/Backup/Session/{sessionId}
Описание	Прерывает сеанс резервного копирования.
Параметры	Идентификатор сеанса резервного копирования.
Ответ	Объект со сведениями о сеансе резервного копирования.

POST	/webapi/Backup/SetElasticsearchRepository/{name}
Описание	Задает репозиторий моментальных снимков OpenSearch (Elasticsearch).
Параметры	Имя существующего репозитория моментальных снимков OpenSearch (Elasticsearch).
Ответ	Объект статуса.

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}
Описание	Удаляет таблицу.
Параметры	Системное имя приложения, глобальный псевдоним таблицы: `Dataset@templateSystemName.tableSystemName`.
Ответ	Объект статуса.

GET	/webapi/Dataset/{solutionAlias}/{datasetGlobalAlias}
Описание	Получает конфигурацию таблицы.
Параметры	Системное имя приложения, глобальный псевдоним таблицы: `Dataset@templateSystemName.tableSystemName`.
Ответ	Объект конфигурации таблицы.

GET	/webapi/Dataset/List/{templateGlobalAlias}
Описание	Получает все таблицы указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов с конфигурациями таблиц.

Document — файлы, прикрепленные к атрибутам типа «документ»

POST	/webapi/Document
Описание	Создает документ.
Параметры	Объект свойств документа.
Ответ	Объект с идентификатором документа.

PUT	/webapi/Document
Описание	Изменяет свойства документа.
Параметры	Объект свойств документа.
Ответ	Объект статуса.

DELETE	/webapi/Document/{documentId}
Описание	Удаляет документ.
Параметры	Идентификатор документа.
Ответ	Объект статуса.

GET	/webapi/Document/{documentId}
Описание	Получает свойства документа.
Параметры	Идентификатор документа.
Ответ	Объект свойств документа.

GET	/webapi/Document/{documentId}/Content
Описание	Получает содержимое документа.
Параметры	Идентификатор документа.
Ответ	Содержимое документа (`application/octet-stream`).

POST	/webapi/Document/Content
Описание	Создает документ путем загрузки файла.
Параметры	Объект с именем файла и его содержимым (`byte array`).
Ответ	Объект с идентификатором документа.

POST	/webapi/Document/Revision/{documentId}/Content
Описание	Создает версию путем загрузки файла.
Параметры	Идентификатор документа, объект с именем файла и его содержимым (`byte array`).
Ответ	Объект с идентификатором версии.

GET	/webapi/Document/Revision/{revisionId}
Описание	Получает свойства версии.
Параметры	Идентификатор версии.
Ответ	Объект свойств версии.

GET	/webapi/Document/Revision/{revisionId}/Content
Описание	Получает содержимое версии.
Параметры	Идентификатор версии.
Ответ	Содержимое версии (`application/octet-stream`).

DocumentExportTemplate — шаблоны экспорта

POST	/webapi/DocumentExportTemplate/{solutionAlias}
Описание	Создает шаблон экспорта.
Параметры	Системное имя приложения, объект свойств шаблона экспорта.
Ответ	Системное имя шаблона экспорта.

PUT	/webapi/DocumentExportTemplate/{solutionAlias}
Описание	Изменяет шаблон экспорта.
Параметры	Системное имя приложения, объект свойств шаблона экспорта.
Ответ	Объект статуса.

DELETE	/webapi/DocumentExportTemplate/{solutionAlias}/{exportTemplateGlobalAlias}
Описание	Удаляет шаблон экспорта.
Параметры	Системное имя приложения, глобальный псевдоним шаблона экспорта: `ExportTemplate@templateSystemName.exportTemplateSystemName`.
Ответ	Объект статуса.

GET	/webapi/DocumentExportTemplate/{solutionAlias}/{exportTemplateGlobalAlias}
Описание	Получает свойства шаблона экспорта.
Параметры	Системное имя приложения, глобальный псевдоним шаблона экспорта: `ExportTemplate@templateSystemName.exportTemplateSystemName`.
Ответ	Объект свойств шаблона экспорта.

GET	/webapi/DocumentExportTemplate/List/{templateGlobalAlias}
Описание	Получает все шаблоны экспорта для указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов со свойствами шаблонов экспорта.

Form — формы и правила для форм (кроме стартовых форм процессов и форм пользовательских задач)

POST	/webapi/Form/{solutionAlias}
Описание	Создает форму.
Параметры	Системное имя приложения, объект конфигурации формы.
Ответ	Системное имя формы.

PUT	/webapi/Form/{solutionAlias}
Описание	Изменяет форму.
Параметры	Системное имя приложения, объект конфигурации формы.
Ответ	Объект статуса.

DELETE	/webapi/Form/{solutionAlias}/{formGlobalAlias}
Описание	Удаляет форму.
Параметры	Системное имя приложения, глобальный псевдоним формы: `Form@templateSystemName.formSystemName`.
Ответ	Объект статуса.

GET	/webapi/Form/{solutionAlias}/{formGlobalAlias}
Описание	Получает конфигурацию формы.
Параметры	Системное имя приложения, глобальный псевдоним формы: `Form@templateSystemName.formSystemName`.
Ответ	Объект конфигурации формы.

GET	/webapi/Form/FormRules/{solutionAlias}/{formGlobalAlias}
Описание	Получает правила для формы.
Параметры	Системное имя приложения, глобальный псевдоним формы: `Form@templateSystemName.formSystemName`.
Ответ	Объект правил для формы.

PUT	/webapi/Form/FormRules/{solutionAlias}/{formGlobalAlias}
Описание	Устанавливает правила для формы.
Параметры	Системное имя приложения, глобальный псевдоним формы: `Form@templateSystemName.formSystemName`, объект правил для формы.
Ответ	Объект статуса.

GET	/webapi/Form/List/{templateGlobalAlias}
Описание	Получает все формы указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов с конфигурациями форм.

SolutionGitIntegration — контроль версий приложений через Git

POST	/webapi/Git/AddRemoteBranch
Описание	Создает ветвь в удаленном репозитории.
Параметры	Объект конфигурации репозитория и ветви.
Ответ	Объект статуса.

POST	/webapi/Git/Connect
Описание	Инициализирует соединение с указанным репозиторием.
Параметры	Объект конфигурации репозитория.
Ответ	Объект статуса.

POST	/webapi/Git/GetRepositoryDetails
Описание	Получает коммиты репозитория.
Параметры	Объект конфигурации репозитория.
Ответ	Массив объектов со свойствами коммитов.

GET	/webapi/Git/GetUserConfiguration
Описание	Получает учетные данные пользователя репозитория.
Параметры	Не требуются.
Ответ	Объект с учетными данными пользователя репозитория.

GET	/webapi/Git/GetUserSolutionConfig
Описание	Получает конфигурацию репозитория и сведения о пользователе.
Параметры	Не требуются.
Ответ	Объект с конфигурацией репозитория и учетными данными пользователя.

POST	/webapi/Git/ListBranches
Описание	Получает все ветви репозитория.
Параметры	Объект конфигурации репозитория.
Ответ	Массив объектов со свойствами ветвей.

POST	/webapi/Git/SaveUserCredentials
Описание	Сохраняет учетные данные пользователя.
Параметры	Объект с конфигурацией репозитория и учетными данными пользователя.
Ответ	Объект статуса.

GET	/webapi/Git/ListRepositories
Описание	Получает все репозитории подключений к Git.
Параметры	Не требуются.
Ответ	Массив объектов с конфигурациями репозиториев.

Heartbeat — мониторинг состояния сервера, процессов, скриптов и служб

GET	/webapi/Heartbeat/Details
Описание	Получает статистику использования служб.
Параметры	Не требуются.
Ответ	Объект сведений об использовании служб.

GET	/webapi/Heartbeat/IsAlive
Описание	Получает статус доступности служб.
Параметры	Не требуются.
Ответ	Объект статуса.

GET	/webapi/Heartbeat/ServerDetails
Описание	Получает информацию о сервере.
Параметры	Не требуются.
Ответ	Объект сведений о сервере.

ProcessObjects — миграция версии диаграммы процесса

POST	/webapi/ProcessObjects/Migrate
Описание	Изменяет версию диаграммы экземпляров процесса и перемещает токены.
Параметры	Глобальный псевдоним шаблона процесса (`ProcessTemplate@applicationSystemName.templateSystemName`), идентификатор целевой диаграммы, идентификаторы экземпляров процесса.
Ответ	Объект статуса.

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}
Описание	Удаляет запись.
Параметры	Идентификатор записи.
Ответ	Объект статуса.

GET	/webapi/Record/{recordId}
Описание	Получает запись.
Параметры	Идентификатор записи.
Ответ	Объект со значениями атрибутов записи: `{"attributeSystemName": "value"}`.

PUT	/webapi/Record/{recordId}
Описание	Изменяет запись.
Параметры	Идентификатор записи, объект со значениями атрибутов записи: `[{"attributeSystemName": "value"}]`.
Ответ	Объект статуса.

POST	/webapi/Record/{recordId}/{deepClone}
Описание	Клонирует запись.
Параметры	Идентификатор записи, флаг глубокого клонирования (`true` — клонировать связанные записи).
Ответ	Клонированный идентификатор записи.

PUT	/webapi/Record/{recordId}/Disable
Описание	Архивирует запись.
Параметры	Идентификатор записи.
Ответ	Объект статуса.

PUT	/webapi/Record/{recordId}/Enable
Описание	Разархивирует запись.
Параметры	Идентификатор записи.
Ответ	Объект статуса.

POST	/webapi/Record/{templateGlobalAlias}
Описание	Создает запись.
Параметры	Системное имя приложения, глобальный псевдоним шаблона (`Template@applicationSystemName.templateSystemName`), объект со значениями атрибутов записи: `[{"attributeSystemName": "value"}]`.
Ответ	Идентификатор записи.

Record — несколько записей и экспорт/импорт записей (кроме шаблонов процессов)

DELETE	/webapi/Records
Описание	Удаляет указанные записи.
Параметры	Массив идентификаторов записей.
Ответ	Объект статуса.

PUT	/webapi/Records
Описание	Изменяет указанные записи.
Параметры	Массив идентификаторов записей и объектов со значениями атрибутов записей: `[{"attributeSystemName": "value"}]`.
Ответ	Объект статуса.

DELETE	/webapi/Records/{templateGlobalAlias}
Описание	Удаляет все записи из указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Объект статуса.

GET	/webapi/Records/{templateGlobalAlias}
Описание	Получает все записи указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов со значениями атрибутов записей: `[{"attributeSystemName": "value"}]`.

POST	/webapi/Records/{templateGlobalAlias}
Описание	Создает записи.
Параметры	Глобальный псевдоним шаблона (`Template@applicationSystemName.templateSystemName`), массив объектов со значениями атрибутов записи: `[{"attributeSystemName": "value"}]`.
Ответ	Массив идентификаторов записей.

GET	/webapi/Records/{templateGlobalAlias}/Export
Описание	Экспортирует все записи указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Серийные записи данных.

PUT	/webapi/Records/BulkEdit
Описание	Обновляет указанные записи с теми же данными.
Параметры	Запишите свойства и значения для обновления.
Ответ	Объект статуса.

PUT	/webapi/Records/Disable
Описание	Архивирует указанные записи.
Параметры	Массив идентификаторов записей.
Ответ	Объект статуса.

PUT	/webapi/Records/Enable
Описание	Разархивирует указанные записи.
Параметры	Массив идентификаторов записей.
Ответ	Объект статуса.

POST	/webapi/Records/Export
Описание	Экспортирует указанные записи.
Параметры	Объект глобального псевдонима шаблона записи, массив идентификаторов записей.
Ответ	Серийные записи данных.

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
Описание	Удаляет запись с указанными значениями ключевых атрибутов.
Параметры	Объект глобального псевдонима шаблона, объект с системными именами и значениями ключевых атрибутов.
Ответ	Идентификатор удалённой записи. Если несколько записей совпадают, возвращает `null`, и никакие записи не удаляются.

POST	/webapi/ReferenceData/Get
Описание	Получает значения атрибутов записи с указанными значениями ключевых атрибутов.
Параметры	Объект глобального псевдонима шаблона, объект с ключевыми системными именами атрибутов и значениями, массив системных имён атрибутов, которые необходимо получить.
Ответ	Объект со значениями атрибутов записи. Если несколько записей совпадают, возвращает `null`.

POST	/webapi/ReferenceData/List
Описание	Получает список записей с указанными значениями ключевых атрибутов.
Параметры	Объект глобального псевдонима шаблона, объект с ключевыми системными именами атрибутов и значениями, массив системных имён атрибутов, которые необходимо получить.
Ответ	Массив объектов со значениями атрибутов записей.

PUT	/webapi/ReferenceData/Put
Описание	Изменяет запись с указанными значениями ключевых атрибутов.
Параметры	Объект глобального псевдонима шаблона, массив системных имён ключевых атрибутов, объект с системными именами и значениями ключевых атрибутов, объект с системными именами атрибутов и их новыми значениями.
Ответ	Идентификатор отредактированной записи. Если несколько записей совпадают, возвращает `null` и никакие записи не редактируются.

Solution — приложения

GET	/webapi/Solution
Описание	Получает все приложения.
Параметры	Не требуются.
Ответ	Массив объектов со свойствами приложения.

POST	/webapi/Solution
Описание	Создает приложение.
Параметры	Объект со свойствами приложения.
Ответ	Системное имя приложения.

PUT	/webapi/Solution
Описание	Изменяет свойства приложения.
Параметры	Объект со свойствами приложения.
Ответ	Объект статуса.

DELETE	/webapi/Solution/{solutionAlias}
Описание	Удаляет приложение.
Параметры	Системное имя приложения.
Ответ	Объект статуса.

GET	/webapi/Solution/{solutionAlias}
Описание	Получает свойства приложения.
Параметры	Системное имя приложения.
Ответ	Объект со свойствами приложения.

POST	/webapi/Toolbar/{solutionAlias}
Описание	Создает область кнопок.
Параметры	Системное имя приложения, объект конфигурации области кнопок.
Ответ	Системное имя области кнопок.

PUT	/webapi/Toolbar/{solutionAlias}
Описание	Изменяет область кнопок.
Параметры	Системное имя приложения, объект конфигурации области кнопок.
Ответ	Объект статуса.

DELETE	/webapi/Toolbar/{solutionAlias}/{toolbarGlobalAlias}
Описание	Удаляет область кнопок.
Параметры	Системное имя приложения, глобальный псевдоним области кнопок: `Toolbar@templateSystemName.toolbarAlias`.
Ответ	Объект статуса.

GET	/webapi/Toolbar/{solutionAlias}/{toolbarGlobalAlias}
Описание	Получает область кнопок по имени системы.
Параметры	Системное имя приложения, глобальный псевдоним области кнопок: `Toolbar@templateSystemName.toolbarAlias`.
Ответ	Объект конфигурации области кнопок.

GET	/webapi/Toolbar/List/{templateGlobalAlias}
Описание	Получает все области кнопок для указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов конфигурации области кнопок.

Transfer — экспорт/импорт модели приложения

GET	/webapi/Transfer/{fileId}/Validate
Описание	Проверяет модель приложения.
Параметры	Идентификатор файла модели приложения.
Ответ	Объект с итогом проверки.

GET	/webapi/Transfer/{solutionAlias}
Описание	Экспорт модели приложения.
Параметры	Системное имя приложения.
Ответ	Объект с ZIP-файлом модели приложения в формате Base64 и сводкой экспорта.

POST	/webapi/Transfer/{solutionAlias}/{fileId}/{publishAfterImport}/{policy}
Описание	Импортирует модель приложения.
Параметры	Системное имя приложения, идентификатор файла ZIP/CTF модели приложения, флаг публикации импортированных диаграмм процессов (`true` — публикация), политика состояния поведения (`ApplyNew`, `ApplyOld`, `DisableAll` или `EnableAll`).
Ответ	Объект со сводкой по импорту приложений.

POST	/webapi/Transfer/Upload
Описание	Загружает файл модели приложения.
Параметры	ZIP-файл модели приложения в формате Base64.
Ответ	Объект с идентификатором загруженного файла.

UserCommand — кнопки

POST	/webapi/UserCommand/{solutionAlias}
Описание	Создает кнопку.
Параметры	Системное имя приложения, объект конфигурации кнопки.
Ответ	Системное имя кнопки.

PUT	/webapi/UserCommand/{solutionAlias}
Описание	Изменяет кнопку.
Параметры	Системное имя приложения, объект конфигурации кнопки.
Ответ	Объект статуса.

DELETE	/webapi/UserCommand/{solutionAlias}/{userCommandGlobalAlias}
Описание	Удаляет кнопку.
Параметры	Системное имя приложения, глобальный псевдоним кнопки: `UserCommand@templateSystemName.userCommandAlias`.
Ответ	Объект статуса.

GET	/webapi/UserCommand/{solutionAlias}/{userCommandGlobalAlias}
Описание	Получает конфигурацию кнопки.
Параметры	Системное имя приложения, глобальный псевдоним кнопки: `UserCommand@templateSystemName.userCommandAlias`.
Ответ	Объект конфигурации кнопки.

PUT	/webapi/UserCommand/{solutionAlias}/{userCommandGlobalAlias}/Disable
Описание	Архивирует кнопку.
Параметры	Системное имя приложения, глобальный псевдоним кнопки: `UserCommand@templateSystemName.userCommandAlias`.
Ответ	Объект статуса.

PUT	/webapi/UserCommand/{solutionAlias}/{userCommandGlobalAlias}/Enable
Описание	Разархивирует кнопку.
Параметры	Системное имя приложения, глобальный псевдоним кнопки: `UserCommand@templateSystemName.userCommandAlias`.
Ответ	Объект статуса.

GET	/webapi/UserCommand/List/{templateGlobalAlias}
Описание	Получает все кнопки указанного шаблона.
Параметры	Системное имя приложения, глобальный псевдоним шаблона: `Template@applicationSystemName.templateSystemName`.
Ответ	Массив объектов конфигурации кнопок.

WorkerEngine — системные службы

GET	/webapi/WorkerEngine/GetConfiguration
Описание	Получает статусы системных служб (`true` — включена).
Параметры	Не требуются.
Ответ	Объект со статусами системных служб.

PUT	/webapi/WorkerEngine/SetConfiguration
Описание	Устанавливает статусы системных служб.
Параметры	Объект со статусами системных служб (`true` — включена).
Ответ	Объект статуса.