Создать статус задачи

Запрос позволяет создать новый статус задачи.

POST

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

Для выполнения запроса требуются права администратора.

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

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

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

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

{
    "key": "myStatus",
    "name": {
        "ru": "Мой статус",
        "en": "My status"
    },
    "type": "paused"
}
Заголовки

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

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

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

Тело запроса содержит информацию, необходимую для создания нового статуса:

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

Параметр Описание Тип данных
key Ключ (идентификатор) статуса. Должен состоять из латинских букв и начинаться с маленькой буквы Строка
name Название статуса Объект
type Тип статуса. Допустимые значения:
  • new;
  • inProgress;
  • paused;
  • done;
  • cancelled
 Строка

Поля объекта name

Параметр Описание Тип данных
ru Название статуса на русском Строка
en Название статуса на английском Строка

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

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

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

[
    {
        "self": "https://api.tracker.yandex.net/v3/statuses/29",
        "id": 29,
        "version": 1,
        "key": "pause",
        "name": "On pause",
        "description": "Issue is paused",
        "order": 350,
        "type": "paused"
    }
]
Параметры ответа
Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о типе задачи Строка
id Уникальный идентификатор статуса задачи в Трекере Число
version Версия статуса задачи Число
key Ключ статуса Строка
name Название статуса Строка
description Описание статуса Строка
order Вес статуса. Параметр влияет на порядок отображения статуса в интерфейсе Число
type Тип статуса Строка
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
409
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
Предыдущая
Получить список статусов
Следующая
Редактировать статус задачи