PUT комментарий: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) |
ENetrebin (обсуждение | вклад) |
||
| Строка 12: | Строка 12: | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись проблем ( <code>problems.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация . | Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Запись проблем ( <code>problems.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
Текущая версия на 08:13, 17 октября 2022
Обновляет указанный комментарий к проблеме.
Запрос потребляет application/jsonполезную нагрузку.
| PUT | Managed | 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 | Успех. Комментарий обновлен. |