GET все комментарии: различия между версиями

Текущая версия от 08:51, 26 декабря 2024

Список всех комментариев по указанной проблеме.

Запрос создает application/jsonполезную нагрузку.

GET	АппОптима	`https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments`
GET	Среда АктивногоШлюза	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments`

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( problems.read) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр	Тип	Описание	In	Необходимость
problemId	string	ID требуемой проблемы.	path	требуется
nextPageKey	string	Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey . Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса, кроме параметра необязательных полей .	query	по желанию
pageSize	integer	Количество комментариев в полезной нагрузке одного ответа. Максимально допустимый размер страницы – 500. Если не установлено, используется 10.	query	по желанию

Ответ

Коды ответов

Код	Тип	Описание
200	CommentsList	Успех

Объекты тела ответа

Объект `CommentsList`

Список комментариев.

Элемент	Тип	Описание
comments	Comment[]	Записи результатов.
pageSize	integer	Количество записей на странице.
nextPageKey	string	Курсор для следующей страницы результатов. Имеет значение `null`на последней странице. Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.
totalCount	integer	Общее количество записей в результате.

Объект `Comment`

Комментарий к проблеме.

Элемент	Тип	Описание
authorName	string	Пользователь, написавший комментарий.
createdAtTimestamp	integer	Отметка времени создания комментария в миллисекундах UTC.
context	string	Контекст комментария.
id	string	Идентификатор комментария.
content	string	Текст комментария.

JSON-модель тела ответа

<{
  "comments": [
    {
      "authorName": "string",
      "createdAtTimestamp": 1,
      "context": "string",
      "id": "string",
      "content": "string"
    }
  ],
  "pageSize": 1,
  "nextPageKey": "AQAAABQBAAAABQ==",
  "totalCount": 1
}

@@ Строка 4: / Строка 4: @@
 {| class="wikitable"
 | rowspan="2" |GET
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments</nowiki></code>
 |-
@@ Строка 119: / Строка 119: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "comments": [
       {