GET /api/boards/{BoardID}/board

Returns Board items for the specified Board, in the form of a JSON or XML object.

Note: There are two operations with essentially the same signature that return the same data in different formats, depending on the Accept header you use. GET /api/boards/{BoardID}/board with JSON or XML headers returns an RSS feed, and GET /api/boards/{BoardID}/board (this operation) with vendor-specific JSON or XML headers returns the information in the form of a JSON or XML object.

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
URL
Sample Request
Request Headers
Request Parameters

Response
Sample Response
Response Headers
Response Body
Error Codes/Messages

HTTP Method

GET

URL

https://{hostname}/api/boards/{BoardID}/board

Sample Request

The example below shows a request for the Support Board for the specified tenant.

Sample Request URL

https://{hostname}/api/boards/supportboard.acmepaymentscorp/board

Sample request headers

Accept: application/vnd.soa.v72+json

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	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.

Header

Description

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

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
BoardID	Path	string	Required	The unique ID for a specific user-defined board.
ItemType	Query	string[ ]	Optional	A filtering parameter, specifying one or more board item (forum entry) types to be returned, such as an alert, discussion, or ticket. For valid values, see Board Item Types.
ItemID	Query	string	Optional	The unique ID for a specific forum entry. If specified, results are limited to information relating to that item ID. If not specified, no filter is applied.
Tag	Query	string[	Optional	A user-defined tag. If specified, results are limited to board items relating to that tag. If not specified, no filter is applied.
IncludeComments	Query	boolean	Optional	Indicates whether comments should be included in the information returned. Default: true. If set to false, comments are excluded.
NumberOfComments	Query	integer	Optional	The number of comments to be returned (if IncludeComments is not set to false). Default value: 2.
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.
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, all matching results are returned.
SortBy	Query	string	Optional	An optional parameter allowing users to sort results by a specific value; for example, com.soa.sort.order.updated sorts with the most updated entries first. For valid values, see Sort By Values. If not specified, items are returned in the sort order of DescendingDate, which means that the most recent items are first.
RetrievingUserID	Query	string	Optional	The unique UserID of the user performing a specific action.
IncludeSelfAuthored	Query	string	Optional	Indicates whether resources authored by the requestor should be included. Default: true.
PublishedState	Query	string	Optional	Indicates that only resources in a specific state should be returned. Valid values: published or unpublished. Default: published, indicating that only resources that have been published are returned.

Response

If successful, this operation returns HTTP status code 200, with the requested Board items.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/vnd.soa.v72+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+json
Expires: Fri, 27 Mar 2015 20:06:42 GMT

Sample response body: application/vnd.soa.v72+json

{
  "BoardItem" : [ {
    "BoardItemID" : "discussion11784.acmepaymentscorp",
    "Title" : "Extended Support hours",
    "Description" : "We are considering extending our technical support hours. Gathering data on which times would be best.",
    "Author" : "2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp",
    "PubDate" : "2015-03-28T01:05:15Z",
    "CreatedDts" : "2015-03-28T01:05:15Z",
    "Archivable" : true,
    "ResourceID" : [ "supportboard.acmepaymentscorp" ],
    "Type" : "Discussion",
    "MarkCount" : 0,
    "IsMarked" : false,
    "CommentCount" : 0,
    "Tag" : [ "extend", "hours", "support" ],
    "Visibility" : "Public",
    "CommentsAllowed" : true,
    "State" : "com.soa.board.item.open",
    "AuthoringUser" : {
      "UserID" : "2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp",
      "Name" : "adminacmepaymentscorp",
      "Image" : {
        "Url" : "http://{hostname}/api/users/2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp/avatar",
        "Title" : "adminacmepaymentscorp",
        "Link" : "#/users/2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp/details"
      }
    },
    "TargetResources" : {
      "TargetResource" : [ {
        "Name" : "Support",
        "ID" : "supportboard.acmepaymentscorp",
        "Type" : "board",
        "Image" : {
        }
      } ]
    },
    "CommentsPreview" : {
      "Count" : 0,
      "Comment" : [ ]
    },
    "Published" : true
  } ]
}

Response Headers

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

Header	Description
Content-Type	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