POST /api/discussions/{DiscussionID}/comments

Adds a comment to the specified discussion.

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 Registered site user, and must be an authorized user of the resource that the discussion relates to.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/discussions/{DiscussionID}/comments

Back to top

Sample Request

The example below shows a comment on the specified discussion.

Request URL

https://{hostname}/api/discussions/discussion25786.acmepaymentscorp/comments?userId=2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp

Sample request headers

POST /api/discussions/discussion25786.acmepaymentscorp/comments?userId=2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "Content":"Content":"Awesome! extending to 9pm PST would be great for us since we are in Hawaii.",
  "UserID":"434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp"
}

Back to top

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, application/vnd.soa.v71+json, application/vnd.soa.v72+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

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

Back to top

Response

If successful, this operation returns HTTP status code 200, with the unique CommentID for the new comment.

Back to top

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, 20 Feb 2015 15:23:24 GMT

Sample response body

3a7e2509-0474-4938-8bcd-2aee1d9ecae1

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
CommentID string The unique ID for a specific comment.

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics