POST /api/boards/items/{BoardItemID}/comments

Adds a comment to the specified Board item.

Note: If the platform settings support the use of markdown in comments, and you want to include an artifact, you must first run the POST /api/boards/items/comments/artifacts operation to upload the artifact. The BoardItemID is returned in the response. Then, run this operation to save the comment with the artifact.

Authorization Roles/Permissions: Must be logged in. Must be a user logged in to the platform, with visibility of the Board. For more information about how authorization and visibility work for Board operations, see Boards in the Community Manager developer portal.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/boards/items/{BoardItemID}/comments

Sample Request

The examples below show comments on board items.

Sample Request URL

https://{hostname}/api/boards/items/4077d933-34ae-4d0c-b0ef-790f67695cf0.acmepaymentscorp/comments

Sample request headers

POST http://{hostname}/api/boards/items/4077d933-34ae-4d0c-b0ef-790f67695cf0.acmepaymentscorp/comments HTTP/1.0
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: no markdown, no artifacts

{
  "Content":"Awesome idea!",
  "UserID":"c3274638-70fe-4522-bad2-8fa7ba8b6264.acmepaymentscorp",
  "BoardItemArtifacts":{
    "BoardItemArtifact":[
    ]
  },
  "MediaType":"text/plain"
}

Sample request body: markdown, one artifact

{
  "Content":"Here's a PDF with conference information: \n[conference_notes.pdf](conference_notes.pdf \"conference_notes.pdf\")\n",
  "UserID":"34a8e183-1231-4e58-8c13-7b5416a56e8a.acmepaymentscorp",
  "BoardItemArtifacts":{
    "BoardItemArtifact":[
      {
        "ContextID":"cfa198e3-add7-4403-89f2-0a25de51910b.acmepaymentscorp",
        "FileName":"conference_notes",
        "BaseUri":"http://{hostname}",
        "UriPath":"/api/boards/items/comments/cfa198e3-add7-4403-89f2-0a25de51910b.acmepaymentscorp/conference_notes.pdf"
      }
    ]
  },
  "MediaType":"text/markdown"
}

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, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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
BoardItemID	Path	string	Required	The unique ID for a specific Board item. Can be any unique ID for a Board item that supports comments: APIID, APIVersionID, AppID, AppVersionID, GroupID, DiscussionID, TicketID, AlertID.
comment	Body	Comment	Required	Contains information about a comment on a Board item such as a ticket, discussion, or alert. Content and UserID are required.

Response

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

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: text/plain
Expires: Thu, 21 May 2015 20:20:12 GMT

Sample response body

11b988fd-0efc-4eda-86b7-361f2814e811

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 ID for 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
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content.For example, you might get this response if you send an incorrect JSON object in the request, or specified the wrong media type in the Content-Type header.
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.

Related Topics