GET все комментарии: различия между версиями
Материал из Dynatrace
ENetrebin (обсуждение | вклад) (Новая страница: «Список всех комментариев по указанной проблеме. Запрос создает <code>application/json</code>полезну...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |GET | ||
| | |Managed | ||
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments</nowiki></code> | |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments</nowiki></code> | ||
|- | |- | ||
| | |Среда АктивногоШлюза | ||
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments</nowiki></code> | |<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments</nowiki></code> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( <code>problems.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( <code>problems.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 22: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
! | !Необходимость | ||
|- | |- | ||
| | |problemId | ||
| | |string | ||
|ID требуемой проблемы. | |ID требуемой проблемы. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |nextPageKey | ||
| | |string | ||
|Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. | |Курсор для следующей страницы результатов. Вы можете найти его в поле nextPageKey предыдущего ответа. | ||
| Строка 38: | Строка 35: | ||
Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса, кроме параметра необязательных полей . | Когда nextPageKey настроен на получение последующих страниц, вы должны опустить все остальные параметры запроса, кроме параметра необязательных полей . | ||
| | |query | ||
|по желанию | |по желанию | ||
|- | |- | ||
| | |pageSize | ||
| | |integer | ||
|Количество комментариев в полезной нагрузке одного ответа. | |Количество комментариев в полезной нагрузке одного ответа. | ||
| Строка 48: | Строка 45: | ||
Если не установлено, используется 10. | Если не установлено, используется 10. | ||
| | |query | ||
|по желанию | |по желанию | ||
|} | |} | ||
| Строка 61: | Строка 58: | ||
|- | |- | ||
|200 | |200 | ||
| | |CommentsList | ||
|Успех | |Успех | ||
|} | |} | ||
| Строка 67: | Строка 64: | ||
=== Объекты тела ответа === | === Объекты тела ответа === | ||
==== Объект | ==== Объект <code>CommentsList</code> ==== | ||
Список комментариев. | Список комментариев. | ||
{| class="wikitable" | {| class="wikitable" | ||
| Строка 74: | Строка 71: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |comments | ||
| | |Comment[] | ||
|Записи результатов. | |Записи результатов. | ||
|- | |- | ||
| | |pageSize | ||
| | |integer | ||
|Количество записей на странице. | |Количество записей на странице. | ||
|- | |- | ||
| | |nextPageKey | ||
| | |string | ||
|Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице. | |Курсор для следующей страницы результатов. Имеет значение <code>null</code>на последней странице. | ||
Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. | Используйте его в параметре запроса nextPageKey для получения последующих страниц результата. | ||
|- | |- | ||
| | |totalCount | ||
| | |integer | ||
|Общее количество записей в результате. | |Общее количество записей в результате. | ||
|} | |} | ||
==== Объект | ==== Объект <code>Comment</code> ==== | ||
Комментарий к проблеме. | Комментарий к проблеме. | ||
{| class="wikitable" | {| class="wikitable" | ||
| Строка 100: | Строка 97: | ||
!Описание | !Описание | ||
|- | |- | ||
| | |authorName | ||
| | |string | ||
|Пользователь, написавший комментарий. | |Пользователь, написавший комментарий. | ||
|- | |- | ||
|createdAtTimestamp | |createdAtTimestamp | ||
| | |integer | ||
|Отметка времени создания комментария в миллисекундах UTC. | |Отметка времени создания комментария в миллисекундах UTC. | ||
|- | |- | ||
| | |context | ||
| | |string | ||
|Контекст комментария. | |Контекст комментария. | ||
|- | |- | ||
| | |id | ||
| | |string | ||
|Идентификатор комментария. | |Идентификатор комментария. | ||
|- | |- | ||
| | |content | ||
| | |string | ||
|Текст комментария. | |Текст комментария. | ||
|} | |} | ||
Текущая версия на 07:51, 17 октября 2022
Список всех комментариев по указанной проблеме.
Запрос создает application/jsonполезную нагрузку.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments
|
| Среда АктивногоШлюза | 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
}
