GET /api/boards/items/comments/{CommentID}/details

Returns details about the specified Board comment.

Authorization Roles/Permissions: Must be an authorized user for the resource. For more information about how authorization and visibility work for Board operations, see Boards in the developer portal.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/boards/comments/{CommentID}/details

Back to top

Sample Request

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

Request URL

https://{hostname}/api/boards/items/comments/3a7e2509-0474-4938-8bcd-2aee1d9ecae1.acmepaymentscorp/details

Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

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

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
CommentID Path string Required The unique ID for a specific comment.

Back to top

Response

If successful, this operation returns HTTP status code 200, with information about the specified comment.

Back to top

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: Fri, 20 Feb 2015 17:23:38 GMT

Sample response body: application/json

{
  "Comment" : {
    "CommentID" : "3a7e2509-0474-4938-8bcd-2aee1d9ecae1.acmepaymentscorp",
    "CommentSubjectID" : "discussion11572.acmepaymentscorp",
    "Content" : "Awesome! extending to 9pm PST would be great for us since we are in Hawaii.",
    "Created" : "2015-02-20T20:23:24Z",
    "Marks" : 1,
    "UserID" : "434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp",
    "Published" : true,
    "WorkflowState" : "Published"
  },
  "Action" : [ {
    "value" : "comment.action.delete",
    "label" : "comment.action.delete"
  } ]
}

Back to top

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

Back to top

Response Body

Name Type Description
CommentDetail CommentDetail Contains details about a comment on a Board item such as a ticket or discussion, including the comment itself and valid workflow actions.

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

More information about Akana API Platform API error messages.

Back to top

Related Topics