GET /api/discussions

Returns a list of discussions that match specified filter criteria, in the form of a JSON object.

Note: Use this operation rather than GET /api/discussions (with Accept header of application/json) which returns the results in the form of an RSS channel.

Authorization Roles/Permissions: Anyone can use this operation; login is not required. However, note that for any operations that do not require login, information about private resources is not returned unless the user is logged in and is authorized to view information about those resources. Without login, only public information is returned. However, the results are restricted according to the user's permissions. When the user is not logged in, only public discussion information is returned.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/discussions

Back to top

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/vnd.soa.v71+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/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+xml

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
DiscussionSubjectID Query string Optional The unique ID for the specific resource that a discussion relates to; for example, the AppVersionID, APIVersionID, GroupID, or a custom BoardID. Use this if you only want information about discussions for a specific resource such as an app version or API version.
DiscussionType Query string Optional The type of discussion. No longer in use.
RetrievingUserID Query string Optional The ID of the user retrieving the discussion information.
IncludeAPIDiscussions Query boolean Optional Indicates whether API discussions should be included in the information returned. Default: true. If set to false, API discussions are excluded.
IncludeAppDiscussions Query boolean Optional Indicates whether app discussions should be included in the information returned. Default: false. If set to true, app discussions are included.
IncludeBoardDiscussions Query boolean Optional Indicates whether Board discussions should be included in the information returned. Default: false. If set to true, Board discussions are included.
IncludeGroupDiscussions Query boolean Optional Indicates whether group discussions should be included in the information returned. Default: false. If set to true, group discussions are included.
AuthorID Query string Optional The unique ID for the author of a discussion. If this parameter is included, only discussions created by this author are included in the results.
ItemID Query string Optional The unique ID for a specific forum entry.
Tag Query string Optional Name of a specific discussion tag, if information relating to only a specific tag is required.
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.
count Query integer Optional The number of results to be returned, from the specified starting point. If not specified, all matching results are returned.
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 information about discussions.

Back to top

Sample Response

The sample response below shows successful completion of sample request #1.

Sample response headers: application/vnd.soa.v71+json

Status Code: 200 OK
Content-Type: application/vnd.soa.v71+json
Expires: Mon, 11 May 2015 16:19:05 GMT

Sample response body: application/vnd.soa.v71+json

{
  "Discussion":[
    {
      "DiscussionID":"063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp",
      "DiscussionSubjectID":"ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp",
      "DiscussionType":"com.soa.discussion.type.comment",
      "Topic":"Call for feature requests ",
      "Content":"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!",
      "UserID":"8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp",
      "Created":"2015-05-11T20:29:53Z",
      "Comments":0,
      "Marks":0,
      "IsMarked":false,
      "Visibility":"Limited",
      "PubDate":"2015-05-11T20:29:53Z",
      "CommentsPreview":{
        "Count":0,
        "Comment":[

        ]
      },
      "Action":[
        {
          "value":"discussion.action.delete",
          "label":"discussion.action.delete"
        }
      ],
      "Link":"../acmepaymentscorp#/forum/discussions/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/details",
      "AuthoringUser":{
        "UserID":"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"
        }
      },
      "TargetResources":{
        "TargetResource":[
          {
            "Name":"ACME Payments API",
            "ID":"2f8d7e07-d23c-4f28-9129-02163c032bc7.acmepaymentscorp",
            "Type":"api"
          },
          {
            "Name":"1.0",
            "ID":"ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp",
            "Type":"apiversion"
          }
        ]
      },
      "Image":{
        "Url":"http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar"
      },
      "Published":true,
      "DescriptionMediaType":"text/markdown",
      "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"
          }
        ]
      }
    }
  ]
}

Back to top

Sample response headers: application/vnd.soa.v72+xml

Status Code: 200 OK
Content-Type: application/vnd.soa.v72+xml
Expires: Mon, 11 May 2015 16:21:44 GMT

