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 | ManagedDynatrace for Government | 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 an access token with problems.write 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 required problem. | path | required |
| body | Problem | The JSON body of the request. Contains the closing comment on the problem. | body | optional |
Request body objects
The ProblemCloseRequestDtoImpl object
| Element | Type | Description | Required |
|---|---|---|---|
| message | string | The text of the closing comment. | required |
Request body JSON model
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 | Type | Description |
|---|---|---|
| 200 | Problem | Success |
| 204 | The problem is closed already the request hasn't been executed. |
Response body objects
The ProblemCloseResult object
The result of closing a problem.
| Element | Type | Description |
|---|---|---|
| closeTimestamp | integer | The timestamp when the user triggered the closing. |
| closing | boolean | True, if the problem is being closed. |
| comment | Comment | The comment to a problem. |
| problemId | string | The ID of the problem. |
The Comment object
The comment to a problem.
| Element | Type | Description |
|---|---|---|
| authorName | string | The user who wrote the comment. |
| content | string | The text of the comment. |
| context | string | The context of the comment. |
| createdAtTimestamp | integer | The timestamp of comment creation, in UTC milliseconds. |
| id | string | The ID of the comment. |
Response body JSON model
{
"closeTimestamp": 1,
"closing": true,
"comment": {
"authorName": "string",
"content": "string",
"context": "string",
"createdAtTimestamp": 1,
"id": "string"
},
"problemId": "string"
}