====== Описание методов API ======
===== Авторизация =====
**components/services/login.asmx**
|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|Authenticate|[[product:api:list:authenticate|Авторизация]]|Возвращает идентификатор сессии ASPNETSessionId, который используется при вызове всех методов API| |
|AuthenticateByUser|[[product:api:list:AuthenticateByUser|Авторизация от имени другого пользователя]]|Позволяет администратору авторизоваться под выбранным пользователем|3.20|
|AuthenticateAdminAsUser|[[product:api:list:AuthenticateAdminAsUser|Авторизация администратора от имени другого пользователя]]|Позволяет администратору авторизоваться под выбранным пользователем |3.24|
|AuthenticateByToken|[[product:api:list:AuthenticateByToken|Аутентификация по токену]]|Метод для аутентификации в системе по выданному токену|3.26|
|CheckSession|[[product:api:list:checksession|Проверка активности сессии]]|Возвращает идентификатор сессии ASPNETSessionId, если сессия активна. И Session ends, если сессия не активна|3.14.3232.26072-09fa3d0|
|Login*|[[product:api:list:Login|Вход в Систему под определённым пользователем]]|Метод для входа в Систему с логином и паролем пользователя. \\ ''ВНИМАНИЕ: метод устарел.'' \\ ''Рекомендуется использовать метод Authenticate - [[product:api:list:authenticate|Авторизация]] (см. выше)'' | |
|WhoAmI|[[product:api:list:WhoAmI|Проверка пользователя]]|Возвращает имя и роль пользователя, вошедшего в Систему|

=====Пользователи=====
**components/services/persons.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|AddPersonsToGroups|[[product:api:list:addpersonstogroups|Добавить пользователей в группы]]|На входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно или нет, с указанием причины). При успешном завершении работы метода соответствующие пользователи будут добавлены в соответствующие группы пользователей Системы. |3.23|
|CheckUserPhoto|[[product:api:list:checkuserphoto|Проверка наличия фотографии у пользователя]]|Метод возвращает ссылку на фото, типа ~/Pages/PopupPages/Documents/GetImage.ashx?v=1&docid=0d6aecc1-17a3-4af3-939c-8c7b92cb63eb, если фотография нестандартная. В случае стандартной фотографии метод вернет значение null. При возникновении ошибки, вернется ошибка.|2.05.1922.22458-e57d332|
|CreatePerson|[[product:api:list:createperson|Создание пользователя]]|Возвращает ID вновь созданного пользователя|Изменен с версии 3.24|
|DeletePersonsFromGroups|[[product:api:list:deletepersonsfromgroups|Удалить пользователей из групп]]|На входе – массивы значений: GUID пользователей, GUID групп пользователей. На выходе – результат выполнения метода (успешно, либо нет с указанием причины). При успешном завершении работы метода соответствующие пользователи будут удалены из соответствующих групп пользователей Системы.|3.23|
|EditPerson|[[product:api:list:editperson|Редактирование пользователя]]|Метод изменяет данные о пользователе в системе, согласно переданным параметрам|Изменен с версии 3.23|
|GetAllowedPersons|[[product:api:list:getallowedpersons|Получение списка пользователей, которым разрешен вход в систему]]|Возвращает всех пользователей в массиве Persons, которым разрешен вход в систему| |
|GetGroups|[[product:api:list:getgroups|Получение информации о группах пользователей]]|Возвращает массив GetGroupsResult, содержащий информацию о группах пользователей| |
|GetPerson|[[product:api:list:getperson|Получение информации о пользователе]]|Возвращает массив SLPerson, в котором находится информация о полном имени пользователя, его идентификаторе, электронная почта и сведения о привязке пользователя к Active Directory|Изменен с версии 3.29|
|GetPersonRequests|[[product:api:list:getpersonrequests|Получить историю пользовательских запросов]]| |3.17|
|GetPersons|[[product:api:list:getpersons|Получение информации о пользователях]]|Возвращает массив Persons с информацией о каждом пользователе в подмассиве SlPerson| |
|GetPersonsXml|[[product:api:list:getpersonsxml|Получение списка пользователей]]|Возвращает массив всех пользователей Users, содержащий расширенные сведения о каждом пользователе в подмассивах UserWrapper|2.2.2.2|
|LinkUserToAD|[[product:api:list:linkusertoad|Создание связи с Active Directory]]|Возвращает идентификатор созданной связи пользователя системы с Active Directory| |
|DeleteLinkWithAD|[[product:api:list:deletelinkwithad|Удаление связи с Active Directory]]|Удаляет привязку пользователя системы к Active Directory| |
|LinkUserToOpenIdConnect|[[product:api:list:linkuserto_oid|Создание связи с Open ID]]|Возвращает идентификатор созданной связи пользователя системы с Open ID|3.29|
|DeleteLinksWithOpenIdConnect|[[product:api:list:deletelinkuserwith_oid|Удаление связи с Open ID]]|Удаляет привязку пользователя системы к Open ID|3.29|
|CreateToken|[[product:api:list:CreateToken|Создание токена для пользователя]]|Метод для создания токена для пользователя, от имени которого осуществлен вход|3.26|
|RevokeAllTokensByUsers|[[product:api:list:RevokeAllTokensByUsers|Отзыв всех выданных токенов по списку пользователей]]|4.4.2.1.	Метод для отзыва всех действующих токенов по списку пользователей|3.26|

