Содержание

Авторизация
Пользователи
Безопасность
Проекты
Связи
Справочники
Классификаторы
Табель учёта времени
Документы
Дискуссии
Согласования
Базовый план
Формы сбора отчетности
Отчеты
Интеграции
Администрирование
Для изучения API

Описание методов API

Авторизация

components/services/login.asmx

Метод	Название	Описание	Начиная с версии
Authenticate	Авторизация	Возвращает идентификатор сессии ASPNETSessionId, который используется при вызове всех методов API
AuthenticateByUser	Авторизация от имени другого пользователя	Позволяет администратору авторизоваться под выбранным пользователем	3.20
AuthenticateAdminAsUser	Авторизация администратора от имени другого пользователя	Позволяет администратору авторизоваться под выбранным пользователем	3.24
AuthenticateByToken	Аутентификация по токену	Метод для аутентификации в системе по выданному токену	3.26
CheckSession	Проверка активности сессии	Возвращает идентификатор сессии ASPNETSessionId, если сессия активна. И Session ends, если сессия не активна	3.14.3232.26072-09fa3d0
Login*	Вход в Систему под определённым пользователем	Метод для входа в Систему с логином и паролем пользователя. `ВНИМАНИЕ: метод устарел.` `Рекомендуется использовать метод Authenticate - Авторизация (см. выше)`
WhoAmI	Проверка пользователя	Возвращает имя и роль пользователя, вошедшего в Систему

Пользователи

components/services/persons.asmx

Метод	Название	Описание	Начиная с версии
AddPersonsToGroups	Добавить пользователей в группы	На входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно или нет, с указанием причины). При успешном завершении работы метода соответствующие пользователи будут добавлены в соответствующие группы пользователей Системы.	3.23
CheckUserPhoto	Проверка наличия фотографии у пользователя	Метод возвращает ссылку на фото, типа ~/Pages/PopupPages/Documents/GetImage.ashx?v=1&docid=0d6aecc1-17a3-4af3-939c-8c7b92cb63eb, если фотография нестандартная. В случае стандартной фотографии метод вернет значение null. При возникновении ошибки, вернется ошибка.	2.05.1922.22458-e57d332
CreatePerson	Создание пользователя	Возвращает ID вновь созданного пользователя	Изменен с версии 3.24
DeletePersonsFromGroups	Удалить пользователей из групп	На входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно, либо нет с указанием причины). При успешном завершении работы метода соответствующие пользователи будут удалены из соответствующих групп пользователей Системы.	3.23
EditPerson	Редактирование пользователя	Метод изменяет данные о пользователе в системе, согласно переданным параметрам	Изменен с версии 3.23
GetAllowedPersons	Получение списка пользователей, которым разрешен вход в систему	Возвращает всех пользователей в массиве Persons, которым разрешен вход в систему
GetGroups	Получение информации о группах пользователей	Возвращает массив GetGroupsResult, содержащий информацию о группах пользователей
GetPerson	Получение информации о пользователе	Возвращает массив SLPerson, в котором находится информация о полном имени пользователя, его идентификаторе, электронная почта и сведения о привязке пользователя к Active Directory	Изменен с версии 3.29
GetPersonRequests	Получить историю пользовательских запросов		3.17
GetPersons	Получение информации о пользователях	Возвращает массив Persons с информацией о каждом пользователе в подмассиве SlPerson
GetPersonsXml	Получение списка пользователей	Возвращает массив всех пользователей Users, содержащий расширенные сведения о каждом пользователе в подмассивах UserWrapper	2.2.2.2
LinkUserToAD	Создание связи с Active Directory	Возвращает идентификатор созданной связи пользователя системы с Active Directory
DeleteLinkWithAD	Удаление связи с Active Directory	Удаляет привязку пользователя системы к Active Directory
LinkUserToOpenIdConnect	Создание связи с Open ID	Возвращает идентификатор созданной связи пользователя системы с Open ID	3.29
DeleteLinksWithOpenIdConnect	Удаление связи с Open ID	Удаляет привязку пользователя системы к Open ID	3.29
CreateToken	Создание токена для пользователя	Метод для создания токена для пользователя, от имени которого осуществлен вход	3.26
RevokeAllTokensByUsers	Отзыв всех выданных токенов по списку пользователей	4.4.2.1. Метод для отзыва всех действующих токенов по списку пользователей	3.26

