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

Returns details about a specific Board item, excluding comments. Valid for all board types.

Used, when a user performs an action on a board item, to refresh the board item without refreshing the entire page.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned. 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}/details

Sample Request

The example below shows a request for the details about a discussion on the Support Board.

Sample Request URL

https://{hostname}/api/boards/items/discussion11451.acmepaymentscorp/details

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

Response

If successful, this operation returns HTTP status code 200, with the Board item details.

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: Mon, 23 Feb 2015 16:13:13 GMT

Sample response body: application/json

{
  "Type" : "Discussion",
  "ItemID" : "discussion11451.acmepaymentscorp",
  "State" : "Published",
  "Discussion" : {
    "DiscussionID" : "discussion11451.acmepaymentscorp",
    "DiscussionSubjectID" : "supportboard.acmepaymentscorp",
    "Topic" : "Extended Support hours",
    "Content" : "We are considering extending Support hours. Comments welcome.",
    "UserID" : "ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp",
    "UserName" : "adminacmepaymentscorp",
    "Created" : "2015-02-23T19:06:19Z",
    "Comments" : 1,
    "Marks" : 2,
    "Visibility" : "Public",
    "PubDate" : "2015-02-23T19:16:48Z",
    "AuthoringUser" : {
      "UserID" : "ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp",
      "Name" : "adminacmepaymentscorp",
      "Image" : {
        "Url" : "http://{hostname}/api/users/ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp/avatar",
        "Title" : "adminacmepaymentscorp"
      }
    },
    "Image" : {
      "Url" : "http://{hostname}/api/users/ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp/avatar"
    },
    "Published" : true
  },
  "TargetResources" : {
    "TargetResource" : [ {
      "Name" : "Support",
      "ID" : "supportboard.acmepaymentscorp",
      "Type" : "board"
    } ]
  }
}

Response Headers

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

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

Response Body

Name	Type	Description
AbstractBoardItemDetails	AbstractBoardItemDetails	Contains details about a board item.

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.

Related Topics