===== Безопасность =====
**components/services/APISecurity.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|AddPersonsToProjectMembers|[[product/api/list/AddPersonsToProjectMembers|Добавить пользователя в участники]]|Добавить пользователя в число участников объекта|3.21|
|DeletePersonsFromProjectMembers|[[:product:api:list:DeletePersonsFromProjectMembers|Удалить пользователя из участников]]|Удалить пользователя из числа участников объекта|3.29|
|AddPersonsToProjectPermissionRoles|[[product/api/list/AddPersonsToProjectPermissionRoles|Назначить проектное право]]|Назначить на проектную роль безопасности определенного пользователя или группы пользователей.|3.20|
|DeletePersonsToProjectPermissionRoles|[[product:api:list:DeletePersonsToProjectPermissionRoles|Снять проектное право]]|Снять с проектной роли безопасности определенного пользователя или группы пользователей.|3.20|
|GetProjectPermissionPersons|[[product:api:list:GetProjectPermissionPersons|Получить список пользователей, назначенных на проектную роль объекта иерархии]]|Метод позволяет получить список пользователей и групп пользователей, назначенных на указанную проектную роль в указанном объекте|3.24|
=====Проекты=====
**components/services/APIProjects.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|AddLinkTaskToTask|[[product:api:list:addlinktasktotask|Установка связи между объектами типа «Задача»]]|Установка временной зависимости между объектами.|3.17|
|AddResourcesTask|[[product:api:list:addresourcestask|Назначение ресурсов на объект типа «Задача»]]| |3.17|
|ChangeParent|[[product:api:list:changeparent|Перемещение проекта]]|Изменяет родительский проект у выбранного проекта|2.05.1929.21162-abc1d91|
|ConvertProjectType|[[product:api:list:convertprojecttype|Конвертация типа объекта]]|Изменяет тип объекта (аналог опции «Преобразовать» на карточке объекта)|3.23|
|CreateProject|[[product/api/list/createproject|Создание проекта]]|Создает проект, согласно переданным параметрам|Изменен с версии 3.29 |
|CreateProjectByDiscussion|[[product:api:list:createprojectbydiscussion|Создание проекта по дискуссии]]|Создает проект, согласно переданным параметрам, основанием создания проекта является указанная дискуссия|3.04.2176.31684-3bea33f|
|DelegateProject|[[product:api:list:delegateproject|Делегирование проекта]]|Делегирует проект другому пользователю системы| |
|DeleteLinkTaskToTask|[[product:api:list:deletelinktasktotask|Удаление связи между объектами типа «Задача»]]|Удаление временной зависимости между объектами.|3.17|
|DeleteProject|[[product:api:list:deleteproject|Удаление проекта]]|Удаляет проект| |
|DeleteResourcesTask|[[product:api:list:deleteresourcestask|Удаление ресурсов из объекта типа «Задача»]]| |3.17|
|GetGroupsWithPersonsIdsAllowedToWriteDiscussion|[[product:api:list:getgroupswithpersonsidsallowedtowritediscussion|Получение групп и входящих в них пользователей по идентификатору проекта]]|Возвращает всех участников проекта и группы, в которые входят участники|3.02.2131.30991-7d9e342|
|GetHorizontalRelationsProjects|[[product:api:list:gethorizontalrelationsprojects|Получение горизонтальных связей проекта]]| | |
|GetProject|[[product:api:list:getproject|Получение информации о проекте]]|Возвращает всю информацию о проекте|Изменен с версии 3.29|
|GetProjectChilds|[[product:api:list:getprojectchilds|Получение подпроектов по типу]]|Возвращает идентификаторы всех подпроектов по типу проекта с указанием на родительский проект|2.05.1929.21162-abc1d91|
|GetProjectFields|[[product:api:list:getprojectfields|Получение информации о реквизитах проекта]]|Возвращает идентификаторы реквизитов, даже если они не заполнены в карточке проекта|2.2.2.2|
|GetProjectInfo|[[product:api:list:GetProjectInfo|Получение информации о проекте]]|
|GetProjectResourceAssignments|[[product:api:list:getprojectresourceassignments|Получение ресурсов по проекту]]|Возвращает информацию о ресурсах в выбранном проекте|3.03.2118.29620-0a5e94d|
|GetProjectTypes|[[product:api:list:getprojectstypes|Получение информации о всех типах объектов]]| |3.20|
|GetProjects|[[product:api:list:getprojects|Получение информации о проектах]]|Возвращает информацию о выбранных фильтром проектах|Изменен с версии 3.29|
|GetProjectsUidsByType|[[product:api:list:getprojectsuidsbytype|Получение списка идентификаторов проектов по их типу]]|Возвращает массив идентификаторов проекта с указанием на родительский проект. Если идентификатор родительского проекта ParentProjectId отсутствует, запрос вернет все проекты указанного типа| |
|GetSubprojectsDates|[[product:api:list:GetSubprojectsDates|Получение данных дочерних проектов]]|Возвращает массив данных дочерних объектов|
|GetWorkCalendars|[[product:api:list:getworkcalendars|Получение списка производственных календарей]]|Возвращает список производственных календарей|3.23|
|LockObjectFields|[[product:api:list:lockobjectfields|Блокировка реквизитов проекта]]|Производит блокировку реквизитов проекта, у которых установлена опция "Возможность блокировать"|3.16.3190.21290-49c1b0f|
|ScheduleProject|[[product:api:list:ScheduleProject|Запуск планировщика с уровня указанного объекта]]|Запускает планировщика с уровня указанного объекта|3.23|
|UnlockObjectFields|[[product:api:list:unlockobjectfields|Разблокировка реквизитов проекта]]|Производит разблокировку реквизитов проекта, у которых установлена опция "Возможность блокировать"|3.16.3190.21290-49c1b0f|
|UpdateProject|[[product:api:list:updateproject|Редактирование информации о проекте]]|Изменяет выбранный проект, согласно передаваемым параметрам. Возвращает строку Everything allright при удачном обновлении проекта|Изменен с версии 3.29|
|UpdateProjectExt|[[product:api:list:UpdateProjectExt|Обновление проекта]]| |Не поддерживается после версии 3.23|
|UpdateProjectFields|[[product:api:list:updateprojectfields|Редактирование реквизитов проекта]]|Изменяет реквизиты выбранного проекта|2.2.2.2|

