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

Parameter
Type
Description
In
Required
problemId
string

The ID of the problem to be closed.

path
required
content
string

The closing comment.

query
required

Response

Response codes

Code
Type
Description
200

Success

4XX

Client side error.

5XX

Server side error.

Response body objects

The ProblemCloseResult object

The result of closing a problem.

Element
Type
Description
closeTimestamp
integer

The timestamp when the closure was triggered.

closing
boolean

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

comment

The comment to the problem.

problemId
string

The ID of the problem.

The ProblemComment object

The comment to the problem.

Element
Type
Description
content
string

The text of the comment.

context
string

The context of the comment.

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

createdAtTimestamp
integer

The timestamp of the comment creation, in UTC milliseconds.

id
string

The ID of the comment.

userName
string

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"
}

Related topics