Импортировать комментарии
Запрос может быть выполнен только если у пользователя есть право на изменение задачи, в которую импортируется комментарий.
С помощью запроса вы можете импортировать в Трекер комментарии к задаче.
Формат запроса
Чтобы импортировать комментарий, используйте HTTP-запрос с методом POST
. Параметры комментария передаются в теле запроса в формате JSON:
POST /v2/issues/<issue_id>/comments/_import
Host: https://api.tracker.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Content-Type: application/json
{
"text": "Test",
"createdAt": "2017-08-29T12:34:41.740+0000",
"createdBy": 1110000000011111,
"updatedAt": "2017-09-07T11:24:31.140+0000",
"updatedBy": 1110000000011111
}
- <issue_id>
-
Ключ задачи, к которой будет прикреплен комментарий.
- Host
-
Адрес узла, предоставляющего API:
https://api.tracker.yandex.net
- Authorization
-
OAuth-токен в формате
OAuth <значение токена>
, например:OAuth 0c4181a7c2cf4521964a72ff57a34a07
- X-Org-ID
-
Идентификатор организации.
- Content-Type
-
Формат тела запроса. Должен иметь значение
application/json
. Строка для логина
Число для идентификатора
Строка для логина
Число для идентификатора
Строка для логина
Число для идентификатора
Строка для логина
Число для идентификатора
Тело запроса содержит параметры комментария:
Параметр | Описание | Тип данных |
---|---|---|
text | Текст комментария, не более 512000 символов. | Строка |
createdAt | Дата и время создания комментария в формате | Строка |
createdBy | Логин или идентификатор автора комментария. | |
updatedAt | Дата и время последнего изменения комментария в формате Параметр указывается только вместе с параметром | Строка |
updatedBy | Логин или идентификатор пользователя, который редактировал комментарий последним. Параметр указывается только вместе с параметром | |
Параметр | Описание | Тип данных |
---|---|---|
text | Текст комментария, не более 512000 символов. | Строка |
createdAt | Дата и время создания комментария в формате | Строка |
createdBy | Логин или идентификатор автора комментария. | |
updatedAt | Дата и время последнего изменения комментария в формате Параметр указывается только вместе с параметром | Строка |
updatedBy | Логин или идентификатор пользователя, который редактировал комментарий последним. Параметр указывается только вместе с параметром | |
Формат ответа
В случае успешного выполнения запроса API возвращает ответ с кодом 201. Тело запроса содержит информацию о импортированной задаче в формате JSON.
{
"self": "https://api.tracker.yandex.net/v2/issues/JUNE-2/comments/9849018",
"id": 9849018,
"longId" : "5fa15a24ac894475dd14ff07",
"text": "Комментарий",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
"id": "<id сотрудника>",
"display": "<отображаемое имя сотрудника>"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000049224",
"id": "<id сотрудника>",
"display": "<отображаемое имя сотрудника>"
},
"createdAt": "2017-06-11T05:11:12.347+0000",
"updatedAt": "2017-06-11T05:11:12.347+0000",
"version": 1,
"type" : "standard",
"transport" : "internal"
}
- standart — отправлен через интерфейс Трекера;
- incoming — создан из входящего письма;
- outcoming — создан из исходящего письма.
- internal — через интерфейс Трекера;
- email — через письмо.
- standart — отправлен через интерфейс Трекера;
- incoming — создан из входящего письма;
- outcoming — создан из исходящего письма.
- internal — через интерфейс Трекера;
- email — через письмо.
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на объект комментария | Строка. |
id | Идентификатор комментария | Число. |
longId | Идентификатор комментария в виде строки | Строка. |
text | Текст комментария. | Строка. |
createdBy | Объект с информацией о создателе комментария. | Объект. |
updatedBy | Объект с информацией о сотруднике, внесшем последнее изменение в комментарий. | Объект. |
createdAt | Дата и время создания комментария в формате: | Строка. |
updatedAt | Дата и время обновления комментария. | Строка. |
version | Версия комментария. Каждое изменение комментария увеличивает номер версии. | Число. |
type | Тип комментария: | Строка. |
transport | Способ добавления комментария: | Строка. |
Поля объекта createdBy | ||
self | Ссылка на пользователя Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Поля объекта updatedBy | ||
self | Ссылка на пользователя Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Параметр | Описание | Тип данных |
---|---|---|
self | Ссылка на объект комментария | Строка. |
id | Идентификатор комментария | Число. |
longId | Идентификатор комментария в виде строки | Строка. |
text | Текст комментария. | Строка. |
createdBy | Объект с информацией о создателе комментария. | Объект. |
updatedBy | Объект с информацией о сотруднике, внесшем последнее изменение в комментарий. | Объект. |
createdAt | Дата и время создания комментария в формате: | Строка. |
updatedAt | Дата и время обновления комментария. | Строка. |
version | Версия комментария. Каждое изменение комментария увеличивает номер версии. | Число. |
type | Тип комментария: | Строка. |
transport | Способ добавления комментария: | Строка. |
Поля объекта createdBy | ||
self | Ссылка на пользователя Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Поля объекта updatedBy | ||
self | Ссылка на пользователя Трекера. | Строка. |
id | Идентификатор пользователя. | Строка. |
display | Отображаемое имя пользователя. | Строка. |
Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
422 Unprocessable Entity | Ошибка валидации JSON, запрос отклонен. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |
HTTP-код ошибки | Описание ошибки |
---|---|
400 Bad Request | Один из параметров запроса имеет недопустимое значение или формат данных. |
403 Forbidden | У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен. |
404 Not Found | Запрашиваемый ресурс не найден. |
422 Unprocessable Entity | Ошибка валидации JSON, запрос отклонен. |
500 Internal Server Error | Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время. |
503 Service Unavailable | Сервис API временно недоступен. |