Создать категорию поля задачи
Статья создана
Обновлена 26 августа 2024 г.
Запрос позволяет создать категорию поля задачи.
Формат запроса
Перед выполнением запроса получите доступ к API.
Чтобы создать категорию для поля задачи используйте HTTP-запрос с методом POST. Параметры запроса передаются в его теле в формате JSON:
POST /v2/fields/categories
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
"name": {
"en": "Название на английском языке",
"ru": "Название на русском языке"
},
"description": "Текстовое описание",
"order": 400
}
Заголовки
-
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 для бизнеса, используется заголовок
Параметры тела запроса
Обязательные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| name | Название категории:
|
Строка |
| order | Вес поля при отображении в интерфейсе. Поля с меньшим весом отображаются выше полей с большим весом. | Число |
Дополнительные параметры
| Параметр | Описание | Тип данных |
|---|---|---|
| description | Описание категории. | Строка |
Формат ответа
Запрос выполнен успешно
Запрос выполнен с ошибкой
В случае успешного выполнения запроса API возвращает ответ с кодом 201 Created.
Тело ответа содержит информацию об измененном проекте в формате JSON.
{
"id" : "604f9920d23cd5********",
"name" : "category_name",
"self" : "https://api.tracker.yandex.net/v2/fields/categories/604f9920d23cd5********",
"version" : 1
}
Параметры ответа
| Параметр | Описание | Тип данных |
|---|---|---|
| id | Уникальный идентификатор категории. | Строка |
| name | Название категории на русском языке. | Строка |
| self | Адрес ресурса API, который содержит информацию о категории. | Строка |
| version | Версия категории. Каждое изменение поля увеличивает номер версии. | Число |
Если запрос не был успешно обработан, API возвращает ответ с кодом ошибки:
- 400
- Один или несколько параметров запроса имеют недопустимое значение.
- 401
- Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
- 403
- У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
- 404
- Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
- 422
- Ошибка валидации JSON, запрос отклонен.
- 500
- Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
- 503
- Сервис API временно недоступен.