Документация
Полная документация по REST API доступна в разделе "Справочник разработчика"
В справочнике разработчика выберите интересующую сущность и на дополнительной панели справа будет представлен полный перечень атрибутов, с их характеристиками, примеры запросов REST API, пример возвращаемых данных, объектная модель и примеры написания PHP-скриптов для автоматизации.
По каждому артефакту можно быстро получить ссылку на REST API на форме редактирования артефакта (вкладка Дополнительно) или в модуле, где артефакт отображается:
ИИ-функции
Для работы ИИ-функций требуется настроенная интеграция с AI-сервисами (Администрирование - Настройки - Приложение).
Для выборки проектных артефактов похожих по смыслу можно использовать специальный endpoint:
/pm/my/api/latest/rag?entites=...&like=...
| Параметр | Описание параметра |
|---|---|
| entities | Перечень названий классов сущностей через запятую, по которым необходимо осуществить поиск похожих, например: Issue, Requirement, Increment |
| like | Фраза, на основании которой необходимо найти похожие по смыслу артефакты. |
| distance | Степень похожести позволяет управлять качеством выдачи. |
| стандартные параметры | Использование остальных стандартных параметров типа fields, limit и т.п. вы можете изучить в Справочнике разработчика. |