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

На этой странице приведен список стандартных параметров задачи, которые доступны по умолчанию в Трекер, а также описание стандартных объектов, которые могут содержаться в задаче.

Помимо стандартных параметров, в задаче могут содержаться:

При создании или редактировании задачи вы можете использовать следующие параметры в теле запроса:

При импорте задач можно указать значения параметров, которые недоступны при создании и редактировании задач. Импорт задач и поддерживаемые параметры описаны на странице Импортировать задачу.

Параметр

Описание

Тип данных

access

Массив с идентификаторами или логинами пользователей, перечисленных в поле «Доступ»

Массив строк или чисел

affectedVersions

Идентификаторы версий, перечисленные в поле «Найдено в версиях». Версии должны существовать в очереди

Массив чисел

assignee

Логин или идентификатор исполнителя задачи

Число или строка

attachmentIds

Идентификаторы временных файлов, которые будут прикреплены к описанию задачи

Массив строк

boards

Идентификаторы досок задач, на которые нужно добавить задачу

Массив чисел

components

Имена или идентификаторы компоненты очереди, которые добавлены в задачу

Массив строк или чисел

createdBy

Логин или идентификатор автора задачи

Число или строка

deadline

Дедлайн задачи в формате YYYY-MM-DD

Дата

description

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

Строка

descriptionAttachmentIds

Идентификаторы временных файлов, которые будут добавлены в описание задачи

Массив строк

emailCc

Адреса получателей копии письма

Массив строк

emailCreatedBy

Адрес, от имени которого было создано письмо

Строка

emailFrom

Адрес отправителя письма

Строка

emailTo

Адреса получателей письма

Строка

end

Дата завершения работы над задачей в формате YYYY-MM-DD

Дата

epic

Ключ или идентификатор эпика, к которому относится задача

Строка

estimation

Оценка в рабочих днях, часах или минутах. Формат: <число><единица>, например 1d, 2h, 30m

Строка

fixVersions

Идентификаторы версий, перечисленные в поле «Исправить в версиях». Версии должны существовать в очереди

Массив чисел

followers

Массив с идентификаторами или логинами наблюдателей задачи

Массив чисел или строк

linkedGoals

Идентификатор цели или объект со списком связанных целей. Если указан идентификатор цели, она станет основной целью задачи.

Объект, число или строка

markupType

Тип отображаемой в тексте разметки. Если вы используете в тексте описания задачи разметку YFM, укажите значение md

Строка

originalEstimation

Первоначальная оценка в рабочих днях, часах или минутах. Формат: <число><единица>, например 1d, 2h, 30m

Строка

parent

Ключ или идентификатор родительской задачи

Строка

pendingReplyFrom

Логины или идентификаторы пользователей, от которых ожидается ответ

Массив чисел или строк

possibleSpam

Признак того, что задача создана на основе письма, которое является спамом

Логическое значение

priority

Ключ или идентификатор приоритета задачи

Строка или число

project

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

Объект

qaEngineer

Логин или идентификатор QA-инженера

Число или строка

receivedReplyFor

Логин или идентификатор пользователя, для которого получен ответ

Число или строка

sprint

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

Число

start

Дата начала работы над задачей в формате YYYY-MM-DD

Дата

storyPoints

Оценка задачи в Story Points

Число

summary

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

Строка

tags

Теги задачи

Массив строк

type

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

Строка или число

unique

Опциональное поле, значение которого должно быть уникально в пределах Трекера организации. Такое значение можно использовать, чтобы предотвратить создание дубликатов задач, например с помощью триггера. При повторной попытке создать задачу с тем же значением параметра дубликат создан не будет, а ответ будет содержать ошибку с кодом 409

Строка

Объекты в параметрах задачи

Объекты с данными пользователей

Параметры assignee, createdBy, followers, pendingReplyFrom и voters содержат информацию о пользователях.

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о пользователе. Строка
id Идентификатор пользователя. Строка
display Отображаемое имя пользователя. Строка
passportUid Уникальный идентификатор аккаунта пользователя в организации Яндекс 360 для бизнеса и Яндекс ID. Число
cloudUid Уникальный идентификатор пользователя в Yandex Cloud Organization. Строка

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

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

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

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

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

Параметр Описание Тип данных
primary Идентификатор основного проекта задачи (поле проекта shortId) Число
secondary Идентификаторы дополнительных проектов задачи (поле проекта shortId) Массив чисел

Если в адресе запроса указана версия API v2, параметр project может содержать только идентификатор основного проекта.

Например: "project": 1234

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

Параметр Описание Тип данных
primary Идентификатор основной связанной цели Число или строка
secondary Идентификаторы дополнительных целей задачи Массив чисел или строк

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

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

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

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

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

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

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

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