Описание SOAP API (XML)
Авторизация
URL: components/services/login.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| Authenticate | Авторизация | Возвращает идентификатор сессии ASPNETSessionId, который используется при вызове всех методов API | 4.00 |
| AuthenticateAdminAsUser | Авторизация Администратора от имени другого Пользователя | Позволяет Администратору авторизоваться под выбранным Пользователем | 4.00 |
| AuthenticateByUser | Авторизация от имени другого пользователя | Позволяет Администратору авторизоваться под выбранным Пользователем | 4.00 |
| AuthenticateByToken | Аутентификация по токену | Метод для аутентификации в системе по выданному токену | 4.00 |
| CheckSession | Проверка активности сессии | Возвращает идентификатор сессии ASPNETSessionId, если сессия активна. И Session ends, если сессия не активна | 4.00 |
| WhoAmI | Проверка Пользователя | Возвращает имя и роль Пользователя, вошедшего в Систему | 4.00 |
Пользователи
URL: components/services/persons.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| AddPersonsToGroups | Добавить пользователей в группы | На входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно или нет, с указанием причины). При успешном завершении работы метода соответствующие пользователи будут добавлены в соответствующие группы пользователей Системы. | 4.00 |
| CheckUserPhoto | Проверка наличия фотографии у Пользователя | Метод возвращает ссылку на фото, типа ~/Pages/PopupPages/Documents/GetImage.ashx?v=1&docid=0d6aecc1-17a3-4af3-939c-8c7b92cb63eb, если фотография нестандартная. В случае стандартной фотографии метод вернет значение null. При возникновении ошибки, вернется ошибка. | 4.00 |
| CreatePerson | Создание Пользователя | Возвращает ID вновь созданного пользователя | 4.00 |
| DeletePersonsFromGroups | Удалить пользователей из групп | На входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно, либо нет с указанием причины). При успешном завершении работы метода соответствующие пользователи будут удалены из соответствующих групп пользователей Системы. | 4.00 |
| EditPerson | Редактирование пользователя | Метод изменяет данные о пользователе в системе согласно переданным параметрам | 4.00 |
| GetAllowedPersons | Получение списка пользователей, которым разрешен вход в систему | Возвращает всех пользователей в массиве Persons, которым разрешен вход в систему | 4.00 |
| GetGroups | Получение информации о группах пользователей | Возвращает массив GetGroupsResult, содержащий информацию о группах пользователей | 4.00 |
| GetPerson | Получение информации о пользователе | Возвращает массив SLPerson, в котором находится информация о полном имени пользователя, его идентификаторе, электронной почте и сведения о привязке пользователя к Active Directory | 4.00 |
| GetPersonRequests | Получить историю пользовательских запросов | 4.00 | |
| GetPersons | Получение информации о пользователях | Возвращает массив Persons с информацией о каждом пользователе в подмассиве SlPerson | 4.00 |
| GetPersonsXml | Получение списка пользователей | Возвращает массив всех пользователей Users, содержащий расширенные сведения о каждом пользователе в подмассивах UserWrapper | 4.00 |
| LinkUserToAD | Создание связи с Active Directory | Возвращает идентификатор созданной связи пользователя системы с Active Directory | 4.00 |
| DeleteLinkWithAD | Удаление связи с Active Directory | Удаляет привязку пользователя системы к Active Directory | 4.00 |
| LinkUserToOpenIdConnect | Создание связи с Open ID | Возвращает идентификатор созданной связи пользователя системы с Open ID | 4.00 |
| DeleteLinksWithOpenIdConnect | Удаление связи с Open ID | Удаляет привязку пользователя системы к Open ID | 4.00 |
| CreateToken | Создание токена для пользователя | Метод для создания токена для пользователя, от имени которого осуществлен вход | 4.00 |
| RevokeAllTokensByUsers | Отзыв всех выданных токенов по списку пользователей | Метод для отзыва всех действующих токенов по списку пользователей | 4.00 |
Безопасность
URL: components/services/APISecurity.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| AddPersonsToProjectMembers | Добавить пользователя в участники | Добавить пользователя в число участников объекта | 4.00 |
| DeletePersonsFromProjectMembers | Удалить пользователя из участников | Удалить пользователя из числа участников объекта | 4.00 |
| AddPersonsToProjectPermissionRoles | Назначить проектное право | Назначить на проектную роль безопасности определенного пользователя или группы пользователей | 4.00 |
| DeletePersonsToProjectPermissionRoles | Снять проектное право | Снять с проектной роли безопасности определенного пользователя или группы пользователей | 4.00 |
| GetProjectPermissionPersons | Получить список пользователей, назначенных на проектную роль объекта иерархии | Метод позволяет получить список пользователей и групп пользователей, назначенных на указанную проектную роль в указанном объекте | 4.00 |
Проекты
URL: components/services/APIProjects.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| AddLinkTaskToTask | Установка связи между объектами типа «Задача» | Установка временной зависимости между объектами | 4.00 |
| AddResourcesTask | Назначение ресурсов на объект типа «Задача» | 4.00 | |
| ChangeParent | Перемещение проекта | Изменяет родительский проект у выбранного проекта | 4.00 |
| ConvertProjectType | Конвертация типа объекта | Изменяет тип объекта (аналог опции «Преобразовать» на карточке объекта) | 4.00 |
| CreateProject | Создание проекта | Создает проект согласно переданным параметрам | 4.00 |
| CreateProjectByDiscussion | Создание проекта по дискуссии | Создает проект, согласно переданным параметрам Основанием создания проекта является указанная дискуссия | 4.00 |
| DelegateProject | Делегирование проекта | Делегирует проект другому пользователю Системы | 4.00 |
| DelegateProjectHierarchy | Делегирование иерархии объектов Системы | Делегирует иерархию объектов другому пользователю Системы | 4.02 |
| DeleteLinkTaskToTask | Удаление связи между объектами типа «Задача» | Удаление временной зависимости между объектами. | 4.00 |
| DeleteProject | Удаление проекта | Удаляет проект | 4.00 |
| DeleteResourcesTask | Удаление ресурсов из объекта типа «Задача» | 4.00 | |
| GetGroupsWithPersonsIdsAllowedToWriteDiscussion | Получение групп и входящих в них пользователей по идентификатору проекта | Возвращает всех участников проекта и группы, в которые входят участники | 4.00 |
| GetHorizontalRelationsProjects | Получение горизонтальных связей проекта | 4.00 | |
| GetProject | Получение информации о проекте | Возвращает всю информацию о проекте | 4.00 |
| GetProjectChilds | Получение подпроектов по типу | Возвращает идентификаторы всех подпроектов по типу проекта с указанием на родительский проект | 4.00 |
| GetProjectFields | Получение информации о реквизитах проекта | Возвращает идентификаторы реквизитов, даже если они не заполнены в карточке проекта | 4.00 |
| GetProjectInfo | Получение информации о проекте | 4.00 | |
| GetProjectResourceAssignments | Получение ресурсов по проекту | Возвращает информацию о ресурсах в выбранном проекте | 4.00 |
| GetProjectsTypes | Получение информации о всех типах объектов | 4.00 | |
| GetProjects | Получение информации о проектах | Возвращает информацию о выбранных фильтром проектах | 4.00 |
| GetProjectsUidsByType | Получение списка идентификаторов проектов по их типу | Возвращает массив идентификаторов проекта с указанием на родительский проект. Если идентификатор родительского проекта ParentProjectId отсутствует, запрос вернет все проекты указанного типа | 4.00 |
| GetSubprojectsDates | Получение данных дочерних проектов | Возвращает массив данных дочерних объектов | 4.00 |
| GetWorkCalendars | Получение списка производственных календарей | Возвращает список производственных календарей | 4.00 |
| LockObjectFields | Блокировка реквизитов проекта | Производит блокировку реквизитов проекта, у которых установлена опция «Возможность блокировать» | 4.00 |
| ScheduleProject | Запуск планировщика с уровня указанного объекта | Запускает планировщика с уровня указанного объекта | 4.00 |
| UnlockObjectFields | Разблокировка реквизитов проекта | Производит разблокировку реквизитов проекта, у которых установлена опция «Возможность блокировать» | 4.00 |
| UpdateProject | Редактирование информации о проекте | Изменяет выбранный проект, согласно передаваемым параметрам. Возвращает строку Everything allright при удачном обновлении проекта | 4.00 |
| UpdateProjectFields | Редактирование реквизитов проекта | Изменяет реквизиты выбранного проекта | 4.00 |
Связи
URL: components/services/APIRelations.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| AddHorizontalRelations | Добавить горизонтальную связь | Добавление горизонтальной связи между объектами иерархии | 4.00 |
| RemoveHorizontalRelations | Удалить горизонтальную связь | Удаление горизонтальной связи между объектами иерархии | 4.00 |
Таблицы
URL: components/Services/APIService.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| ChangeDirectoryRecord | Редактирование записи в таблице | 4.00 | |
| ChangeDirectoryRecords | Редактирование записей в таблице | 4.00 | |
| ChangeDirectoryRecordStatus | Изменение статуса записи таблицы | Изменяет статус (утверждено/на редактировании) записи таблицы | 4.00 |
| ConvertClassifierItemIdToObjectId | Получение списка объектов по классификатору | Возвращает ID объекта, которому соответствует указанный ID записи классификатора | 4.00 |
| DeleteDirectoryRecord | Удаление записи таблицы | Удаляет указанную запись таблицы | 4.00 |
| DeleteDirectoryRecords | Удаление записей таблицы | Удаляет указанные записи таблицы | 4.00 |
| GetChildRecords | Получение списка записей таблицы из дочерней таблицы | 4.00 | |
| GetDirectoriesList | Получение списка таблиц | 4.00 | |
| GetDocumentVersions | Получение информации о версии документа | Возвращает порядковый номер версии документа по его идентификатору | 4.00 |
| GetRecords | Получение списка записей таблиц | Возвращает по идентификатору таблицы список записей таблицы и системную дату Метод работает только с реквизитами-классификаторами, основанными на объектах | 4.00 |
| GetRelationObjects | Получение связи для указанного шаблона объектной таблицы | Возвращает идентификатор связи объектной таблицы и проекта | 4.00 |
| GetUsedObjectsByClassifier | Получение информации об объектах, к которым привязана таблица | Возвращает объекты, в которых используется таблица | 4.00 |
| GetUsedTemplatesForClassifier | Получение списка использованных шаблонов | 4.00 | |
| InsertDirectoryRecord | Добавление записи в таблицу | 4.00 | |
| InsertDirectoryRecords | Добавление записей в таблицу | 4.00 | |
| InsertObjectToProjectRelation | Создание связи Таблица-Проект | Создает связь существующей таблицы и проекта | 4.00 |
| SearchDirectoryRecordValues | Поиск идентификаторов объектов по реквизитам таблицы | Возвращает идентификаторы всех объектов по заданным параметрам реквизита таблицы | 4.00 |
| SearchDirectoryRecordsByStatus | Поиск идентификаторов объектов по статусу записей таблицы | 4.00 | |
| SendMail | Отправка сообщения электронной почты | Отправка информации и документов из Системы на почту | 4.00 |
| SendMessage | Отправка уведомления в Системе | 4.00 |
Классификаторы
URL: components/Services/APIService.asmx
| Метод | Название | Начиная с версии |
|---|---|---|
| InsertClassifierRecord | Добавление записи в классификатор | 4.00 |
| GetClassifierRecords | Получение записей классификатора | 4.00 |
Табель учёта времени
URL: components/Services/APITimesheets.asmx
| Метод | Название | Начиная с версии |
|---|---|---|
| ApproveTimesheet | Утверждение табеля учета времени пользователя Системы | 4.00 |
| DeclineTimesheet | Отклонение табеля учета времени пользователя Системы | 4.00 |
Документы
URL: components/Services/APIDocuments.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| CreateTemplateDocument | Добавления контрольного документа в объект | Что такое контрольный документ | 4.00 |
| DeleteDocuments | Удаление документа из объекта | Удаляет любой документ (не версии-файлы, а весь документ целиком) | 4.00 |
| GetDocumentVersions | Получение идентификатора последней версии документа | Возвращает идентификатор и номер версии документа | 4.00 |
| UpdateDocumentFields | Изменение реквизитов документа | 4.00 | |
| UpdateDocumentVersion | Добавление новой версии документа | Добавляет файл в качестве новой версии документа | 4.00 |
| CreateDocument | Создание документа в объекте | Создаёт документ в объекте и возвращает идентификатор созданного документа | 4.00 |
| DownloadDocumentFile | Скачивание версии документа в кодировке base64 | Скачивает документ по его индентефикатору | 4.00 |
| GetDocumentInfo | Получение информации о документе | Возвращает всю информацию по указанному в запросе документу - данные по его активной версии и реквизитам | 4.00 |
| GetDocumentsIds | Получение списка идентификаторов всех документов объекта | Возвращает массив идентификаторов документов в объекте\объектах иерархии Системы. | 4.00 |
Дискуссии
URL: components/Services/APIDiscussions.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| AskUsersTotopic | Запрос ответа пользователей в дискуссии | Метод запрашивает ответ в указанной дискуссии у заданных пользователей | 4.00 |
| CreateTopic | Создание дискуссии | 4.00 | |
| CreateTopicReply | Создание ответа на дискуссию | 4.00 | |
| CreateTopicWithFields | Создание дискуссии с дополнительными полями | Включено добавление реквизитов дискуссии при создании | 4.00 |
| GetTopicInfo | Получение информации о дискуссии | 4.00 | |
| GetTopicsInfoByProject | Получение списка дискуссий по идентификатору проекта | Метод возвращает свойства каждой найденной дискуссии в соответствии с передаваемыми критериями поиска. | 4.00 |
| OpenExistingTopic | Открытие закрытой дискуссии | 4.00 | |
| ReaskUsersTotopic | Повторный запрос ответа у всех участников дискуссии | Если запрос уже установлен, он снимается. Затем заново приглашаются в дискуссию все существующие участники | 4.00 |
| UpdateTopic | Редактирование дискуссии | 4.00 |
Согласования
URL: components/Services/APINegotiations.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| CreateNegotiation | Создание согласования | Создаёт согласование без вложений | 4.00 |
| GetNegotiation | Получить данные согласования | Возвращает массив данных согласования | 4.00 |
| UpdateRoute | Изменить перечень согласующих в маршруте согласования | 4.00 | |
| CloseNegotiation | Закрытие согласования | Метод для закрытия активного согласования | 4.00 |
Базовый план
URL: components/Services/APIPlans.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| CreateBaselinePlan | Создание базового плана | Создаёт базовый план выбранного проекта | 4.00 |
| GetBaselinePlanProject | Получение базовых планов | Выгрузка базовых планов | 4.00 |
Формы сбора отчетности
URL: components/Services/APIForms.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| DeleteFormRequest | Удаление запроса заполнения формы сбора отчетности | Отменяет запросы формы или форм | 4.00 |
Отчеты
URL: components/Services/APIReports.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| DownloadSpreadsheetReportFile | Скачивание файла отчёта | Скачивание файла отчёта для дальнейшей отправки на почту | 4.00 |
| SaveSpreadsheetReportFileAsDocument | Сохранение отчёта в файл в Системе | 4.00 |
Интеграции
URL: components/services/Integrations.asmx
| Метод | Название | Описание | Начиная с версии |
|---|---|---|---|
| DeleteOpenIdConnectProvider | Удаление связи с Open ID (во всех профилях пользователей) | Удаляет привязку к указанному провайдеру Open ID во всех профилях пользователей | 4.00 |
Администрирование
URL: components/Services/APIService.asmx
| Метод | Название | Начиная с версии |
|---|---|---|
| GetDirectoryInfo | Получение информации о реквизитах объекта\таблицы в Администрировании | 4.00 |
События
URL: components/Services/APIScheduledEvents.asmx
| Метод | Название | Начиная с версии |
|---|---|---|
| InsertTimerEvent | Запланировать запуск бизнес-операции на определённый день и время | 4.00 |
| CheckTimerEvent | Просмотр очереди сообщений бизнес-операции | 4.00 |