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 developer portal.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

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

Back to top

Sample Request

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

Request URL

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

Sample request headers

Accept: application/vnd.soa.v72+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/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

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.

Back to top

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.

Back to top

Response

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

Back to top

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

Back to top

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

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Fri, 27 Mar 2015 20:07:51 GMT

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BoardItems xmlns="http://soa.com/xsd/board/1.0" xmlns:ns2="http://soa.com/xsd/comment/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0" xmlns:ns5="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns6="http://soa.com/xsd/alert/1.0" xmlns:ns7="http://soa.com/xsd/api/1.0" xmlns:ns8="http://soa.com/xsd/contract/1.0" xmlns:ns9="http://soa.com/xsd/ticket/1.0" xmlns:ns10="http://soa.com/xsd/app/1.0" xmlns:ns11="http://soa.com/xsd/discussion/1.0" xmlns:ns12="http://soa.com/xsd/review/1.0" xmlns:ns13="http://soa.com/xsd/resource/1.0">
  <BoardItem>
    <BoardItemID>discussion11784.acmepaymentscorp</BoardItemID>
    <Title>Extended Support hours</Title>
    <Description>We are considering extending our technical support hours. Gathering data on which times would be best.</Description>
    <Author>2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp</Author>
    <PubDate>2015-03-28T01:05:15Z</PubDate>
    <CreatedDts>2015-03-28T01:05:15Z</CreatedDts>
    <Archivable>true</Archivable>
    <ResourceID>supportboard.acmepaymentscorp</ResourceID>
    <Type>Discussion</Type>
    <MarkCount>0</MarkCount>
    <IsMarked>false</IsMarked>
    <CommentCount>0</CommentCount>
    <Tag>extend</Tag>
    <Tag>hours</Tag>
    <Tag>support</Tag>
    <Visibility>Public</Visibility>
    <CommentsAllowed>true</CommentsAllowed>
    <State>com.soa.board.item.open</State>
    <ns4:AuthoringUser>
      <ns4:UserID>2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp</ns4:UserID>
      <ns4:Name>adminacmepaymentscorp</ns4:Name>
      <ns4:Image>
        <ns4:Url>http://{hostname}/api/users/2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp/avatar</ns4:Url>
        <ns4:Title>adminacmepaymentscorp</ns4:Title>
        <ns4:Link>#/users/2a20e13e-9888-4ed6-969e-c3efa73772af.acmepaymentscorp/details</ns4:Link>
      </ns4:Image>
    </ns4:AuthoringUser>
    <ns4:TargetResources>
      <ns4:TargetResource>
        <ns4:Name>Support</ns4:Name>
        <ns4:ID>supportboard.acmepaymentscorp</ns4:ID>
        <ns4:Type>board</ns4:Type>
        <ns4:Image />
      </ns4:TargetResource>
    </ns4:TargetResources>
    <ns2:CommentsPreview>
      <ns2:Count>0</ns2:Count>
    </ns2:CommentsPreview>
    <Published>true</Published>
  </BoardItem>
</BoardItems>

Back to top

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

Back to top

Response Body

Name Type Description
BoardItems BoardItems Contains information about one or more board items.

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