Содержание

Описание SOAP API (XML)


Авторизация


URL: components/services/login.asmx

МетодНазваниеОписаниеНачиная с версии
AuthenticateАвторизацияВозвращает идентификатор сессии ASPNETSessionId, который используется при вызове всех методов API4.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 Directory4.00
GetPersonRequestsПолучить историю пользовательских запросов 4.00
GetPersonsПолучение информации о пользователяхВозвращает массив Persons с информацией о каждом пользователе в подмассиве SlPerson4.00
GetPersonsXmlПолучение списка пользователейВозвращает массив всех пользователей Users, содержащий расширенные сведения о каждом пользователе в подмассивах UserWrapper4.00
LinkUserToADСоздание связи с Active DirectoryВозвращает идентификатор созданной связи пользователя системы с Active Directory4.00
DeleteLinkWithADУдаление связи с Active DirectoryУдаляет привязку пользователя системы к Active Directory4.00
LinkUserToOpenIdConnectСоздание связи с Open IDВозвращает идентификатор созданной связи пользователя системы с Open ID4.00
DeleteLinksWithOpenIdConnectУдаление связи с Open IDУдаляет привязку пользователя системы к Open ID4.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


Документы


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


События


URL: components/Services/APIScheduledEvents.asmx