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

Статья создана

Yandex.Cloud

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

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

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

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

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

POST /v2/issues/
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

{
    "summary": "название задачи",
    "queue": {
        "id": "111",
        "key": "test"
        }
}

Заголовки

Host

Адрес узла, предоставляющего API:
```
https://api.tracker.yandex.net
```
Authorization

OAuth-токен в формате OAuth <значение токена>, например:
```
OAuth 0c4181a7c2cf4521964a72ff57a34a07
```
X-Org-ID

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

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

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

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

Параметр	Описание	Тип данных
summary	Название задачи.	Строка
queue	Очередь, в которой нужно создать задачу.	Может задаваться как объект, как строка (если передается ключ очереди), как число (если передается идентификатор очереди).

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

Параметр	Описание	Тип данных
parent	Родительская задача.	Объект или строка.
description	Описание задачи.	Строка
sprint	Блок с информацией о спринтах.	Массив объектов или строк.
type	Тип задачи.	Может задаваться как объект, как строка (если передается ключ типа задачи), как число (если передается идентификатор типа задачи).
priority	Приоритет задачи.	Может задаваться как объект, как строка (если передается ключ приоритета), как число (если передается идентификатор приоритета).
followers	Идентификаторы или логины наблюдателей задачи.	Массив объектов или строк.
assignee	Идентификатор или логин исполнителя задачи.	Массив объектов или строк.
unique	Поле с уникальным значением, позволяющее предотвратить создание дубликатов задач. При повторной попытке создать задачу с тем же значением данного параметра дубликат создан не будет, а ответ будет содержать ошибку с кодом 409.	Строка
attachmentIds	Список идентификаторов вложений.	Массив строк

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

Параметр	Описание	Тип данных
id	Идентификатор очереди.	Строка
key	Ключ очереди.	Строка

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

Параметр	Описание	Тип данных
id	Идентификатор родительской задачи.	Строка
key	Ключ родительской задачи.	Строка

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

Параметр	Описание	Тип данных
id	Идентификатор типа задачи.	Строка
key	Ключ типа задачи.	Строка

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

Параметр	Описание	Тип данных
id	Идентификатор приоритета.	Строка
key	Ключ приоритета.	Строка

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

Параметр	Описание	Тип данных
id	Идентификатор сотрудника.	Строка

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

Параметр	Описание	Тип данных
id	Идентификатор сотрудника.	Строка

Пример: Создать задачу

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

Создается задача с названием Test Issue в очереди с ключом TREK.

Новая задача является подзадачей JUNE-2.

Тип создаваемой задачи – Ошибка.

Исполнитель задачи – <user_login>
POST /v2/issues/ HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID: <идентификатор организации>

{
    "queue": "TREK",
    "summary": "Test Issue",
    "parent":"JUNE-2",
    "type": "bug",
    "assignee": "<user_login>",
    "attachmentIds": [55, 56]
}

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

Запрос выполнен успешно

Запрос выполнен с ошибкой

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

Тело запроса содержит информацию о созданной задаче в формате 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	Адрес ресурса API, который содержит информацию о задаче.	Строка
id	Идентификатор задачи.	Строка
key	Ключ задачи.	Строка
display	Отображаемое название задачи.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка

Поля объектов массива sprint

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о спринте.	Строка
id	Идентификатор спринта.	Строка
display	Отображаемое название спринта.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о типе задаче.	Строка
id	Идентификатор типа задачи.	Строка
key	Ключ типа задачи.	Строка
display	Отображаемое название типа задачи.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о приоритете.	Строка
id	Идентификатор приоритета.	Строка
key	Ключ приоритета.	Строка
display	Отображаемое название приоритета.	Строка

Поля объектов массива followers

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о пользователе.	Строка
id	Идентификатор пользователя.	Строка
display	Отображаемое имя пользователя.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию об очереди.	Строка
id	Идентификатор очереди.	Строка
key	Ключ очереди.	Строка
display	Отображаемое название очереди.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о статусе.	Строка
id	Идентификатор статуса.	Строка
key	Ключ статуса.	Строка
display	Отображаемое название статуса.	Строка

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

Параметр	Описание	Тип данных
self	Адрес ресурса API, который содержит информацию о статусе.	Строка
id	Идентификатор статуса.	Строка
key	Ключ статуса.	Строка
display	Отображаемое название статуса.	Строка

404: Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.

409: При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.

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

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

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

Была ли статья полезна?