Discussions Service: Overview
The Discussions service provides operations for managing discussions about apps or APIs, including the associated comments and marks.
URL: https://{hostname}/api/discussions
Note: Most of these operations take the DiscussionID as a parameter. You can get this value from the response to the GET /api/discussions.IDs on the Platform operation. For information about any other IDs used in path parameters, see
| Action | Endpoint | Description |
|---|---|---|
| comment on discussion | POST /api/discussions/{DiscussionID}/comments | Adds a comment to the specified discussion. |
| delete discussion | DELETE /api/discussions/{DiscussionID} | Deletes the specified discussion. |
| get discussion | GET /api/discussions/{DiscussionID} | Returns the specified discussion. |
| get discussion comments | GET /api/discussions/{DiscussionID}/comments | Returns the comments associated with a specified discussion. |
| get discussion details | GET /api/discussions/{DiscussionID}/details | Returns information about a discussion, including details such as workflow steps that are valid for the discussion and, possibly, comments and target resources relating to the discussion. |
| get discussion list | GET /api/discussions | Returns a list of discussions that match specified filter criteria, in the form of a JSON object. |
| list discussions | 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. |
| mark comment | POST /api/discussions/{DiscussionID}/comments/{commentID}/marks | Adds a mark to a comment on a discussion. |
| mark discussion | POST /api/discussions/{DiscussionID}/marks | Marks a discussion. |
| start discussion | POST /api/discussions | Starts a new discussion. |
| unmark comment | DELETE /api/discussions/{DiscussionID}/comments/{commentID}/marks/{UserID} | Removes the specified user's mark from a comment that the user has previously marked. |
| unmark discussion | DELETE /api/discussions/{DiscussionID}/marks/{UserID} | Removes the user's mark from a discussion that the user has previously marked. |