GET /api/boards/items/{BoardItemID}/commentdetails

Returns the list of comments for a specific Board item.

Authorization Roles/Permissions: Must be logged in. Must be an authorized user for the resource. 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

GET

URL

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

Sample Request

The example below shows a request for the comment details for the specified discussion.

Sample Request URL

https://{hostname}/api/boards/items/discussion11712.acmepaymentscorp/commentdetails

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/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. For example, if it is an API board, it is the APIID. For information about how to find a BoardItemID, see Board Item ID.
IncludeActions	Query	boolean	Optional	Indicates whether workflow actions currently valid for the resource should be included in the results. Default: true. For valid workflow actions, see Workflow Actions.
PublishedState	Query	string	Optional	Indicates that only resources in a specific state should be returned. Valid values: published or unpublished. Default: all, indicating that published and unpublished results are returned.
start	Query	integer	Optional	An index number indicating the starting point for the results to be returned. If not specified, results start at position 0, the first result.
count	Query	integer	Optional	The number of results to be returned, from the specified starting point. If not specified, 100 matching results are returned.

Response

If successful, this operation returns HTTP status code 200, with the comments on the specified board item.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Wed, 20 May 2015 19:42:21 GMT

Sample response body: application/json

{
  "totalResults" : 2,
  "startIndex" : 0,
  "CommentDetail" : [ {
    "Comment" : {
      "CommentID" : "039f8888-060b-433d-8b39-fda0e53a7545.acmepaymentscorp",
      "CommentSubjectID" : "discussion11712.acmepaymentscorp",
      "Content" : "Awesome. Some Saturday time would be very helpful for us.",
      "Created" : "2015-02-24T23:00:45Z",
      "Marks" : 1,
      "IsMarked" : false,
      "UserID" : "c51f0547-2e81-45b5-865f-fbebc786ac36.acmepaymentscorp",
      "UserName" : "JonathanSwift",
      "AvatarURL" : "http://acmepaymentscorp/api/users/c51f0547-2e81-45b5-865f-fbebc786ac36.acmepaymentscorp/avatar",
      "Published" : false,
      "WorkflowState" : "Pending"
      "MediaType" : "text/markdown",
      "BoardItemArtifacts" : {
        "BoardItemArtifact" : [ ]
      }
    },
    "Action" : [ {
      "value" : "comment.action.approve",
      "label" : "comment.action.approve"
    }, {
      "value" : "comment.action.delete",
      "label" : "comment.action.delete"
    }, {
      "value" : "comment.action.reject.publish",
      "label" : "comment.action.reject.publish"
    } ]
  }, {
    "Comment" : {
      "CommentID" : "4a6f2809-6499-4fc3-b85d-9e6bac44eedc.acmepaymentscorp",
      "CommentSubjectID" : "discussion11712.acmepaymentscorp",
      "Content" : "Great idea! Support Hawaii business hours please.",
      "Created" : "2015-02-24T22:31:33Z",
      "Marks" : 1,
      "IsMarked" : false,
      "UserID" : "89d50b6a-f4fe-48de-9aea-1ac685d12de3.acmepaymentscorp",
      "UserName" : "JaneMead",
      "AvatarURL" : "http://acmepaymentscorp/api/users/89d50b6a-f4fe-48de-9aea-1ac685d12de3.acmepaymentscorp/avatar",
      "Published" : true,
      "WorkflowState" : "Published",
      "MediaType" : "text/markdown",
      "BoardItemArtifacts" : {
        "BoardItemArtifact" : [ ]
      }
    },
    "Action" : [ {
      "value" : "comment.action.delete",
      "label" : "comment.action.delete"
    } ]
  } ]
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
CommentDetails	CommentDetail	Contains information about comments on a Board item such as a ticket, discussion, or alert.

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 specify an incorrect BoardItemID in the URL.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics