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

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

POST

https://api.tracker.yandex.net/v3/issues/<id_задачи>/comments/_import

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

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

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

POST /v3/issues/<id_задачи>/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.
Authorization: токен для авторизации в одном из форматов:
- OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее
- Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Трекеру привязана организация Yandex Cloud Organization. Читать подробнее
X-Org-ID или X-Cloud-Org-ID: идентификатор организации.
- Используйте заголовок X-Org-ID, если к Трекеру привязана организация Яндекс 360 для бизнеса.
- Используйте заголовок X-Cloud-Org-ID, если к Трекеру привязана организация Yandex Cloud Organization.
Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Ресурс

Параметр	Описание	Тип данных
<id_задачи>	Ключ задачи, к которой будет прикреплен файл.	Строка

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

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

Параметр	Описание	Тип данных
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/v3/issues/JUNE-2/comments/9849****",
        "id": 9849****,
        "longId" : "5fa15a24ac894475********",
        "text": "Комментарий",
        "createdBy": {
            "self": "https://api.tracker.yandex.net/v3/users/11********",
            "id": "11********",
            "display": "Имя Фамилия"
        },
        "updatedBy": {
            "self": "https://api.tracker.yandex.net/v3/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 — отправлен через интерфейс Трекера; incoming — создан из входящего письма; outcoming — создан из исходящего письма.	Строка
transport	Способ добавления комментария: internal — через интерфейс Трекера; email — через письмо.	Строка

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

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

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

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

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

400: Один или несколько параметров запроса имеют недопустимое значение.

403: У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Трекера — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.

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

422: Ошибка валидации JSON, запрос отклонен.

500: Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

503: Сервис API временно недоступен.

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

Импортировать файлы

Импортировать связи