GET /api/apps/versions/{AppVersionID}/board

Returns a list of Board items for the specified app version. Items are returned as an RSS channel.

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

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/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}]

Back to top

Sample Request

The example below shows a request for the Board for a specific app version.

Sample request URL

https://{hostname}/api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/board

Sample request headers

GET /api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/board HTTP/1.1
Host:{hostname}
Accept: application/json
X-Csrf-Token_{tenant}: {TokenID}

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

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
AppVersionID Path string Required The unique ID for a specific app version.
ItemType Query string[ ] Optional Indicates the type of board item (forum entry), such as an alert, discussion, or ticket.
APIID Query 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.
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 Required 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 app version board items in the form of an RSS feed in JSON or XML format.

Back to top

Sample Response

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

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Fri, 31 May 2013 18:31:15 GMT
Content-Type: application/json

Sample response body: application/json

{
  "channel" : {
    "title" : "App Version Board",
    "startIndex" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "title" : "Feature requests",
      "description" : "We are developing our feature list for the next release. Any feature requests?",
      "category" : [ {
        "value" : "DISCUSSION",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "version",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "feature",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.board.item.acmepaymentscorp",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "com.soa.discussion.type.comment",
        "domain" : "uddi:soa.com:discussiontype"
      } ],
      "guid" : {
        "value" : "discussion23921.acmepaymentscorp"
      },
      "pubDate" : "2013-05-31T17:48:09.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-31T17:48:09.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "discussion.action.delete",
          "label" : "discussion.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    }, {
      "title" : "API Access request",
      "description" : "ACMECorp member JaneSaoirse has requested access to the Sandbox implementation for the ACME Payments DeLuxe (Version 2.0) on behalf of the  PaaStime (2.0) application",
      "category" : [ {
        "value" : "CONTRACT_REQUEST",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "apicontract.status.activated",
        "domain" : "uddi:soa.com:wfstate"
      }, {
        "value" : "Sandbox",
        "domain" : "uddi:soa.com:environment"
      } ],
      "guid" : {
        "value" : "contract_request23623.acmepaymentscorp"
      },
      "pubDate" : "2013-05-23T22:14:30.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/apps/app16964.acmepaymentscorp/avatars/f250a96e-2f81-4e3e-88fc-61431fd80e5c.png",
        "Link" : "#/app/app16964.acmepaymentscorp"
      },
      "CreatedDate" : "2013-05-23T22:14:30.000Z",
      "Actions" : {
        "Action" : [ {
          "value" : "apicontract.action.suspend",
          "label" : "apicontract.action.suspend"
        }, {
          "value" : "apicontract.action.cancel",
          "label" : "apicontract.action.cancel"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 1,
        "Comment" : [ {
          "CommentID" : "comment23624.acmepaymentscorp",
          "CommentSubjectID" : "contract_request23623.acmepaymentscorp",
          "Content" : "API access has been activated. ",
          "Created" : "2013-05-23T22:14:30Z",
          "Marks" : 0,
          "IsMarked" : false,
          "UserID" : "global.acmepaymentscorp",
          "UserName" : "ACMECorp",
          "AvatarURL" : "https://{hostname}/api/tenants/global.acmepaymentscorp/avatar"
        } ]
      },
      "EntityReferences" : {
        "EntityReference" : [ {
          "Guid" : "contract23622.acmepaymentscorp",
          "Category" : [ {
            "value" : "contract",
            "domain" : "uddi:soa.com:resourcetype"
          } ]
        } ]
      },
      "EntityReference" : [ {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "PaaStime",
        "Guid" : "app16964.acmepaymentscorp",
        "Category" : [ {
          "value" : "app",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp",
        "Category" : [ {
          "value" : "app-version",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "ACME Payments DeLuxe",
        "Guid" : "api19427.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "ACME Payments DeLuxe",
        "Guid" : "api19427.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "Version 2.0",
        "Guid" : "apiversion19429.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:ns2="http://soa.com/xsd/business/1.0" xmlns:ns3="http://soa.com/xsd/user/1.0" 
xmlns:ns4="http://soa.com/xsd/rss/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/resource/1.0" 
xmlns:ns8="http://soa.com/xsd/fault/1.0" xmlns:ns9="http://soa.com/xsd/api/1.0" 
xmlns:ns10="http://soa.com/xsd/board/1.0" version="1.0">
  <channel>
    <title>App Version Board</title>
    <ns6:startIndex>0</ns6:startIndex>
    <ns6:itemsPerPage>0</ns6:itemsPerPage>
    <item>
      <title>Feature requests</title>
      <description>We are developing our feature list for the next release. Any feature requests?</description>
      <category domain="uddi:soa.com:resourcetype">DISCUSSION</category>
      <category domain="uddi:soa.com:tag">version</category>
      <category domain="uddi:soa.com:tag">feature</category>
      <category domain="uddi:soa.com:archivable">true</category>
      <category domain="uddi:soa.com:state">com.soa.board.item.acmepaymentscorp</category>
      <category domain="uddi:soa.com:discussiontype">com.soa.discussion.type.comment</category>
      <guid>discussion23921.acmepaymentscorp</guid>
      <pubDate>2013-05-31T17:48:09.000Z</pubDate>
      <ns4:CreatedDate>2013-05-31T17:48:09.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>0</ns5:Count>
      </ns5:CommentsPreview>
      <ns4:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns4:Image>
          <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>PaaStime</Title>
        <Guid>app16964.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>2.0</Title>
        <Guid>4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns4:Image>
      <ns4:Actions>
        <ns4:Action label="discussion.action.delete">discussion.action.delete</ns4:Action>
      </ns4:Actions>
    </item>
    <item>
      <title>API Access request</title>
      <description>ACMECorp member JaneSaoirse has requested access to the Sandbox implementation for the ACME Payments DeLuxe (Version 2.0) on behalf of the  PaaStime (2.0) application</description>
      <category domain="uddi:soa.com:resourcetype">CONTRACT_REQUEST</category>
      <category domain="uddi:soa.com:archivable">false</category>
      <category domain="uddi:soa.com:wfstate">apicontract.status.activated</category>
      <category domain="uddi:soa.com:environment">Sandbox</category>
      <guid>contract_request23623.acmepaymentscorp</guid>
      <pubDate>2013-05-23T22:14:30.000Z</pubDate>
      <ns4:CreatedDate>2013-05-23T22:14:30.000Z</ns4:CreatedDate>
      <ns4:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns4:Marks>
      <ns5:CommentsPreview>
        <ns5:Count>1</ns5:Count>
        <ns5:Comment>
          <ns5:CommentID>comment23624.acmepaymentscorp</ns5:CommentID>
          <ns5:CommentSubjectID>contract_request23623.acmepaymentscorp</ns5:CommentSubjectID>
          <ns5:Content>API access has been activated. </ns5:Content>
          <ns5:Created>2013-05-23T22:14:30Z</ns5:Created>
          <ns5:Marks>0</ns5:Marks>
          <ns5:IsMarked>false</ns5:IsMarked>
          <ns3:UserID>global.acmepaymentscorp</ns3:UserID>
          <ns3:UserName>ACMECorp</ns3:UserName>
          <ns3:AvatarURL>https://{hostname}/api/tenants/global.acmepaymentscorp/avatar</ns3:AvatarURL>
        </ns5:Comment>
      </ns5:CommentsPreview>
      <ns4:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns4:Image>
          <Url>https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatars/b423eac3-4dbd-4b8c-a2f6-841caacd6dc1.png</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns4:Image>
      </ns4:AuthoringUser>
      <ns4:EntityReference>
        <Title>PaaStime</Title>
        <Guid>app16964.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>PaaStime</Title>
        <Guid>app16964.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>2.0</Title>
        <Guid>4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">app-version</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>ACME Payments DeLuxe</Title>
        <Guid>api19427.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>ACME Payments DeLuxe</Title>
        <Guid>api19427.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">api</ns4:Category>
      </ns4:EntityReference>
      <ns4:EntityReference>
        <Title>Version 2.0</Title>
        <Guid>apiversion19429.acmepaymentscorp</Guid>
        <ns4:Category domain="uddi:soa.com:resourcetype">apiversion</ns4:Category>
      </ns4:EntityReference>
      <ns4:Image>
        <Url>https://{hostname}/api/apps/app16964.acmepaymentscorp/avatars/f250a96e-2f81-4e3e-88fc-61431fd80e5c.png</Url>
        <Link>#/app/app16964.acmepaymentscorp</Link>
      </ns4:Image>
      <ns4:EntityReferences>
        <ns4:EntityReference>
          <Guid>contract23622.acmepaymentscorp</Guid>
          <ns4:Category domain="uddi:soa.com:resourcetype">contract</ns4:Category>
        </ns4:EntityReference>
      </ns4:EntityReferences>
      <ns4:Actions>
        <ns4:Action label="apicontract.action.suspend">apicontract.action.suspend</ns4:Action>
        <ns4:Action label="apicontract.action.cancel">apicontract.action.cancel</ns4:Action>
      </ns4: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, text/xml, application/json

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

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 Version 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 version, 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" : "DISCUSSION",
"domain" : "uddi:soa.com:resourcetype"

The example above indicates that the Board item is a discussion.

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

The example above indicates that the Board item is 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 item. Each includes value and label, and both contain the name of the valid action. For example:

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

The example above indicates that Delete is a valid action for this Board item, which is a discussion.

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.

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
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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics