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: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned. 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/items/{BoardItemID}/details

Back to top

Sample Request

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

Request URL

https://{hostname}/api/boards/items/discussion11451.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/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

Back to top

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.

Back to top

Response

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

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: 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"
    } ]
  }
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Expires: Mon, 23 Feb 2015 16:14:08 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DiscussionDetails xmlns="http://soa.com/xsd/discussion/1.0" xmlns:ns2="http://soa.com/xsd/user/1.0" 
xmlns:ns3="http://soa.com/xsd/comment/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns5="http://soa.com/xsd/board/1.0" xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns7="http://soa.com/xsd/review/1.0" xmlns:ns8="http://soa.com/xsd/ticket/1.0" 
xmlns:ns9="http://soa.com/xsd/api/1.0" xmlns:ns10="http://soa.com/xsd/app/1.0" 
xmlns:ns11="http://soa.com/xsd/alert/1.0" xmlns:ns12="http://soa.com/xsd/contract/1.0" 
xmlns:ns13="http://soa.com/xsd/rss/1.0">
  <ns5:Type>Discussion</ns5:Type>
  <ns5:ItemID>discussion11451.acmepaymentscorp</ns5:ItemID>
  <ns5:State>Published</ns5:State>
  <Discussion>
    <DiscussionID>discussion11451.acmepaymentscorp</DiscussionID>
    <DiscussionSubjectID>supportboard.acmepaymentscorp</DiscussionSubjectID>
    <Topic>Extended Support hours</Topic>
    <Content>We are considering extending Support hours. Comments welcome.</Content>
    <ns2:UserID>ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp</ns2:UserID>
    <ns2:UserName>adminacmepaymentscorp</ns2:UserName>
    <Created>2015-02-23T19:06:19Z</Created>
    <Comments>1</Comments>
    <Marks>2</Marks>
    <Visibility>Public</Visibility>
    <PubDate>2015-02-23T19:16:48Z</PubDate>
    <ns4:AuthoringUser>
      <ns4:UserID>ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp</ns4:UserID>
      <ns4:Name>adminacmepaymentscorp</ns4:Name>
      <ns4:Image>
        <ns4:Url>http://{hostname}/api/users/ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp/avatar</ns4:Url>
        <ns4:Title>adminacmepaymentscorp</ns4:Title>
      </ns4:Image>
    </ns4:AuthoringUser>
    <ns4:Image>
      <ns4:Url>http://{hostname}/api/users/ebaf377c-a14b-43d2-9114-8d27d56e5379.acmepaymentscorp/avatar</ns4:Url>
    </ns4:Image>
    <Published>true</Published>
  </Discussion>
  <ns4:TargetResources>
    <ns4:TargetResource>
      <ns4:Name>Support</ns4:Name>
      <ns4:ID>supportboard.acmepaymentscorp</ns4:ID>
      <ns4:Type>board</ns4:Type>
    </ns4:TargetResource>
  </ns4:TargetResources>
</DiscussionDetails>

Back to top

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

Back to top

Response Body

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

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