===== Связи =====
**components/services/APIRelations.asmx**
|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|AddHorizontalRelations|[[product/api/list/AddHorizontalRelations|Добавить горизонтальную связь]]| |3.21|
|RemoveHorizontalRelations|[[product:api:list:RemoveHorizontalRelations|Удалить горизонтальную связь]]| |3.21|
=====Справочники=====
**components/Services/APIService.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|ChangeDirectoryRecord|[[product:api:list:changedirectoryrecord|Редактирование записи в справочнике]]| |Изменен с версии 3.23 \\ предыдущие изменения 3.01|
|ChangeDirectoryRecords|[[product:api:list:changedirectoryrecords|Редактирование записей в справочнике]]| 
|ChangeDirectoryRecordStatus|[[product:api:list:changedirectoryrecordstatus|Изменение статуса записи справочника]]|Изменяет статус (утверждено/на редактировании) записи справочника| |
|ConvertClassifierItemIdToObjectId|[[product:api:list:ConvertClassifierItemIdToObjectId|Получение списка объектов по классификатору]]|Возвращает ID объекта, которому соответствует указанный ID записи классификатора |
|DeleteDirectoryRecord|[[product:api:list:DeleteDirectoryRecord|Удаление записи справочника]]|Удаляет указанную запись справочника|
|DeleteDirectoryRecords|[[product:api:list:DeleteDirectoryRecords|Удаление записей справочника]]|Удаляет указанные записи справочника|
|GetChildRecords|[[product:api:list:getchildrecords|Получение списка записей справочника из дочернего справочника]]| |3.06.2489.27673-42799a3|
|GetDirectoriesList|[[product:api:list:getdirectorieslist|Получение списка справочников]]| | |
|GetDocumentVersions|[[product:api:list:GetDocumentVersions|Получение информации о версии документа]]|Возвращает порядковый номер версии документа по его индентификатору|
|GetRecords|[[product:api:list:getrecords|Получение списка записей справочника]]|Возвращает по идентификатору справочника: список записей справочника и системная дата. \\ Метод работает только с реквизитами-классификаторами, основанных на объектах.|Изменен с версии 3.23 \\ предыдущие изменения 3.01((Возвращаются не только записи справочника, но и системные даты.))|
|GetRelationObjects|[[product:api:list:getrelationobjects|Получение связи для указанного шаблона объектного справочника]]|Возвращает идентификатор связи объектного справочника и проекта|3.06.2467.30148-1017b6b|
|GetUsedObjectsByClassifier|[[product:api:list:GetUsedObjectsByClassifier|Получение информации об объектах, к которым привязан справочник]]|Возвращает объекты, в которых используется справочник| |
|GetUsedTemplatesForClassifier|[[product:api:list:GetUsedTemplatesForClassifier|Получение списка использованных шаблонов]]|
|InsertDirectoryRecord|[[product:api:list:insertdirectoryrecord|Добавление записи в справочник]]| |Изменен с версии 3.23 \\ предыдущие изменения 3.01|
|InsertDirectoryRecords|[[product:api:list:insertdirectoryrecords|Добавление записей в справочник]]| 
|InsertObjectToProjectRelation|[[product:api:list:insertobjecttoprojectrelation|Создание связи Справочник-Проект]]|Создает связь существующего справочника и проекта|3.06.2467.30148-1017b6b|
|SearchDirectoryRecordValues|[[product:api:list:searchdirectoryrecordvalues|Поиск идентификаторов объектов по реквизитам справочника]]|Возвращает идентификаторы всех объектов по заданным параметрам реквизита справочника|3.17|
|SearchDirectoryRecordsByStatus|[[product:api:list:searchdirectoryrecordsbystatus|Поиск идентификаторов объектов по статусу записей справочника]]| |3.06|
|SendMail|[[product:api:list:SendMail|Отправка сообщения электронной почты]]|Отправка информации и документов из Системы на почту|изменено с 3.24|
|SendMessage|[[product:api:list:SendMessage|Отправка уведомления в Системе]]|
=====Классификаторы=====
**components/Services/APIService.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|InsertClassifierRecord|[[product:api:list:insertclassifierrecord|Добавление записи в классификатор]]| | |
|GetClassifierRecords|[[product:api:list:getclassifierrecords|Получение записей классификатора]]| | |

