Problems API - POST close a problem
Closes the specified problem and adds the closing comment.
The request consumes and produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
POST |
|
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 | ClosingComment |
The JSON body of the request. Contains the closing comment on the problem. |
body | optional |
Body format
The ClosingComment object
The closing comment on a problem.
Element | Type | Description | Required |
---|---|---|---|
message | string |
The text of the closing comment. |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"message": "string"
}
Response
Response codes
Code | Description |
---|---|
200 | Success |
204 | The problem is closed already the request hasn't been executed. |
Response body
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. |
problemId | string | The ID of the problem. |
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": 0,
"closing": true,
"problemId": "string",
"comment": {
"createdAtTimestamp": 0,
"authorName": "string",
"context": "string",
"id": "string",
"content": "string"
}
}