Безопасность

components/services/APISecurity.asmx

Метод	Название	Описание	Начиная с версии
AddPersonsToProjectMembers	Добавить пользователя в участники	Добавить пользователя в число участников объекта	3.21
DeletePersonsFromProjectMembers	Удалить пользователя из участников	Удалить пользователя из числа участников объекта	3.29
AddPersonsToProjectPermissionRoles	Назначить проектное право	Назначить на проектную роль безопасности определенного пользователя или группы пользователей.	3.20
DeletePersonsToProjectPermissionRoles	Снять проектное право	Снять с проектной роли безопасности определенного пользователя или группы пользователей.	3.20
GetProjectPermissionPersons	Получить список пользователей, назначенных на проектную роль объекта иерархии	Метод позволяет получить список пользователей и групп пользователей, назначенных на указанную проектную роль в указанном объекте	3.24

Проекты

components/services/APIProjects.asmx

Метод	Название	Описание	Начиная с версии
AddLinkTaskToTask	Установка связи между объектами типа «Задача»	Установка временной зависимости между объектами.	3.17
AddResourcesTask	Назначение ресурсов на объект типа «Задача»		3.17
ChangeParent	Перемещение проекта	Изменяет родительский проект у выбранного проекта	2.05.1929.21162-abc1d91
ConvertProjectType	Конвертация типа объекта	Изменяет тип объекта (аналог опции «Преобразовать» на карточке объекта)	3.23
CreateProject	Создание проекта	Создает проект, согласно переданным параметрам	Изменен с версии 3.29
CreateProjectByDiscussion	Создание проекта по дискуссии	Создает проект, согласно переданным параметрам, основанием создания проекта является указанная дискуссия	3.04.2176.31684-3bea33f
DelegateProject	Делегирование проекта	Делегирует проект другому пользователю системы
DeleteLinkTaskToTask	Удаление связи между объектами типа «Задача»	Удаление временной зависимости между объектами.	3.17
DeleteProject	Удаление проекта	Удаляет проект
DeleteResourcesTask	Удаление ресурсов из объекта типа «Задача»		3.17
GetGroupsWithPersonsIdsAllowedToWriteDiscussion	Получение групп и входящих в них пользователей по идентификатору проекта	Возвращает всех участников проекта и группы, в которые входят участники	3.02.2131.30991-7d9e342
GetHorizontalRelationsProjects	Получение горизонтальных связей проекта
GetProject	Получение информации о проекте	Возвращает всю информацию о проекте	Изменен с версии 3.29
GetProjectChilds	Получение подпроектов по типу	Возвращает идентификаторы всех подпроектов по типу проекта с указанием на родительский проект	2.05.1929.21162-abc1d91
GetProjectFields	Получение информации о реквизитах проекта	Возвращает идентификаторы реквизитов, даже если они не заполнены в карточке проекта	2.2.2.2
GetProjectInfo	Получение информации о проекте
GetProjectResourceAssignments	Получение ресурсов по проекту	Возвращает информацию о ресурсах в выбранном проекте	3.03.2118.29620-0a5e94d
GetProjectTypes	Получение информации о всех типах объектов		3.20
GetProjects	Получение информации о проектах	Возвращает информацию о выбранных фильтром проектах	Изменен с версии 3.29
GetProjectsUidsByType	Получение списка идентификаторов проектов по их типу	Возвращает массив идентификаторов проекта с указанием на родительский проект. Если идентификатор родительского проекта ParentProjectId отсутствует, запрос вернет все проекты указанного типа
GetSubprojectsDates	Получение данных дочерних проектов	Возвращает массив данных дочерних объектов
GetWorkCalendars	Получение списка производственных календарей	Возвращает список производственных календарей	3.23
LockObjectFields	Блокировка реквизитов проекта	Производит блокировку реквизитов проекта, у которых установлена опция «Возможность блокировать»	3.16.3190.21290-49c1b0f
ScheduleProject	Запуск планировщика с уровня указанного объекта	Запускает планировщика с уровня указанного объекта	3.23
UnlockObjectFields	Разблокировка реквизитов проекта	Производит разблокировку реквизитов проекта, у которых установлена опция «Возможность блокировать»	3.16.3190.21290-49c1b0f
UpdateProject	Редактирование информации о проекте	Изменяет выбранный проект, согласно передаваемым параметрам. Возвращает строку Everything allright при удачном обновлении проекта	Изменен с версии 3.29
UpdateProjectExt	Обновление проекта		Не поддерживается после версии 3.23
UpdateProjectFields	Редактирование реквизитов проекта	Изменяет реквизиты выбранного проекта	2.2.2.2

