POST комментарий: различия между версиями
Материал из Документация Ключ-АСТРОМ
ENetrebin (обсуждение | вклад) (Новая страница: «Размещает комментарий к указанной проблеме. Запрос создает <code>application/json</code>полезную на...») |
ENetrebin (обсуждение | вклад) |
||
| Строка 3: | Строка 3: | ||
Запрос создает <code>application/json</code>полезную нагрузку. | Запрос создает <code>application/json</code>полезную нагрузку. | ||
{| class="wikitable" | {| class="wikitable" | ||
| rowspan=" | | rowspan="2" |POST | ||
| | |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> | ||
|- | |- | ||
| | |Cреда АктивногоШлюза | ||
|<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> | ||
|} | |} | ||
== Аутентификация == | == Аутентификация == | ||
Чтобы выполнить этот запрос, вам нужен токен доступа с областью | Чтобы выполнить этот запрос, вам нужен токен доступа с областью Write problems ( <code>problems.write</code>) . Чтобы узнать, как его получить и использовать, см. раздел [[Токены и аутентификация (API)|Токены и аутентификация]] . | ||
== Параметры == | == Параметры == | ||
| Строка 22: | Строка 19: | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !In | ||
!Необходимый | !Необходимый | ||
|- | |- | ||
| | |problemId | ||
| | |string | ||
|ID требуемой проблемы. | |ID требуемой проблемы. | ||
| | |path | ||
|требуется | |требуется | ||
|- | |- | ||
| | |body | ||
| | |CommentRequestDtoImpl | ||
|Тело JSON запроса. Содержит добавляемый комментарий. | |Тело JSON запроса. Содержит добавляемый комментарий. | ||
| | |body | ||
|по желанию | |по желанию | ||
|} | |} | ||
| Строка 40: | Строка 37: | ||
=== Объекты тела запроса === | === Объекты тела запроса === | ||
==== Объект | ==== Объект <code>CommentRequestDtoImpl</code> ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
!Элемент | !Элемент | ||
!Тип | !Тип | ||
!Описание | !Описание | ||
! | !Необходимость | ||
|- | |- | ||
| | |message | ||
| | |string | ||
|Текст комментария. | |Текст комментария. | ||
|требуется | |требуется | ||
|- | |- | ||
| | |context | ||
| | |string | ||
|Контекст комментария. | |Контекст комментария. | ||
|по желанию | |по желанию | ||
Текущая версия на 08:04, 17 октября 2022
Размещает комментарий к указанной проблеме.
Запрос создает application/jsonполезную нагрузку.
| POST | Managed | 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 | Успех. Комментарий добавлен. |
