Редактировать задачу

Запрос позволяет внести изменения в задачу.
Ограничение. Статус задачи может быть изменен только с помощью запроса «Выполнить переход в статус».
  1. Формат запроса
  2. Формат ответа

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

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

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

PATCH /v2/issues/<issue-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>
{
   Тело запроса в формате JSON
}
Параметры запроса
Параметр Описание Тип данных
Ресурс
<issue-id> Идентификатор или ключ задачи. Число/Строка.
Дополнительные параметры
version Версия задачи. Изменения вносятся только в текущую версию задачи. Число.
Параметр Описание Тип данных
Ресурс
<issue-id> Идентификатор или ключ задачи. Число/Строка.
Дополнительные параметры
version Версия задачи. Изменения вносятся только в текущую версию задачи. Число.
Параметры тела запроса
Параметр Описание Тип данных
Дополнительные параметры
summary

Название задачи.

 Строка.
parent

Родительская задача.

Объект или строка.
description

Описание задачи.

 Строка.
sprint

Блок с информацией о спринтах.

Массив объектов или строк.
type

Тип задачи.

Объект, строка (если передается ключ типа задачи) или число (если передается идентификатор типа задачи).
priority

Приоритет задачи.

 Объект, строка (если передается ключ приоритета) или число (если передается идентификатор приоритета).
followers

Идентификаторы или логины наблюдателей задачи.

Массив объектов или строк.
Поля объекта parent
id Идентификатор родительской задачи. Строка.
key Ключ родительской задачи. Строка.
Поля объекта sprint
id Идентификатор спринта. Информацию о спринте можно получить при помощи запроса. Число.
Поля объекта type
id Идентификатор типа задачи. Строка.
key Ключ типа задачи. Строка.
Поля объекта priority
id Идентификатор приоритета. Строка.
key Ключ приоритета. Строка.
Поля объекта followers
id Идентификатор сотрудника. Строка.
Параметр Описание Тип данных
Дополнительные параметры
summary

Название задачи.

 Строка.
parent

Родительская задача.

Объект или строка.
description

Описание задачи.

 Строка.
sprint

Блок с информацией о спринтах.

Массив объектов или строк.
type

Тип задачи.

Объект, строка (если передается ключ типа задачи) или число (если передается идентификатор типа задачи).
priority

Приоритет задачи.

 Объект, строка (если передается ключ приоритета) или число (если передается идентификатор приоритета).
followers

Идентификаторы или логины наблюдателей задачи.

Массив объектов или строк.
Поля объекта parent
id Идентификатор родительской задачи. Строка.
key Ключ родительской задачи. Строка.
Поля объекта sprint
id Идентификатор спринта. Информацию о спринте можно получить при помощи запроса. Число.
Поля объекта type
id Идентификатор типа задачи. Строка.
key Ключ типа задачи. Строка.
Поля объекта priority
id Идентификатор приоритета. Строка.
key Ключ приоритета. Строка.
Поля объекта followers
id Идентификатор сотрудника. Строка.
Формат тела запроса

В теле запроса передается JSON-объект с идентификаторами изменяемых полей задачи и их значениями.

  • Чтобы добавить или удалить значение из массива, используйте команды add и remove:
    • {
    "followers": { "add": ["<id сотрудника1>", "<id сотрудника2>"] }
}
Примечание. Команда add добавляет новые значения в массив. Чтобы перезаписать массив (удалить старые значения и добавить новые), используйте команду set.
  • Чтобы обнулить значение поля, укажите значение null. Чтобы обнулить массив, используйте пустой массив []. Отдельные значения в массиве можно изменить с помощью команд target и replacement:
    • {"followers": null}
    • {
  "followers": {
    "replace": [
        {"target": "<идентификатор1>", "replacement": "<идентификатор2>"},
        {"target": "<идентификатор3>", "replacement": "<идентификатор4>"}]
  }
}
  • Например, чтобы изменить тип задачи на «Ошибка», используйте один из способов:
    • {"type": 1}
    • {"type": "bug"}
    • {
    "type": { "id": "1" }
}
    • {
    "type": { "name": "Ошибка" }
}
    • {   
    "type": {"set": "bug"}
}

Пример 1: Изменить название, описание, тип и приоритет задачи.

  • Используется HTTP-метод PATCH.

  • Редактируется задача TEST-1.
  • Новый тип задачи: «Ошибка».
  • Новый приоритет задачи: «Низкий».
PATCH /v2/issues/TEST-1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

{
    "summary": "Новое название задачи",
    "description": "Новое описание задачи",    
    "type": {
        "id": "1",
        "key": "bug"
        },
    "priority": {
        "id": "2",
        "key": "minor"
        }
}

