Получить список всех проектов

Запрос позволяет получить список всех проектов организации.

GET

https://api.tracker.yandex.net/v3/projects

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

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

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

Чтобы получить список проектов, используйте HTTP-запрос с методом GET.

GET /v3/projects
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки

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

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

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

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

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

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

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

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

Параметры запроса

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

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

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

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

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

{
    "self": "https://api.tracker.yandex.net/v3/projects/1",
    "id": "1",
    "version": 1,
    "key": "Проект 1",
    "name": "Проект 1",
    "description": "Первый проект",
    "lead": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Имя Фамилия"
    },
    "status": "launched",
    "startDate": "2020-11-01",
    "endDate": "2020-12-01"
},
{
    "self": "https://api.tracker.yandex.net/v3/projects/2",
    "id": "2",
    "version": 1,
    "key": "Проект 2",
    "name": "Проект 2",
    "description": "Еще один проект",
    "lead": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Имя Фамилия"
    },
    "status": "launched",
    "startDate": "2020-11-02",
    "endDate": "2020-12-02"
},
{
    ...
},
{
    ...
}
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о проекте. Строка
id Идентификатор проекта. Число
version Версия проекта. Каждое изменение параметров увеличивает номер версии. Число
key Ключ проекта. Совпадает с названием проекта. Строка
name Название проекта. Строка
description Описание проекта. Параметр не отображается в интерфейсе Tracker. Строка
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
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
Предыдущая
Получить параметры проекта
Следующая
Получить список очередей проекта