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

URL

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

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.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Request Parameters

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.

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

Response Headers

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

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.

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

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.

More information about Akana API Platform API error messages.

Related Topics