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

components/services/login.asmx

МетодНазваниеОписаниеНачиная с версии
AuthenticateАвторизацияВозвращает идентификатор сессии ASPNETSessionId, который используется при вызове всех методов API
AuthenticateByUserАвторизация под пользователемПозволяет администратору авторизоваться в под выбранным пользователем3.20
CheckSessionПроверка активности сессииВозвращает идентификатор сессии ASPNETSessionId, если сессия активна. И Session ends, если сессия не активна3.14.3232.26072-09fa3d0

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.23
DeleteLinkWithADУдаление связи с Active DirectoryУдаляет привязку пользователя системы с Active Directory
DeletePersonsFromGroupsУдалить пользователей из группНа входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно, либо нет с указанием причины). При успешном завершении работы метода соответствующие пользователи будут удалены из соответствующих групп пользователей Системы.3.23
EditPersonРедактирование пользователяМетод изменяет данные о пользователе в системе, согласно переданным параметрамИзменен с версии 3.23
GetAllowedPersonsПолучение списка пользователей, которым разрешен вход в системуВозвращает всех пользователей в массиве Persons, которым разрешен вход в систему
GetGroupsПолучение информации о группах пользователейВозвращает массив GetGroupsResult, содержащий информацию о группах пользователей
GetPersonПолучение информации о пользователеВозвращает массив SLPerson, в котором находится информация о полном имени пользователя, его идентификаторе, электронная почта и сведения о привязке пользователя к Active DirectoryИзменен с версии 3.23
GetPersonRequestsПолучить историю пользовательских запросов 3.17
GetPersonsПолучение информации о пользователяхВозвращает массив Persons с информацией о каждом пользователе в подмассиве SlPerson
GetPersonsXmlПолучение списка пользователейВозвращает массив всех пользователей Users, содержащий расширенные сведения о каждом пользователе в подмассивах UserWrapper2.2.2.2
LinkUserToADСоздание связи с Active DirectoryВозвращает идентификатор созданной связи пользователя системы с Active Directory

components/services/APISecurity.asmx

МетодНазваниеОписаниеНачиная с версии
AddPersonsToProjectMembersДобавить пользователя в участникиДобавить пользователя в число участников объекта3.21
AddPersonsToProjectPermissionRolesНазначить проектное правоНазначить на проектную роль безопасности определенного пользователя или группы пользователей.3.20
DeletePersonsToProjectPermissionRolesСнять проектное правоСнять с проектной роли безопасности определенного пользователя или группы пользователей.3.20

components/services/APIProjects.asmx

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

components/services/APIRelations.asmx

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

components/Services/APIService.asmx

МетодНазваниеОписаниеНачиная с версии
ChangeDirectoryRecordРедактирование записи в справочнике Изменен с версии 3.23
предыдущие изменения 3.01
ChangeDirectoryRecordStatusИзменение статуса записи справочникаИзменяет статус (утверждено/на редактировании) записи справочника
DeleteDirectoryRecordУдаление записи справочникаУдаляет указанную запись справочника
GetChildRecordsПолучение списка записей справочника из дочернего справочника 3.06.2489.27673-42799a3
GetDirectoriesListПолучение списка справочников
GetDirectoryInfoПолучение информации о справочнике
GetDirectoryRequisitesПолучение реквизитов справочника 3.10
GetRecordsПолучение списка записей справочникаВозвращает по идентификатору справочника: список записей справочника и системная дата.
Метод работает только с реквизитами-классификаторами, основанных на объектах.
Изменен с версии 3.23
предыдущие изменения 3.011)
GetRelationObjectsПолучение связи для указанного шаблона объектного справочникаВозвращает идентификатор связи объектного справочника и проекта3.06.2467.30148-1017b6b
InsertDirectoryRecordДобавление записей в справочник Изменен с версии 3.23
предыдущие изменения 3.01
InsertObjectToProjectRelationСоздание связи Справочник-ПроектСоздает связь существующего справочника и проекта3.06.2467.30148-1017b6b
SearchDirectoryRecordValuesПоиск идентификаторов объектов по реквизитам справочникаВозвращает идентификаторы всех объектов по заданным параметрам реквизита справочника3.17
SearchDirectoryRecordsByStatusПоиск идентификаторов объектов по статусу записей справочника 3.06

components/Services/APIService.asmx

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

components/Services/APIDocuments.asmx

МетодНазваниеОписаниеНачиная с версии
CreateTemplateDocumentДобавления контрольного документа в объектЧто такое контрольный документ3.22
DeleteDocumentsУдаление документа из объектаУдаляет любой документ (не версии-файлы, а весь документ целиком)3.22
GetDocumentVersions2)Получение идентификатора последней версии документаВозвращает идентификатор и номер версии документа3.01.2026.31155-aba3460

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/APIPlans.asmx

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

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


1)
Возвращаются не только записи справочника, но и системные даты.
2)
До версии 3.22 в находился в разделе components/Services/APIService.asmx
  • product/api/list.txt
  • Последнее изменение: 15/09/2021 08:40
  • Екатерина Холкина