Параметры ответа

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

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

  • Глобальные пользовательские поля, созданные в организации.
  • Локальные поля, специфичные для конкретной очереди.

При получении информации о задаче API возвращает следующие поля:

Параметр

Описание

Тип данных

access

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

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

affectedVersions

Версии, перечисленные в поле "Обнаружено в версиях".

JSON-массив

aliases

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

Массив строк

assignee

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

Объект

attachments

Список вложенных файлов. Отображается в ответе, если указан параметр запроса expand=attachments

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

boards

Массив объектов с информацией о досках, на которых расположена задача

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

checklistDone

Количество выполненных пунктов чеклиста

Число

checklistItems

Массив объектов с информацией о пунктах чеклиста

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

checklistTotal

Количество пунктов чеклиста

Число

comments

Комментарии к задаче. Отображается в ответе, если указан параметр запроса expand=comments

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

commentWithExternalMessageCount

Количество комментариев с внешними сообщениями

Целое число

commentWithoutExternalMessageCount

Количество комментариев без внешних сообщений

Целое число

components

Массив объектов с информацией о компонентах очереди, к которым относится задача

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

createdAt

Дата и время создания задачи в формате YYYY-MM-DDThh:mm:ss.sss±hhmm.

Строка

createdBy

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

Объект

deadline

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

Дата

description

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

Строка

emailCc

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

Массив строк

emailCreatedBy

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

Строка

emailFrom

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

Строка

emailTo

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

Массив строк

end

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

Дата

epic

Эпик, к которому относится задача

Объект

estimation

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

Строка

favorite

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

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

Логический

fixVersions

Версии, перечисленные в поле "Исправить в версиях".

JSON-массив

followers

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

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

followingMaillists

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

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

id

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

Строка

key

Ключ задачи

Строка

lastCommentUpdatedAt

Дата и время последнего добавленного комментария в формате YYYY-MM-DDThh:mm:ss.sss±hhmm.

Строка

lastQueue

Очередь, из которой была перенесена задача

Объект

linkedGoals

Основная связанная цель

Объект

links

Список связанных задач. Отображается в ответе, если указан параметр запроса expand=links

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

originalEstimation

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

Строка

parent

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

Объект

pendingReplyFrom

Массив объектов с информацией о сотрудниках, от которых ожидается ответ

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

previousQueue

Очередь, из которой была перенесена задача

Объект

previousStatus

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

Объект

priority

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

Объект

project

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

Объект

qaEngineer

Объект с информацией о QA-инженере

Объект

queue

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

Объект

receivedReplyFor

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

Объект

resolution

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

Объект

resolvedAt

Дата и время перевода задачи в статус «Решена» в формате YYYY-MM-DDThh:mm:ss.sss±hhmm.

Строка

resolvedBy

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

Объект

self

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

Строка

sla

Информация о правилах SLA

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

spent

Значение параметра "Затрачено времени".

Строка

sprint

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

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

start

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

Дата

status

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

Объект

statusStartTime

Дата и время последнего изменения статуса задачи в формате YYYY-MM-DDThh:mm:ss.sss±hhmm.

Строка

statusType

Тип статуса задачи

Объект

storyPoints

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

Число

summary

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

Строка

tags

Теги задачи

Массив строк

transitions

Список доступных переходов в другие статусы. Отображается в ответе, если указан параметр запроса expand=transitions

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

type

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

Объект

unique

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

Строка

updatedAt

Дата и время последнего изменения задачи в формате YYYY-MM-DDThh:mm:ss.sss±hhmm.

Строка

updatedBy

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

Объект

version

Версия задачи. Каждое изменение параметров задачи увеличивает номер версии.
Редактирование задачи будет заблокировано, если версия достигнет предельного значения: для роботов 10100, для пользователей 11100.

Число

votedBy

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

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

voters

Пользователи, проголосовавшие за задачу

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

votes

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

Число

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

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

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

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

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

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

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

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

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

Параметры status и previousStatus содержат информацию о статусе задачи.

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

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

Параметр queue содержит информацию об очереди задачи.

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

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

Параметр parent содержит информацию о родительской задаче.

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

Параметр links содержит информацию о связях задачи.

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о связи Строка
id Идентификатор связи Число
type Блок с информацией о типе связи Объект
direction Тип связи задачи, указанной в запросе, по отношению к задаче в поле object. Возможны следующие значения:
  • outward — задача, указанная в запросе, является основной для задачи в поле object.
  • inward — задача в поле object является основной для задачи, указанной в запросе.
Строка
object Блок с информацией о связанной задаче Объект
createdBy Блок с информацией о создателе связи Объект
updatedBy Блок с информацией о последнем изменившем связанную задачу пользователе. Объект
createdAt Дата и время создания связи Строка
updatedAt Дата и время изменения связи Строка
assignee Исполнитель связанной задачи Объект
status Статус связанной задачи Объект

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

Параметр project содержит информацию о проектах, к которым относится задача.

Параметр Описание Тип данных
primary Основной проект задачи Объект
secondary Список дополнительных проектов задачи Массив объектов

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

Поля объекта, содержащего данные проекта

Параметры primary и secondary содержат объекты со следующими полями:

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

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

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

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

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

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

Параметр attachments содержит информацию о прикрепленных файлах.

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о файле Строка
id Идентификатор файла Строка
name Имя файла Строка
content Адрес для скачивания файла Строка
thumbnail Адрес для скачивания миниатюры (для изображений) Строка
createdBy Объект с информацией о пользователе, загрузившем файл Объект
createdAt Дата и время загрузки файла Строка
mimetype Тип файла Строка
size Размер файла в байтах Число

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

Параметр comments содержит информацию о комментариях к задаче.

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

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

Параметр sla содержит информацию о правилах SLA.

Параметр Описание Тип данных
self Адрес ресурса API Строка
id Идентификатор правила SLA Число
key Ключ правила SLA Строка
name Название правила SLA Строка
status Статус выполнения правила SLA Строка

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

Параметр Описание Тип данных
id Идентификатор пункта чеклиста. Строка
text Текст пункта чеклиста. Строка
textHtml Текст пункта чеклиста в формате HTML. Строка
checked Признак выполнения пункта чеклиста:
  • true — пункт отмечен как выполненный;
  • false — пункт не отмечен как выполненный.
Логический
assignee Исполнитель пункта чеклиста. Объект
deadline Крайний срок исполнения пункта чеклиста. Объект
checklistItemType Тип пункта чеклиста. Строка

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

Параметр access содержит информацию о правах доступа к задаче.

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

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

Параметр Описание Тип данных
id Идентификатор доски Строка
name Название доски Строка

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

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

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

Параметр components содержит информацию о компонентах очереди.

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

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

Параметр resolution содержит информацию о резолюции задачи.

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

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

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

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

Параметр Описание Тип данных
id Идентификатор типа статуса Число
display Отображаемое название статуса Строка
key Технический ключ статуса (например, "inProgress", "open", "resolved", "paused"). Строка