Problems API - POST a comment
Posts a comment on the specified problem.
The request consumes 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 | CommentRequestDtoImpl |
The JSON body of the request. Contains the comment to be added. |
body | optional |
Body format
The CommentRequestDtoImpl object
Element | Type | Description | Required |
---|---|---|---|
message | string |
The text of the comment. |
required |
context | string |
The context of the 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",
"context": "string"
}
Response
Response codes
Code | Description |
---|---|
201 | Success. The comment has been added. |
Response body
A successful request doesn't return any content.