Открыть меню
Открыть персональное меню
Вы не представились системе
Your IP address will be publicly visible if you make any edits.

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

Материал из Документация АппОптима
(Новая страница: «Получает указанный комментарий к проблеме. Запрос создает <code>application/json</code>полезную наг...»)
 
Нет описания правки
 
(не показаны 2 промежуточные версии 2 участников)
Строка 1: Строка 1:
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A1%D0%B5%D0%BB%D0%B5%D0%BA%D1%82%D0%BE%D1%80%20%D0%BE%D0%B1%D1%8A%D0%B5%D0%BA%D1%82%D0%BE%D0%B2-,%D0%9F%D1%80%D0%BE%D0%B1%D0%BB%D0%B5%D0%BC%D1%8B%20v2,-JSON%2D%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8 Проблемы v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=JSON%2D%D0%BC%D0%BE%D0%B4%D0%B5%D0%BB%D0%B8-,%D0%9A%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B8,-GET%20%D0%B2%D1%81%D0%B5%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B8 Комментарии] / GET комментарий'''''
Получает указанный комментарий к проблеме.
Получает указанный комментарий к проблеме.


Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЛУЧИТЬ
| rowspan="2" |GET
|Удалось
|АппОптима
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}</nowiki></code>
|<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}</nowiki></code>
|-
|-
|SaaS
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/comments/{commentId}</nowiki></code>
|-
|Окружающая среда ActiveGate
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}</nowiki></code>
|<code><nowiki>https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}</nowiki></code>
|}
|}


== Аутентификация ==
== Аутентификация ==
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( <code>problems.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам нужен токен доступа с областью чтения проблем ( <code>problems.read</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 22: Строка 21:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимость
|-
|-
|идентификатор проблемы
|problemId
|нить
|string
|ID требуемой проблемы.
|ID требуемой проблемы.
|дорожка
|path
|требуется
|требуется
|-
|-
|идентификатор комментария
|commentId
|нить
|string
|ID требуемого комментария.
|ID требуемого комментария.
|дорожка
|path
|требуется
|требуется
|}
|}
Строка 47: Строка 46:
|-
|-
|200
|200
|Комментарий
|Comment
|Успех
|Успех
|}
|}
Строка 53: Строка 52:
=== Объекты тела ответа ===
=== Объекты тела ответа ===


==== Объект _ <code>Comment</code> ====
==== Объект <code>Comment</code> ====
Комментарий к проблеме.
Комментарий к проблеме.
{| class="wikitable"
{| class="wikitable"
Строка 60: Строка 59:
!Описание
!Описание
|-
|-
|имя автора
|authorName
|нить
|string
|Пользователь, написавший комментарий.
|Пользователь, написавший комментарий.
|-
|-
|createdAtTimestamp
|createdAtTimestamp
|целое число
|integer
|Отметка времени создания комментария в миллисекундах UTC.
|Отметка времени создания комментария в миллисекундах UTC.
|-
|-
|контекст
|context
|нить
|string
|Контекст комментария.
|Контекст комментария.
|-
|-
|я бы
|id
|нить
|string
|Идентификатор комментария.
|Идентификатор комментария.
|-
|-
|содержание
|content
|нить
|string
|Текст комментария.
|Текст комментария.
|}
|}


=== JSON-модель тела ответа ===
=== JSON-модель тела ответа ===
  <code>{
  <{
   "authorName": "string",
   "authorName": "string",
   "createdAtTimestamp": 1,
   "createdAtTimestamp": 1,
Строка 88: Строка 87:
   "id": "string",
   "id": "string",
   "content": "string"
   "content": "string"
  }</code>
  }

Текущая версия от 16:20, 2 января 2025

API АппОптима / Эндпойнты среды / Развёртывание / Проблемы v2 / Комментарии / GET комментарий

Получает указанный комментарий к проблеме.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимость
problemId string ID требуемой проблемы. path требуется
commentId string ID требуемого комментария. path требуется

Ответ

Коды ответов

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

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

Объект Comment

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

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

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

<{
  "authorName": "string",
  "createdAtTimestamp": 1,
  "context": "string",
  "id": "string",
  "content": "string"
}