Problems API v2 - POST close a problem

Closes the specified problem and adds the closing comment.

The request consumes and produces an application/json payload.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/problems/{problemId}/close Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close

Authentication

To execute this request, you need the Write problems (problems.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
problemId	string	The ID of the required problem.	path	required
body	ProblemCloseRequestDtoImpl	The JSON body of the request. Contains the closing comment on the problem.	body	optional

Body format

Request parametersJSON model

The ProblemCloseRequestDtoImpl object

Element	Type	Description	Required
message	string	The text of the closing comment.	required

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

      {
  "message": "string"
}

Response

Response codes

Code	Description
200	Success
204	The problem is closed already the request hasn't been executed.

Response body

Response parametersJSON model

The ProblemCloseResult object

The result of closing a problem.

Element	Type	Description
closeTimestamp	integer	The timestamp when the user triggered the closing.
problemId	string	The ID of the problem.
closing	boolean	True, if the problem is being closed.
comment	Comment

The Comment object

The comment to a problem.

Element	Type	Description
createdAtTimestamp	integer	The timestamp of comment creation, in UTC milliseconds.
authorName	string	The user who wrote the comment.
context	string	The context of the comment.
id	string	The ID of the comment.
content	string	The text of the comment.

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