GET /api/apis/{APIID}/board

Returns a list of Forum entries for the specified API.

If the API only has one version, the results returned for GET /api/apis/{APIID}/board (this operation) and GET /api/apis/{APIVersionID}/board are the same.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apis/{APIID}/board

Back to top

Sample Request

The example below a request for an API's Board items. The request is limited to the first 10 items relating to a specified user.

Request URL #1

https://{hostname}/api/apis/api18969.acmepaymentscorp/board?start=0&count=10&RetrievingUserID=user12262.acmepaymentscorp&SortBy=DescendingDate

Request URL #2

Requests Board items of type Alert for the specified API.

https://{hostname}/api/apis/api200.acmepaymentscorp/board?start=0&count=10&RetrievingUserID=user10002.acmepaymentscorp&SortBy=DescendingDate&ItemType=Alert

Sample request headers

Accept:application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

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

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 QueryData Type Required Description
APIID Path string Required The unique ID for a specific API.
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.
AppID Query string Optional If specified, only board items relating to that app are returned. If not specified, items relating to all apps 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 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 API 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 API board returned as an RSS channel in JSON format. There are two items on the board.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json

Sample response body #1: application/json

{
  "channel" : {
    "title" : "API Board",
    "startIndex" : 0,
    "totalResults" : 0,
    "itemsPerPage" : 10,
    "item" : [ {
      "title" : "ACMECorp member PhilipPirrip  has been invited to the ACME Payments API UG Group",
      "description" : "Please join the ACME Payments API user group!",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.group.membership.state.pending",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "group_member_req19794.acmepaymentscorp"
      },
      "pubDate" : "2013-02-12T17:11:37.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-02-12T17:11:37.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "PhilipPirrip",
        "Guid" : "2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp",
        "Category" : [ {
          "value" : "user",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "acmepaymentscorp",
        "Guid" : "api18969.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "apiversion19184.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    }, {
      "title" : "ACMECorp member JonathanSwift  has been invited to the ACME Payments API UG Group",
      "description" : "Please join the ACME Payments API user group!",
      "category" : [ {
        "value" : "GROUP_MEMBER_REQ",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "false",
        "domain" : "uddi:soa.com:archivable"
      }, {
        "value" : "com.soa.group.membership.state.pending",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "group_member_req19795.acmepaymentscorp"
      },
      "pubDate" : "2013-02-12T17:11:37.000Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar",
        "Link" : "#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-02-12T17:11:37.000Z",
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "JonathanSwift",
        "Guid" : "45742f96-aad2-45d8-b507-420cf07c87ff.acmepaymentscorp",
        "Category" : [ {
          "value" : "user",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "acmepaymentscorp",
        "Guid" : "api18969.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "2.0",
        "Guid" : "apiversion19184.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Sample response body #2: application/json

The example below is a response to the sample URL, given above, requesting a list of Board items of type Alert.

{
  "channel" : {
    "title" : "API Board",
    "startIndex" : 0,
    "totalResults" : 0,
    "itemsPerPage" : 10,
    "item" : [ {
      "title" : "Scheduled outage",
      "description" : "There will be a scheduled outage tomorrow, 21 February 2013, 12:00-3:00pm EST.",
      "category" : [ {
        "value" : "ALERT",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "alert",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "problem",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "issue",
        "domain" : "uddi:soa.com:tag"
      }, {
        "value" : "Minor",
        "domain" : "uddi:soa.com:alertpriority"
      }, {
        "value" : "Production",
        "domain" : "uddi:soa.com:alertenvironment"
      } ],
      "guid" : {
        "value" : "alert10027.acmepaymentscorp"
      },
      "pubDate" : "2013-02-20T20:19:15.518Z",
      "AuthoringUser" : {
        "ID" : "522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp",
        "Name" : "JaneSaoirse",
        "Image" : {
          "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar",
          "Title" : "JaneSaoirse",
          "Link" : "#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "https://{hostname}/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar",
        "Link" : "../acmepaymentscorp#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details"
      },
      "CreatedDate" : "2013-02-20T20:19:15.518Z",
      "Actions" : {
        "Action" : [ {
          "value" : "apialert.action.delete",
          "label" : "apialert.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "ACME Payments API",
        "Guid" : "api200.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "1.0",
        "Guid" : "apiversion500.acmepaymentscorp",
        "Category" : [ {
          "value" : "apiversion",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Back to top

Sample response headers: text/xml

HTTP/1.1 200 OK
Content-Type: text/xml

Sample response body #1: text/xml

<?xml version="1.0" encoding="UTF-8"?>
<rss xmlns:ns2="http://soa.com/xsd/rss/1.0" 
xmlns:ns3="http://soa.com/xsd/comment/1.0" 
xmlns:ns4="http://soa.com/xsd/user/1.0" 
xmlns:ns5="http://a9.com/-/spec/opensearch/1.1/" 
xmlns:ns6="http://soa.com/xsd/resource/1.0" 
xmlns:ns7="http://soa.com/xsd/fault/1.0" 
xmlns:ns8="http://soa.com/xsd/api/1.0" 
xmlns:ns9="http://soa.com/xsd/board/1.0" version="1.0">
  <channel>
    <title>API Board</title>
    <ns5:startIndex>0</ns5:startIndex>
    <ns5:itemsPerPage>10</ns5:itemsPerPage>
    <ns5:totalResults>0</ns5:totalResults>
    <item>
      <title>ACMECorp member PhilipPirrip  has been invited to the ACME Payments API UG Group</title>
      <description>Please join the ACME Payments API user group!</description>
      <category domain="uddi:soa.com:resourcetype">GROUP_MEMBER_REQ</category>
      <category domain="uddi:soa.com:archivable">false</category>
      <category domain="uddi:soa.com:wfstate">com.soa.group.membership.state.pending</category>
      <guid>group_member_req19794.acmepaymentscorp</guid>
      <pubDate>2013-02-12T17:11:37.000Z</pubDate>
      <ns2:CreatedDate>2013-02-12T17:11:37.000Z</ns2:CreatedDate>
      <ns2:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns2:Marks>
      <ns3:CommentsPreview>
        <ns3:Count>0</ns3:Count>
      </ns3:CommentsPreview>
      <ns2:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns2:Image>
          <Url>http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns2:Image>
      </ns2:AuthoringUser>
      <ns2:EntityReference>
        <Title>PhilipPirrip</Title>
        <Guid>2d0bc425-49ec-4c04-b272-cc8f6f20e52b.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">user</ns2:Category>
      </ns2:EntityReference>
      <ns2:EntityReference>
        <Title>acmepaymentscorp</Title>
        <Guid>api18969.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">api</ns2:Category>
      </ns2:EntityReference>
      <ns2:EntityReference>
        <Title>2.0</Title>
        <Guid>apiversion19184.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">apiversion</ns2:Category>
      </ns2:EntityReference>
      <ns2:Image>
        <Url>http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns2:Image>
    </item>
    <item>
      <title>ACMECorp member JonathanSwift  has been invited to the ACME Payments API UG Group</title>
      <description>Please join the ACME Payments API user group!</description>
      <category domain="uddi:soa.com:resourcetype">GROUP_MEMBER_REQ</category>
      <category domain="uddi:soa.com:archivable">false</category>
      <category domain="uddi:soa.com:wfstate">com.soa.group.membership.state.pending</category>
      <guid>group_member_req19795.acmepaymentscorp</guid>
      <pubDate>2013-02-12T17:11:37.000Z</pubDate>
      <ns2:CreatedDate>2013-02-12T17:11:37.000Z</ns2:CreatedDate>
      <ns2:Marks>
        <Count>0</Count>
        <IsMarkedByReader>false</IsMarkedByReader>
      </ns2:Marks>
      <ns3:CommentsPreview>
        <ns3:Count>0</ns3:Count>
      </ns3:CommentsPreview>
      <ns2:AuthoringUser>
        <ID>522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp</ID>
        <Name>JaneSaoirse</Name>
        <ns2:Image>
          <Url>http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar</Url>
          <Title>JaneSaoirse</Title>
          <Link>#/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
        </ns2:Image>
      </ns2:AuthoringUser>
      <ns2:EntityReference>
        <Title>JonathanSwift</Title>
        <Guid>45742f96-aad2-45d8-b507-420cf07c87ff.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">user</ns2:Category>
      </ns2:EntityReference>
      <ns2:EntityReference>
        <Title>acmepaymentscorp</Title>
        <Guid>api18969.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">api</ns2:Category>
      </ns2:EntityReference>
      <ns2:EntityReference>
        <Title>2.0</Title>
        <Guid>apiversion19184.acmepaymentscorp</Guid>
        <ns2:Category domain="uddi:soa.com:resourcetype">apiversion</ns2:Category>
      </ns2:EntityReference>
      <ns2:Image>
        <Url>http://cdn.acmepaymentscorp.soa.com/api/users/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/avatar</Url>
        <Link>#/user/522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp/details</Link>
      </ns2:Image>
    </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/json, text/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

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 API 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.

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

More information about Akana API Platform API error messages.

Back to top

Related Topics