===== Табель учёта времени =====
**components/Services/APITimesheets.asmx**
|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|ApproveTimesheet|[[product:api:list:ApproveTimesheet|Утверждение табеля учета времени пользователя Системы]]| |3.23 |
|DeclineTimesheet|[[product:api:list:DeclineTimesheet|Отклонение табеля учета времени пользователя Системы]]| |3.23 |

=====Документы=====
**components/Services/APIDocuments.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|CreateTemplateDocument|[[product:api:list:CreateTemplateDocument|Добавления контрольного документа в объект]]|[[product/documents/control_doc|Что такое контрольный документ]]|3.22|
|DeleteDocuments|[[product:api:list:DeleteDocuments|Удаление документа из объекта]]|Удаляет любой документ (не версии-файлы, а весь документ целиком)|3.22|
|GetDocumentVersions((До версии 3.22 находился в разделе **components/Services/APIService.asmx**))|[[product:api:list:getdocumentversions|Получение идентификатора последней версии документа]]|Возвращает идентификатор и номер версии документа|3.01.2026.31155-aba3460|
|UpdateDocumentFields|[[product:api:list:UpdateDocumentFields|Изменение реквизитов документа]]|
|UpdateDocumentVersion|[[product:api:list:UpdateDocumentVersion|Добавление новой версии документа]]|Добавляет файл в качестве новой версии документа|3.24|
|CreateDocument|[[product:api:list:CreateDocument|Создание документа в объекте]]|Создаёт документ в объекте и возвращает идентификатор созданного документа |3.24|
|DownloadDocumentFile|[[product:api:list:DownloadDocumentFile|Скачивание версии документа в кодировке base64]]|Скачивает документ по его индентефикатору|3.24|
|GetDocumentInfo|[[product:api:list:GetDocumentInfo|Получение информации о документе]]|Возвращает всю информацию по указанному в запросе документу - данные по его активной версии и реквизитам |3.24|
|GetDocumentsIds|[[product:api:list:GetDocumentsIds|Получение списка идентификаторов всех документов объекта]]|Возвращает массив идентификаторов документов в объекте(ах) иерархии Системы.|3.24|

