Problems API - POST close

Closes the specified problem and adds the closing comment.

The request produces an application/json payload.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/problem/details/{problemId}/close
  • SaaS https://{your-environment-id}{problemId}/close


Parameter Type Description In Required
problemId string

The ID of the problem to be closed.

path required
content string

The closing comment.

query optional

Response format

The ProblemCloseResult object

The result of closing a problem.

Element Type Description
problemId string

The ID of the problem.

comment ProblemComment

The closing comment to the problem.

closeTimestamp integer

The timestamp when the closure was triggered.

closing boolean

The problem is in process of closing (true) or closed (false).

The ProblemComment object

The comment to the problem.

Element Type Description
id string

The ID of the comment.

createdAtTimestamp integer

The timestamp of the comment creation, in UTC milliseconds.

content string

The text of the comment.

userName string

The author of the comment.

context string

The context of the comment.

Could be any textual comment. You can only set it via REST API.