Связи

components/services/APIRelations.asmx

Метод	Название	Описание	Начиная с версии
AddHorizontalRelations	Добавить горизонтальную связь		3.21
RemoveHorizontalRelations	Удалить горизонтальную связь		3.21

Справочники

components/Services/APIService.asmx

Метод	Название	Описание	Начиная с версии
ChangeDirectoryRecord	Редактирование записи в справочнике		Изменен с версии 3.23 предыдущие изменения 3.01
ChangeDirectoryRecords	Редактирование записей в справочнике
ChangeDirectoryRecordStatus	Изменение статуса записи справочника	Изменяет статус (утверждено/на редактировании) записи справочника
ConvertClassifierItemIdToObjectId	Получение списка объектов по классификатору	Возвращает ID объекта, которому соответствует указанный ID записи классификатора
DeleteDirectoryRecord	Удаление записи справочника	Удаляет указанную запись справочника
DeleteDirectoryRecords	Удаление записей справочника	Удаляет указанные записи справочника
GetChildRecords	Получение списка записей справочника из дочернего справочника		3.06.2489.27673-42799a3
GetDirectoriesList	Получение списка справочников
GetDocumentVersions	Получение информации о версии документа	Возвращает порядковый номер версии документа по его индентификатору
GetRecords	Получение списка записей справочника	Возвращает по идентификатору справочника: список записей справочника и системная дата. Метод работает только с реквизитами-классификаторами, основанных на объектах.	Изменен с версии 3.23 предыдущие изменения 3.01¹⁾
GetRelationObjects	Получение связи для указанного шаблона объектного справочника	Возвращает идентификатор связи объектного справочника и проекта	3.06.2467.30148-1017b6b
GetUsedObjectsByClassifier	Получение информации об объектах, к которым привязан справочник	Возвращает объекты, в которых используется справочник
GetUsedTemplatesForClassifier	Получение списка использованных шаблонов
InsertDirectoryRecord	Добавление записи в справочник		Изменен с версии 3.23 предыдущие изменения 3.01
InsertDirectoryRecords	Добавление записей в справочник
InsertObjectToProjectRelation	Создание связи Справочник-Проект	Создает связь существующего справочника и проекта	3.06.2467.30148-1017b6b
SearchDirectoryRecordValues	Поиск идентификаторов объектов по реквизитам справочника	Возвращает идентификаторы всех объектов по заданным параметрам реквизита справочника	3.17
SearchDirectoryRecordsByStatus	Поиск идентификаторов объектов по статусу записей справочника		3.06
SendMail	Отправка сообщения электронной почты	Отправка информации и документов из Системы на почту	изменено с 3.24
SendMessage	Отправка уведомления в Системе

Классификаторы

components/Services/APIService.asmx

Метод	Название	Описание	Начиная с версии
InsertClassifierRecord	Добавление записи в классификатор
GetClassifierRecords	Получение записей классификатора

Табель учёта времени

components/Services/APITimesheets.asmx

Метод	Название	Описание	Начиная с версии
ApproveTimesheet	Утверждение табеля учета времени пользователя Системы		3.23
DeclineTimesheet	Отклонение табеля учета времени пользователя Системы		3.23

Документы

components/Services/APIDocuments.asmx