Пример 2: Изменить родительскую задачу, добавить в спринты, добавить наблюдателей.

  • Используется HTTP-метод PATCH.

  • Редактируется задача TEST-1.
  • Новая родительская задача: TEST-2.
  • Задача добавляется в спринты с идентификаторами 3 и 2. Спринты должны быть на разных досках.
  • Добавлены наблюдатели с логинами userlogin-1 и userlogin-2.
PATCH /v2/issues/TEST-1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-Id: <идентификатор организации>

{
    "parent": {
        "key": "TEST-2"},  
    "sprint": [{"id": "3"}, {"id": "2"}],
    "followers": {
        "add": ["userlogin-1", "userlogin-2"]
        }
}

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

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

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

{
    "self": "https://api.tracker.yandex.net/v2/issues/TREK-9844",
    "id": "593cd211ef7e8a332414f2a7",
    "key": "TREK-9844",
    "version": 7,
    "lastCommentUpdatedAt": "2017-07-18T13:33:44.291+0000",
    "summary": "subtask",
    "parent": {
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2",
        "id": "593cd0acef7e8a332414f28e",
        "key": "JUNE-2",
        "display": "Task"
        },
    "aliases": [
            "JUNE-3"
        ],

    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        },
    "description": "<#<html><head></head><body><div>test</div><div>&nbsp;</div><div>&nbsp;</div> </body></html>#>",    
    "sprint": [
            {
        "self": "https://api.tracker.yandex.net/v2/sprints/5317",
        "id": "5317",
        "display": "спринт1"
            }
        ],
    "type": {
        "self": "https://api.tracker.yandex.net/v2/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Задача"
        },
    "priority": {
        "self": "https://api.tracker.yandex.net/v2/priorities/2",
        "id": "2",
        "key": "normal",
        "display": "Средний"
        },

    "createdAt": "2017-06-11T05:16:01.339+0000",
    "followers": [
        {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000016876",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        }
        ],
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        },
    "votes": 0,
    "assignee": {
        "self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
        "id": "<id сотрудника>",
        "display": "<отображаемое имя сотрудника>"
        },
    "queue": {
        "self": "https://api.tracker.yandex.net/v2/queues/TREK",
        "id": "111",
        "key": "TREK",
        "display": "Трек"
        },
    "updatedAt": "2017-07-18T13:33:44.291+0000",
    "status": {
        "self": "https://api.tracker.yandex.net/v2/statuses/1",
        "id": "1",
        "key": "open",
        "display": "Открыт"
        },
    "previousStatus": {
        "self": "https://api.tracker.yandex.net/v2/statuses/2",
        "id": "2",
        "key": "resolved",
        "display": "Решен"
        },
    "favorite": false
}
Параметры ответа
Параметр Описание Тип данных
self

Адрес ресурса API, который содержит информацию о задаче.

 Строка.
id

Идентификатор задачи.

 Строка.
key

Ключ задачи.

 Строка
version

Версия задачи. Каждое изменение параметров задачи увеличивает номер версии.

 Число.
lastCommentUpdatedAt

Дата и время последнего добавленного комментария.

 Строка.
summary

Название задачи.

 Строка.
parent

Объект с информацией о родительской задаче.

 Объект.
aliases

Массив с информацией об альтернативных ключах задачи.

 Массив строк.
updatedBy

Объект с информацией о последнем сотруднике, изменявшим задачу.

 Объект.
description

Описание задачи.

 Строка.
sprint

Массив объектов с информацией о спринте.

 Массив объектов.
type

Объект с информацией о типе задачи.

 Объект.
priority

Объект с информацией о приоритете.

 Объект.
createdAt

Дата и время создания задачи.

 Строка.
followers

Массив объектов с информацией о наблюдателях задачи.

 Массив объектов.
createdBy

Объект с информацией о создателе задачи.

 Объект.
votes

Количество голосов за задачу.

 Число.
assignee

Объект с информацией об исполнителе задачи.

 Объект.
queue

Объект с информацией об очереди задачи.

 Объект.
updatedAt

Дата и время последнего обновления задачи.

 Строка.
status

Объект с информацией о статусе задачи.

 Объект.
previousStatus

Объект с информацией о предыдущем статусе задачи.

 Объект.
favorite

Признак избранной задачи:

  • true — пользователь добавил задачу в избранное;

  • false — задача не добавлена в избранное.

 Логический.
Поля объекта parent
self

Ссылка на задачу.

Строка.
id

Идентификатор задачи.

Строка.
key

Ключ задачи.

Строка.
display

