Закрывает указанную проблему и добавляет закрывающий комментарий.
Запрос потребляет и создает application/jsonполезную нагрузку.
| POST | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close
|
| 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"
}
}