Связаться с намиПодключиться

Импортировать комментарии

Статья создана
Обновлена 26 августа 2024 г.

Важно

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

С помощью запроса вы можете импортировать в Tracker комментарии к задаче.

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

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

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

{
  "text": "Test",
  "createdAt": "2017-08-29T12:34:41.740+0000",
  "createdBy": 11********
}
Заголовки

  • Host

    Адрес узла, предоставляющего API:

    api.tracker.yandex.net

  • Authorization

    OAuth-токен в формате OAuth <OAuth-токен>, например:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID или X-Cloud-Org-ID

    Идентификатор организации. Узнать его можно на странице организаций Tracker.

    • Если к Tracker привязана только организация Яндекс 360 для бизнеса, используется заголовок X-Org-ID.
    • Если к Tracker привязана только организация Yandex Cloud Organization, используется заголовок X-Cloud-Org-ID.
    • Если к Tracker одновременно привязаны организации Яндекс 360 для бизнеса и Yandex Cloud Organization, используется заголовок X-Org-ID и идентификатор организации Яндекс 360 для бизнеса.
Ресурс
Параметр Описание Тип данных
<ключ_или_идентификатор_задачи> Ключ задачи, к которой будет прикреплен файл. Строка
Параметры тела запроса

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

Параметр Описание Тип данных
text Текст комментария, не более 512000 символов. Строка
createdAt Дата и время создания комментария в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать любое значение в интервале времени от создания до последнего обновления задачи. Строка
createdBy Логин или идентификатор автора комментария.
  • Строка для логина
  • Число для идентификатора

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

Параметр Описание Тип данных
updatedAt Дата и время последнего изменения комментария в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Вы можете указать любое значение в интервале времени от создания до последнего обновления задачи.

Параметр указывается только вместе с параметром updatedBy.		 Строка
updatedBy Логин или идентификатор пользователя, который редактировал комментарий последним.

Параметр указывается только вместе с параметром updatedAt.
  • Строка для логина
  • Число для идентификатора

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

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

Тело ответа содержит параметры прикрепленного файла в формате JSON:

{
        "self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/comments/9849****",
        "id": 9849****,
        "longId" : "5fa15a24ac894475********",
        "text": "Комментарий",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v2/users/11********",
            "id": "11********",
            "display": "Иван Иванов"
        },
        "createdAt": "2017-06-11T05:11:12.347+0000",
        "updatedAt": "2017-06-11T05:11:12.347+0000",
        "version": 1,
        "type" : "standard",
        "transport" : "internal"   
}
Параметры ответа
Параметр Описание Тип данных
self Ссылка на объект комментария Строка
id Идентификатор комментария Число
longId Идентификатор комментария в виде строки Строка
text Текст комментария. Строка
createdBy Объект с информацией о создателе комментария. Объект
updatedBy Объект с информацией о сотруднике, внесшем последнее изменение в комментарий. Объект
createdAt Дата и время создания комментария в формате:
YYYY-MM-DDThh:mm:ss.sss±hhmm		 Строка
updatedAt Дата и время обновления комментария.
YYYY-MM-DDThh:mm:ss.sss±hhmm		 Строка
version Версия комментария. Каждое изменение комментария увеличивает номер версии. Число
type Тип комментария:
  • standart — отправлен через интерфейс Tracker;
  • incoming — создан из входящего письма;
  • outcoming — создан из исходящего письма.
 Строка
transport Способ добавления комментария:
  • internal — через интерфейс Tracker;
  • email — через письмо.
 Строка

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

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

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

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

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.
Предыдущая
Импортировать файлы
Следующая
Импортировать связи