POST /api/tickets/{TicketID}/comments

Adds a comment to the specified ticket.

Note: If you are using markdown, and will be incorporating one or more artifacts in your comment, you must upload the artifacts first. Run the POST /api/boards/items/comments/artifacts operation to upload the first artifact and the POST /api/boards/items/comments/{CommentID}/artifacts operation to upload any subsequent artifacts. Use the values from the responses, such as the BoardItemID and the image paths, to construct the payload for adding the comment.

Authorization Roles/Permissions: Must be logged in. Must be an authorized user for the resource the ticket relates to.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/tickets/{TicketID}/comments

Sample Request

The example below shows a comment added to the specified ticket.

Sample Request URL 

https://{hostname}/api/tickets/ticket25687.acmepaymentscorp/comments

Sample request headers 

POST /api/tickets/ticket25687.acmepaymentscorp/comments HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body 

{
  "Content":"FYI I've also experienced the same problem. Really glad you are getting it fixed.",
  "UserID":"b302bcd5-23cb-4e13-9135-68a7a88e729e.acmepaymentscorp"
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json or application/xml

application/vnd.soa.v71+json or application/vnd.soa.v71+xml

application/vnd.soa.v72+json or application/vnd.soa.v72+xml

application/vnd.soa.v80+json or application/vnd.soa.v80+xml

application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter Parm Type Data Type Required Description
TicketID Path string Required The unique ID for a specific ticket.
Comment Body Comment Required Contains information about a comment on a Board item such as a ticket, discussion, or alert.

Response

If successful, this operation returns HTTP status code 200, with the CommentID in the response.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers 

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Fri, 15 May 2015 15:55:31 GMT

Sample response body 

ce792717-9e6e-4de9-8f39-0e7175581289

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Response Body

Name Type Description
CommentID string The unique CommentID assigned to the comment that was added.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.