ENetrebin (обсуждение | вклад) Нет описания правки |
Нет описания правки |
||
| (не показаны 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 Комментарии] / PUT комментарий''''' | |||
Обновляет указанный комментарий к проблеме. | Обновляет указанный комментарий к проблеме. | ||
| Строка 4: | Строка 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan="2" |PUT | | rowspan="2" |PUT | ||
| | |АппОптима | ||
|<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> | ||
|- | |- | ||
| Строка 12: | Строка 14: | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись проблем ( <code>problems.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись проблем ( <code>problems.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 63: | Строка 65: | ||
=== JSON-модель тела запроса === | === JSON-модель тела запроса === | ||
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе. | ||
< | <{ | ||
"message": "string", | "message": "string", | ||
"context": "string" | "context": "string" | ||
} | } | ||
== Ответ == | == Ответ == | ||
Текущая версия от 16:20, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Проблемы v2 / Комментарии / PUT комментарий
Обновляет указанный комментарий к проблеме.
Запрос потребляет application/jsonполезную нагрузку.
| PUT | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/comments/{commentId}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись проблем ( problems.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| problemId | string | ID требуемой проблемы. | path | требуется |
| commentId | string | ID требуемого комментария. | path | требуется |
| body | CommentRequestDtoImpl | Тело JSON запроса. Содержит обновленный комментарий. | body | по желанию |
Объекты тела запроса
Объект CommentRequestDtoImpl
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| message | string | Текст комментария. | требуется |
| context | string | Контекст комментария. | по желанию |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"message": "string",
"context": "string"
}
Ответ
Коды ответов
| Код | Описание |
|---|---|
| 204 | Успех. Комментарий обновлен. |