Подключиться
Yandex Tracker

Получить параметры проекта

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

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

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

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

GET /v2/projects/<project-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

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

Ресурс

Параметр Описание Тип данных
<project-id> Идентификатор проекта. Число.

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

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

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

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

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

{
    "self": "https://api.tracker.yandex.net/v2/projects/9",
    "id": "9",
    "version": 1,
    "key": "Проект",
    "name": "Проект",
    "description": "Новый проект",
    "lead": {
        "self": "https://api.tracker.yandex.net/v2/users/12314567890",
        "id": "1234567890",
        "display": "Имя Фамилия"
    },
    "status": "launched",
    "startDate": "2020-11-16",
    "endDate": "2020-12-16"
}

Параметры ответа

Параметр Описание Тип данных
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 и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
В этой статье: