GET /api/apps/{AppID}/board

Returns a list of Board items for the specified app.

Authorization Roles/Permissions: App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/apps/{AppID}/board[?ItemType={ItemType}][&APIID={APIID}]
[&TicketLabel={TicketLabel}][&TicketState={TicketState}][&ItemID={ItemID}][&Tag={Tag}]
[&IncludeComments={IncludeComments}][&NumberOfComments={NumberOfComments}]
[&IncludeActions={IncludeActions}][&start={start}][&count={count}][&SortBy={SortBy}]
[&RetrievingUserID={RetrievingUserID}]

Sample Request

The example below shows a request for the first two items on an app's board.

Sample request URL

https://{hostname}/api/apps/app16964.acmepaymentscorp/board?start=0&count=2&RetrievingUserID=522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp

Sample request headers

GET /api/apps/app16964.acmepaymentscorp/board?start=0&count=2&RetrievingUserID=522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp HTTP/1.1
Host:{hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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
AppID Query string Optional The unique ID for a specific app.
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.
APIID Path string Required .If specified, only board items relating to that API are returned. If not specified, items relating to all APIs are returned.
TicketLabel Query string Optional A filtering parameter: if specified, only tickets with that label are returned. If not specified, no filter is applied. For valid values, refer to Ticket Label Values.
TicketState Query string Optional A filtering parameter: if specified, only tickets of that state are returned. For valid values, refer to Ticket State Values.
ItemID Query string Optional

The unique ID for a specific forum entry.

If specified, results are limited to items 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.
IncludeCommentActions Query boolean Optional Indicates whether workflow actions currently valid for a comment on the board should be included in the results. Default: false. For valid workflow actions for comments, see Comments: Valid 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 app board items in the form of an RSS feed in JSON or XML format.

Sample Response

The sample response below shows the app board returned as an RSS channel in JSON format.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Fri, 31 May 2013 20:13:57 GMT
Content-Type: application/json

Sample response body: application/json

{
  "channel" : {
    "title" : "App Board",
    "startIndex" : 0,
    "itemsPerPage" : 2,
    "item" : [ {
      "title" : "ACMECorp member MaryJones  has been invited to the PaaStime application team",
      "description" : "ACMECorp member MaryJones, I would like to invite you to join the development team for my application.  ",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.group.membership.state.approved",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "group_member_req23850.acmepaymentscorp"
      },
      "pubDate" : "2013-05-31T18:10:19.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-05-30T00:36:00.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 2,
        "Comment" : [ {
          "CommentID" : "comment23861.acmepaymentscorp",
          "CommentSubjectID" : "group_member_req23850.acmepaymentscorp",
          "Content" : "Love to, thanks!",
          "Created" : "2013-05-30T01:14:53Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp",
          "UserName" : "PhilipPirrip",
          "AvatarURL" : "https://{hostname}/api/users/2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp/avatars/ce76ac4e-02db-47a3-a0d4-1f2e66a6cf3e.png"
        }, {
          "CommentID" : "comment23923.acmepaymentscorp",
          "CommentSubjectID" : "group_member_req23850.acmepaymentscorp",
          "Content" : "MaryJones accepted the membership invitation and commented \"Of course! Appreciate the invite. Sounds like a great app.\"",
          "Created" : "2013-05-31T18:10:19Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp",
          "UserName" : "JenniferMeadows",
          "AvatarURL" : "https://{hostname}/api/users/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/avatars/14402873-86bf-4b70-a5b1-acf50e789eeb.png"
        } ]
      },
      "EntityReference" : [ {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "Application team for [PaaStime]",
        "Guid" : "group16965.acmepaymentscorp",
        "Category" : [ {
          "value" : "group",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "JenniferMeadows",
        "Guid" : "d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp",
        "Category" : [ {
          "value" : "user",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    }, {
      "title" : "ACMECorp member JonathanSwift  has been invited to the PaaStime application team",
      "description" : "ACMECorp member JonathanSwift, I would like to invite you to join the development team for my application.  ",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.group.membership.state.approved",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "group_member_req23851.acmepaymentscorp"
      },
      "pubDate" : "2013-05-31T17:50:47.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-05-30T00:35:49.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1,
        "Comment" : [ {
          "CommentID" : "comment23932.acmepaymentscorp",
          "CommentSubjectID" : "group_member_req23851.acmepaymentscorp",
          "Content" : "JonathanSwift accepted the membership invitation and commented \"Love to, thanks!\"",
          "Created" : "2013-05-31T17:50:47Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp",
          "UserName" : "JonathanSwift",
          "AvatarURL" : "https://{hostname}/api/users/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp/avatars/12d0fdd6-4707-4262-8c88-28ab3b5036c3.png"
        } ]
      },
      "EntityReference" : [ {
        "Title" : "JonathanSwift",
        "Guid" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp",
        "Category" : [ {
          "value" : "user",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "Application team for [PaaStime]",
        "Guid" : "group16965.acmepaymentscorp",
        "Category" : [ {
          "value" : "group",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

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

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 App Board, and the channel includes paging values: StartIndex, TotalResults (if applicable), and ItemsPerPage. Each item in the channel represents a Board item for the app, and includes the information listed 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" : "GROUP_MEMBER_REQ",
"domain" : "uddi:soa.com:resourcetype"

The example above indicates that the Board item is a group member request.

"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.
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 each comment, 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 name/value pairs with information about the category for the 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
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.