GET /api/apis/{APIVersionID}/board

Returns a list of Forum entries for the specified API version.

If the API only has one version, the results returned for GET /api/apis/{APIID}/board and GET /api/apis/{APIVersionID}/board (this operation) 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/versions/{APIVersionID}/board

Sample Request

The example below a request for an API's Board items. It includes several additional optional parameters: start, count, RetrievingUserID, and SortBy.

Sample Request URL

https://{hostname}/api/apis/versions/apiversion19184.acmepaymentscorp/board

Sample request headers

GET /api/apis/versions/apiversion19184.acmepaymentscorp/board?start=0&count=10&RetrievingUserID=522320b9-cb6b-495d-ae07-e4b3bfdb3f6a.acmepaymentscorp&SortBy=DescendingDate HTTP/1.1
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 version board items in the form of an RSS feed in JSON or XML format.

Sample Response #1

The sample response below shows the API version board returned as an RSS channel.

Sample response headers: application/json

Status Code: 200 OK
Date: Thu, 14 Feb 2013 22:31:56 GMT
Content-Type: application/json

Sample response body: application/json

{
  "channel" : {
    "title" : "API Version Board",
    "startIndex" : 0,
    "totalResults" : 0,
    "itemsPerPage" : 0,
    "item" : [ {
      "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" : "957482b9-ck7f-0gk5-ae07-9flgok5djtus.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 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"
        } ]
      } ]
    } ]
  },
  "version" : "1.0"
}

Sample Response #2

The sample response below shows the API version board when the IncludeCommentActions=true parameter is included in the request. The response includes valid actions (Action) for the Board items. The URL parameters in this case were: start=0&count=10&RetrievingUserID=[userid]&SortBy=DescendingDate&IncludeCommentActions=true&IncludeSelfAuthored=true&PublishedState=all.

Sample response headers #2: application/json

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

Sample response body #2: application/json

{
  "channel":{
    "title":"API Version Board",
    "startIndex":0,
    "itemsPerPage":10,
    "item":[
      {
        "title":"test discussion",
        "description":"aasdf",
        "category":[
          {
            "value":"DISCUSSION",
            "domain":"uddi:soa.com:resourcetype"
          },
          {
            "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":"text\/markdown",
            "domain":"uddi:soa.com:descriptionmediatype"
          },
          {
            "value":"com.soa.discussion.type.comment",
            "domain":"uddi:soa.com:discussiontype"
          },
          {
            "value":"Published",
            "domain":"uddi:soa.com:wfstate"
          }
        ],
        "guid":{
          "value":"discussion10133.acmepaymentscorp"
        },
        "pubDate":"Thu, 24 Oct 2019 16:56:44 -0500",
        "BoardItemArtifacts":{
          "BoardItemArtifact":[
          ]
        },
        "Actions":{
          "Action":[
            {
              "value":"discussion.action.unpublish",
              "label":"discussion.action.unpublish"
            },
            {
              "value":"discussion.action.delete",
              "label":"discussion.action.delete"
            }
          ]
        },
        "AuthoringUser":{
          "ID":"59c4524b-5408-435e-9f5b-dc9554a9bf4c.acmepaymentscorp",
          "Name":"adminlocalhost",
          "Image":{
            "Url":"http:\/\/localhost:7900\/api\/users\/avatar\/_VK7KYoA_L8iD5_GJxEUQkTQ",
            "Title":"adminlocalhost",
            "Link":"#\/users\/59c4524b-5408-435e-9f5b-dc9554a9bf4c.acmepaymentscorp\/details"
          }
        },
        "CreatedDate":"Thu, 24 Oct 2019 16:56:25 -0500",
        "EntityReference":[
          {
            "Title":"my_title",
            "Guid":"62f3a10b-3c3a-4dda-88cb-185ac73b27a2.acmepaymentscorp",
            "Category":[
              {
                "value":"api",
                "domain":"uddi:soa.com:resourcetype"
              }
            ]
          },
          {
            "Title":"v1",
            "Guid":"67792726-5334-41e1-aa35-9efdaa3e4a7b.acmepaymentscorp",
            "Category":[
              {
                "value":"apiversion",
                "domain":"uddi:soa.com:resourcetype"
              }
            ]
          }
        ],
        "Marks":{
          "Count":0,
          "IsMarkedByReader":false
        },
        "CommentsPreview":{
          "Count":1,
          "Comment":[
            {
              "CommentID":"c14e6b49-4dd1-4392-a1c4-c860643d3248.acmepaymentscorp",
              "CommentSubjectID":"discussion10133.acmepaymentscorp",
              "Content":"a comment",
              "Created":"2019-10-24T21:56:44Z",
              "Marks":0,
              "IsMarked":false,
              "UserID":"59c4524b-5408-435e-9f5b-dc9554a9bf4c.acmepaymentscorp",
              "UserName":"adminlocalhost",
              "AvatarURL":"http:\/\/localhost:7900\/api\/users\/avatar\/_VK7KYoA_L8iD5_GJxEUQkTQ",
              "Published":true,
              "WorkflowState":"Published",
              "MediaType":"text\/markdown",
              "BoardItemArtifacts":{
                "BoardItemArtifact":[
                ]
              },
              "Action":[
                {
                  "value":"comment.action.delete",
                  "label":"comment.action.delete"
                }
              ]
            }
          ]
        },
        "Image":{
          "Url":"http:\/\/localhost:7900\/api\/apis\/avatar\/_VK7KYoA_L8iD5_GJxEUQkTQ",
          "Link":"#\/apiversion\/62f3a10b-3c3a-4dda-88cb-185ac73b27a2.acmepaymentscorp"
        }
      }
    ]
  },
  "version":"1.0"
}

