Problems API - POST close

This API is deprecated. Use the Problems API v2 instead.

Closes the specified problem and adds the closing comment.

The request consumes and produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/problem/details/{problemId}/close
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/problem/details/{problemId}/close

Authentication

To execute this request, you need an access token with DataExport scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
problemIdstring

The ID of the problem to be closed.

pathrequired
contentstring

The closing comment.

queryrequired

Response

Response codes

CodeTypeDescription
200ProblemCloseResult

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ProblemCloseResult object

The result of closing a problem.

ElementTypeDescription
closeTimestampinteger

The timestamp when the closure was triggered.

closingboolean

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

commentProblemComment

The comment to the problem.

problemIdstring

The ID of the problem.

The ProblemComment object

The comment to the problem.

ElementTypeDescription
contentstring

The text of the comment.

contextstring

The context of the comment.

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

createdAtTimestampinteger

The timestamp of the comment creation, in UTC milliseconds.

idstring

The ID of the comment.

userNamestring

The author of the comment.

Response body JSON model

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