Создать категорию поля задачи

Запрос позволяет создать категорию поля задачи.

POST

https://api.tracker.yandex.net/v3/fields/categories

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

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

Чтобы создать категорию для поля задачи используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON:

POST /v3/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.

  • 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.

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

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

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

Параметр Описание Тип данных
name Название категории:
  • en — на английском языке;
  • ru — на русском языке.
 Строка
order Вес поля при отображении в интерфейсе. Поля с меньшим весом отображаются выше полей с большим весом. Число

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

Параметр Описание Тип данных
description Описание категории. Строка

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

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

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

{
    "id" : "604f9920d23cd5********",
    "name" : "category_name",
    "self": "https://api.tracker.yandex.net/v3/fields/categories/604f9920d23cd5********",
    "version" : 1
}
Параметры ответа
Параметр Описание Тип данных
id Уникальный идентификатор категории. Строка
name Название категории на русском языке. Строка
self Адрес ресурса API, который содержит информацию о категории. Строка
version Версия категории. Каждое изменение поля увеличивает номер версии. Число

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

400
Один или несколько параметров запроса имеют недопустимое значение.
401
Пользователь не авторизован. Проверьте, были ли выполнены действия, описанные в разделе Доступ к API.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Изменить возможные значения поля задачи
Следующая
Создать локальное поле очереди