Sample response body: application/vnd.soa.v72+xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Discussions xmlns="http://soa.com/xsd/discussion/1.0" xmlns:ns2="http://soa.com/xsd/user/1.0" 
xmlns:ns3="http://soa.com/xsd/comment/1.0" xmlns:ns4="http://soa.com/xsd/dnmodel/1.0" 
xmlns:ns5="http://soa.com/xsd/board/1.0" xmlns:ns6="http://soa.com/xsd/rss/1.0" 
xmlns:ns7="http://a9.com/-/spec/opensearch/1.1/" xmlns:ns8="http://soa.com/xsd/alert/1.0" 
xmlns:ns9="http://soa.com/xsd/api/1.0" xmlns:ns10="http://soa.com/xsd/contract/1.0" 
xmlns:ns11="http://soa.com/xsd/ticket/1.0" xmlns:ns12="http://soa.com/xsd/app/1.0" 
xmlns:ns13="http://soa.com/xsd/review/1.0">
  <Discussion>
    <DiscussionID>063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp</DiscussionID>
    <DiscussionSubjectID>ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp</DiscussionSubjectID>
    <DiscussionType>com.soa.discussion.type.comment</DiscussionType>
    <Topic>Call for feature requests </Topic>
    <Content>We are planning for our next release. Feature requests welcome! 
![image](http://{hostname}/api/boards/items/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/img_dollars.jpg "img_dollars.jpg")
Cash prizes for the first five suggestions that we use!</Content>
    <ns2:UserID>8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp</ns2:UserID>
    <Created>2015-05-11T20:29:53Z</Created>
    <Comments>0</Comments>
    <Marks>0</Marks>
    <IsMarked>false</IsMarked>
    <Visibility>Limited</Visibility>
    <PubDate>2015-05-11T20:29:53Z</PubDate>
    <ns3:CommentsPreview>
      <ns3:Count>0</ns3:Count>
    </ns3:CommentsPreview>
    <ns4:Action label="discussion.action.delete">discussion.action.delete</ns4:Action>
    <Link>../acmepaymentscorp#/forum/discussions/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/details</Link>
    <ns4:AuthoringUser>
      <ns4:UserID>8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp</ns4:UserID>
      <ns4:Name>JaneMead</ns4:Name>
      <ns4:Image>
        <ns4:Url>http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar</ns4:Url>
        <ns4:Title>JaneMead</ns4:Title>
        <ns4:Link>#/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/details</ns4:Link>
      </ns4:Image>
    </ns4:AuthoringUser>
    <ns4:TargetResources>
      <ns4:TargetResource>
        <ns4:Name>ACME Payments API</ns4:Name>
        <ns4:ID>2f8d7e07-d23c-4f28-9129-02163c032bc7.acmepaymentscorp</ns4:ID>
        <ns4:Type>api</ns4:Type>
      </ns4:TargetResource>
      <ns4:TargetResource>
        <ns4:Name>1.0</ns4:Name>
        <ns4:ID>ecbf7010-abcf-41f8-9f52-1c02b3a51984.acmepaymentscorp</ns4:ID>
        <ns4:Type>apiversion</ns4:Type>
      </ns4:TargetResource>
    </ns4:TargetResources>
    <ns4:Image>
      <ns4:Url>http://{hostname}/api/users/8dba2d85-1108-417f-ad81-7a369e9e5d79.acmepaymentscorp/avatar</ns4:Url>
    </ns4:Image>
    <Published>true</Published>
    <ns5:DescriptionMediaType>text/markdown</ns5:DescriptionMediaType>
    <ns5:BoardItemArtifacts>
      <ns5:BoardItemArtifact>
        <ns5:ContextID>063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp</ns5:ContextID>
        <ns5:FileName>img_dollars.jpg</ns5:FileName>
        <ns5:BaseUri>http://{hostname}</ns5:BaseUri>
        <ns5:UriPath>/api/boards/items/063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp/img_dollars.jpg</ns5:UriPath>
      </ns5:BoardItemArtifact>
    </ns5:BoardItemArtifacts>
  </Discussion>
</Discussions>

Back to top

Response Headers

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

Header Description
Content-Type application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+xml

Back to top

Response Body

Name Type Description
Discussions Discussions Contains information about one or more discussions.

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