POST закрытие проблемы: различия между версиями

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

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

Закрывает указанную проблему и добавляет закрывающий комментарий.

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

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

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

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

Параметры

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

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

Объект `ProblemCloseRequestDtoImpl`

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

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

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

<{
  "message": "string"
}

Ответ

Коды ответов

Код	Тип	Описание
200	ProblemCloseResult	Успех
204		Проблема уже закрыта, запрос не выполнен.

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

Объект `ProblemCloseResult`

Результат закрытия проблемы.

Элемент	Тип	Описание
closeTimestamp	integer	Отметка времени, когда пользователь инициировал закрытие.
problemId	string	Идентификатор проблемы.
closing	boolean	Правда, если проблема закрывается.
comment	Comment	Комментарий к проблеме.

Объект `Comment`

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

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

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

<{
  "closeTimestamp": 1,
  "problemId": "string",
  "closing": true,
  "comment": {
    "authorName": "string",
    "createdAtTimestamp": 1,
    "context": "string",
    "id": "string",
    "content": "string"
  }
}

@@ Строка 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=DELETE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9-,%D0%9F%D1%80%D0%BE%D0%B1%D0%BB%D0%B5%D0%BC%D1%8B,-GET%20%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA Проблемы] / POST закрытие проблемы'''''
 Закрывает указанную проблему и добавляет закрывающий комментарий.
@@ Строка 4: / Строка 6: @@
 {| class="wikitable"
 | rowspan="2" |POST
-|Managed
+|АппОптима
 |<code><nowiki>https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close</nowiki></code>
 |-
@@ Строка 52: / Строка 54: @@
 === JSON-модель тела запроса ===
 Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
-  <code>{
+  <{
     "message": "string"
-  }</code>
+  }
 == Ответ ==
@@ Строка 128: / Строка 130: @@
 === JSON-модель тела ответа ===
-  <code>{
+  <{
     "closeTimestamp": 1,
     "problemId": "string",
@@ Строка 139: / Строка 141: @@
       "content": "string"
     }
-  }</code>
+  }