Sample response headers #2

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

Sample response body #2

{
  "channel":{
    "title":"API Version Board",
    "startIndex":0,
    "itemsPerPage":10,
    "item":[
      {
        "title":"test discussion",
        "description":"aasdf",
        "category":[
          {
            "value":"DISCUSSION",
            "domain":"uddi:soa.com:resourcetype"
          },
          {
            "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":"text\/markdown",
            "domain":"uddi:soa.com:descriptionmediatype"
          },
          {
            "value":"com.soa.discussion.type.comment",
            "domain":"uddi:soa.com:discussiontype"
          },
          {
            "value":"Published",
            "domain":"uddi:soa.com:wfstate"
          }
        ],
        "guid":{
          "value":"discussion10133.acmepaymentscorp"
        },
        "pubDate":"Thu, 24 Oct 2019 16:56:44 -0500",
        "BoardItemArtifacts":{
          "BoardItemArtifact":[
          ]
        },
        "Actions":{
          "Action":[
            {
              "value":"discussion.action.unpublish",
              "label":"discussion.action.unpublish"
            },
            {
              "value":"discussion.action.delete",
              "label":"discussion.action.delete"
            }
          ]
        },
        "AuthoringUser":{
          "ID":"59c4524b-5408-435e-9f5b-dc9554a9bf4c.acmepaymentscorp",
          "Name":"adminlocalhost",
          "Image":{
            "Url":"http:\/\/localhost:7900\/api\/users\/avatar\/_VK7KYoA_L8iD5_GJxEUQkTQ",
            "Title":"adminlocalhost",
            "Link":"#\/users\/59c4524b-5408-435e-9f5b-dc9554a9bf4c.acmepaymentscorp\/details"
          }
        },
        "CreatedDate":"Thu, 24 Oct 2019 16:56:25 -0500",
        "EntityReference":[
          {
            "Title":"my_title",
            "Guid":"62f3a10b-3c3a-4dda-88cb-185ac73b27a2.acmepaymentscorp",
            "Category":[
              {
                "value":"api",
                "domain":"uddi:soa.com:resourcetype"
              }
            ]
          },
          {
            "Title":"v1",
            "Guid":"67792726-5334-41e1-aa35-9efdaa3e4a7b.acmepaymentscorp",
            "Category":[
              {
                "value":"apiversion",
                "domain":"uddi:soa.com:resourcetype"
              }
            ]
          }
        ],
        "Marks":{
          "Count":0,
          "IsMarkedByReader":false
        },
        "CommentsPreview":{
          "Count":1,
          "Comment":[
            {
              "CommentID":"c14e6b49-4dd1-4392-a1c4-c860643d3248.acmepaymentscorp",
              "CommentSubjectID":"discussion10133.acmepaymentscorp",
              "Content":"a comment",
              "Created":"2019-10-24T21:56:44Z",
              "Marks":0,
              "IsMarked":false,
              "UserID":"59c4524b-5408-435e-9f5b-dc9554a9bf4c.acmepaymentscorp",
              "UserName":"adminlocalhost",
              "AvatarURL":"http:\/\/localhost:7900\/api\/users\/avatar\/_VK7KYoA_L8iD5_GJxEUQkTQ",
              "Published":true,
              "WorkflowState":"Published",
              "MediaType":"text\/markdown",
              "BoardItemArtifacts":{
                "BoardItemArtifact":[
                ]
              },
              "Action":[
                {
                  "value":"comment.action.delete",
                  "label":"comment.action.delete"
                }
              ]
            }
          ]
        },
        "Image":{
          "Url":"http:\/\/localhost:7900\/api\/apis\/avatar\/_VK7KYoA_L8iD5_GJxEUQkTQ",
          "Link":"#\/apiversion\/62f3a10b-3c3a-4dda-88cb-185ac73b27a2.acmepaymentscorp"
        }
      }
    ]
  },
  "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 Version Board, and the channel includes paging values: StartIndex, TotalResults, and ItemsPerPage. Each item in the channel represents a Board item for the API version, and includes the information listed 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