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

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

Материал из Документация АппОптима
(Новая страница: «Размещает комментарий к указанной проблеме. Запрос создает <code>application/json</code>полезную на...»)
 
Нет описания правки
 
(не показана 1 промежуточная версия 1 участника)
Строка 3: Строка 3:
Запрос создает <code>application/json</code>полезную нагрузку.
Запрос создает <code>application/json</code>полезную нагрузку.
{| class="wikitable"
{| class="wikitable"
| rowspan="3" |ПОЧТА
| rowspan="2" |POST
|Удалось
|АппОптима
|<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>
|-
|-
|SaaS
|Cреда АктивногоШлюза
|<code><nowiki>https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/comments</nowiki></code>
|-
|Окружающая среда ActiveGate
|<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.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Чтобы выполнить этот запрос, вам нужен токен доступа с областью Write problems ( <code>problems.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] .


== Параметры ==
== Параметры ==
Строка 22: Строка 19:
!Тип
!Тип
!Описание
!Описание
!В
!In
!Необходимый
!Необходимый
|-
|-
|идентификатор проблемы
|problemId
|нить
|string
|ID требуемой проблемы.
|ID требуемой проблемы.
|дорожка
|path
|требуется
|требуется
|-
|-
|тело
|body
|Запрос комментария Dto Impl
|CommentRequestDtoImpl
|Тело JSON запроса. Содержит добавляемый комментарий.
|Тело JSON запроса. Содержит добавляемый комментарий.
|тело
|body
|по желанию
|по желанию
|}
|}
Строка 40: Строка 37:
=== Объекты тела запроса ===
=== Объекты тела запроса ===


==== Объект _ <code>CommentRequestDtoImpl</code> ====
==== Объект <code>CommentRequestDtoImpl</code> ====
{| class="wikitable"
{| class="wikitable"
!Элемент
!Элемент
!Тип
!Тип
!Описание
!Описание
!Необходимый
!Необходимость
|-
|-
|сообщение
|message
|нить
|string
|Текст комментария.
|Текст комментария.
|требуется
|требуется
|-
|-
|контекст
|context
|нить
|string
|Контекст комментария.
|Контекст комментария.
|по желанию
|по желанию
Строка 60: Строка 57:
=== JSON-модель тела запроса ===
=== JSON-модель тела запроса ===
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
  <code>{
  <{
   "message": "string",
   "message": "string",
   "context": "string"
   "context": "string"

Текущая версия от 14:40, 25 декабря 2024

Размещает комментарий к указанной проблеме.

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

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

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

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

Параметры

Параметр Тип Описание In Необходимый
problemId string ID требуемой проблемы. path требуется
body CommentRequestDtoImpl Тело JSON запроса. Содержит добавляемый комментарий. body по желанию

Объекты тела запроса

Объект CommentRequestDtoImpl

Элемент Тип Описание Необходимость
message string Текст комментария. требуется
context string Контекст комментария. по желанию

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

<{
  "message": "string",
  "context": "string"
}

Ответ

Коды ответов

Код Описание
201 Успех. Комментарий добавлен.