Методы System Core API
System Core API Comindware Business Application Platform представляет собой системные методы API, которые являются универсальными и неизменными в рамках одной и той же версии Comindware Business Application Platform.
Список системных методов можно посмотреть по адресу http://your-host/Docs/SystemApi, где your-host — адрес вашего домена.
Область System Core API
Для доступа к swagger-описанию системных методов перейдите по ссылке http://yourhost/api/public/system/, где your-host — адрес вашего домена.
Для вызова системного метода отправьте запрос HTTP-POST на адрес метода (приведен в swagger-описании).
Например, для создания шаблона записи нужно отправить запрос HTTP-POST на адрес http://your-host/api/public/system/TeamNetwork/ObjectAppService/Create, указав системное имя шаблона записи в теле ("body") запроса (например, "Car"). В ответ на запрос система отправит id созданного шаблона записи (например, "oa.1").
Данные методы используются при написании скриптов, обращаться к ним стоит, только если вы точно понимаете, что и зачем делаете, иначе вы можете потерять важные данные или настройки.
Ниже даны определения для используемых понятий:
Inline — особый тип документа, который отображается на форме как текстовый блок и который можно редактировать в форме.
Стрим — тип файла, в котором хранятся пользовательские данные.
Версия (ревизия/revision) — добавление новой версии файла при замене файла в атрибуте (ревизии).
Account – Аккаунт | |||
---|---|---|---|
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Base/AccountService/get_DefaultAccountLanguage |
Возвращает язык, который установлен для аккаунтов по умолчанию | - | Язык, который установлен для аккаунтов по умолчанию |
/Base/AccountService/List | Возвращает список аккаунтов с информацией о них | - | Список аккаунтов с информацией о них |
/Base/AccountService/ListInfo | Вернуть основную информацию о нескольких аккаунтах по их идентификаторам | Массив идентификаторов (в квадратных скобках, через запятую) | Список аккаунтов с основной информацией о них |
/Base/AccountService/Get | Вернуть информацию об аккаунте по его идентификатору | Идентификатор аккаунта | Информация об аккаунте |
/Base/AccountService/GetInfo | Вернуть основную информацию об аккаунте по его идентификатору | Идентификатор аккаунта | Основная информация об аккаунте |
/Base/AccountService/Create | Создать новый аккаунт | Информация для создания аккаунта | Статус |
/Base/AccountService/Edit | Редактировать информацию об аккаунте | Редактируемая информация об аккаунте | Статус |
/Base/AccountService/Delete | Удалить аккаунт | Идентификатор аккаунта | Статус |
/Base/AccountService/ProvisionAccount | В текущей версии продукта данный метод не используется | ||
/Base/AccountService/GetFullName | Получить полное имя аккаунта | Идентификатор аккаунта | Полное имя аккаунта |
/Base/AccountService/GetAbbreviation | Получить аббревиатуру полного имени аккаунта | Полное имя аккаунта | Аббревиатура полного имени аккаунта |
/Base/AccountService/SaveProfilePhoto | Обновить фото в аккаунте | Идентификатор аккаунта, фото в формате json | Статус |
/Base/AccountService/GetProfilePhoto | Отобразить фото аккаунта в формате json | Идентификатор аккаунта и размер изображения | Фото аккаунта в формате json |
/Base/AccountService/FindByEmail | Найти аккаунт по адресу электронной почты | Адрес электронной почты | Идентификатор аккаунта |
/Base/AccountService/FindByUsername | Найти аккаунт по имени пользователя | Имя пользователя | Идентификатор аккаунта |
/Base/AccountService/SetAccountPassword | Изменить пароль аккаунта | Идентификатор аккаунта, новый пароль | Статус |
/Base/AccountService/SetOwnAccountPassword | Установить пароль для текущего аккаунта | Предыдущий пароль и новый пароль | Статус |
/Base/AccountService/GetSystemInfo | Отобразить системную информацию об аккаунте | Идентификатор аккаунта | Системная информация об аккаунте |
/Base/AccountService/SetSystemInfo | Редактировать системную информацию об аккаунте | Системная информация об аккаунте | Статус |
/Base/AccountService/ListAccountsByEmailDomain | Отобразить аккаунты с определёнными доменами в электронных адресах | Домен электронного адреса | Основная информация об аккаунте |
/Base/AccountService/Disable | Архивировать аккаунт | Идентификатор аккаунта | Статус |
/Base/AccountService/Disable1 | Архивировать несколько аккаунтов | Идентификатор аккаунта | Статус |
/Base/AccountService/Enable | Разархивировать аккаунт | Идентификатор аккаунта | Статус |
/Base/AccountService/Enable1 | Разархивировать несколько аккаунтов | Идентификатор аккаунта | Статус |
/Base/AccountService/Activate | Активировать аккаунт | Идентификатор аккаунта | Статус |
/Base/AccountService/Activate1 | Активировать несколько аккаунтов | Идентификатор аккаунта | Статус |
/Base/AccountService/Deactivate | Деактивировать аккаунт | Идентификатор аккаунта | Статус |
/Base/AccountService/Deactivate1 | Деактивировать несколько аккаунтов | Идентификаторы аккаунтов | Статус |
/Base/AccountService/GetPasswordValidationParameters | Отобразить список требований к паролю | - | Требования к паролю |
Ontology – Объект | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Base/OntologyService/GetAxioms | Отобразить невычисляемые атрибуты со значениями для любого объекта без указания его типа по его идентификатору | Идентификатор объекта | Невычисляемые атрибуты объекта со значениями |
/Base/OntologyService/GetAxiomsByPredicate | Отобразить значения невычисляемых атрибутов объекта по предикату | Идентификатор объекта, атрибут | Значение атрибута |
/Base/OntologyService/GetValuesByPredicate | Отобразить значения атрибутов объекта по предикату | Идентификатор объекта, атрибут | Значение атрибута |
/Base/OntologyService/GetReferences | Отобразить список ссылок на объект по его идентификатору | Идентификатор объекта | Список использований объекта |
/Base/OntologyService/Remove | Удалить объект по его идентификатору | Идентификатор объекта | Статус |
/Base/OntologyService/RemoveValuesByPredicate | Удалить значения по предикату | Идентификатор объекта, предикат | Статус |
/Base/OntologyService/GetCurrentConnections | Отобразить текущие подключения | - | - |
/Base/OntologyService/ResetConnections | Отключить все текущие подключения | - | Статус |
/Base/OntologyService/ResetConnection | Отключить подключения по идентификатору аккаунта | Идентификатор аккаунта | Статус |
AccountGroup – Группы Аккаунтов | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Base/AccountGroupService/ListReferences | Вывести список групп аккаунтов с их названиями, идентификаторами и системными именами | Выбор отображения в списке группы со всеми аккаунтами | Список групп аккаунтов с их названиями, идентификаторами и системными именами |
/Base/AccountGroupService/ListInfo | Вывести список групп аккаунтов с основной информацией | Выбор отображения в списке групп Active Directory | Список групп аккаунтов с основной информацией |
/Base/AccountGroupService/List | Вывести список групп аккаунтов с информацией и списком участников | - | Список групп аккаунтов с информацией и списком участников |
/Base/AccountGroupService/GetInfo | Вывести информацию о группе по её идентификатору | Идентификатор группы | Информация о группе аккаунтов |
/Base/AccountGroupService/Get | Вывести информацию об аккаунтах, входящих в данную группу | Идентификатор группы | Информация об аккаунтах, входящих в данную группу |
/Base/AccountGroupService/TryGetBySid | Показать группу по идентификатору группы в Active Directory и идентификатору | Идентификатор группы и идентификатор группы в Active Directory | Логическое значение true/false |
/Base/AccountGroupService/Create | Создать новую группу аккаунтов | Параметры для новой группы аккаунтов | Статус |
/Base/AccountGroupService/Edit | Изменить информацию о группе аккаунтов | Новые параметры для группы аккаунтов | Статус |
/Base/AccountGroupService/IncludeMembers | Включить аккаунты в группу аккаунтов | Идентификаторы аккаунтов и групп аккаунтов, которые необходимо включить | Статус |
/Base/AccountGroupService/SetMembers | Назначить аккаунты в группу аккаунтов | Идентификатор группы аккаунтов и список идентификаторов аккаунтов, которые необходимо включить | Статус |
/Base/AccountGroupService/ExcludeMembers | Исключить аккаунты из группы аккаунтов | Идентификаторы аккаунтов и группы аккаунтов, которые необходимо включить | Статус |
/Base/AccountGroupService/IncludesMember | Проверить, входит ли данный аккаунт в группу аккаунтов | Идентификаторы аккаунтов и группы аккаунтов, которые необходимо включить | Логическое значение true/false |
/Base/AccountGroupService/GetUsers | Вывести список идентификаторов аккаунтов, входящих в группу аккаунтов (исключая аккаунты, входящие в группы аккаунтов из текущей группы аккаунтов) | Идентификатор группы аккаунтов | Список идентификаторов аккаунтов |
/Base/AccountGroupService/GetGroups | Вывести список идентификаторов групп аккаунтов, которые входят в группу аккаунтов | Идентификатор группы аккаунтов | Список идентификаторов групп аккаунтов |
/Base/AccountGroupService/ListPeopleExpanded | Вывести полный список идентификаторов аккаунтов, которые входят в данную группу аккаунтов (включая аккаунты, входящие в группы аккаунтов из текущей группы аккаунтов) | Идентификатор группы аккаунтов | Список идентификаторов аккаунтов |
/Base/AccountGroupService/GetMemberOf | Вывести идентификаторы групп аккаунтов, которые содержат данную группу аккаунтов | Идентификатор группы аккаунтов | Список идентификаторов групп аккаунтов |
/Base/AccountGroupService/FindGroupByDn | Вывести идентификатор группы аккаунтов по его уникальному имени Active Directory | Уникальное имя Active Directory | Идентификатор группы аккаунтов |
/Base/AccountGroupService/Delete | Удалить группу | Идентификатор группы | Статус |
GlobalConfiguration – Глобальная конфигурация | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Base/GlobalConfigurationService/get_ExternalNotificationEnabled | Проверить, включены ли внешние уведомления | - | Логическое значение true/false |
/Base/GlobalConfigurationService/get_GlobalNotificationListening | Проверить, включены ли системные уведомления | - | Логическое значение true/false |
/Base/GlobalConfigurationService/get_TracingEnabled | Проверить, включён ли мониторинг производительности | - | Логическое значение true/false |
/Base/GlobalConfigurationService/get_ServerAddress | Получить адрес сервера | - | Адрес сервера |
/Base/GlobalConfigurationService/get_CompilationOnSaveDisabled | Отключить компиляцию при сохранении | - | Логическое значение true/false |
/Base/GlobalConfigurationService/get_LastTimestamp | Отобразить последние временные отметки | - | Список временных отметок |
/Base/GlobalConfigurationService/get_PasswordValidationPolicy | Отобразить установленную политику проверки пароля | - | Политика проверки пароля |
/Base/GlobalConfigurationService/get_RegisteredAuthChannels | Отобразить зарегистрированные каналы аутентификации | - | Список зарегистрированных каналов аутентификации |
/Base/GlobalConfigurationService/add_PropertyChanged | В текущей версии продукта данный метод не используется | ||
/Base/GlobalConfigurationService/remove_PropertyChanged | В текущей версии продукта данный метод не используется | ||
/Base/GlobalConfigurationService/GetActiveConfiguration | Отобразить активную глобальную конфигурацию | - | Активная глобальная конфигурация |
/Base/GlobalConfigurationService/SetActiveConfiguration | Настроить активную глобальную конфигурацию | Параметры для настройки активной глобальной конфигурации | Статус |
/Base/GlobalConfigurationService/RegisterAuthChannel | Зарегистрировать канал аутентификации | Канал | Статус |
/Base/GlobalConfigurationService/UnregisterAuthChannel | Снять регистрацию канала аутентификации | Канал | Статус |
CommunicationChannel – Подключения | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Base/CommunicationChannelService/Get | Получить информацию о подключении по идентификатору | Идентификатор подключения | Информация о подключении |
/Base/CommunicationChannelService/GetByAlias | Получить информацию о подключении по системному имени | Системное имя подключения | Информация о подключении |
/Base/CommunicationChannelService/List | Получить список подключений с информацией о них по запросу | Запрос | Список подключений с информацией о них |
/Base/CommunicationChannelService/ListInfo | Получить список подключений с основной информацией о них по запросу | Запрос | Список подключений с основной информацией о них |
/Base/CommunicationChannelService/Create | Создать новое подключение по заданным параметрам | Параметры для создания подключения | Идентификатор подключения |
/Base/CommunicationChannelService/Edit | Редактировать существующее подключение согласно заданным параметрам | Параметры для редактирования подключения | Статус |
/Base/CommunicationChannelService/Delete | Удалить существующее подключение по его идентификатору | Идентификатор подключения | Информация об удалённом подключении |
/Base/CommunicationChannelService/GetBasicAuthValue | Получить значение аутентификации для канала связи | Системное имя подключения | Значение аутентификации для канала связи |
/Base/CommunicationChannelService/IsDisabled | Проверить отключено ли подключение по идентификатору | Идентификатор подключения | Логическое значение true/false |
/Base/CommunicationChannelService/GetDefaultChannelId |
Отобразить подключение по умолчанию |
- | Идентификатор подключения |
/Base/CommunicationChannelService/GetEmailTestMessage | Отправить тестовое сообщение выбранным получателям | Получатели | Информация о тестовом сообщении |
/Base/CommunicationChannelService/Test | Протестировать подключение по заданным параметрам | Параметры для тестирования | Информация о тестировании |
/Base/CommunicationChannelService/SendMessage | Отправить сообщение по заданным параметрам | Параметры для сообщения | Статус |
/Base/CommunicationChannelService/GetDefaultAccountMap | Показать стандартный набор атрибутов для аккаунта | - | Набор атрибутов для аккаунта |
/Base/CommunicationChannelService/GetDefaultGroupMap | Показать стандартный набор атрибутов для группы аккаунтов | - | Набор атрибутов для группы аккаунтов |
Object – Записи | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/ObjectService/Create | Создать запись согласно заданным параметрам | Параметры для создания записи | Идентификатор созданной записи |
/TeamNetwork/ObjectService/Edit | Редактировать запись согласно заданным параметрам | Параметры для редактирования записи | Логическое значение true/false |
/TeamNetwork/ObjectService/Get | Получить информацию о записи по заданным параметрам | Параметры запроса | Информация о записи |
/TeamNetwork/ObjectService/GetPropertyValues | Получить информацию о значениях атрибутов экземпляров шаблонов записи по заданным параметрам | Идентификатор экземпляра шаблона записи и системное имя атрибута | Информация о значениях атрибутов экземпляров шаблонов записи |
/TeamNetwork/ObjectService/List | Отобразить все записи по идентификатору шаблона записи | Идентификатор шаблона записи | Записи с информацией о них |
/TeamNetwork/ObjectService/ListWithAlias | Отобразить все записи по системному имени шаблона записи | Системное имя шаблона записи | Записи с информацией о них |
/TeamNetwork/ObjectService/CreateWithAlias | Создать запись по системному имени шаблона записи и заданным данным | Системное имя шаблона записи и данные | Идентификатор записи |
/TeamNetwork/ObjectService/EditWithAlias | Редактировать запись по идентификатору записи и заданным данным | Идентификатор записи и данные | Статус |
/TeamNetwork/ObjectService/GetWithAlias | Получить информацию об экземпляре шаблона записи по его идентификатору | Идентификатор записи | Информация об экземпляре шаблона записи |
/TeamNetwork/ObjectService/IsDisabled | Проверить, является ли запись архивной по её идентификатору | Идентификатор записи | Логическое значение true/false |
/TeamNetwork/ObjectService/Disable | Архивировать запись по её идентификатору | Идентификатор записи | Статус |
/TeamNetwork/ObjectService/Disable1 | Архивировать несколько записей по их идентификаторам | Идентификаторы записей | Статус |
/TeamNetwork/ObjectService/Enable | Разархивировать запись по её идентификатору | Идентификатор записи | Статус |
/TeamNetwork/ObjectService/Enable1 | Разархивировать несколько записей по их идентификаторам | Идентификаторы записей | Статус |
/TeamNetwork/ObjectService/Delete | Удалить запись по идентификатору | Идентификатор записи | Статус |
/TeamNetwork/ObjectService/Delete1 | Удалить записи по заданным параметрам | Параметры удаления | Статус |
/TeamNetwork/ObjectService/DeleteAll | Удалить все записи по идентификатору шаблона записи | Идентификатор шаблона записи | Количество удалённых записей |
/TeamNetwork/ObjectService/ExcludeFromContainer | Исключить аккаунт(-ы) из шаблона аккаунтов | Идентификатор(-ы) аккаунта(-ов) и идентификатор шаблона аккаунтов | Статус |
/TeamNetwork/ObjectService/IncludeInContainer | Включить аккаунт в шаблон аккаунтов | Идентификатор аккаунта и идентификатор шаблона аккаунтов | Статус |
/TeamNetwork/ObjectService/IncludeInContainer1 | Включить несколько аккаунтов в шаблон аккаунтов | Идентификаторы аккаунтов и идентификатор шаблона аккаунтов | Статус |
/TeamNetwork/ObjectService/Clone | Клонировать запись вместе с данными в новую запись (исключая атрибуты, значения которых прописаны в параметрах) | Идентификатор копируемой записи и параметры копирования | Идентификатор созданной записи |
/TeamNetwork/ObjectService/Clone1 | Показать глубину копирования данных при клонировании записи вместе с данными в новую запись (исключая атрибуты, значения которых прописаны в параметрах) | Идентификатор копируемой записи и параметры копирования | Идентификатор созданной записи |
/TeamNetwork/ObjectService/GetInfo | Показать информацию о записи по идентификатору | Идентификатор записи | Информация о записи |
/TeamNetwork/ObjectService/ResolveDisplayName | Получить отображаемое имя записи по её идентификатору | Идентификатор записи | Отображаемое имя записи |
/TeamNetwork/ObjectService/ResolveObjectInfo | Получить идентификатор и имя шаблона записи, идентификатор и отображаемое имя записи по её идентификатору | Идентификатор записи | Идентификатор и имя шаблона записи, идентификатор и отображаемое имя записи |
/TeamNetwork/ObjectService/ResolveObjectApp | Получить идентификатор шаблона записи по идентификатору записи | Идентификатор записи | Идентификатор шаблона записи |
/TeamNetwork/ObjectService/ValidateObjectApp | Проверить шаблон записи | Идентификатор записи, идентификатор шаблона записи и параметр безопасности | Логическое значение true/false |
/TeamNetwork/ObjectService/GetHistory | Отобразить историю записи | Идентификатор записи | История записи |
/TeamNetwork/ObjectService/BulkCreate | Создать несколько записей по заданным параметрам | Параметры для создания записей | Идентификаторы созданных записей |
/TeamNetwork/ObjectService/BulkEdit | Редактировать несколько записей по заданным параметрам | Параметры для редактирования записей | Количество отредактированных записей |
/TeamNetwork/ObjectService/BulkEdit1 | Редактировать несколько записей по заданным параметрам (без идентификатора шаблона записи) | Параметры для редактирования записей | Количество отредактированных записей |
/TeamNetwork/ObjectService/Edit1 | Редактировать запись по уникальному идентификатору, заданному в шаблоне записи | Системное имя шаблона записи, уникальный идентификатор и данные для редактирования | Идентификатор записи |
/TeamNetwork/ObjectService/Get1 | Получить информацию о записи по уникальному идентификатору, заданному в шаблоне записи | Системное имя шаблона записи, уникальный идентификатор и системные имена необходимых атрибутов | Информация о записи |
/TeamNetwork/ObjectService/Delete2 | Удалить запись по уникальному идентификатору, заданному в шаблоне записи |
Системное имя шаблона записи и уникальный идентификатор
|
Статус |
/TeamNetwork/ObjectService/EditWithAlias1 | Редактировать запись по системному имени шаблона записи | Системное имя шаблона записи, идентификатор записи и данные для редактирования | Статус |
/TeamNetwork/ObjectService/DeleteWithAlias | Удалить запись по системному имени шаблона записи и идентификатору записи | Системное имя шаблона записи и идентификатор записи | Статус |
/TeamNetwork/ObjectService/GetWithAlias1 | Получить информацию о записи по системному имени шаблона записи | Системное имя шаблона записи и идентификатор записи | Информация о записи |
ObjectApp – Шаблоны записи | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/ObjectAppService/List | Получить информацию обо всех шаблонах записи | - | Информация обо всех шаблонах записи |
/TeamNetwork/ObjectAppService/ListAll | Получить информацию обо всех шаблонах записи, включая архивированные | - | Информация обо всех шаблонах записи, включая архивированные |
/TeamNetwork/ObjectAppService/ListAppsForAccount | Отобразить информацию о шаблонах записи, которые были созданы определенным аккаунтом | Идентификатор аккаунта | Информация о шаблонах записи |
/TeamNetwork/ObjectAppService/ListBySolution | Отобразить информацию о шаблонах записи в определенном приложении | Идентификатор приложения | Информация о шаблонах записи |
/TeamNetwork/ObjectAppService/ListAllBySolution | Отобразить информацию обо всех шаблонах записи в определенном приложении, включая архивированные | Идентификатор приложения | Информация обо всех шаблонах записи |
/TeamNetwork/ObjectAppService/Get | Отобразить информацию о шаблоне записи по его идентификатору | Идентификатор шаблона записи | Информация о шаблоне записи |
/TeamNetwork/ObjectAppService/GetByAlias | Отобразить информацию о шаблоне записи по системному имени | Системное имя шаблона записи | Информация о шаблоне записи |
/TeamNetwork/ObjectAppService/GetByObject | Получить информацию о шаблоне записи по идентификатору записи | Идентификатор записи | Информация о шаблоне записи |
/TeamNetwork/ObjectAppService/GetAccountPropertyInstanceApp | Показать, какому шаблону принадлежит ссылочный атрибут шаблона аккаунтов | Идентификатор шаблона аккаунтов | Идентификатор шаблона |
/TeamNetwork/ObjectAppService/GetRolePropertyInstanceApp | Показать, к какому шаблону относится атрибут шаблона ролей | Идентификатор шаблона ролей | Идентификатор шаблона |
/TeamNetwork/ObjectAppService/GetOrganizationalUnitPropertyInstanceApp | Показать, к какому шаблону относится атрибут шаблона оргединиц | Идентификатор шаблона оргединицы | Идентификатор шаблона |
/TeamNetwork/ObjectAppService/GetIdByObject | Получить идентификатор шаблона записи по идентификатору записи | Идентификатор записи | Идентификатор шаблона записи |
/TeamNetwork/ObjectAppService/GetAppAlias | Отобразить системное имя шаблона записи по его идентификатору | Идентификатор шаблона записи | Системное имя шаблона записи |
/TeamNetwork/ObjectAppService/Create | Создать шаблон записи по заданным параметрам | Параметры для создания шаблона записи | Идентификатор шаблона записи |
/TeamNetwork/ObjectAppService/Update | Обновить шаблон записи по заданным параметрам | Параметры для обновления шаблона записи | Статус |
/TeamNetwork/ObjectAppService/GetContainerInfo | Отобразить основную информацию о шаблоне записи | Идентификатор шаблона записи | Основная информация о шаблоне записи |
/TeamNetwork/ObjectAppService/Delete | Удалить шаблон записи по его идентификатору | Идентификатор шаблона записи | Статус |
/TeamNetwork/ObjectAppService/Disable | Архивировать шаблон записи по его идентификатору | Идентификатор шаблона записи | Статус |
/TeamNetwork/ObjectAppService/Enable | Разархивировать шаблон записи по его идентификатору | Идентификатор шаблона записи | Статус |
/TeamNetwork/ObjectAppService/SetName | Назначить имя для шаблона записи | Новое имя и идентификатор шаблона записи | Статус |
/TeamNetwork/ObjectAppService/SetAlias | Назначить системное имя для шаблона записи | Новое системное имя и идентификатор шаблона записи | Статус |
/TeamNetwork/ObjectAppService/SetSolution | Назначить приложение для шаблона записи | Идентификаторы приложения и шаблона записи | Статус |
/TeamNetwork/ObjectAppService/SetDescription | Назначить описание для шаблона записи | Описание и идентификатор для шаблона записи | Статус |
/TeamNetwork/ObjectAppService/SetNamePropertyId | Назначить атрибут, который используется как заголовок записей | Идентификаторы шаблона записи и его атрибута | Статус |
/TeamNetwork/ObjectAppService/UnsetNamePropertyId | Снять назначение атрибута, который используется как заголовок записей | Идентификаторы шаблона записи и его атрибута | Статус |
/TeamNetwork/ObjectAppService/CreateProperty | Создать новый атрибут шаблона записи по заданным параметрам | Идентификатор шаблона записи, системное имя нового атрибута, тип нового атрибута | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateProperty1 | Создать новый атрибут шаблона записи с типом данных «Список значений» по заданным параметрам | Параметры для создания | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateNumberProperty | Создать атрибут с типом данных "число" в шаблоне записи по заданным параметрам | Идентификатор шаблона записи, системное имя нового атрибута, тип нового атрибута и количество знаков после запятой | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateAccountProperty | Создать атрибут с типом данных «аккаунт» в шаблоне записи по заданным параметрам | Шаблон записи, в котором будет создаваться атрибут, системное имя нового атрибута, шаблон аккаунта, который будет привязан к атрибуту | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateRoleProperty | Создать атрибут с типом данных «роль» в шаблоне записи по заданным параметрам | Шаблон записи, в котором будет создаваться атрибут, системное имя нового атрибута, шаблон ролей, который будет привязан к атрибуту | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateOrganizaionalUnitProperty | Создать атрибут с типом данных «организационная единица» в шаблоне записи по заданным параметрам | Шаблон записи, в котором создаётся атрибут, системное имя нового атрибута, шаблон оргеденицы, к которому привязан атрибут | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateForwardProperty | Создать атрибут с типом данных «запись» в шаблоне записи по заданным параметрам | Шаблон записи, в котором создаётся атрибут, системное имя нового атрибута, шаблон записи, к которому привязан атрибут | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/CreateBackwardProperty | Создать атрибут с типом данных «ссылка» на шаблон записи этого атрибута со взаимной связью атрибутов по заданным параметрам | Шаблон записи, в котором создаётся атрибут, системное имя нового атрибута, атрибут данного шаблона записи | Идентификатор созданного атрибута |
/TeamNetwork/ObjectAppService/BindProperties | Установить связи между атрибутами шаблонов записи | Идентификаторы атрибутов с включённой опцией «Хранить несколько значений» | Сообщение об успехе или ошибке |
/TeamNetwork/ObjectAppService/UnbindProperties | Убрать связи между атрибутами шаблонов записи | Идентификаторы атрибутов, между которыми необходимо убрать связь | Сообщение об успехе или ошибке |
/TeamNetwork/ObjectAppService/DisableProperty | Архивировать атрибут шаблона записи по его идентификатору | Идентификатор атрибута | Статус |
/TeamNetwork/ObjectAppService/EnableProperty | Разархивировать атрибут шаблона записи по его идентификатору | Идентификатор атрибута | Статус |
/TeamNetwork/ObjectAppService/ListProperties | Отобразить список атрибутов шаблона записи по его идентификатору | Идентификатор шаблона записи | Список атрибутов с информацией о них |
/TeamNetwork/ObjectAppService/ListAllProperties | Отобразить список атрибутов шаблона записи по его идентификатору (включая архивированные) | Идентификатор шаблона записи | Список атрибутов с информацией о них (включая архивированные) |
/TeamNetwork/ObjectAppService/TryGetProperties | Отобразить список атрибутов шаблона записи по его идентификатору с возможностью выбора архивированных атрибутов | Идентификатор шаблона записи и опция включения в список архивированных атрибутов | Список атрибутов с информацией о них |
/TeamNetwork/ObjectAppService/GetProperty | Получить информацию об атрибуте шаблона записи по его идентификатору | Идентификатор атрибута шаблона записи | Информация об атрибуте |
/TeamNetwork/ObjectAppService/IsDisplayProperty | Управлять отображением атрибута шаблона записи | Идентификатор атрибута и шаблона записи | Логическое значение true/false |
/TeamNetwork/ObjectAppService/GetPropertyAlias | Отобразить системное имя атрибута шаблона записи | Идентификатор атрибута | Системное имя атрибута |
/TeamNetwork/ObjectAppService/SetPropertyName | Изменить имя атрибута шаблона записи | Идентификатор атрибута и новое имя | Статус |
/TeamNetwork/ObjectAppService/SetPropertyAlias | Изменить системное имя атрибута шаблона записи | Идентификатор атрибута и новое системное имя | Статус |
/TeamNetwork/ObjectAppService/SetPropertyDescription | Изменить описание атрибута шаблона записи | Идентификатор атрибута и новое описание | Статус |
/TeamNetwork/ObjectAppService/SetPropertyType | Изменить тип данных для атрибута шаблона записи | Идентификатор атрибута и новый тип | Статус |
/TeamNetwork/ObjectAppService/SetPropertyInstanceApp | Перенести атрибут в другой шаблон записи | Идентификатор атрибута, тип атрибута, шаблон записи, в который необходимо перенести атрибут | Статус |
/TeamNetwork/ObjectAppService/SetPropertyPresentationFormat | Установить вариант отображения атрибута | Идентификатор атрибута и вариант отображения | Статус |
/TeamNetwork/ObjectAppService/SetPropertyIsUnique | Включить контроль уникальности значений для атрибута шаблона записи | Параметры для настройки | Статус |
/TeamNetwork/ObjectAppService/SetPropertyIsIndexed | Включить использование атрибута в поиске | Идентификатор атрибута, параметры | Статус |
/TeamNetwork/ObjectAppService/SetPropertyIsDigitGrouping | Включить группировку разрядов числа в атрибуте |
Идентификатор атрибута, включить/выключить группировку |
Статус |
/TeamNetwork/ObjectAppService/SetPropertyDecimalPlaces |
Установить количество знаков после запятой у атрибута |
Идентификатор атрибута, количество знаков после запятой | Статус |
/TeamNetwork/ObjectAppService/SetPropertyIsMultiValue | Хранить несколько значений в атрибуте шаблона записи | Параметры для настройки | Статус |
/TeamNetwork/ObjectAppService/SetPropertyIsOwnership | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/ObjectAppService/SetPropertyIsCalculated | Вычислять атрибут шаблона записи по выражению | Параметры для настройки | Статус |
/TeamNetwork/ObjectAppService/SetPropertyIsTracked | Включить запись изменений в журнал | Идентификатор атрибута, включение записи изменений | Статус |
/TeamNetwork/ObjectAppService/EditProperty | Редактировать атрибут шаблона записи согласно заданным параметрам | Параметры для редактирования | Идентификатор редактируемой записи |
/TeamNetwork/ObjectAppService/DeleteProperty | Удалить атрибут шаблона записи согласно заданным параметрам | Параметры для удаления | Информация об удалённых данных |
/TeamNetwork/ObjectAppService/ListForms | Отобразить список форм для шаблона записи | Идентификатор шаблона записи | Список форм с информацией о них |
/TeamNetwork/ObjectAppService/ListForm | Отобразить информацию о формах шаблона записи, включая информацию о формах, которые в них входят | Идентификатор шаблона записи | Информация о форме шаблона записи, включая информацию о формах, которые в неё входят |
/TeamNetwork/ObjectAppService/GetForm | Отобразить информацию о конкретной форме шаблона записи | Параметры для отображения | Информация о форме шаблона записи |
/TeamNetwork/ObjectAppService/CreateForm | Создать форму шаблона записи по заданным параметрам | Параметры для создания | Идентификатор созданной формы |
/TeamNetwork/ObjectAppService/EditForm | Редактировать форму шаблона записи по заданным параметрам | Параметры для редактирования | Статус |
/TeamNetwork/ObjectAppService/DeleteForm | Удалить конкретную форму шаблона записи | Идентификатор шаблона записи и формы | Статус |
/TeamNetwork/ObjectAppService/SetDefaultForm | Установить форму по умолчанию | Идентификатор шаблона записи и формы | Статус |
/TeamNetwork/ObjectAppService/GetDynamicRules | Отобразить информацию о правилах для формы | Идентификатор шаблона записи и формы | Информация о правилах для формы |
/TeamNetwork/ObjectAppService/SetDynamicRules | Установить правила для формы по заданному набору параметров | Параметры для созданий правил | Статус |
/TeamNetwork/ObjectAppService/SetPropertyPresentationFileFormat | Установить фильтр расширений файлов | Идентификатор атрибута, файлы форматов | Статус |
/TeamNetwork/ObjectAppService/FixReferencePropertiesWithoutInstanceApp | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/ObjectAppService/SetPropertyValueVariants | Установить список значений для атрибута с типом данных «список значений» по заданным параметрам | Параметры для создания списка значений | Статус |
/TeamNetwork/ObjectAppService/SetPropertyPossibleValueRule | Установить проверку значения атрибута | Идентификатор атрибута и выражение для проверки значения | Статус |
/TeamNetwork/ObjectAppService/SetPropertyUriSchemeFormats | Выбрать допустимые схемы URI | Идентификатор атрибута, выбранные допустимые схемы URI | Статус |
/TeamNetwork/ObjectAppService/SetPropertyImageWidth | Установить ширину для масштабирования изображения в атрибуте с типом данных «изображение» | Идентификатор атрибута и значение ширины | Статус |
/TeamNetwork/ObjectAppService/SetPropertyImageHeight | Установить высоту для масштабирования изображения в атрибуте с типом данных «изображение» | Идентификатор атрибута и значение высоты | Статус |
/TeamNetwork/ObjectAppService/SetPropertyImagePreservAspectRation | Повернуть изображение | Идентификатор атрибута, поворот изображения | Статус |
/TeamNetwork/ObjectAppService/SetPropertyImageColorType | Установить цветовой режим для атрибута с типом данных «изображение» | Идентификатор атрибута и цветовой режим | Статус |
/TeamNetwork/ObjectAppService/SetPropertyImageXResolution | Установить ширину по координате X для масштабирования изображения в атрибуте с типом данных «изображение» | Идентификатор атрибута и значение ширины | Статус |
/TeamNetwork/ObjectAppService/SetPropertyImageYResolution | Установить высоту по координате Y для масштабирования изображения в атрибуте с типом данных «изображение» | Идентификатор атрибута и значение высоты | Статус |
/TeamNetwork/ObjectAppService/SetPropertyValidationMaskRegex | Установить особую маску | Идентификатор атрибута, тип атрибута, регулярное выражение маски | Статус |
/TeamNetwork/ObjectAppService/SetPropertyValidationExpression | Установить проверку значений | Идентификатор атрибута, выражение, тип проверки | Статус |
ObjectAppExport – Шаблоны экспорта
|
|||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/ObjectAppExportService/ListExportTemplates | Отобразить все шаблоны экспорта по идентификатору шаблона записи | Идентификатор шаблона записи | Список шаблонов экспорта |
/TeamNetwork/ObjectAppExportService/GetExportTemplate | Отобразить информацию о шаблоне экспорта по его идентификатору | Идентификатор шаблона экспорта | Информация о шаблоне экспорта |
/TeamNetwork/ObjectAppExportService/CreateExportTemplate | Создать шаблон экспорта по заданным параметрам | Параметры для создания шаблона экспорта | Идентификатор шаблона экспорта |
/TeamNetwork/ObjectAppExportService/CreateexportTemplate1 | Создать шаблон экспорта по расширенному набору заданных параметров | Параметры для создания шаблона экспорта | Идентификатор шаблона экспорта |
/TeamNetwork/ObjectAppExportService/SetExportSourceTemplate | Привязать документ к шаблону экспорта | Параметры для привязки | Статус |
/TeamNetwork/ObjectAppExportService/SetOutputFileNameTemplate | Назначить имя файла для экспорта | Параметры для назначения | Статус |
/TeamNetwork/ObjectAppExportService/DeleteExportTemplate | Удалить шаблон экспорта по его идентификатору | Идентификатор шаблона экспорта | Статус |
/TeamNetwork/ObjectAppExportService/EditExportTemplate | Редактировать шаблон экспорта согласно параметрам | Параметры для редактирования | Статус |
/TeamNetwork/ObjectAppExportService/SetExportAsPdf | Настроить экспорт в pdf для шаблона экспорта | Параметры настройки | Статус |
/TeamNetwork/ObjectAppExportService/ExecuteExportTemplate | Выгрузить запись по шаблону экспорта | Идентификатор шаблона экспорта, идентификатор записи | Имя и тип записи |
/TeamNetwork/ObjectAppExportService/GetTemplateStreamId | Получить идентификатор стрима для шаблона экспорта | Идентификатор шаблона экспорта | Идентификатор стрима |
/TeamNetwork/ObjectAppExportService/GetTemplateStream | Получить стрим для шаблона экспорта по записи | Идентификатор шаблона экспорта, идентификатор записи | Стрим |
/TeamNetwork/ObjectAppExportService/GetTemplateStream1 | Получить стрим для шаблона экспорта | Идентификатор шаблона экспорта | Стрим |
/TeamNetwork/ObjectAppExportService/InitAspose | Настроить разметку | - | Статус |
/TeamNetwork/ObjectAppExportService/ExecuteWordExportTemplate | Выгрузить запись по шаблону экспорта в Word | Параметры выгрузки | Данные |
/TeamNetwork/ObjectAppExportService/ExecuteExcelExportTemplate | Выгрузить запись по шаблону экспорта в Excel | Параметры выгрузки | Данные |
UserTask – Пользовательские задачи | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/UserTaskService/ListAllTasks | Отобразить список всех активных задач | - | Список всех активных задач с информацией |
/TeamNetwork/UserTaskService/ListPossibleParentTasks | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/UserTaskService/ListPossiblePredecessorTasks | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/UserTaskService/ListPossibleDependentTasks | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/UserTaskService/Get | Отобразить информацию о задаче по идентификатору задачи | Идентификатор задачи | Информация о задаче |
/TeamNetwork/UserTaskService/GetBusinessObject | Получить экземпляр шаблона записи для задачи | Идентификатор задачи | Идентификатор записи |
/TeamNetwork/UserTaskService/Create | Создать задачу по заданным параметрам | Параметры для создания задачи | Статус |
/TeamNetwork/UserTaskService/Edit | Редактировать информацию о задаче | Измененные параметры для задачи | Статус |
/TeamNetwork/UserTaskService/AddPredecessor | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/UserTaskService/RemovePredecessor | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/UserTaskService/Reassign | Переназначить задачу | Идентификатор задачи, новый исполнитель | Статус |
/TeamNetwork/UserTaskService/StartWork | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/UserTaskService/Cancel | Отменить задачу по идентификатору | Идентификатор задачи | Статус |
/TeamNetwork/UserTaskService/Complete | Выполнить задачу по идентификатору | Идентификатор задачи | Статус |
/TeamNetwork/UserTaskService/Defer | Отсрочить задачу по идентификатору | Идентификатор задачи | Статус |
/TeamNetwork/UserTaskService/Delete | Удалить задачу по идентификатору | Идентификатор задачи | Статус |
/TeamNetwork/UserTaskService/Move | Перенести задачу | Идентификатор задачи, идентификатор шаблона записи | Статус |
/TeamNetwork/UserTaskService/ListSubtasks | Отобразить список подзадач по идентификатору задачи | Идентификатор задачи | Список подзадач |
/TeamNetwork/UserTaskService/ListTaskSuccessors | Отобразить список преемников задачи по идентификатору задачи | Идентификатор задачи | Список преемников задачи |
/TeamNetwork/UserTaskService/CanRead |
Отобразить возможность чтения задачи по её идентификатору |
Идентификатор задачи | Логическое значение true/false |
/TeamNetwork/UserTaskService/ListPossibleAssignees | Отобразить список возможных исполнителей задачи по идентификатору задачи | Идентификатор задачи | Список возможных исполнителей задачи |
/TeamNetwork/UserTaskService/GetTaskFormReference | Получить информацию об идентификаторе формы, записи и шаблона записи для задачи | Идентификатор задачи | Идентификатор формы, записи и шаблона записи для задачи |
Document – Документы | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/DocumentService/GetDocument | Отобразить информацию о документе по его идентификатору | Идентификатор документа | Информация о документе |
/TeamNetwork/DocumentService/GetInlineDocument | Получить информацию о документе класса inline | Идентификатор документа | Информация о документе |
/TeamNetwork/DocumentService/GetDocumentTitle | Отобразить название документа по его идентификатору | Идентификатор документа | Название документа |
/TeamNetwork/DocumentService/CreateDocument | Создать документ по заданным параметрам | Параметры для создания документа | Идентификатор документа |
/TeamNetwork/DocumentService/CreateDocumentWithStream | Создать документ в определённом стриме по заданным параметрам | Параметры для создания документа | Идентификатор документа |
/TeamNetwork/DocumentService/CreateDocumentWithStream1 | Создать документ в определённом стриме по заданным параметрам | Параметры для создания документа | Идентификатор документа |
/TeamNetwork/DocumentService/CreateInlineDocument | Создать документ класса inline по заданным параметрам | Параметры для создания документа | Идентификатор документа |
/TeamNetwork/DocumentService/HasSignPermission | Показать право подписи документа по идентификатору задачи | Идентификатор задачи | Логическое значение true/false |
/TeamNetwork/DocumentService/EditDocument | Редактировать информацию о документе | Параметры для редактирования информации о документе | Статус |
/TeamNetwork/DocumentService/EditInlineDocument | Редактировать информацию о документе класса inline | Параметры для редактирования информации о документе | Статус |
/TeamNetwork/DocumentService/DeleteDocument | Удалить документ по идентификатору документа | Идентификатор документа | Статус |
/TeamNetwork/DocumentService/GetSignatureContent | Отобразить информацию о подписи документа по идентификатору подписи | Идентификатор подписи | Информация о подписи |
/TeamNetwork/DocumentService/GetDocumentRevisions | Отобразить информацию о версиях документа по идентификатору документа | Идентификатор документа | Информация о версиях документа |
/TeamNetwork/DocumentService/GetDocumentRevision | Отобразить информацию об определённой ревизии документа по идентификатору версии | Идентификатор версии | Информация об определённой версии документа |
/TeamNetwork/DocumentService/GetDocumentIdByRevision | Отобразить идентификатор документа по идентификатору версии документа | Идентификатор версии документа | Идентификатор документа |
/TeamNetwork/DocumentService/CreateDocumentRevision | Создать новую версию документа в нужном стриме | Идентификатор документа, идентификатор стрима и имя файла | Идентификатор созданного документа |
/TeamNetwork/DocumentService/CreateDocumentRevision1 | Создать новую версию документа | Идентификатор документа и имя файла | Идентификатор созданного документа |
/TeamNetwork/DocumentService/SaveSignature1 |
Создать подпись по заданным параметрам |
Подписывающий, название подписи, содержание подписи | Идентификатор созданной подписи |
/TeamNetwork/DocumentService/GetContent | Получить данные документа по его идентификатору | Идентификатор документа | Название документа, данные документа |
/TeamNetwork/DocumentService/GetZippedDocuments | Получить сжатые документы по идентификаторам записей | Идентификаторы записей и системные имена атрибутов документа | Данные |
/TeamNetwork/DocumentService/GetZippedStreams | Получить сжатые стримы | Идентификаторы стримов | Данные |
/TeamNetwork/DocumentService/GetExternalContent | Получить данные из внешнего ресурса | URI ресурса, логин, пароль | Данные |
Dataset – Таблицы | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/DatasetService/QueryData | Отобразить данные из таблицы по запросу | Запрос по форме | Данные из таблицы, которые соответствуют запросу |
/TeamNetwork/DatasetService/GetQueries | Отобразить информацию обо всех таблицах для шаблона записи | Идентификатор шаблона записи | Информация о таблицах |
/TeamNetwork/DatasetService/QueryAutocompleteData | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/DatasetService/GetCollectionFilteredSorteredValues | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/DatasetService/QueryJournalData | В текущей версии продукта данный метод не используется | ||
DatasetExport - Экспорт данных | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/DatasetExportService/ExportToExcel | Экспортировать данные в Excel | Параметры для экспорта | Имя и тип |
DatasetConfiguration – Пользовательская конфигурация таблиц | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/DatasetConfigurationService/Create | Создать новую пользовательскую конфигурацию таблицы по заданным параметрам | Параметры для создания | Идентификатор пользовательской конфигурации таблицы |
/TeamNetwork/DatasetConfigurationService/Get | Отобразить информацию о пользовательской конфигурации таблиц по идентификатору | Идентификатор пользовательской конфигурации таблиц | Информация о пользовательской конфигурации таблиц |
/TeamNetwork/DatasetConfigurationService/Edit | Редактировать пользовательскую конфигурацию таблицы по заданным параметрам | Параметры для редактирования | Идентификатор пользовательской конфигурации таблицы |
/TeamNetwork/DatasetConfigurationService/Delete | Удалить пользовательскую конфигурацию таблицы по идентификатору | Идентификатор пользовательской конфигурации таблицы | Информация о пользовательской конфигурации таблицы |
/TeamNetwork/DatasetConfigurationService/List | Отобразить информацию о пользовательской конфигурации таблицы по идентификатору шаблона записи | Идентификатор шаблона записи | Информация о пользовательской конфигурации таблицы |
/TeamNetwork/DatasetConfigurationService/ListInfo | Отобразить основную информацию о пользовательской конфигурации таблицы по идентификатору шаблона записи | Идентификатор шаблона записи | Основная информация о пользовательской конфигурации таблицы |
/TeamNetwork/DatasetConfigurationService/GetPossibleColumns | Отобразить все атрибуты шаблона записи, которые можно использовать как столбцы таблицы | Идентификатор шаблона записи | Информация об атрибутах шаблона записи, которые можно использовать как столбцы таблицы |
/TeamNetwork/DatasetConfigurationService/CreateDefaultDataset | Создать таблицу по умолчанию для шаблона записи | Идентификатор шаблона записи | Системное имя таблицы |
/TeamNetwork/DatasetConfigurationService/CreateDatasetWithSystemDataSources | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/DatasetConfigurationService/SavePersonalDataset | Создать персональную конфигурацию таблицы по заданным параметрам | Параметры конфигурации | Идентификатор конфигурации |
/TeamNetwork/DatasetConfigurationService/GetPersonalDataset | Получить информацию о персональной конфигурации | Идентификатор таблицы | Параметры конфигурации |
/TeamNetwork/DatasetConfigurationService/DeletePersonalDataset | Удалить персональную конфигурацию | Идентификатор таблицы | Статус |
/TeamNetwork/DatasetConfigurationService/IsJournal | Показать, является ли таблица журналом | Идентификатор таблицы | Логическое значение true/false |
GlobalFunction – Скрипты | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/GlobalFunctionService/Create | Создать новый скрипт по заданным параметрам | Параметры для создания | Идентификатор скрипта |
/TeamNetwork/GlobalFunctionService/Edit | Редактировать скрипт по заданным параметрам | Параметры для редактирования | Статус |
/TeamNetwork/GlobalFunctionService/Build | Скомпилировать скрипты в приложении | Идентификатор приложения | Статус |
/TeamNetwork/GlobalFunctionService/Delete | Удалить скрипт по идентификатору | Идентификатор глобальной настройки | Статус |
/TeamNetwork/GlobalFunctionService/DeleteBySolution | Удалить скрипты по идентификатору приложения | Идентификатор приложения | Статус |
/TeamNetwork/GlobalFunctionService/Execute | Получить скрипт по заданным параметрам | Параметры для скрипта | Скрипт и дополнительная информация |
/TeamNetwork/GlobalFunctionService/ExecuteByAlias | Получить скрипт по системным именам | Системное имя приложения, системное имя скрипта и параметры | Скрипт |
/TeamNetwork/GlobalFunctionService/ListInfo | Отобразить информацию обо всех скриптах | - | Информация о скриптах |
/TeamNetwork/GlobalFunctionService/ListInfo1 | Отобразить информацию обо всех скриптах по приложению | Идентификатор приложения | Информация о скриптах |
/TeamNetwork/GlobalFunctionService/List | Отобразить информацию о скриптах по идентификатору приложения | Идентификатор приложения | Информация о скриптах |
/TeamNetwork/GlobalFunctionService/Get | Отобразить скрипт и информацию о нём по идентификатору | Идентификатор скрипта | Срипт и информация о нём |
/TeamNetwork/GlobalFunctionService/GetNavigationReference | Отобразить информацию о скрипте по идентификатору | Идентификатор скрипта | Информация о скрипте |
ScriptDetails – Свойства скриптов | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/TeamNetwork/ScriptDetailsService/GetSolutionId | Отобразить идентификатор приложения | Параметры для запроса | Идентификатор приложения |
/TeamNetwork/ScriptDetailsService/ParseAssemblyPath | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/ScriptDetailsService/RegisterGlobalFunction | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/ScriptDetailsService/RegisterProcessScript | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/ScriptDetailsService/RegisterUserCommand | В текущей версии продукта данный метод не используется | ||
/TeamNetwork/ScriptDetailsService/EraseContext | В текущей версии продукта данный метод не используется | ||
Template – Шаблоны | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Solution/TemplateService/List | Отобразить список шаблонов | Фильтр для поиска шаблонов | Информация о шаблонах |
/Solution/TemplateService/Get | Отобразить информацию о шаблоне по его идентификатору | Идентификатор шаблона | Информация о конкретном шаблоне |
/Solution/TemplateService/Edit | Редактировать шаблон по заданным параметрам | Параметры для редактирования шаблона | Статус |
/Solution/TemplateService/Create | Создать шаблон по заданным параметрам | Параметры для создания шаблона | Информация о созданном шаблоне |
/Solution/TemplateService/Delete | Удалить шаблон | Идентификатор шаблона, статус действия | Информация об удалённом шаблоне |
/Solution/TemplateService/BulkDelete | Удалить несколько шаблонов | Идентификаторы шаблонов, статус действия | Информация об удалённых шаблонах |
/Solution/TemplateService/DeleteBySolution | Удалить шаблон по приложению | Приложение | Статус |
/Solution/TemplateService/Archive | Архивировать шаблон по идентификатору | Идентификатор шаблона | Статус |
/Solution/TemplateService/Unarchive | Разархивировать шаблон по идентификатору | Идентификатор шаблона | Статус |
/Solution/TemplateService/GetUsages | Отобразить список использований шаблона | Идентификатор шаблона | Список использований шаблона |
/Solution/TemplateService/GetNamePropertyId | Вернуть идентификатор атрибута, который является именем записей шаблона | Идентификатор шаблона | Идентификатор атрибута |
/Solution/TemplateService/ListSolutionProperties |
Отобразить атрибуты приложения по фильтру |
Фильтр атрибутов | Список атрибутов |
/Solution/TemplateService/ListReferences | Отобразить список ссылок на шаблон | Фильтр для поиска ссылок | Список ссылок на шаблон |
SolutionVariable – Переменные приложений | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Solution/SolutionVariableService/Create | Создать новую переменную приложения по заданному набору параметров | Параметры для создания переменной | Идентификатор созданной переменной |
/Solution/SolutionVariableService/Get | Получить информацию о переменной по её идентификатору | Идентификатор переменной | Информация о переменной |
/Solution/SolutionVariableService/Get1 | Получить информацию о переменной по системному имени приложения и переменной | Системное имя приложения и переменной | Информация о переменной |
/Solution/SolutionVariableService/Edit | Редактировать переменную приложения по заданному набору параметров | Параметры для редактирования переменной | Идентификатор переменной |
/Solution/SolutionVariableService/List | Отобразить информацию обо всех переменных приложения по идентификатору | Идентификатор приложения | Информация обо всех переменных приложения |
/Solution/SolutionVariableService/Delete | Удалить переменную(-ые) по идентификатору(-ам) | Идентификатор переменной(-ых) | Статус |
/Solution/SolutionVariableService/DeleteBySolution | Удалить все переменные в приложении по его идентификатору | Идентификатор приложения | Статус |
/Solution/SolutionVariableService/GetValue | Отобразить значение переменной по её идентификатору | Идентификатор переменной | Значение переменной |
/Solution/SolutionVariableService/GetValue1 | Отобразить значение переменной по системному имени приложения и переменной | Системное имя приложения и переменной | Значение переменной |
/Solution/SolutionVariableService/SetValue | Установить значение переменной приложения по её идентификатору | Идентификатор переменной приложения и новое значение | Новое значение переменной |
/Solution/SolutionVariableService/SetValue1 | Установить значение переменной приложения по её системному имени и системному имени приложения | Системное имя переменной, системное имя приложения и новое значение | Новое значение переменной |
/Solution/SolutionVariableService/SetValue2 | Установить значение переменной приложения по её системному имени и системному имени приложения | Системное имя переменной, системное имя приложения и новое значение | Новое значение переменной |
ProcessApp – Шаблоны процессов | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Process/ProcessAppService/Get | Отобразить информацию о шаблоне процесса по его идентификатору | Идентификатор шаблона процесса | Информация о шаблоне процесса |
/Process/ProcessAppService/GetProcessAppIdByAlias | Получить системное имя для шаблона процесса | Идентификатор шаблона процесса | Системное имя шаблона процесса |
/Process/ProcessAppService/List | Отобразить список шаблонов процессов с информацией о них | - | Список шаблонов процессов с информацией о них |
/Process/ProcessAppService/ListAll | Отобразить список шаблонов процесса с информацией о них, включая архивированные шаблоны процесса | - | Список шаблонов процесса с информацией о них, включая архивированные шаблоны процесса |
/Process/ProcessAppService/Delete | Удалить шаблон процесса по идентификатору | Идентификатор шаблона процесса | Статус |
/Process/ProcessAppService/Disable | Архивировать шаблон процесса по идентификатору | Идентификатор шаблона процесса | Статус |
/Process/ProcessAppService/Enable | Разархивировать шаблон процесса по идентификатору | Идентификатор шаблона процесса | Статус |
/Process/ProcessAppService/ListProcessAppSchemes | Отобразить список процессов с информацией о них | Идентификатор шаблона процесса | Список процессов с информацией о них |
/Process/ProcessAppService/ListAppsByIds | Отобразить список шаблонов процесса с информацией о них по их идентификаторам | Идентификаторы шаблонов процесса | Список шаблонов процесса с информацией о них |
/Process/ProcessAppService/ListBySolution | Отобразить список шаблонов процесса с информацией о них по приложению | Идентификатор приложения | Список шаблонов процесса с информацией о них |
/Process/ProcessAppService/ListAllBySolution | Отобразить список шаблонов процесса с информацией о них по приложению, включая архивированные шаблоны процесса | Идентификатор приложения | Список шаблонов процессов с информацией о них, включая архивированные шаблоны процесса |
/Process/ProcessAppService/ListAppsForAccount | Отобразить список шаблонов процесса с информацией о них по аккаунту | Идентификатор аккаунта | Список шаблонов процесса с информацией о них |
/Process/ProcessAppService/ListProcessAppDiagrams | Отобразить список диаграмм процесса, которые связанны с данным шаблоном процесса | Идентификатор шаблона процесса | Список диаграмм процесса с информацией о них |
/Process/ProcessAppService/ListDiagramActivityStatistic | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/GetRoutStatistics | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/GetActiveDiagramId | Отобразить идентификатор активной диаграммы для шаблона процесса | Идентификатор шаблона процесса | Идентификатор активной диаграммы |
/Process/ProcessAppService/TryGetLastPublishedDiagaram | Проверить, является ли диаграмма последней опубликованной для шаблона процесса | Идентификатор шаблона процесса и идентификатор диаграммы | Логическое значение true/false |
/Process/ProcessAppService/TryGetLastDiagram | Проверить, является ли диаграмма последней для шаблона процесса | Идентификатор шаблона процесса и идентификатор диаграммы | Логическое значение true/false |
/Process/ProcessAppService/GetExecutableActivitiesMap | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/GetActiveSchemeId | Получить идентификатор активной схемы по идентификатору шаблона процесса | Идентификатор шаблона процесса | Идентификатор схемы |
/Process/ProcessAppService/ListMappedActivities | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/ListDiagramActivitiesPassed | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/GetScheme | Получить информацию о схеме по идентификатору | Идентификатор схемы | Информация о схеме |
/Process/ProcessAppService/GetActiveSchemeDiagramId | Получить идентификатор диаграммы для шаблона процесса | Идентификатор шаблона процесса | Идентификатор диаграммы |
/Process/ProcessAppService/GetNextActivities | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/GetProcessActivityInfo | В текущей версии продукта данный метод не используется | ||
/Process/ProcessAppService/GetProcessAppReference | Получить информацию о названии и системном имени шаблона процесса по его идентификатору | Идентификатор шаблона процесса | Название и системное имя шаблона процесса |
/Process/ProcessAppService/Cleanup | Убрать нерабочие процессы | - | Статус |
/Process/ProcessAppService/RebuildProcessRules | Собрать заново правила для данных на неактуальных версиях | Идентификатор шаблона процесса | Количество собранных заново правил |
ProcessObject – Экземпляры процессов | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Process/ProcessObjectService/CreateToken | Создать токен по заданным параметрам | Параметры для создания токена | Статус |
/Process/ProcessObjectService/Get | Получить информацию об экземпляре процесса по его идентификатору | Идентификатор экземпляра процесса | Информация об экземпляре процесса |
/Process/ProcessObjectService/GetActiveTokens | Отобразить информацию об активных токенах для экземпляра процесса | Идентификатор экземпляра процесса | Информацию об активных токенах |
/Process/ProcessObjectService/GetActiveErrors | Отобразить информацию об активных ошибках для экземпляра процесса | Идентификатор экземпляра процесса | Информацию об активных ошибках |
/Process/ProcessObjectService/GetActiveSubtasks | Отобразить информацию об активных подзадачах для экземпляра процесса | Идентификатор экземпляра процесса | Информацию об активных подзадачах |
/Process/ProcessObjectService/GetCompletedSubtasks | Отобразить информацию о выполненных подзадачах для экземпляра процесса | Идентификатор экземпляра процесса | Информацию о выполненных подзадачах |
/Process/ProcessObjectService/GetCancelledSubtasks | Отобразить информацию об отменённых подзадачах для экземпляра процесса | Идентификатор экземпляра процесса | Информацию об отменённых подзадачах |
/Process/ProcessObjectService/GetProcessDiagramContext | Отобразить информацию о схемах для диаграммы и идентификатора шаблона процесса | Идентификатор диаграммы | Информация о схемах для диаграммы и идентификатор шаблона процесса |
/Process/ProcessObjectService/GetProcessObjectContext | Отобразить расширенную информацию по экземпляру процесса | Идентификатор экземпляра процесса, схема | Расширенная информация по экземпляру процесса |
/Process/ProcessObjectService/GetEmbeddedInstanceId | В текущей версии продукта данный метод не используется | ||
/Process/ProcessObjectService/GetActiveSubcases | В текущей версии продукта данный метод не используется | ||
/Process/ProcessObjectService/GetCompletedSubcases | В текущей версии продукта данный метод не используется | ||
/Process/ProcessObjectService/GetCancelledSubcases | В текущей версии продукта данный метод не используется | ||
/Process/ProcessObjectService/GetActiveSubprocesses | Отобразить информацию об активных подпроцессах для экземпляра процесса | Идентификатор экземпляра процесса | Информация об активных подпроцессах |
/Process/ProcessObjectService/GetCompletedSubprocesses | Отобразить информацию о выполненных подпроцессах для экземпляра процесса | Идентификатор экземпляра процесса | Информация о выполненных подпроцессах |
/Process/ProcessObjectService/GetCancelledSubprocesses | Отобразить информацию об отменённых подпроцессах для экземпляра процесса | Идентификатор экземпляра процесса | Информация об отменённых подпроцессах |
/Process/ProcessObjectService/GetSubprocesses | Получить список подпроцессов по заданным параметрам | Параметры запроса | Список подпроцессов |
/Process/ProcessObjectService/GetReferencedProcesses | Отобразить связанные с записью процессы | Идентификатор записи | Информация о связанных процессах |
/Process/ProcessObjectService/GetReferencedTasks | Отобразить связанные с записью задачи | Идентификатор записи | Информация о связанных задачах |
/Process/ProcessObjectService/Create | Создать экземпляр процесса по заданным параметрам | Параметры для создания | Идентификатор процесса |
/Process/ProcessObjectService/Create1 | Создать экземпляр процесса по расширенному набору параметров | Расширенный набор параметров для создания | Идентификатор процесса |
/Process/ProcessObjectService/CreateWithObjectId | Создать экземпляр процесса по идентификатору записи | Идентификатор шаблона процесса, имя записи, идентификатор записи и параметр синхронизации (всегда 0) | Идентификатор созданного экземпляра процесса |
/Process/ProcessObjectService/CancelProcess | Отменить экземпляр процесса по его идентификатору | Идентификатор экземпляра процесса | Статус |
/Process/ProcessObjectService/RemoveToken | Удалить токен по его идентификатору | Идентификатор токена | Статус |
/Process/ProcessObjectService/AddToken | Добавить токен по заданным параметрам | Параметры для добавления токена | Статус |
/Process/ProcessObjectService/IgnoreTokenRuleError | Пропустить ошибку правил для токена | Идентификатор ошибки | Статус |
/Process/ProcessObjectService/IgnoreTokenLocationError | Пропустить ошибку расположения токена | Идентификатор ошибки, новое расположение | Статус |
/Process/ProcessObjectService/IgnoreTokenFlowSelectionError | Пропустить ошибку выбора следующей задачи | Идентификатор ошибки, следующие задачи | Статус |
/Process/ProcessObjectService/RetryToken | Повторить токен по его идентификатору | Идентификатора токена | Статус |
/Process/ProcessObjectService/Migrate |
Мигрировать экземпляр процесса в другую схему по заданным параметрам |
Параметры миграции | Результаты миграции |
Diagram – Диаграммы процесса | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Process/DiagramService/Get | Отобразить информацию о диаграмме по идентификатору | Идентификатор диаграммы | Информация о диаграмме |
/Process/DiagramService/GetDraft | Отобразить информацию о черновике диаграммы по идентификатору | Идентификатор диаграммы | Информация о черновике диаграммы |
/Process/DiagramService/GetActivity | Отобразить информацию о действиях над элементами диаграммы | Идентификатор сервера | Информация о действиях над элементами диаграммы |
/Process/DiagramService/GetActivities | Отобразить информацию о действиях над элементами определённой диаграммы | Идентификатор сервера | Информация о действиях над элементами определённой диаграммы |
/Process/DiagramService/GetDiagramStatusInfo | Отобразить информацию о статусе диаграммы | Идентификатор диаграммы | Информация о статусе диаграммы |
/Process/DiagramService/GetDiagramInfo | Отобразить информацию о диаграмме по заданным параметрам | Параметры для запроса | Информация о диаграмме |
/Process/DiagramService/GetProperties | Отобразить основные свойства диаграммы | Идентификатор диаграммы | Основные свойства диаграммы |
/Process/DiagramService/GetRevision | Получить информацию об определённой версии диаграммы | Параметры для запроса | Информация об определённой версии диаграммы |
/Process/DiagramService/GetProcessDiagramActivity | Получить информацию о действиях на диаграмме процесса | Параметры для запроса | Информация о действиях на диаграмме процесса |
/Process/DiagramService/GetDiagramNavigationReference | Показать тип диаграммы и её принадлежность к приложению и процессу | Идентификатор диаграммы | Тип диаграммы и её принадлежность к приложению и процессу |
/Process/DiagramService/GetDiagramActivityNavigationReference | В текущей версии продукта данный метод не используется | Идентификатор диаграммы | Информация |
/Process/DiagramService/ListRevisions | Отобразить все версии диаграммы с информацией о них по запросу | Параметры для запроса | Версии диаграммы с информацией о них |
/Process/DiagramService/ListActivities | Отобразить список действий над элементами диаграммы с информацией о них | Идентификатор диаграммы | Список действий над элементами диаграммы с информацией о них |
/Process/DiagramService/GetActivityTriggers | Получить информацию о действиях триггеров на диаграмме | Идентификатор диаграммы | Информация о действиях триггеров на диаграмме |
/Process/DiagramService/CreateDiagram | Создать диаграмму по заданному набору параметров | Параметры для создания | Идентификатор созданной диаграммы |
/Process/DiagramService/CreateDefaultProcessDiagram | Создать диаграмму процесса по умолчанию | Идентификатор шаблона процесса | Идентификатор созданной диаграммы |
/Process/DiagramService/CreateRevision | Создать версию диаграммы | Идентификатор диаграммы и описание | Идентификатор версии диаграммы |
/Process/DiagramService/CreateActivity | Создать действие над элементами на диаграмме по заданным параметрам | Параметры для создания | Информация о действии над элементами на диаграмме |
/Process/DiagramService/CreateProcessDiagramActivity | Создать действие над элементами на диаграмме процесса по заданным параметрам | Параметры для создания | Информация о действии над элементами на диаграмме процесса |
/Process/DiagramService/BulkCreateProcessDiagramActivity | Создать множество действий над элементами на диаграмме процесса по заданным параметрам | Параметры для создания | Информация о действиях над элементами на диаграмме процесса |
/Process/DiagramService/Edit | Редактировать диаграмму по заданному набору параметров | Параметры для редактирования | Статус |
/Process/DiagramService/EditActivity | Редактировать действие над элементами диаграммы | Идентификатор действия | Информация о действии над элементами диаграммы |
/Process/DiagramService/EditPublishedActivity | Редактировать опубликованное действие над элементами диаграммы | Идентификатор опубликованного действия | Информация об опубликованном действии над элементами диаграммы |
/Process/DiagramService/EditActivities | Редактировать действия над элементами диаграммы по заданным параметрам | Параметры для редактирования | Информация о действиях над элементами диаграммы |
/Process/DiagramService/EditProcessDiagramActivities | Редактировать действия над элементами диаграммы процесса по заданным параметрам | Параметры для редактирования | Информация о действиях над элементами диаграммы процесса |
/Process/DiagramService/GetLastDiagram | Получить идентификатор последней диаграммы для шаблона процесса | Идентификатор шаблона процесса | Идентификатор диаграммы |
/Process/DiagramService/DeleteActivity | Удалить последнее действие над элементами диаграммы | Идентификатор сервера | Статус |
/Process/DiagramService/RemoveRevisions | Удалить версии диаграммы по идентификаторам | Идентификаторы версий диаграммы | Информация об удалённых версиях |
/Process/DiagramService/DeleteDiagramActivity | Удалить действие над элементами диаграммы по заданным параметрам | Параметры для удаления | Статус |
/Process/DiagramService/DeleteDiagramActivities | Удалить действия над элементами диаграммы по заданным параметрам | Параметры для удаления | Логическое значение true/false |
/Process/DiagramService/RemoveDiagrams | Удалить несколько диаграмм по идентификаторам | Идентификаторы диаграмм, возможность выбрать удалять ли черновики | Статус |
/Process/DiagramService/RestoreRevision | Восстановить диаграмму по версии | Идентификатор диаграммы и идентификатор версии | Статус |
/Process/DiagramService/ResolveDiagram | В текущей версии продукта данный метод не используется | ||
/Process/DiagramService/IsDiagramPublished | Проверить, была ли опубликована диаграмма | Идентификатор диаграммы | Логическое значение true/false |
/Process/DiagramService/CleanTriggersOnActivity | Убрать сценарии, которые были добавлены в версии диаграммы | Версия диаграммы | Статус |
DiagramPublishing – Публикация диаграмм | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Process/DiagramPublishingService/Validate | Проверить диаграмму | Параметры для запроса | Информация |
/Process/DiagramPublishingService/Publish | Опубликовать диаграмму | Идентификаторы шаблона процесса и диаграммы, возможность опубликовать диаграмму как новую версию | Список ошибок |
ProcessReport – Сообщения об ошибках | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Process/ProcessReportService/CreateScriptsReport | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/CreateProcessesReport | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/CreateWorkerThreadsReport | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/CreateRecievedMailReport | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/CreateExpressionReport | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/CreateTriggersReport | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/ResetScriptCounter | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/ResetProcessCounter | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/ResetWorkerThreadCounter | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/ResetRecievedMailCounter | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/ResetExpressionCounter | В текущей версии продукта данный метод не используется | ||
/Process/ProcessReportService/ResetTriggerCounter | В текущей версии продукта данный метод не используется | ||
ConversationConfiguration – Конфигурации обсуждений | |||
Запрос | Описание | Параметры на входе | Параметры на выходе |
/Conversation/ConversationConfigurationService/Create | Создать обсуждение по заданному набору параметров | Параметры для создания | Идентификатор обсуждения |
/Conversation/ConversationConfigurationService/Get | Получить информацию об обсуждении по идентификатору | Идентификатор обсуждения | Информация об обсуждении |
/Conversation/ConversationConfigurationService/Update | Обновить данные в обсуждении по идентификатору | Идентификатор обсуждения | Статус |
/Conversation/ConversationConfigurationService/Delete | Удалить обсуждение по идентификатору | Идентификатор обсуждения | Статус |
/Conversation/ConversationConfigurationService/GetObjectConversationId | Получить идентификатор обсуждения по связанному объекту | Идентификатор объекта | Идентификатор обсуждения |
/Conversation/ConversationConfigurationService/GetOrAddSystemConversation | В текущей версии продукта данный метод не используется | ||
/Conversation/ConversationConfigurationService/GetSystemConversation | В текущей версии продукта данный метод не используется | ||
/Conversation/ConversationConfigurationService/GetOrAddObjectConversation | В текущей версии продукта данный метод не используется | ||
/Conversation/ConversationConfigurationService/GetParticipants | Получить список идентификаторов участников обсуждения по идентификатору обсуждения | Идентификатор обсуждения | Идентификаторы участников обсуждения с указанной ролью в обсуждении |
/Conversation/ConversationConfigurationService/Query | Вывести набор сообщений по запросу | Параметры запроса | Набор сообщений |
/Conversation/ConversationConfigurationService/IsSystem | В текущей версии продукта данный метод не используется |