Методы Web API


Содержание

Введение

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

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

Доступ к Web API

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

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

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

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

https://your-host/docs/webapi

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

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

Определения

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

Описание методов 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}

Задает репозиторий моментальных снимков Elasticsearch.

Имя существующего репозитория моментальных снимков 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@solutionSystemName.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

Получает все ветви репозитория.

Объект конфигурации репозитория.

Массив объектов со свойствами ветвей.

GET

/webapi/Git/ListRepositories

Получает все репозитории подключений к Git.

 

Массив объектов с конфигурациями репозиториев.

POST

/webapi/Git/SaveUserCredentials

Сохраняет учетные данные пользователя.

Объект с конфигурацией репозитория и учетными данными пользователя.

Объект статуса.

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.

PUT

/webapi/ReferenceData/Put

Изменяет запись с указанными значениями ключевых атрибутов. 

Объект глобального псевдонима шаблона, массив системных имён ключевых атрибутов, объект с системными именами и значениями ключевых атрибутов, объект с системными именами атрибутов и их новыми значениями.

Идентификатор отредактированной записи. Если несколько записей совпадают, возвращает null и никакие записи не редактируются.

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}

Удаляет область кнопок.

Системное имя приложения, глобальный псевдоним области кнопок: 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 — включена).

Объект статуса.



Номер Статьи: 1940
Размещено: Mon, Dec 13, 2021
Последнее обновление: Thu, May 23, 2024

Online URL: https://kb.comindware.ru/article/metody-web-api-1940.html