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