GET /api/discussions

Returns a list of discussions that match specified filter criteria, as an RSS feed.

Note: GET /api/discussions (list discussions, with custom Accept header) returns the same information as a JSON object. We recommend using that operation rather than this one.

Authorization Roles/Permissions: Must be logged in and have permission to view the requested resources. If the user is logged in but doesn't have permission to view certain resources, the operation works, but limited (or empty) results are returned.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/discussions[?DiscussionSubjectID={DiscussionSubjectID}][&ItemID={ItemID}][&Tag={Tag}]
[&SortBy={SortBy}][&IncludeComments={IncludeComments}][&NumberOfComments={NumberOfComments}][&count={count}]

Sample Request

Request URL #1

>The example below shows a request for the discussion items relating to a specific API version.

https://{hostname}/api/discussions?DiscussionSubjectID=f8e35097-f3e7-4583-9f6b-f25c7fe0e632.acmepaymentscorp

Request URL #2

The example below shows a request for a specific discussion.

https://{hostname}/api/discussions?ItemID=discussion11019.acmepaymentscorp

Sample request headers

Accept: application/json

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 discussion list. The information is sent as an RSS feed.

Sample Response

The sample response below shows the response to sample request #1.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Expires: Mon, 11 May 2015 16:10:25 GMTT

Sample response body: application/json

{
  "channel" : {
    "title" : "",
    "link" : "../acmepaymentscorp#/forum/discussions",
    "description" : "",
    "startIndex" : 0,
    "itemsPerPage" : 1,
    "item" : [ {
      "title" : "Call for feature requests ",
      "description" : "We are planning for our next release. Feature requests welcome! 
\n\n![image](http://{hostname}/api/boards/items/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/img_dollars.jpg 
\"img_dollars.jpg\")\n\nCash prizes for the first five suggestions that we use!",
      "category" : [ {
        "value" : "DISCUSSION",
        "domain" : "uddi:soa.com:resourcetype"
      }, {
        "value" : "com.soa.discussion.type.comment",
        "domain" : "uddi:soa.com:discussiontype"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:published"
      }, {
        "value" : "true",
        "domain" : "uddi:soa.com:published"
      }, {
        "value" : "text/markdown",
        "domain" : "uddi:soa.com:descriptionmediatype"
      }, {
        "value" : "com.soa.board.item.closed",
        "domain" : "uddi:soa.com:state"
      }, {
        "value" : "Published",
        "domain" : "uddi:soa.com:wfstate"
      } ],
      "guid" : {
        "value" : "063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp"
      },
      "pubDate" : "Mon, 11 May 2015 20:29:53 +0000",
      "BoardItemArtifacts" : {
        "BoardItemArtifact" : [ {
          "ContextID" : "063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp",
          "FileName" : "img_dollars.jpg",
          "BaseUri" : "http://{hostname}",
          "UriPath" : "/api/boards/items/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/img_dollars.jpg"
        } ]
      },
      "AuthoringUser" : {
        "ID" : "8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp",
        "Name" : "JaneMead",
        "Image" : {
          "Url" : "http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar",
          "Title" : "JaneMead",
          "Link" : "#/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/details"
        }
      },
      "Image" : {
        "Url" : "http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar"
      },
      "CreatedDate" : "Mon, 11 May 2015 20:29:53 +0000",
      "Actions" : {
        "Action" : [ {
          "value" : "discussion.action.unpublish",
          "label" : "discussion.action.unpublish"
        }, {
          "value" : "discussion.action.delete",
          "label" : "discussion.action.delete"
        } ]
      },
      "Marks" : {
        "Count" : 0,
        "IsMarkedByReader" : false
      },
      "CommentsPreview" : {
        "Count" : 0,
        "Comment" : [ ]
      },
      "EntityReference" : [ {
        "Title" : "ACME Payments API",
        "Guid" : "2f8d7e07-d23c-4f28-9129-02163c032bc7.acmepaymentscorp",
        "Category" : [ {
          "value" : "api",
          "domain" : "uddi:soa.com:resourcetype"
        } ]
      }, {
        "Title" : "1.0",
        "Guid" : "ecbf7010-abcf-41f8-9f52-1c02b3a51984.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 channel includes a link to the Board for the discussion and also paging values: StartIndex, TotalResults (if applicable), and ItemsPerPage. Each item in the channel represents a discussion, and includes the information listed below.

"value" : "DISCUSSION",
"domain" : "uddi:soa.com:resourcetype"

"value" : "event",
"domain" : "uddi:soa.com:tag"

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

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

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