Изменить проект

Запрос позволяет обновить информацию о проекте.

PUT

https://api.tracker.yandex.net/v3/projects/<id_проекта>?version=<номер_версии>

Вы также можете использовать новый, более гибкий и функциональный API обновления информации о сущности, представляющий унифицированный метод обновления информации о проектах и портфелях.

Формат запроса

Перед выполнением запроса получите доступ к API.

Чтобы изменить проект, используйте HTTP-запрос с методом PUT. В теле запроса укажите параметры в формате JSON.

PUT /v3/projects/<id_проекта>?version=<номер_версии>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "queues": "<ключ_очереди>" 
}
Заголовки

  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_проекта> Идентификатор проекта Число
Параметры запроса

Обязательные параметры

Параметр Описание Тип данных
version Версия проекта. Изменения вносятся только в текущую версию проекта. Число

Дополнительные параметры

Параметр Описание Тип данных
expand Дополнительные поля, которые будут включены в ответ:
  • queues — очереди проекта.
Строка
Параметры тела запроса

Обязательные параметры

Параметр Описание Тип данных
queues Задачи, которые планируется включать в проект. Строка

Дополнительные параметры

Параметр Описание Тип данных
name Название проекта. Строка
description Описание проекта. Параметр не отображается в интерфейсе Трекера. Строка
lead Идентификатор или логин исполнителя проекта. Число / Строка
status Этап, на котором находится проект:
  • DRAFT – Черновик.
  • IN_PROGRESS — В работе.
  • LAUNCHED — Запущен.
  • POSTPONED — Отложен.
Строка
startDate Дата начала проекта в формате YYYY-MM-DD. Строка
endDate Дата завершения проекта в формате YYYY-MM-DD. Строка

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело ответа содержит информацию об измененном проекте в формате JSON.

{
    "self": "https://api.tracker.yandex.net/v3/projects/9",
    "id": "9",
    "version": 5,
    "key": "Project",
    "name": "Project",
    "description": "Project with changes",
    "lead": {
        "self": "https://api.tracker.yandex.net/v3/users/11********",
        "id": "11********",
        "display": "Имя Фамилия",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": 11********
    },
    "status": "launched",
    "startDate": "2020-11-16",
    "endDate": "2020-12-16"
}
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о проекте. Строка
id Идентификатор проекта. Число
version Версия проекта. Каждое изменение параметров увеличивает номер версии. Число
key Ключ проекта. Совпадает с названием проекта. Строка
name Название проекта. Строка
description Описание проекта. Параметр не отображается в интерфейсе Трекера. Строка
lead Блок с информацией об исполнителе проекта. Объект
status Этап, на котором находится проект:
  • DRAFT — Черновик.
  • IN_PROGRESS — В работе.
  • LAUNCHED — Запущен.
  • POSTPONED — Отложен.
Строка
startDate Дата начала проекта в формате YYYY-MM-DD. Строка
endDate Дата завершения проекта в формате YYYY-MM-DD. Строка

Поля объекта lead

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Число
display Отображаемое имя пользователя. Строка

Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
412
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
423
Редактирование объекта заблокировано. Возможно, превышено допустимое значение параметра version — количество обновлений объекта. Максимальное значение версии составляет 10100 для роботов и 11100 для пользователей.
428
Доступ к ресурсу отклонен. Проверьте, указаны ли все обязательные условия выполнения запроса.
Предыдущая
Получить список очередей проекта
Следующая
Удалить проект