GET /api/boards/{BoardID}/board

Returns Board items for the specified user-defined board, in the form of an RSS feed.

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 (this operation) with JSON or XML headers returns an RSS feed, and GET /api/boards/{BoardID}/board with vendor-specific JSON or XML headers returns the information in the form of a JSON or XML object.

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/{BoardID}/board

Back to top

Sample Request

The example below shows a request for the board items for the Support Board, with no additional parameters.

Request URL

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

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/xml, application/json, application/rss+xml

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.

For the Support board, the only valid value is Discussion. For user-defined boards, it depends on the custom implementation.

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 board items for the specified board.

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 15:38:17 GMT

Sample response body: application/json

{
  "channel" : {
    "title" : "Board",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Extended Support hours",
      "description" : "We are considering extending Support hours. Comments welcome.",
      "category" : [ {
        "value" : "DISCUSSION",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "support",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "hours",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:published"
      }, {
        "value" : "com.soa.board.item.open",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "com.soa.discussion.type.comment",
        "domain" : "uddi:soa.com:discussiontype"
      }, {
        "value" : "Published",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "discussion11572.acmepaymentscorp"
      },
      "pubDate" : "2015-02-20T20:34:17.000Z",
      "AuthoringUser" : {
        "ID" : "b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp",
        "Name" : "adminacmepaymentscorp",
        "Image" : {
          "Url" : "http://{hostname}/api/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/avatar",
          "Title" : "adminacmepaymentscorp",
          "Link" : "#/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/avatar",
        "Link" : "#/user/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/details"
      },
      "CreatedDate" : "2015-02-20T20:17:51.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "discussion.action.unpublish",
          "label" : "discussion.action.unpublish"
        }, {
          "value" : "discussion.action.delete",
          "label" : "discussion.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 1,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1,
        "Comment" : [ {
          "CommentID" : "5fe3540c-1e88-4bdb-b170-6d94dc0e327c.acmepaymentscorp",
          "CommentSubjectID" : "discussion11572.acmepaymentscorp",
          "Content" : "Saturday 1-5pm PST would be great for us.",
          "Created" : "2015-02-20T20:34:17Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "2f280dbc-4d60-4ecc-bf67-6908d0f89ad3.acmepaymentscorp",
          "UserName" : "JonathanSwift",
          "AvatarURL" : "http://{hostname}/api/users/2f280dbc-4d60-4ecc-bf67-6908d0f89ad3.acmepaymentscorp/avatar",
          "Published" : false,
          "WorkflowState" : "Pending"
        }, {
          "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,
          "IsMarked" : false,
          "UserID" : "434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp",
          "UserName" : "JaneMead",
          "AvatarURL" : "http://{hostname}/api/users/434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp/avatar",
          "Published" : true
        } ]
      },
      "EntityReference" : {
        "Title" : "Support",
        "Guid" : "supportboard.acmepaymentscorp",
        "Category" : [ {
          "value" : "board",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }
    } ]
  },
  "version" : "1.0"
}

Back to top

Sample response headers: application/xml

Status Code: 200 OK
Content-Type: application/xml
Expires: Fri, 20 Feb 2015 15:42:18 GMT

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/rss/1.0" 
xmlns:ns4="http://soa.com/xsd/user/1.0" xmlns:ns5="http://soa.com/xsd/comment/1.0" 
xmlns:ns6="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns7="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns8="http://soa.com/xsd/resource/1.0" xmlns:ns9="http://soa.com/xsd/legals/1.0" 
xmlns:ns10="http://soa.com/xsd/fault/1.0" xmlns:ns11="http://soa.com/xsd/api/1.0" 
xmlns:ns12="http://soa.com/xsd/board/1.0" xmlns:ns13="http://soa.com/xsd/review/1.0" 
xmlns:ns14="http://soa.com/xsd/ticket/1.0" xmlns:ns15="http://soa.com/xsd/app/1.0" 
xmlns:ns16="http://soa.com/xsd/discussion/1.0" xmlns:ns17="http://soa.com/xsd/alert/1.0" 
xmlns:ns18="http://soa.com/xsd/contract/1.0" xmlns:ns19="http://soa.com/xsd/search/1.0" 
xmlns:ns20="http://soa.com/xsd/workflow/1.0" version="1.0">
  <channel>
    <title>Board</title>
    <ns6:startIndex>0</ns6:startIndex>
    <ns6:itemsPerPage>0</ns6:itemsPerPage>
    <item>
      <title>Extended Support hours</title>
      <description>We are considering extending Support hours. Comments welcome.</description>
      <category domain="uddi:soa.com:resourcetype">DISCUSSION</category>
      <category domain="uddi:soa.com:tag">support</category>
      <category domain="uddi:soa.com:tag">hours</category>
      <category domain="uddi:soa.com:archivable">true</category>
      <category domain="uddi:soa.com:published">true</category>
      <category domain="uddi:soa.com:state">com.soa.board.item.open</category>
      <category domain="uddi:soa.com:discussiontype">com.soa.discussion.type.comment</category>
      <category domain="uddi:soa.com:wfstate">Published</category>
      <guid>discussion11572.acmepaymentscorp</guid>
      <pubDate>2015-02-20T20:34:17.000Z</pubDate>
      <ns3:CreatedDate>2015-02-20T20:17:51.000Z</ns3:CreatedDate>
      <ns3:Marks>
        <Count>1</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns3:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>1</ns5:Count>
        <ns5:Comment>
          <ns5:CommentID>5fe3540c-1e88-4bdb-b170-6d94dc0e327c.acmepaymentscorp</ns5:CommentID>
          <ns5:CommentSubjectID>discussion11572.acmepaymentscorp</ns5:CommentSubjectID>
          <ns5:Content>Saturday 1-5pm PST would be great for us.</ns5:Content>
          <ns5:Created>2015-02-20T20:34:17Z</ns5:Created>
          <ns5:Marks>0</ns5:Marks>
          <ns5:IsMarked>false</ns5:IsMarked>
          <ns4:UserID>2f280dbc-4d60-4ecc-bf67-6908d0f89ad3.acmepaymentscorp</ns4:UserID>
          <ns4:UserName>JonathanSwift</ns4:UserName>
          <ns4:AvatarURL>http://{hostname}/api/users/2f280dbc-4d60-4ecc-bf67-6908d0f89ad3.acmepaymentscorp/avatar</ns4:AvatarURL>
          <ns5:Published>false</ns5:Published>
          <ns5:WorkflowState>Pending</ns5:WorkflowState>
        </ns5:Comment>
        <ns5:Comment>
          <ns5:CommentID>3a7e2509-0474-4938-8bcd-2aee1d9ecae1.acmepaymentscorp</ns5:CommentID>
          <ns5:CommentSubjectID>discussion11572.acmepaymentscorp</ns5:CommentSubjectID>
          <ns5:Content>Awesome! extending to 9pm PST would be great for us since we are in Hawaii.</ns5:Content>
          <ns5:Created>2015-02-20T20:23:24Z</ns5:Created>
          <ns5:Marks>1</ns5:Marks>
          <ns5:IsMarked>false</ns5:IsMarked>
          <ns4:UserID>434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp</ns4:UserID>
          <ns4:UserName>JaneMead</ns4:UserName>
          <ns4:AvatarURL>http://{hostname}/api/users/434d706d-b32e-49a2-bfe7-2bf23e032347.acmepaymentscorp/avatar</ns4:AvatarURL>
          <ns5:Published>true</ns5:Published>
        </ns5:Comment>
      </ns5:CommentsPreview>
      <ns3:AuthoringUser>
        <ID>b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp</ID>
        <Name>adminacmepaymentscorp</Name>
        <ns3:Image>
          <Url>http://{hostname}/api/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/avatar</Url>
          <Title>adminacmepaymentscorp</Title>
          <Link>#/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/details</Link>
        </ns3:Image>
      </ns3:AuthoringUser>
      <ns3:EntityReference>
        <Title>Support</Title>
        <Guid>supportboard.acmepaymentscorp</Guid>
        <ns3:Category domain="uddi:soa.com:resourcetype">board</ns3:Category>
      </ns3:EntityReference>
      <ns3:Image>
        <Url>http://{hostname}/api/users/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/avatar</Url>
        <Link>#/user/b2972b42-7fdc-426d-84cd-344a1e98e010.acmepaymentscorp/details</Link>
      </ns3:Image>
      <ns3:Actions>
        <ns3:Action label="discussion.action.unpublish">discussion.action.unpublish</ns3:Action>
        <ns3:Action label="discussion.action.delete">discussion.action.delete</ns3:Action>
      </ns3:Actions>
    </item>
  </channel>
</rss>

Back to top

Response Headers

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

Header Description
Content-Type application/xml, application/json, application/rss+xml

Back to top

Response Body

The response body is in the form of an RSS channel, and includes the items listed below. The RSS version is 1.0. The title of the RSS Channel is Board, and the channel includes paging values: StartIndex, TotalResults, and ItemsPerPage. Each item in the RSS channel represents a Board item, and includes the information below.

Name Description
title The text title of the Board item.
description Descriptive text for the Board item.
category[ ]

An array of sets of two name/value pairs, each including Value and Domain, with a value for each. For example:

"value" : "false",
"domain" : "uddi:soa.com:archivable"

The example above indicates that the Board item is not archivable.

GUID GUID for the Board item.
pubdate The date/timestamp when the information was generated.
AuthoringUser

Information about the user who authored the Board item, including:

  • ID: the unique UserID
  • Name: The user's name as it appears in the platform
  • Image: Information about the user's image, including URL, Title, and Link
Image Information about the image for the resource that the Board item is associated with, including URL and link.
CreatedDate The date/timestamp when the information was generated.
Actions

An array of name/value pair sets containing information about one or more action events that are valid for the current user to perform on the resource. Each includes value and label, and both contain the name of the valid action. For example:

"value" : "discussion.action.unpublish",
"label" : "discussion.action.unpublish"

The example above indicates that Unpublish is a valid action for the Board item.

For information on valid workflow actions for different types of resources, see Workflow Actions

Note: if the current user does not have authority to perform the actions, even though they are valid for the object, they are not returned.

Marks Information about marks on the Board item, including a numeric count and a boolean value, IsMarkedByReader, indicating whether the current user (if a user is logged in) marked the Board item.
CommentsPreview Information about comments on the Board item, including a numeric count and information about the specific comments, if applicable.
EntityReference

An array of one or more entity references for the Board item. Each includes:

  • Title
  • GUID: the unique ID for the item.
  • Category[ ]: An array of sets of two name/value pairs, each including Value and Domain, with a value for each.

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