Проекты и портфели. Обзор
Статья создана
Обновлена 26 августа 2024 г.
API Entities (Сущности) представляет унифицированный набор методов для управления проектами и портфелями, более гибкий и функциональный, чем API управления проектами.
С помощью данного API вы сможете:
- Создавать, редактировать и удалять проекты и портфели.
- Получать информацию о проектах и портфелях.
- Искать и пакетно обновлять проекты и портфели.
- Создавать, редактировать и удалять чеклисты.
- Редактировать, перемещать и удалять отдельные пункты чеклиста.
Параметры запроса
С помощью параметров запроса вы можете включить в тело ответа дополнительную информацию.
Для параметра fields запроса укажите одно или несколько значений:
| Поле | Описание |
|---|---|
| summary | Название сущности |
| description | Описание сущности |
| author | Автор (идентификатор пользователя) |
| lead | Ответственный (идентификатор пользователя) |
| teamUsers | Участники (массив идентификаторов пользователей) |
| clients | Заказчики (массив идентификаторов пользователей) |
| followers | Наблюдатели (массив идентификаторов пользователей) |
| start | Дата начала |
| end | Дедлайн |
| checklistItems | Чеклисты |
| tags | Теги |
| parentEntity | Идентификатор родительской сущности (поле «Входит в портфель»). Передается только значение для поля «Основной портфель». |
| teamAccess | Доступ |
| quarter | Кварталы начала и окончания проекта |
| entityStatus | Статус |
| issueQueues | Очереди задач, содержащихся в проекте |
Пример: Включить в ответ описание проекта и информацию о пунктах чеклиста
POST /v2/entities/<тип_сущности>/<идентификатор_сущности>/checklistItems?fields=description&fields=checklistItems
В тело ответа будет включена запрашиваемая информация в формате JSON.