Метод	Название	Описание	Начиная с версии
CreateTemplateDocument	Добавления контрольного документа в объект	Что такое контрольный документ	3.22
DeleteDocuments	Удаление документа из объекта	Удаляет любой документ (не версии-файлы, а весь документ целиком)	3.22
GetDocumentVersions²⁾	Получение идентификатора последней версии документа	Возвращает идентификатор и номер версии документа	3.01.2026.31155-aba3460
UpdateDocumentFields	Изменение реквизитов документа
UpdateDocumentVersion	Добавление новой версии документа	Добавляет файл в качестве новой версии документа	3.24
CreateDocument	Создание документа в объекте	Создаёт документ в объекте и возвращает идентификатор созданного документа	3.24
DownloadDocumentFile	Скачивание версии документа в кодировке base64	Скачивает документ по его индентефикатору	3.24
GetDocumentInfo	Получение информации о документе	Возвращает всю информацию по указанному в запросе документу - данные по его активной версии и реквизитам	3.24
GetDocumentsIds	Получение списка идентификаторов всех документов объекта	Возвращает массив идентификаторов документов в объекте(ах) иерархии Системы.	3.24

Дискуссии

components/Services/APIDiscussions.asmx

Метод	Название	Описание	Начиная с версии
AskUsersTotopic	Запрос ответа пользователей в дискуссии	Метод запрашивает ответ в указанной дискуссии у заданных пользователей	3.01.2104.30480-d3da9ee
CreateTopic	Создание дискуссии
CreateTopicReply	Создание ответа на дискуссию
CreateTopicWithFields	Создание дискуссии с дополнительными полями	Включено добавление реквизитов дискуссии при создании	3.01.2104.30480-d3da9ee
GetTopicInfo	Получение информации о дискуссии		3.04.2209.34455-ffff9e6
GetTopicsInfoByProject	Получение списка дискуссий по идентификатору проекта	Метод возвращает свойства каждой найденной дискуссии в соответствии с передаваемыми критериями поиска.	3.04.2209.34455-ffff9e6
OpenExistingTopic	Открытие закрытой дискуссии		3.01.2104.30480-d3da9ee
ReaskUsersTotopic	Повторный запрос ответа у всех участников дискуссии	Если запрос уже установлен, он снимается. Затем заново приглашаются в дискуссию все существующие участники	3.01.2104.30480-d3da9ee
UpdateTopic	Редактирование дискуссии		3.20

Согласования

components/Services/APINegotiations.asmx

Метод	Название	Описание	Начиная с версии
CreateNegotiation	Создание согласования	Создаёт согласование без вложений	3.23
GetNegotiation	Получить данные согласования	Возвращает массив данных согласования
UpdateRoute	Изменить перечень согласующих в маршруте согласования
CloseNegotiation	Закрытие согласования	Метод для закрытия активного согласования	3.25

Базовый план

components/Services/APIPlans.asmx

Метод	Название	Описание	Начиная с версии
CreateBaselinePlan	Создание базового плана	Создаёт базовый план выбранного проекта	3.16.3190.21290-49c1b0f
GetBaselinePlanProject	Получение базовых планов	Выгрузка базовых планов	3.04.2147.21764-e8cb788

Формы сбора отчетности

components/Services/APIForms.asmx

Метод	Название	Описание	Начиная с версии
DeleteFormRequest	Удаление запроса заполнения формы сбора отчетности	Отменяет запросы формы или форм	3.24

Отчеты

components/Services/APIReports.asmx

Метод	Название	Описание	Начиная с версии
DownloadSpreadsheetReportFile	Скачивание файла отчёта	Скачивание файла отчёта для дальнейшей отправки на почту	3.24
SaveSpreadsheetReportFileAsDocument	Сохранение отчёта в файл в Системе		3.24

Интеграции

components/services/Integrations.asmx

Метод	Название	Описание	Начиная с версии
DeleteOpenIdConnectProvider	Удаление связи с Open ID (во всех профилях пользователей)	Удаляет привязку к указанному провайдеру Open ID во всех профилях пользователей	3.29

Администрирование

components/services/APIService.asmx

Метод	Название	Описание	Начиная с версии
GetDirectoryInfo	Получение информации о реквизитах объекта\справочника в Администрировании

———————-

Устаревшие методы API

Для изучения API

Вызов методов API с помощью SoapUI

Вызов методов API с помощью Postman

¹⁾

Возвращаются не только записи справочника, но и системные даты.

²⁾

До версии 3.22 находился в разделе components/Services/APIService.asmx