Методы System Core API
Содержание
- Введение
- Доступ к System Core API
- Пример вызова метода System Core API
- Использование Swagger
- Определения
- Описание методов System Core API
- Account – аккаунты
- Ontology – объект
- AccountGroup – группы аккаунтов
- GlobalConfiguration – глобальная конфигурация
- CommunicationChannel – подключения
- EncryptedNavigation Reference — внешние ссылки на формы
- Object — записи
- ObjectApp — шаблоны записей
- ObjectAppExport — шаблоны экспорта
- UserTask — пользовательские задачи
- Document — документы
- Dataset — таблицы
- DatasetExport - Экспорт данных
- DatasetConfiguration — пользовательская конфигурация таблиц
- GlobalFunction — скрипты
- ScriptDetails — свойства скриптов
- Template — шаблоны
- SolutionVariable — переменные приложений
- ProcessApp — шаблоны процессов
- ProcessObject — экземпляры процессов
- Diagram — диаграммы процессов
- DiagramPublishing — публикация диаграмм
- ProcessReport — сообщения об ошибках
- ConversationConfiguration — конфигурации обсуждений
Введение
System Core API предоставляет системные RESTful-методы для работы со всеми сущностями в экземпляре Comindware Business Application Platform. Эти методы могут различаться в разных версиях Comindware Business Application Platform.
Здесь представлен обзор методов System Core API. Полную информацию см. в Swagger.
Внимание!
Вызывать методы System Core API следует, только если вы точно понимаете, что и зачем делаете, иначе вы можете потерять важные данные или настройки.
Доступ к System Core API
- Базовый URL-адрес для запросов к System Core API:
https://your-host/api/public/system/ - System Core API поддерживает запросы
POST. - Методы System Core API передают данные в формате JSON.
- System Core API поддерживает базовую проверку подлинности.
- Методы System Core API можно вызывать в C#-скриптах (в отличие от методов Web API и Solution API).
Пример вызова метода System Core API
Чтобы вызвать метод System Core API, отправьте HTTP-запрос на адрес метода (указанный в Swagger), например:
- Для создания шаблона записи с помощью System Core API отправьте POST-запрос на адрес:
http://your-host/api/public/system/TeamNetwork/ObjectAppService/Create - В теле запроса (
body) укажите системное имя шаблона записи (например,"Car"). - В ответ на запрос ПО отправит ID созданного шаблона записи (например,
"oa.1").
- В теле запроса (
Использование Swagger
Swagger предоставляет подробную справку по методам API, включая описания запросов и ответов, а также модели данных с примерами значений.
Swagger позволяет выполнять запросы и просматривать ответы.
Интерфейс Swagger для System Core API доступен по адресу:
https://your-host/docs/SystemApi
Здесь your-host — доменное имя вашего сервера.
Интерфейс Swagger для System Core API
Определения
Методы API и документация Swagger используют следующие имена для сущностей Comindware Business Application Platform:
- activity — элемент диаграммы процесса
- alias — системное имя
- behaviour — сценарий, элемент диаграммы процесса
- container — шаблон, приложение
- dataset — таблица в шаблоне
- global alias (глобальный псевдоним) — путь к объекту, состоящий из его типа, имени родительской системы и имени системы объекта
- id — идентификатор объекта
- inline — особый тип документа, который отображается на форме как текстовый блок и который можно редактировать в форме
- list — массив
- property— атрибут
- revision — версия файла, прикреплённого к атрибуту
- solution — приложение
- scheme — диаграмма процесса
- stream — файл, хранящийся в системе
- transfer — управление версиями приложения
- trigger — сценарий
- user command — кнопка
- worker — системный сервис
- object ( объект) — набор пар свойство/значение
Описание методов System Core API
Account – аккаунты |
|||
|---|---|---|---|
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает язык, который установлен для аккаунтов по умолчанию |
- |
Язык, который установлен для аккаунтов по умолчанию |
|
/ |
Получает список аккаунтов с информацией о них |
- |
Список аккаунтов с информацией о них |
|
/ |
Получает основную информацию о нескольких аккаунтах по их идентификаторам |
Массив идентификаторов |
Список аккаунтов с основной информацией о них |
|
/ |
Получает информацию об аккаунте по его идентификатору |
Идентификатор аккаунта |
Информация об аккаунте |
|
/ |
Получает основную информацию об аккаунте по его идентификатору |
Идентификатор аккаунта |
Основная информация об аккаунте |
|
/ |
Создаёт новый аккаунт |
Информация для создания аккаунта |
Статус |
|
/ |
Изменяет информацию об аккаунте |
Редактируемая информация об аккаунте |
Статус |
|
/ |
Удаляет аккаунт |
Идентификатор аккаунта |
Статус |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает полное имя аккаунта |
Идентификатор аккаунта |
Полное имя аккаунта |
|
/ |
Получает аббревиатуру полного имени аккаунта |
Полное имя аккаунта |
Аббревиатура полного имени аккаунта |
|
/ |
Изменяет фото в аккаунте |
Идентификатор аккаунта, фото в формате JSON |
Статус |
|
/ |
Получает фото аккаунта в формате JSON |
Идентификатор аккаунта и размер изображения |
Фото аккаунта в формате JSON |
|
/ |
Получает аккаунт по адресу электронной почты |
Адрес электронной почты |
Идентификатор аккаунта |
|
/ |
Получает аккаунт по имени пользователя |
Имя пользователя |
Идентификатор аккаунта |
|
/ |
Изменяет пароль аккаунта |
Идентификатор аккаунта, новый пароль |
Статус |
|
/ |
Устанавливает пароль для текущего аккаунта |
Предыдущий пароль и новый пароль |
Статус |
|
/ |
Получает системную информацию об аккаунте |
Идентификатор аккаунта |
Системная информация об аккаунте |
|
/ |
Изменяет системную информацию об аккаунте |
Системная информация об аккаунте |
Статус |
|
/ |
Получает аккаунты с определёнными доменами в адресах эл. почты |
Домен адреса эл. почты |
Основная информация об аккаунте |
|
/ |
Архивирует аккаунт |
Идентификатор аккаунта |
Статус |
|
/ |
Архивирует несколько аккаунтов |
Идентификатор аккаунта |
Статус |
|
/ |
Разархивирует аккаунт |
Идентификатор аккаунта |
Статус |
|
/ |
Разархивирует несколько аккаунтов |
Идентификатор аккаунта |
Статус |
|
/ |
Активировать аккаунт |
Идентификатор аккаунта |
Статус |
|
/ |
Активировать несколько аккаунтов |
Идентификатор аккаунта |
Статус |
|
/ |
Деактивирует аккаунт |
Идентификатор аккаунта |
Статус |
|
/ |
Деактивирует несколько аккаунтов |
Идентификаторы аккаунтов |
Статус |
|
/ |
Получает список требований к паролю |
- |
Требования к паролю |
Ontology – объект |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает невычисляемые атрибуты со значениями для любого объекта без указания его типа по его идентификатору |
Идентификатор объекта |
Невычисляемые атрибуты объекта со значениями |
|
/ |
Получает значения невычисляемых атрибутов объекта по предикату |
Идентификатор объекта, атрибут |
Значение атрибута |
|
/ |
Получает значения атрибутов объекта по предикату |
Идентификатор объекта, атрибут |
Значение атрибута |
|
/ |
Получает список ссылок на объект по его идентификатору |
Идентификатор объекта |
Список использований объекта |
|
/ |
Удаляет объект по его идентификатору |
Идентификатор объекта |
Статус |
|
/ |
Удаляет значения по предикату |
Идентификатор объекта, предикат |
Статус |
|
/ |
Получает текущие подключения |
- |
- |
|
/ |
Отключает все текущие подключения |
- |
Статус |
|
/ |
Отключает подключения по идентификатору аккаунта |
Идентификатор аккаунта |
Статус |
AccountGroup – группы аккаунтов |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает список групп аккаунтов с их названиями, идентификаторами и системными именами |
Выбор отображения в списке группы со всеми аккаунтами |
Список групп аккаунтов с их названиями, идентификаторами и системными именами |
|
/ |
Получает список групп аккаунтов с основной информацией |
Выбор отображения в списке групп Active Directory |
Список групп аккаунтов с основной информацией |
|
/ |
Получает список групп аккаунтов с информацией и списком участников |
- |
Список групп аккаунтов с информацией и списком участников |
|
/ |
Получает информацию о группе по её идентификатору |
Идентификатор группы |
Информация о группе аккаунтов |
|
/ |
Получает информацию об аккаунтах, входящих в данную группу |
Идентификатор группы |
Информация об аккаунтах, входящих в данную группу |
|
/ |
Получает группу по идентификатору группы в Active Directory и идентификатору |
Идентификатор группы и идентификатор группы в Active Directory |
Логическое значение |
|
/ |
Создаёт новую группу аккаунтов |
Параметры для новой группы аккаунтов |
Статус |
|
/ |
Изменяет информацию о группе аккаунтов |
Новые параметры для группы аккаунтов |
Статус |
|
/ |
Включает аккаунты в группу аккаунтов |
Идентификаторы аккаунтов и групп аккаунтов, которые необходимо включить |
Статус |
|
/ |
Назначает аккаунты в группу аккаунтов |
Идентификатор группы аккаунтов и список идентификаторов аккаунтов, которые необходимо включить |
Статус |
|
/ |
Исключает аккаунты из группы аккаунтов |
Идентификаторы аккаунтов и группы аккаунтов, которые необходимо включить |
Статус |
|
/ |
Проверяет, входит ли данный аккаунт в группу аккаунтов |
Идентификаторы аккаунтов и группы аккаунтов, которые необходимо включить |
Логическое значение |
|
/ |
Получает список идентификаторов аккаунтов, входящих в группу аккаунтов (исключая аккаунты, входящие в группы аккаунтов из текущей группы аккаунтов) |
Идентификатор группы аккаунтов |
Список идентификаторов аккаунтов |
|
/ |
Получает список идентификаторов групп аккаунтов, которые входят в группу аккаунтов |
Идентификатор группы аккаунтов |
Список идентификаторов групп аккаунтов |
|
/ |
Получает полный список идентификаторов аккаунтов, которые входят в данную группу аккаунтов (включая аккаунты, входящие в группы аккаунтов из текущей группы аккаунтов) |
Идентификатор группы аккаунтов |
Список идентификаторов аккаунтов |
|
/ |
Получает идентификаторы групп аккаунтов, которые содержат данную группу аккаунтов |
Идентификатор группы аккаунтов |
Список идентификаторов групп аккаунтов |
|
/ |
Получает идентификатор группы аккаунтов по его уникальному имени Active Directory |
Уникальное имя Active Directory |
Идентификатор группы аккаунтов |
|
/ |
Удаляет группу |
Идентификатор группы |
Статус |
GlobalConfiguration – глобальная конфигурация |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Проверяет, включены ли внешние уведомления |
- |
Логическое значение |
|
/ |
Проверяет, включены ли системные уведомления |
- |
Логическое значение |
|
/ |
Проверяет, включён ли мониторинг производительности |
- |
Логическое значение |
|
/ |
Получает адрес сервера |
- |
Адрес сервера |
|
/ |
Отключает компиляцию при сохранении |
- |
Логическое значение |
|
/ |
Получает последние временные отметки |
- |
Список временных отметок |
|
/ |
Получает установленную политику проверки пароля |
- |
Политика проверки пароля |
|
/ |
Получает зарегистрированные каналы аутентификации |
- |
Список зарегистрированных каналов аутентификации |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает активную глобальную конфигурацию |
- |
Активная глобальная конфигурация |
|
/ |
Настраивает активную глобальную конфигурацию |
Параметры для настройки активной глобальной конфигурации |
Статус |
|
/ |
Зарегистрировать канал аутентификации |
Канал |
Статус |
|
/ |
Снимает регистрацию канала аутентификации |
Канал |
Статус |
CommunicationChannel – подключения |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает информацию о подключении по идентификатору |
Идентификатор подключения |
Информация о подключении |
|
/ |
Получает информацию о подключении по системному имени |
Системное имя подключения |
Информация о подключении |
|
/ |
Получает список подключений с информацией о них по запросу |
Запрос |
Список подключений с информацией о них |
|
/ |
Получает список подключений с основной информацией о них по запросу |
Запрос |
Список подключений с основной информацией о них |
|
/ |
Создаёт новое подключение по заданным параметрам |
Параметры для создания подключения |
Идентификатор подключения |
|
/ |
Изменяет существующее подключение согласно заданным параметрам |
Параметры для редактирования подключения |
Статус |
|
/ |
Удаляет существующее подключение по его идентификатору |
Идентификатор подключения |
Информация об удалённом подключении |
|
/ |
Получает значение аутентификации для канала связи |
Системное имя подключения |
Значение аутентификации для канала связи |
|
/ |
Проверяет отключено ли подключение по идентификатору |
Идентификатор подключения |
Логическое значение |
|
/ |
Получает подключение по умолчанию |
- |
Идентификатор подключения |
|
/ |
Отправляет тестовое сообщение выбранным получателям |
Получатели |
Информация о тестовом сообщении |
|
/ |
Протестировать подключение по заданным параметрам |
Параметры для тестирования |
Информация о тестировании |
|
/ |
Отправляет сообщение по заданным параметрам |
Параметры для сообщения |
Статус |
|
/ |
Получает стандартный набор атрибутов для аккаунта |
- |
Набор атрибутов для аккаунта |
|
/ |
Получает стандартный набор атрибутов для группы аккаунтов |
- |
Набор атрибутов для группы аккаунтов |
EncryptedNavigation
|
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Формирует внешнюю ссылку на указанную форму. Если до перехода по ссылке пользователь не вошёл в систему, будет создан аккаунт в группе «Анонимные пользователи». |
Объект со свойствами целевой формы:
|
Внешняя ссылка на форму |
|
/ |
Преобразует внешнюю ссылку в объект со свойствами целевой формы. |
Внешняя ссылка |
Объект со свойствами целевой формы |
Object — записи |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Создаёт запись согласно заданным параметрам |
Параметры для создания записи |
Идентификатор созданной записи |
|
/ |
Изменяет запись согласно заданным параметрам |
Параметры для редактирования записи |
Логическое значение |
|
/ |
Получает информацию о записи по заданным параметрам |
Параметры запроса |
Информация о записи |
|
/ |
Получает информацию о значениях атрибутов экземпляров шаблонов записи по заданным параметрам |
Идентификатор экземпляра шаблона записи и системное имя атрибута |
Информация о значениях атрибутов экземпляров шаблонов записи |
|
/ |
Получает все записи по идентификатору шаблона записи |
Идентификатор шаблона записи |
Записи с информацией о них |
|
/ |
Получает все записи по системному имени шаблона записи |
Системное имя шаблона записи |
Записи с информацией о них |
|
/ |
Создаёт запись по системному имени шаблона записи и заданным данным |
Системное имя шаблона записи и данные |
Идентификатор записи |
|
/ |
Изменяет запись по идентификатору записи и заданным данным |
Идентификатор записи и данные |
Статус |
|
/ |
Получает информацию об экземпляре шаблона записи по его идентификатору |
Идентификатор записи |
Информация об экземпляре шаблона записи |
|
/ |
Проверяет, является ли запись архивной по её идентификатору |
Идентификатор записи |
Логическое значение |
|
/ |
Архивирует запись по её идентификатору |
Идентификатор записи |
Статус |
|
/ |
Архивирует несколько записей по их идентификаторам |
Идентификаторы записей |
Статус |
|
/ |
Разархивирует запись по её идентификатору |
Идентификатор записи |
Статус |
|
/ |
Разархивирует несколько записей по их идентификаторам |
Идентификаторы записей |
Статус |
|
/ |
Удаляет запись по идентификатору |
Идентификатор записи |
Статус |
|
/ |
Удаляет записи по заданным параметрам |
Параметры удаления |
Статус |
|
/ |
Удаляет все записи по идентификатору шаблона записи |
Идентификатор шаблона записи |
Количество удалённых записей |
|
/ |
Исключает аккаунты из шаблона аккаунтов |
Идентификаторы аккаунтов и идентификатор шаблона аккаунтов |
Статус |
|
/ |
Включает аккаунт в шаблон аккаунтов |
Идентификатор аккаунта и идентификатор шаблона аккаунтов |
Статус |
|
/ |
Включает несколько аккаунтов в шаблон аккаунтов |
Идентификаторы аккаунтов и идентификатор шаблона аккаунтов |
Статус |
|
/ |
Клонирует запись вместе с данными в новую запись (исключая атрибуты, значения которых прописаны в параметрах) |
Идентификатор копируемой записи и параметры копирования |
Идентификатор созданной записи |
|
/ |
Получает глубину копирования данных при клонировании записи вместе с данными в новую запись (исключая атрибуты, значения которых прописаны в параметрах) |
Идентификатор копируемой записи и параметры копирования |
Идентификатор созданной записи |
|
/ |
Получает информацию о записи по идентификатору |
Идентификатор записи |
Информация о записи |
|
/ |
Получает отображаемое имя записи по её идентификатору |
Идентификатор записи |
Отображаемое имя записи |
|
/ |
Получает идентификатор и имя шаблона записи, идентификатор и отображаемое имя записи по её идентификатору |
Идентификатор записи |
Идентификатор и имя шаблона записи, идентификатор и отображаемое имя записи |
|
/ |
Получает идентификатор шаблона записи по идентификатору записи |
Идентификатор записи |
Идентификатор шаблона записи |
|
/ |
Проверяет шаблон записи |
Идентификатор записи, идентификатор шаблона записи и параметр безопасности |
Логическое значение |
|
/ |
Получает историю записи |
Идентификатор записи |
История записи |
|
/ |
Создаёт несколько записей по заданным параметрам |
Параметры для создания записей |
Идентификаторы созданных записей |
|
/ |
Изменяет несколько записей по заданным параметрам |
Параметры для редактирования записей |
Количество отредактированных записей |
|
/ |
Изменяет несколько записей по заданным параметрам (без идентификатора шаблона записи) |
Параметры для редактирования записей |
Количество отредактированных записей |
|
/ |
Изменяет запись по уникальному идентификатору, заданному в шаблоне записи |
Системное имя шаблона записи, уникальный идентификатор и данные для редактирования |
Идентификатор записи |
|
/ |
Получает информацию о записи по уникальному идентификатору, заданному в шаблоне записи |
Системное имя шаблона записи, уникальный идентификатор и системные имена необходимых атрибутов |
Информация о записи |
|
/ |
Удаляет запись по уникальному идентификатору, заданному в шаблоне записи |
Системное имя шаблона записи и уникальный идентификатор |
Статус |
|
/ |
Изменяет запись по системному имени шаблона записи |
Системное имя шаблона записи, идентификатор записи и данные для редактирования |
Статус |
|
/ |
Удаляет запись по системному имени шаблона записи и идентификатору записи |
Системное имя шаблона записи и идентификатор записи |
Статус |
|
/ |
Получает информацию о записи по системному имени шаблона записи |
Системное имя шаблона записи и идентификатор записи |
Информация о записи |
ObjectApp — шаблоны записей |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает информацию обо всех шаблонах записи |
- |
Информация обо всех шаблонах записи |
|
/ |
Получает информацию обо всех шаблонах записи, включая архивированные |
- |
Информация обо всех шаблонах записи, включая архивированные |
|
/ |
Получает информацию о шаблонах записи, которые были созданы определенным аккаунтом |
Идентификатор аккаунта |
Информация о шаблонах записи |
|
/ |
Получает информацию о шаблонах записи в определенном приложении |
Идентификатор приложения |
Информация о шаблонах записи |
|
/ |
Получает информацию обо всех шаблонах записи в определенном приложении, включая архивированные |
Идентификатор приложения |
Информация обо всех шаблонах записи |
|
/ |
Получает информацию о шаблоне записи по его идентификатору |
Идентификатор шаблона записи |
Информация о шаблоне записи |
|
/ |
Получает информацию о шаблоне записи по системному имени |
Системное имя шаблона записи |
Информация о шаблоне записи |
|
/ |
Получает информацию о шаблоне записи по идентификатору записи |
Идентификатор записи |
Информация о шаблоне записи |
|
/ |
Получает, какому шаблону принадлежит ссылочный атрибут шаблона аккаунтов |
Идентификатор шаблона аккаунтов |
Идентификатор шаблона |
|
/ |
Получает, к какому шаблону относится атрибут шаблона ролей |
Идентификатор шаблона ролей |
Идентификатор шаблона |
|
/ |
Получает, к какому шаблону относится атрибут шаблона оргединиц |
Идентификатор шаблона оргединицы |
Идентификатор шаблона |
|
/ |
Получает идентификатор шаблона записи по идентификатору записи |
Идентификатор записи |
Идентификатор шаблона записи |
|
/ |
Получает системное имя шаблона записи по его идентификатору |
Идентификатор шаблона записи |
Системное имя шаблона записи |
|
/ |
Создаёт шаблон записи по заданным параметрам |
Параметры для создания шаблона записи |
Идентификатор шаблона записи |
|
/ |
Изменяет шаблон записи по заданным параметрам |
Параметры для обновления шаблона записи |
Статус |
|
/ |
Получает основную информацию о шаблоне записи |
Идентификатор шаблона записи |
Основная информация о шаблоне записи |
|
/ |
Удаляет шаблон записи по его идентификатору |
Идентификатор шаблона записи |
Статус |
|
/ |
Архивирует шаблон записи по его идентификатору |
Идентификатор шаблона записи |
Статус |
|
/ |
Разархивирует шаблон записи по его идентификатору |
Идентификатор шаблона записи |
Статус |
|
/ |
Назначает имя для шаблона записи |
Новое имя и идентификатор шаблона записи |
Статус |
|
/ |
Назначает системное имя для шаблона записи |
Новое системное имя и идентификатор шаблона записи |
Статус |
|
/ |
Назначает приложение для шаблона записи |
Идентификаторы приложения и шаблона записи |
Статус |
|
/ |
Назначает описание для шаблона записи |
Описание и идентификатор для шаблона записи |
Статус |
|
/ |
Назначает атрибут, который используется как заголовок записей |
Идентификаторы шаблона записи и его атрибута |
Статус |
|
/ |
Снимает назначение атрибута, который используется как заголовок записей |
Идентификаторы шаблона записи и его атрибута |
Статус |
|
/ |
Создаёт новый атрибут шаблона записи по заданным параметрам |
Идентификатор шаблона записи, системное имя нового атрибута, тип нового атрибута |
Идентификатор созданного атрибута |
|
/ |
Создаёт новый атрибут шаблона записи типа «Список значений» по заданным параметрам |
Параметры для создания |
Идентификатор созданного атрибута |
|
/ |
Создаёт атрибут типа "число" в шаблоне записи по заданным параметрам |
Идентификатор шаблона записи, системное имя нового атрибута, тип нового атрибута и количество знаков после запятой |
Идентификатор созданного атрибута |
|
/ |
Создаёт атрибут типа «аккаунт» в шаблоне записи по заданным параметрам |
Шаблон записи, в котором будет создаваться атрибут, системное имя нового атрибута, шаблон аккаунта, который будет привязан к атрибуту |
Идентификатор созданного атрибута |
|
/ |
Создаёт атрибут типа «роль» в шаблоне записи по заданным параметрам |
Шаблон записи, в котором будет создаваться атрибут, системное имя нового атрибута, шаблон ролей, который будет привязан к атрибуту |
Идентификатор созданного атрибута |
|
/ |
Создаёт атрибут типа «организационная единица» в шаблоне записи по заданным параметрам |
Шаблон записи, в котором создаётся атрибут, системное имя нового атрибута, шаблон оргеденицы, к которому привязан атрибут |
Идентификатор созданного атрибута |
|
/ |
Создаёт атрибут типа «Запись» в шаблоне записи по заданным параметрам |
Шаблон записи, в котором создаётся атрибут, системное имя нового атрибута, шаблон записи, к которому привязан атрибут |
Идентификатор созданного атрибута |
|
/ |
Создаёт атрибут типа «Запись» на шаблон записи этого атрибута со взаимной связью атрибутов по заданным параметрам |
Шаблон записи, в котором создаётся атрибут, системное имя нового атрибута, атрибут данного шаблона записи |
Идентификатор созданного атрибута |
|
/ |
Устанавливает связи между атрибутами шаблонов записи |
Идентификаторы атрибутов с включённой опцией «Хранить несколько значений» |
Сообщение об успехе или ошибке |
|
/ |
Убрать связи между атрибутами шаблонов записи |
Идентификаторы атрибутов, между которыми необходимо убрать связь |
Сообщение об успехе или ошибке |
|
/ |
Архивирует атрибут шаблона записи по его идентификатору |
Идентификатор атрибута |
Статус |
|
/ |
Разархивирует атрибут шаблона записи по его идентификатору |
Идентификатор атрибута |
Статус |
|
/ |
Получает список атрибутов шаблона записи по его идентификатору |
Идентификатор шаблона записи |
Список атрибутов с информацией о них |
|
/ |
Получает список атрибутов шаблона записи по его идентификатору (включая архивированные) |
Идентификатор шаблона записи |
Список атрибутов с информацией о них (включая архивированные) |
|
/ |
Получает список атрибутов шаблона записи по его идентификатору с возможностью выбора архивированных атрибутов |
Идентификатор шаблона записи и опция включения в список архивированных атрибутов |
Список атрибутов с информацией о них |
|
/ |
Получает информацию об атрибуте шаблона записи по его идентификатору |
Идентификатор атрибута шаблона записи |
Информация об атрибуте |
|
/ |
Управлять отображением атрибута шаблона записи |
Идентификатор атрибута и шаблона записи |
Логическое значение |
|
/ |
Получает системное имя атрибута шаблона записи |
Идентификатор атрибута |
Системное имя атрибута |
|
/ |
Изменяет имя атрибута шаблона записи |
Идентификатор атрибута и новое имя |
Статус |
|
/ |
Изменяет системное имя атрибута шаблона записи |
Идентификатор атрибута и новое системное имя |
Статус |
|
/ |
Изменяет описание атрибута шаблона записи |
Идентификатор атрибута и новое описание |
Статус |
|
/ |
Изменяет тип данных для атрибута шаблона записи |
Идентификатор атрибута и новый тип |
Статус |
|
/ |
Перенести атрибут в другой шаблон записи |
Идентификатор атрибута, тип атрибута, шаблон записи, в который необходимо перенести атрибут |
Статус |
|
/ |
Устанавливает вариант отображения атрибута |
Идентификатор атрибута и вариант отображения |
Статус |
|
/ |
Включает контроль уникальности значений для атрибута шаблона записи |
Параметры для настройки |
Статус |
|
/ |
Включает использование атрибута в поиске |
Идентификатор атрибута, параметры |
Статус |
|
/ |
Включает группировку разрядов числа в атрибуте |
Идентификатор атрибута, флаг включения группировки |
Статус |
|
/ |
Устанавливает количество знаков после запятой у атрибута |
Идентификатор атрибута, количество знаков после запятой |
Статус |
|
/ |
Хранить несколько значений в атрибуте шаблона записи |
Параметры для настройки |
Статус |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Вычислять атрибут шаблона записи по выражению |
Параметры для настройки |
Статус |
|
/ |
Включает запись изменений в журнал |
Идентификатор атрибута, включение записи изменений |
Статус |
|
/ |
Изменяет атрибут шаблона записи согласно заданным параметрам |
Параметры для редактирования |
Идентификатор редактируемой записи |
|
/ |
Удаляет атрибут шаблона записи согласно заданным параметрам |
Параметры для удаления |
Информация об удалённых данных |
|
/ |
Получает список форм для шаблона записи |
Идентификатор шаблона записи |
Список форм с информацией о них |
|
/ |
Получает информацию о формах шаблона записи, включая информацию о формах, которые в них входят |
Идентификатор шаблона записи |
Информация о форме шаблона записи, включая информацию о формах, которые в неё входят |
|
/ |
Получает информацию о конкретной форме шаблона записи |
Параметры для отображения |
Информация о форме шаблона записи |
|
/ |
Создаёт форму шаблона записи по заданным параметрам |
Параметры для создания |
Идентификатор созданной формы |
|
/ |
Изменяет форму шаблона записи по заданным параметрам |
Параметры для редактирования |
Статус |
|
/ |
Удаляет конкретную форму шаблона записи |
Идентификатор шаблона записи и формы |
Статус |
|
/ |
Устанавливает форму по умолчанию |
Идентификатор шаблона записи и формы |
Статус |
|
/ |
Получает информацию о правилах для формы |
Идентификатор шаблона записи и формы |
Информация о правилах для формы |
|
/ |
Устанавливает правила для формы по заданному набору параметров |
Параметры для созданий правил |
Статус |
|
/ |
Устанавливает фильтр расширений файлов |
Идентификатор атрибута, файлы форматов |
Статус |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Устанавливает список значений для атрибута типа «список значений» по заданным параметрам |
Параметры для создания списка значений |
Статус |
|
/ |
Устанавливает проверку значения атрибута |
Идентификатор атрибута и выражение для проверки значения |
Статус |
|
/ |
Выбирает допустимые диаграммы URI |
Идентификатор атрибута, выбранные допустимые диаграммы URI |
Статус |
|
/ |
Устанавливает ширину для масштабирования изображения в атрибуте типа «изображение» |
Идентификатор атрибута и значение ширины |
Статус |
|
/ |
Устанавливает высоту для масштабирования изображения в атрибуте типа «изображение» |
Идентификатор атрибута и значение высоты |
Статус |
|
/ |
Получает изображение |
Идентификатор атрибута, поворот изображения |
Статус |
|
/ |
Устанавливает цветовой режим для атрибута типа «изображение» |
Идентификатор атрибута и цветовой режим |
Статус |
|
/ |
Устанавливает ширину по координате X для масштабирования изображения в атрибуте типа «изображение» |
Идентификатор атрибута и значение ширины |
Статус |
|
/ |
Устанавливает высоту по координате Y для масштабирования изображения в атрибуте типа «изображение» |
Идентификатор атрибута и значение высоты |
Статус |
|
/ |
Устанавливает особую маску |
Идентификатор атрибута, тип атрибута, регулярное выражение маски |
Статус |
|
/ |
Устанавливает проверку значений |
Идентификатор атрибута, выражение, тип проверки |
Статус |
ObjectAppExport — шаблоны экспорта |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает все шаблоны экспорта по идентификатору шаблона записи |
Идентификатор шаблона записи |
Список шаблонов экспорта |
|
/ |
Получает информацию о шаблоне экспорта по его идентификатору |
Идентификатор шаблона экспорта |
Информация о шаблоне экспорта |
|
/ |
Создаёт шаблон экспорта по заданным параметрам |
Параметры для создания шаблона экспорта |
Идентификатор шаблона экспорта |
|
/ |
Создаёт шаблон экспорта по расширенному набору заданных параметров |
Параметры для создания шаблона экспорта |
Идентификатор шаблона экспорта |
|
/ |
Привязать документ к шаблону экспорта |
Параметры для привязки |
Статус |
|
/ |
Назначает имя файла для экспорта |
Параметры для назначения |
Статус |
|
/ |
Удаляет шаблон экспорта по его идентификатору |
Идентификатор шаблона экспорта |
Статус |
|
/ |
Изменяет шаблон экспорта согласно параметрам |
Параметры для редактирования |
Статус |
|
/ |
Настраивает экспорт в PDF для шаблона экспорта |
Параметры настройки |
Статус |
|
/ |
Выгружает запись по шаблону экспорта |
Идентификатор шаблона экспорта, идентификатор записи |
Имя и тип записи |
|
/ |
Получает идентификатор стрима для шаблона экспорта |
Идентификатор шаблона экспорта |
Идентификатор стрима |
|
/ |
Получает стрим для шаблона экспорта по записи |
Идентификатор шаблона экспорта, идентификатор записи |
Стрим |
|
/ |
Получает стрим для шаблона экспорта |
Идентификатор шаблона экспорта |
Стрим |
|
/ |
Настраивает разметку |
- |
Статус |
|
/ |
Выгружает запись по шаблону экспорта в Word |
Параметры выгрузки |
Данные |
|
/ |
Выгружает запись по шаблону экспорта в Excel |
Параметры выгрузки |
Данные |
UserTask — пользовательские задачи |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает список всех активных задач |
- |
Список всех активных задач с информацией |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает информацию о задаче по идентификатору задачи |
Идентификатор задачи |
Информация о задаче |
|
/ |
Получает экземпляр шаблона записи для задачи |
Идентификатор задачи |
Идентификатор записи |
|
/ |
Создаёт задачу по заданным параметрам |
Параметры для создания задачи |
Статус |
|
/ |
Изменяет информацию о задаче |
Измененные параметры для задачи |
Статус |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Переназначает задачу |
Идентификатор задачи, новый исполнитель |
Статус |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Отменить задачу по идентификатору |
Идентификатор задачи |
Статус |
|
/ |
Выполнить задачу по идентификатору |
Идентификатор задачи |
Статус |
|
/ |
Отсрочить задачу по идентификатору |
Идентификатор задачи |
Статус |
|
/ |
Удаляет задачу по идентификатору |
Идентификатор задачи |
Статус |
|
/ |
Перенести задачу |
Идентификатор задачи, идентификатор шаблона записи |
Статус |
|
/ |
Получает список подзадач по идентификатору задачи |
Идентификатор задачи |
Список подзадач |
|
/ |
Получает список преемников задачи по идентификатору задачи |
Идентификатор задачи |
Список преемников задачи |
|
/ |
Получает возможность чтения задачи по её идентификатору |
Идентификатор задачи |
Логическое значение |
|
/ |
Получает список возможных исполнителей задачи по идентификатору задачи |
Идентификатор задачи |
Список возможных исполнителей задачи |
|
/ |
Получает информацию об идентификаторе формы, записи и шаблона записи для задачи |
Идентификатор задачи |
Идентификатор формы, записи и шаблона записи для задачи |
Document — документы |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает информацию о документе по его идентификатору |
Идентификатор документа |
Информация о документе |
|
/ |
Получает информацию о документе класса inline |
Идентификатор документа |
Информация о документе |
|
/ |
Получает название документа по его идентификатору |
Идентификатор документа |
Название документа |
|
/ |
Создаёт документ по заданным параметрам |
Параметры для создания документа |
Идентификатор документа |
|
/ |
Создаёт документ в определённом стриме по заданным параметрам |
Параметры для создания документа |
Идентификатор документа |
|
/ |
Создаёт документ в определённом стриме по заданным параметрам |
Параметры для создания документа |
Идентификатор документа |
|
/ |
Создаёт документ класса inline по заданным параметрам |
Параметры для создания документа |
Идентификатор документа |
|
/ |
Получает право подписи документа по идентификатору задачи |
Идентификатор задачи |
Логическое значение |
|
/ |
Изменяет информацию о документе |
Параметры для редактирования информации о документе |
Статус |
|
/ |
Изменяет информацию о документе класса inline |
Параметры для редактирования информации о документе |
Статус |
|
/ |
Удаляет документ по идентификатору документа |
Идентификатор документа |
Статус |
|
/ |
Получает информацию о подписи документа по идентификатору подписи |
Идентификатор подписи |
Информация о подписи |
|
/ |
Получает информацию о версиях документа по идентификатору документа |
Идентификатор документа |
Информация о версиях документа |
|
/ |
Получает информацию об определённой ревизии документа по идентификатору версии |
Идентификатор версии |
Информация об определённой версии документа |
|
/ |
Получает идентификатор документа по идентификатору версии документа |
Идентификатор версии документа |
Идентификатор документа |
|
/ |
Создаёт новую версию документа в нужном стриме |
Идентификатор документа, идентификатор стрима и имя файла |
Идентификатор созданного документа |
|
/ |
Создаёт новую версию документа |
Идентификатор документа и имя файла |
Идентификатор созданного документа |
|
/ |
Создаёт подпись по заданным параметрам |
Подписывающий, название подписи, содержание подписи |
Идентификатор созданной подписи |
|
/ |
Получает данные документа по его идентификатору |
Идентификатор документа |
Название документа, данные документа |
|
/ |
Получает ZIP-архив с документами из указанных записей. При добавлении в архив к совпадающим именам файлов добавляются порядковые номера. |
Идентификаторы записей и системное имя атрибута типа «Документ» |
Массив байтов с содержимым ZIP-архива |
|
/ |
Получает ZIP-архив с переданными файлами. При добавлении в архив к совпадающим именам файлов добавляются порядковые номера. |
Массив имён файлов и массивов байтов с их содержимым: |
Массив байтов с содержимым ZIP-архива |
|
/ |
Получает распакованные файлы из ZIP-архива. При извлечении из архива к именам файлов добавляются уникальные суффиксы (во избежание конфликтов с имеющимися файлами). |
Массив байтов с содержимым ZIP-архива |
Массив имён файлов и массивов байтов с их содержимым: |
|
/ |
Получает данные из внешнего ресурса |
URI ресурса, логин, пароль |
Данные |
Dataset — таблицы |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает данные из таблицы по запросу |
Запрос по форме |
Данные из таблицы, которые соответствуют запросу |
|
/ |
Получает информацию обо всех таблицах для шаблона записи |
Идентификатор шаблона записи |
Информация о таблицах |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
DatasetExport - Экспорт данных |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Экспортировать данные в Excel |
Параметры для экспорта |
Имя и тип |
DatasetConfiguration — пользовательская конфигурация таблиц |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Создаёт новую пользовательскую конфигурацию таблицы по заданным параметрам |
Параметры для создания |
Идентификатор пользовательской конфигурации таблицы |
|
/ |
Получает информацию о пользовательской конфигурации таблиц по идентификатору |
Идентификатор пользовательской конфигурации таблиц |
Информация о пользовательской конфигурации таблиц |
|
/ |
Изменяет пользовательскую конфигурацию таблицы по заданным параметрам |
Параметры для редактирования |
Идентификатор пользовательской конфигурации таблицы |
|
/ |
Удаляет пользовательскую конфигурацию таблицы по идентификатору |
Идентификатор пользовательской конфигурации таблицы |
Информация о пользовательской конфигурации таблицы |
|
/ |
Получает информацию о пользовательской конфигурации таблицы по идентификатору шаблона записи |
Идентификатор шаблона записи |
Информация о пользовательской конфигурации таблицы |
|
/ |
Получает основную информацию о пользовательской конфигурации таблицы по идентификатору шаблона записи |
Идентификатор шаблона записи |
Основная информация о пользовательской конфигурации таблицы |
|
/ |
Получает все атрибуты шаблона записи, которые можно использовать как столбцы таблицы |
Идентификатор шаблона записи |
Информация об атрибутах шаблона записи, которые можно использовать как столбцы таблицы |
|
/ |
Создаёт таблицу по умолчанию для шаблона записи |
Идентификатор шаблона записи |
Системное имя таблицы |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Создаёт персональную конфигурацию таблицы по заданным параметрам |
Параметры конфигурации |
Идентификатор конфигурации |
|
/ |
Получает информацию о персональной конфигурации |
Идентификатор таблицы |
Параметры конфигурации |
|
/ |
Удаляет персональную конфигурацию |
Идентификатор таблицы |
Статус |
|
/ |
Получает, является ли таблица журналом |
Идентификатор таблицы |
Логическое значение true/false |
GlobalFunction — скрипты |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Создаёт новый скрипт по заданным параметрам |
Параметры для создания |
Идентификатор скрипта |
|
/ |
Изменяет скрипт по заданным параметрам |
Параметры для редактирования |
Статус |
|
/ |
Компилирует скрипты в приложении |
Идентификатор приложения |
Статус |
|
/ |
Удаляет скрипт по идентификатору |
Идентификатор глобальной настройки |
Статус |
|
/ |
Удаляет скрипты по идентификатору приложения |
Идентификатор приложения |
Статус |
|
/ |
Получает скрипт по заданным параметрам |
Параметры для скрипта |
Скрипт и дополнительная информация |
|
/ |
Получает скрипт по системным именам |
Системное имя приложения, системное имя скрипта и параметры |
Скрипт |
|
/ |
Получает информацию обо всех скриптах |
- |
Информация о скриптах |
|
/ |
Получает информацию обо всех скриптах по приложению |
Идентификатор приложения |
Информация о скриптах |
|
/ |
Получает информацию о скриптах по идентификатору приложения |
Идентификатор приложения |
Информация о скриптах |
|
/ |
Получает скрипт и информацию о нём по идентификатору |
Идентификатор скрипта |
Скрипт и информация о нём |
|
/ |
Получает информацию о скрипте по идентификатору |
Идентификатор скрипта |
Информация о скрипте |
ScriptDetails — свойства скриптов |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает идентификатор приложения |
Параметры для запроса |
Идентификатор приложения |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
Template — шаблоны |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает список шаблонов |
Фильтр для поиска шаблонов |
Информация о шаблонах |
|
/ |
Получает информацию о шаблоне по его идентификатору |
Идентификатор шаблона |
Информация о конкретном шаблоне |
|
/ |
Изменяет шаблон по заданным параметрам |
Параметры для редактирования шаблона |
Статус |
|
/ |
Создаёт шаблон по заданным параметрам |
Параметры для создания шаблона |
Информация о созданном шаблоне |
|
/ |
Удаляет шаблон |
Идентификатор шаблона, статус действия |
Информация об удалённом шаблоне |
|
/ |
Удаляет несколько шаблонов |
Идентификаторы шаблонов, статус действия |
Информация об удалённых шаблонах |
|
/ |
Удаляет шаблон по приложению |
Приложение |
Статус |
|
/ |
Архивирует шаблон по идентификатору |
Идентификатор шаблона |
Статус |
|
/ |
Разархивирует шаблон по идентификатору |
Идентификатор шаблона |
Статус |
|
/ |
Получает список использований шаблона |
Идентификатор шаблона |
Список использований шаблона |
|
/ |
Получает идентификатор атрибута, который является именем записей шаблона |
Идентификатор шаблона |
Идентификатор атрибута |
|
/ |
Получает атрибуты приложения по фильтру |
Фильтр атрибутов |
Список атрибутов |
|
/ |
Получает список ссылок на шаблон |
Фильтр для поиска ссылок |
Список ссылок на шаблон |
SolutionVariable — переменные приложений |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Создаёт новую переменную приложения по заданному набору параметров |
Параметры для создания переменной |
Идентификатор созданной переменной |
|
/ |
Получает информацию о переменной по её идентификатору |
Идентификатор переменной |
Информация о переменной |
|
/ |
Получает информацию о переменной по системному имени приложения и переменной |
Системное имя приложения и переменной |
Информация о переменной |
|
/ |
Изменяет переменную приложения по заданному набору параметров |
Параметры для редактирования переменной |
Идентификатор переменной |
|
/ |
Получает информацию обо всех переменных приложения по идентификатору |
Идентификатор приложения |
Информация обо всех переменных приложения |
|
/ |
Удаляет переменные по идентификаторам |
Идентификаторы переменных |
Статус |
|
/ |
Удаляет все переменные в приложении по его идентификатору |
Идентификатор приложения |
Статус |
|
/ |
Получает значение переменной по её идентификатору |
Идентификатор переменной |
Значение переменной |
|
/ |
Получает значение переменной по системному имени приложения и переменной |
Системное имя приложения и переменной |
Значение переменной |
|
/ |
Устанавливает значение переменной приложения по её идентификатору |
Идентификатор переменной приложения и новое значение |
Новое значение переменной |
|
/ |
Устанавливает значение переменной приложения по её системному имени и системному имени приложения |
Системное имя переменной, системное имя приложения и новое значение |
Новое значение переменной |
|
/ |
Устанавливает значение переменной приложения по её системному имени и системному имени приложения |
Системное имя переменной, системное имя приложения и новое значение |
Новое значение переменной |
ProcessApp — шаблоны процессов |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает информацию о шаблоне процесса по его идентификатору |
Идентификатор шаблона процесса |
Информация о шаблоне процесса |
|
/ |
Получает системное имя для шаблона процесса |
Идентификатор шаблона процесса |
Системное имя шаблона процесса |
|
/ |
Получает список шаблонов процессов с информацией о них |
- |
Список шаблонов процессов с информацией о них |
|
/ |
Получает список шаблонов процесса с информацией о них, включая архивированные шаблоны процесса |
- |
Список шаблонов процесса с информацией о них, включая архивированные шаблоны процесса |
|
/ |
Удаляет шаблон процесса по идентификатору |
Идентификатор шаблона процесса |
Статус |
|
/ |
Архивирует шаблон процесса по идентификатору |
Идентификатор шаблона процесса |
Статус |
|
/ |
Разархивирует шаблон процесса по идентификатору |
Идентификатор шаблона процесса |
Статус |
|
/ |
Получает список процессов с информацией о них |
Идентификатор шаблона процесса |
Список процессов с информацией о них |
|
/ |
Получает список шаблонов процесса с информацией о них по их идентификаторам |
Идентификаторы шаблонов процесса |
Список шаблонов процесса с информацией о них |
|
/ |
Получает список шаблонов процесса с информацией о них по приложению |
Идентификатор приложения |
Список шаблонов процесса с информацией о них |
|
/ |
Получает список шаблонов процесса с информацией о них по приложению, включая архивированные шаблоны процесса |
Идентификатор приложения |
Список шаблонов процессов с информацией о них, включая архивированные шаблоны процесса |
|
/ |
Получает список шаблонов процесса с информацией о них по аккаунту |
Идентификатор аккаунта |
Список шаблонов процесса с информацией о них |
|
/ |
Получает список диаграмм процесса, которые связанны с данным шаблоном процесса |
Идентификатор шаблона процесса |
Список диаграмм процесса с информацией о них |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает идентификатор активной диаграммы для шаблона процесса |
Идентификатор шаблона процесса |
Идентификатор активной диаграммы |
|
/ |
Проверяет, является ли диаграмма последней опубликованной для шаблона процесса |
Идентификатор шаблона процесса и идентификатор диаграммы |
Логическое значение |
|
/ |
Проверяет, является ли диаграмма последней для шаблона процесса |
Идентификатор шаблона процесса и идентификатор диаграммы |
Логическое значение |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает идентификатор активной диаграммы по идентификатору шаблона процесса |
Идентификатор шаблона процесса |
Идентификатор диаграммы |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает информацию о диаграмме по идентификатору |
Идентификатор диаграммы |
Информация о диаграмме |
|
/ |
Получает идентификатор диаграммы для шаблона процесса |
Идентификатор шаблона процесса |
Идентификатор диаграммы |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает информацию о названии и системном имени шаблона процесса по его идентификатору |
Идентификатор шаблона процесса |
Название и системное имя шаблона процесса |
|
/ |
Убрать нерабочие процессы |
- |
Статус |
|
/ |
Собрать заново правила для данных на неактуальных версиях |
Идентификатор шаблона процесса |
Количество собранных заново правил |
ProcessObject — экземпляры процессов |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Создаёт токен по заданным параметрам |
Параметры для создания токена |
Статус |
|
/ |
Получает информацию об экземпляре процесса по его идентификатору |
Идентификатор экземпляра процесса |
Информация об экземпляре процесса |
|
/ |
Получает информацию об активных токенах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информацию об активных токенах |
|
/ |
Получает информацию об активных ошибках для экземпляра процесса |
Идентификатор экземпляра процесса |
Информацию об активных ошибках |
|
/ |
Получает информацию об активных подзадачах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информацию об активных подзадачах |
|
/ |
Получает информацию о выполненных подзадачах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информацию о выполненных подзадачах |
|
/ |
Получает информацию об отменённых подзадачах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информацию об отменённых подзадачах |
|
/ |
Получает информацию о диаграммах для диаграммы и идентификатора шаблона процесса |
Идентификатор диаграммы |
Информация о диаграммах для диаграммы и идентификатор шаблона процесса |
|
/ |
Получает расширенную информацию по экземпляру процесса |
Идентификатор экземпляра процесса, диаграмма |
Расширенная информация по экземпляру процесса |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает информацию об активных подпроцессах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информация об активных подпроцессах |
|
/ |
Получает информацию о выполненных подпроцессах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информация о выполненных подпроцессах |
|
/ |
Получает информацию об отменённых подпроцессах для экземпляра процесса |
Идентификатор экземпляра процесса |
Информация об отменённых подпроцессах |
|
/ |
Получает список подпроцессов по заданным параметрам |
Параметры запроса |
Список подпроцессов |
|
/ |
Получает связанные с записью процессы |
Идентификатор записи |
Информация о связанных процессах |
|
/ |
Получает связанные с записью задачи |
Идентификатор записи |
Информация о связанных задачах |
|
/ |
Создаёт экземпляр процесса по заданным параметрам |
Параметры для создания |
Идентификатор процесса |
|
/ |
Создаёт экземпляр процесса по расширенному набору параметров |
Расширенный набор параметров для создания |
Идентификатор процесса |
|
/ |
Создаёт экземпляр процесса по идентификатору записи |
Идентификатор шаблона процесса, имя записи, идентификатор записи и параметр синхронизации (всегда 0) |
Идентификатор созданного экземпляра процесса |
|
/ |
Отменить экземпляр процесса по его идентификатору |
Идентификатор экземпляра процесса |
Статус |
|
/ |
Удаляет токен по его идентификатору |
Идентификатор токена |
Статус |
|
/ |
Добавить токен по заданным параметрам |
Параметры для добавления токена |
Статус |
|
/ |
Пропустить ошибку правил для токена |
Идентификатор ошибки |
Статус |
|
/ |
Пропустить ошибку расположения токена |
Идентификатор ошибки, новое расположение |
Статус |
|
/ |
Пропустить ошибку выбора следующей задачи |
Идентификатор ошибки, следующие задачи |
Статус |
|
/ |
Повторить токен по его идентификатору |
Идентификатора токена |
Статус |
|
/ |
Перевести экземпляр процесса в другую диаграмму по заданным параметрам |
Параметры миграции |
Результаты миграции |
Diagram — диаграммы процессов |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Получает информацию о диаграмме по идентификатору |
Идентификатор диаграммы |
Информация о диаграмме |
|
/ |
Получает информацию о черновике диаграммы по идентификатору |
Идентификатор диаграммы |
Информация о черновике диаграммы |
|
/ |
Получает информацию о действиях над элементами диаграммы |
Идентификатор сервера |
Информация о действиях над элементами диаграммы |
|
/ |
Получает информацию о действиях над элементами определённой диаграммы |
Идентификатор сервера |
Информация о действиях над элементами определённой диаграммы |
|
/ |
Получает информацию о статусе диаграммы |
Идентификатор диаграммы |
Информация о статусе диаграммы |
|
/ |
Получает информацию о диаграмме по заданным параметрам |
Параметры для запроса |
Информация о диаграмме |
|
/ |
Получает основные свойства диаграммы |
Идентификатор диаграммы |
Основные свойства диаграммы |
|
/ |
Получает информацию об определённой версии диаграммы |
Параметры для запроса |
Информация об определённой версии диаграммы |
|
/ |
Получает информацию о действиях на диаграмме процесса |
Параметры для запроса |
Информация о действиях на диаграмме процесса |
|
/ |
Получает тип диаграммы и её принадлежность к приложению и процессу |
Идентификатор диаграммы |
Тип диаграммы и её принадлежность к приложению и процессу |
|
/ |
В текущей версии продукта данный метод не используется |
Идентификатор диаграммы |
Информация |
|
/ |
Получает все версии диаграммы с информацией о них по запросу |
Параметры для запроса |
Версии диаграммы с информацией о них |
|
/ |
Получает список действий над элементами диаграммы с информацией о них |
Идентификатор диаграммы |
Список действий над элементами диаграммы с информацией о них |
|
/ |
Получает информацию о действиях триггеров на диаграмме |
Идентификатор диаграммы |
Информация о действиях триггеров на диаграмме |
|
/ |
Создаёт диаграмму по заданному набору параметров |
Параметры для создания |
Идентификатор созданной диаграммы |
|
/ |
Создаёт диаграмму процесса по умолчанию |
Идентификатор шаблона процесса |
Идентификатор созданной диаграммы |
|
/ |
Создаёт версию диаграммы |
Идентификатор диаграммы и описание |
Идентификатор версии диаграммы |
|
/ |
Создаёт действие над элементами на диаграмме по заданным параметрам |
Параметры для создания |
Информация о действии над элементами на диаграмме |
|
/ |
Создаёт действие над элементами на диаграмме процесса по заданным параметрам |
Параметры для создания |
Информация о действии над элементами на диаграмме процесса |
|
/ |
Создаёт множество действий над элементами на диаграмме процесса по заданным параметрам |
Параметры для создания |
Информация о действиях над элементами на диаграмме процесса |
|
/ |
Изменяет диаграмму по заданному набору параметров |
Параметры для редактирования |
Статус |
|
/ |
Изменяет действие над элементами диаграммы |
Идентификатор действия |
Информация о действии над элементами диаграммы |
|
/ |
Изменяет опубликованное действие над элементами диаграммы |
Идентификатор опубликованного действия |
Информация об опубликованном действии над элементами диаграммы |
|
/ |
Изменяет действия над элементами диаграммы по заданным параметрам |
Параметры для редактирования |
Информация о действиях над элементами диаграммы |
|
/ |
Изменяет действия над элементами диаграммы процесса по заданным параметрам |
Параметры для редактирования |
Информация о действиях над элементами диаграммы процесса |
|
/ |
Получает идентификатор последней диаграммы для шаблона процесса |
Идентификатор шаблона процесса |
Идентификатор диаграммы |
|
/ |
Удаляет последнее действие над элементами диаграммы |
Идентификатор сервера |
Статус |
|
/ |
Удаляет версии диаграммы по идентификаторам |
Идентификаторы версий диаграммы |
Информация об удалённых версиях |
|
/ |
Удаляет действие над элементами диаграммы по заданным параметрам |
Параметры для удаления |
Статус |
|
/ |
Удаляет действия над элементами диаграммы по заданным параметрам |
Параметры для удаления |
Логическое значение |
|
/ |
Удаляет несколько диаграмм по идентификаторам |
Идентификаторы диаграмм, флаг необходимости удаления черновиков |
Статус |
|
/ |
Восстановить диаграмму по версии |
Идентификатор диаграммы и идентификатор версии |
Статус |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Проверяет, была ли опубликована диаграмма |
Идентификатор диаграммы |
Логическое значение |
|
/ |
Убрать сценарии, которые были добавлены в версии диаграммы |
Версия диаграммы |
Статус |
DiagramPublishing — публикация диаграмм |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Проверяет диаграмму |
Параметры для запроса |
Информация |
|
/ |
Опубликовать диаграмму |
Идентификаторы шаблона процесса и диаграммы, возможность опубликовать диаграмму как новую версию |
Список ошибок |
ProcessReport — сообщения об ошибках |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
ConversationConfiguration — конфигурации обсуждений |
|||
|
Запрос |
Описание |
Входные данные |
Выходные данные |
|
/ |
Создаёт обсуждение по заданному набору параметров |
Параметры для создания |
Идентификатор обсуждения |
|
/ |
Получает информацию об обсуждении по идентификатору |
Идентификатор обсуждения |
Информация об обсуждении |
|
/ |
Изменяет данные в обсуждении по идентификатору |
Идентификатор обсуждения |
Статус |
|
/ |
Удаляет обсуждение по идентификатору |
Идентификатор обсуждения |
Статус |
|
/ |
Получает идентификатор обсуждения по связанному объекту |
Идентификатор объекта |
Идентификатор обсуждения |
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
В текущей версии продукта данный метод не используется |
||
|
/ |
Получает список идентификаторов участников обсуждения по идентификатору обсуждения |
Идентификатор обсуждения |
Идентификаторы участников обсуждения с указанной ролью в обсуждении |
|
/ |
Получает набор сообщений по запросу |
Параметры запроса |
Набор сообщений |
|
/ |
В текущей версии продукта данный метод не используется |
||
Эта статья была полезна 3 чел.
