Получить параметры проекта
Запрос позволяет получить информацию о проекте.
Вы также можете использовать новый, более гибкий и функциональный API получения информации о сущности, представляющий унифицированный метод получения информации о проектах и портфелях.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы получить параметры проекта, используйте HTTP-запрос с методом GET.
GET /v2/projects/<идентификатор_проекта>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
Заголовки
-
Host
Адрес узла, предоставляющего API:
api.tracker.yandex.net -
Authorization
OAuth-токен в формате
OAuth <OAuth-токен>, например:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID или X-Cloud-Org-ID
Идентификатор организации. Узнать его можно на странице организаций Tracker.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
X-Org-ID. - Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок
X-Cloud-Org-ID. - Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок
X-Org-IDи идентификатор организации Яндекс 360 для бизнеса.
- Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок
{% cut "Ресурс" %}
Ресурс
| Параметр | Описание | Тип данных |
|---|---|---|
| <идентификатор_проекта> | Идентификатор проекта | Число |
Параметры запроса
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| expand | Дополнительные поля, которые будут включены в ответ:
|
Строка |
Формат ответа
В случае успешного выполнения запроса 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/12********",
"id": "12********",
"display": "Имя Фамилия"
},
"status": "launched",
"startDate": "2020-11-16",
"endDate": "2020-12-16"
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о проекте. | Строка |
| id | Идентификатор проекта. | Число |
| version | Версия проекта. Каждое изменение параметров увеличивает номер версии. | Число |
| key | Ключ проекта. Совпадает с названием проекта. | Строка |
| name | Название проекта. | Строка |
| description | Описание проекта. Параметр не отображается в интерфейсе Tracker. | Строка |
| lead | Блок с информацией об исполнителе проекта. | Объект |
| status | Этап, на котором находится проект:
|
Строка |
| startDate | Дата начала проекта в формате YYYY-MM-DD. |
Строка |
| endDate | Дата завершения проекта в формате YYYY-MM-DD. |
Строка |
Поля объекта lead
| Параметр | Описание | Тип данных |
|---|---|---|
| self | Адрес ресурса API, который содержит информацию о пользователе. | Строка |
| id | Идентификатор пользователя. | Число |
| display | Отображаемое имя пользователя. | Строка |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.