Отображаемое название задачи.

Строка.
Поля объекта updatedBy
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объектов массива sprint
self

Ссылка на спринт.

Строка.
id

Идентификатор спринта.

Строка.
display

Отображаемое название спринта.

Строка.
Поля объекта type
self

Ссылка на тип задачи.

Строка.
id

Идентификатор типа задачи.

Строка.
key

Ключ типа задачи.

Строка.
display

Отображаемое название типа задачи.

Строка.
Поля объекта priority
self

Ссылка на тип приоритета.

Строка.
id

Идентификатор приоритета.

Строка.
key

Ключ приоритета.

Строка.
display

Отображаемое название приоритета.

Строка.
Поля объектов массива followers
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объекта createdBy
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объекта assignee
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объекта queue
self

Ссылка на очередь.

Строка.
id

Идентификатор очереди.

Строка.
key

Ключ очереди.

Строка.
display

Отображаемое название очереди.

Строка.
Поля объекта status
self

Ссылка на статус.

Строка.
id

Идентификатор статуса.

Строка.
key

Ключ статуса.

Строка.
display

Отображаемое название статуса.

Строка.
Поля объекта previousStatus
self

Ссылка на статус.

Строка.
id

Идентификатор статуса.

Строка.
key

Ключ статуса.

Строка.
display

Отображаемое название статуса.

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

Адрес ресурса API, который содержит информацию о задаче.

 Строка.
id

Идентификатор задачи.

 Строка.
key

Ключ задачи.

 Строка
version

Версия задачи. Каждое изменение параметров задачи увеличивает номер версии.

 Число.
lastCommentUpdatedAt

Дата и время последнего добавленного комментария.

 Строка.
summary

Название задачи.

 Строка.
parent

Объект с информацией о родительской задаче.

 Объект.
aliases

Массив с информацией об альтернативных ключах задачи.

 Массив строк.
updatedBy

Объект с информацией о последнем сотруднике, изменявшим задачу.

 Объект.
description

Описание задачи.

 Строка.
sprint

Массив объектов с информацией о спринте.

 Массив объектов.
type

Объект с информацией о типе задачи.

 Объект.
priority

Объект с информацией о приоритете.

 Объект.
createdAt

Дата и время создания задачи.

 Строка.
followers

Массив объектов с информацией о наблюдателях задачи.

 Массив объектов.
createdBy

Объект с информацией о создателе задачи.

 Объект.
votes

Количество голосов за задачу.

 Число.
assignee

Объект с информацией об исполнителе задачи.

 Объект.
queue

Объект с информацией об очереди задачи.

 Объект.
updatedAt

Дата и время последнего обновления задачи.

 Строка.
status

Объект с информацией о статусе задачи.

 Объект.
previousStatus

Объект с информацией о предыдущем статусе задачи.

 Объект.
favorite

Признак избранной задачи:

  • true — пользователь добавил задачу в избранное;

  • false — задача не добавлена в избранное.

 Логический.
Поля объекта parent
self

Ссылка на задачу.

Строка.
id

Идентификатор задачи.

Строка.
key

Ключ задачи.

Строка.
display

Отображаемое название задачи.

Строка.
Поля объекта updatedBy
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объектов массива sprint
self

Ссылка на спринт.

Строка.
id

Идентификатор спринта.

Строка.
display

Отображаемое название спринта.

Строка.
Поля объекта type
self

Ссылка на тип задачи.

Строка.
id

Идентификатор типа задачи.

Строка.
key

Ключ типа задачи.

Строка.
display

Отображаемое название типа задачи.

Строка.
Поля объекта priority
self

Ссылка на тип приоритета.

Строка.
id

Идентификатор приоритета.

Строка.
key

Ключ приоритета.

Строка.
display

Отображаемое название приоритета.

Строка.
Поля объектов массива followers
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объекта createdBy
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объекта assignee
self

Ссылка на пользователя Трекера.

Строка.
id

Идентификатор пользователя.

Строка.
display

Отображаемое имя пользователя.

Строка.
Поля объекта queue
self

Ссылка на очередь.

Строка.
id

Идентификатор очереди.

Строка.
key

Ключ очереди.

Строка.
display

Отображаемое название очереди.

Строка.
Поля объекта status
self

Ссылка на статус.

Строка.
id

Идентификатор статуса.

Строка.
key

Ключ статуса.

Строка.
display

Отображаемое название статуса.

Строка.
Поля объекта previousStatus
self

Ссылка на статус.

Строка.
id

Идентификатор статуса.

Строка.
key

Ключ статуса.

Строка.
display

Отображаемое название статуса.

Строка.