=====Дискуссии=====
**components/Services/APIDiscussions.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|AskUsersTotopic|[[product:api:list:askuserstotopic|Запрос ответа пользователей в дискуссии]]|Метод запрашивает ответ в указанной дискуссии у заданных пользователей|3.01.2104.30480-d3da9ee|
|CreateTopic|[[product:api:list:createtopic|Создание дискуссии]]| | |
|CreateTopicReply|[[product:api:list:createtopicreply|Создание ответа на дискуссию]]| | |
|CreateTopicWithFields|[[product:api:list:createtopicwithfields|Создание дискуссии с дополнительными полями]]|Включено добавление реквизитов дискуссии при создании|3.01.2104.30480-d3da9ee|
|GetTopicInfo|[[product:api:list:gettopicinfo|Получение информации о дискуссии]]| |3.04.2209.34455-ffff9e6|
|GetTopicsInfoByProject|[[product:api:list:gettopicsinfobyproject|Получение списка дискуссий по идентификатору проекта]]|Метод возвращает свойства каждой найденной дискуссии в соответствии с передаваемыми критериями поиска.|3.04.2209.34455-ffff9e6|
|OpenExistingTopic|[[product:api:list:openexistingtopic|Открытие закрытой дискуссии]]| |3.01.2104.30480-d3da9ee|
|ReaskUsersTotopic|[[product:api:list:reaskuserstotopic|Повторный запрос ответа у всех участников дискуссии]]|Если запрос уже установлен, он снимается. Затем заново приглашаются в дискуссию все существующие участники|3.01.2104.30480-d3da9ee|
|UpdateTopic|[[product:api:list:UpdateTopic|Редактирование дискуссии]]| |3.20|

=====Согласования=====
**components/Services/APINegotiations.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|CreateNegotiation|[[product:api:list:CreateNegotiation|Создание согласования]]|Создаёт согласование без вложений|3.23|
|GetNegotiation|[[product:api:list:GetNegotiation|Получить данные согласования]]|Возвращает массив данных согласования|
|UpdateRoute|[[product:api:list:UpdateRoute|Изменить перечень согласующих в маршруте согласования]]|
|CloseNegotiation|[[product:api:list:CloseNegotiation|Закрытие согласования]]|Метод для закрытия активного согласования|3.25|
=====Базовый план=====
**components/Services/APIPlans.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|CreateBaselinePlan|[[product:api:list:createbaselineplan|Создание базового плана]]|Создаёт базовый план выбранного проекта|3.16.3190.21290-49c1b0f|
|GetBaselinePlanProject|[[product:api:list:getbaselineplanproject|Получение базовых планов]]|Выгрузка базовых планов|3.04.2147.21764-e8cb788|

===== Формы сбора отчетности =====
**components/Services/APIForms.asmx** 
|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|DeleteFormRequest|[[product:api:list:DeleteFormRequest|Удаление запроса заполнения формы сбора отчетности]]|Отменяет запросы формы или форм|3.24|

===== Отчеты =====
**components/Services/APIReports.asmx**
|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|DownloadSpreadsheetReportFile|[[product:api:list:DownloadSpreadsheetReportFile|Скачивание файла отчёта]]|Скачивание файла отчёта для дальнейшей отправки на почту|3.24|
|SaveSpreadsheetReportFileAsDocument|[[product:api:list:SaveSpreadsheetReportFileAsDocument|Сохранение отчёта в файл  в Системе]]||3.24|

===== Интеграции =====
**components/services/Integrations.asmx**

|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|DeleteOpenIdConnectProvider|[[product:api:list:delete_oid|Удаление связи с Open ID (во всех профилях пользователей)]]|Удаляет привязку к указанному провайдеру Open ID во всех профилях пользователей|3.29|
===== Администрирование =====
**components/services/APIService.asmx**
|< 100% 15% 25% 45% 15% >|
^Метод^Название^Описание^Начиная с версии^
|GetDirectoryInfo|[[product:api:list:getdirectoryinfo|Получение информации о реквизитах объекта\справочника в Администрировании]]| | |
----------------------

{{fa>trash?2x}} [[product:api:list_old|Устаревшие методы API]]
----------------------

===== Для изучения API =====
[[product:api:list:soapui|Вызов методов API с помощью SoapUI]]

[[product:api:list:postman|Вызов методов API с помощью Postman]]