GET все комментарии

Материал из Документация Ключ-АСТРОМ
Версия от 16:08, 14 октября 2022; ENetrebin (обсуждение | вклад) (Новая страница: «Список всех комментариев по указанной проблеме. Запрос создает <code>application/json</code>полезну...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

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

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

ПОЛУЧИТЬ Удалось https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments
SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/comments
Окружающая среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments

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

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

Параметры

Параметр Тип Описание В Необходимый
идентификатор проблемы нить ID требуемой проблемы. дорожка требуется
ключ следующей страницы нить Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа.

Первая страница всегда возвращается, если вы не укажете параметр запроса nextPageKey .

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

запрос по желанию
размер страницы целое число Количество комментариев в полезной нагрузке одного ответа.

Максимально допустимый размер страницы – 500.

Если не установлено, используется 10.

запрос по желанию

Ответ

Коды ответов

Код Тип Описание
200 Список комментариев Успех

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

Объект _ CommentsList

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

Элемент Тип Описание
Комментарии Комментарий [] Записи результатов.
размер страницы целое число Количество записей на странице.
ключ следующей страницы нить Курсор для следующей страницы результатов. Имеет значение nullна последней странице.

Используйте его в параметре запроса nextPageKey для получения последующих страниц результата.

общее количество целое число Общее количество записей в результате.

Объект _ Comment

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

Элемент Тип Описание
имя автора нить Пользователь, написавший комментарий.
createdAtTimestamp целое число Отметка времени создания комментария в миллисекундах UTC.
контекст нить Контекст комментария.
я бы нить Идентификатор комментария.
содержание нить Текст комментария.

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

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