DiscussionAPI
{ urn:com.soa.discussion.service.impl } DiscussionAPI
The Discussions service provides operations for managing discussions about apps or APIs, including the associated comments and marks.
GET/discussionslistDiscussions
Parameters
Name
Type
Description
Model
DiscussionSubjectID
query
string
DiscussionType
query
string
RetrievingUserID
query
string
IncludeAPIDiscussions
query
boolean
IncludeAppDiscussions
query
boolean
IncludeBoardDiscussions
query
boolean
IncludeGroupDiscussions
query
boolean
AuthorID
query
string
ItemID
query
string
Tag
query
string
SortBy
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
start
query
integer
count
query
integer
IncludeSelfAuthored
query
boolean
PublishedState
query
string
IncludeActions
query
boolean
Reponse
Produces text/xmlapplication/rss+xmlapplication/json
Status Code
Reason
Model
200
Success
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
GET/discussionsgetDiscussionList
Parameters
Name
Type
Description
Model
DiscussionSubjectID
query
string
DiscussionType
query
string
RetrievingUserID
query
string
IncludeAPIDiscussions
query
boolean
IncludeAppDiscussions
query
boolean
IncludeBoardDiscussions
query
boolean
IncludeGroupDiscussions
query
boolean
AuthorID
query
string
ItemID
query
string
Tag
query
string
SortBy
query
string
IncludeComments
query
boolean
NumberOfComments
query
integer
start
query
integer
count
query
integer
IncludeSelfAuthored
query
boolean
PublishedState
query
string
Reponse
Produces application/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
Discussions
Discussions {
Discussion {
Action {}
BoardItemArtifact {
CommentsPreview {
Comment {
Image {
TargetResource {
AuthoringUser {
Discussion( Collection of Discussion )
}
Discussion {
DiscussionID( string )
Action( Collection of Action )
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
DescriptionMediaType( string )
DiscussionType( string )
Marks( int )
CommentsPreview( CommentsPreview )
Image( Image )
Created( dateTime )
TargetResources( Collection of TargetResource )
PubDate( dateTime )
ResourceID( Collection of string )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
DiscussionSubjectID( string )
Visibility( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
CommentsPreview {
Comment( Collection of Comment )
Count( int )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
POST/discussionsstartDiscussion
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
Discussion
Discussion {
Action {}
BoardItemArtifact {
CommentsPreview {
Comment {
Image {
TargetResource {
AuthoringUser {
DiscussionID( string )
Action( Collection of Action, required )
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Comments( int )
DescriptionMediaType( string )
DiscussionType( string )
Marks( int )
CommentsPreview( CommentsPreview, required )
Image( Image, required )
Created( dateTime )
TargetResources( Collection of TargetResource, required )
PubDate( dateTime )
ResourceID( Collection of string )
Content( string )
UserID( string, required )
AuthoringUser( AuthoringUser, required )
Published( boolean )
DiscussionSubjectID( string )
Visibility( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string, required )
ContextID( string )
BaseUri( string )
}
CommentsPreview {
Comment( Collection of Comment, required )
Count( int )
}
Comment {
Action( Collection of Action, required )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string, required )
Published( boolean )
MediaType( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
AuthoringUser {
UserID( string, required )
Image( Image, required )
Name( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/discussions/typesgetDiscussionTypes
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
DiscussionTypes
DiscussionTypes {
DiscussionType( Collection of string )
}
DELETE/discussions/{discussionID}deleteDiscussion
Parameters
Accepts */*
Name
Type
Description
Model
discussionID
path
string
Reponse
Produces text/plainapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/discussions/{discussionID}getDiscussion
Parameters
Accepts */*
Name
Type
Description
Model
discussionID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Discussion
Discussion {
Action {}
BoardItemArtifact {
CommentsPreview {
Comment {
Image {
TargetResource {
AuthoringUser {
DiscussionID( string )
Action( Collection of Action )
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
DescriptionMediaType( string )
DiscussionType( string )
Marks( int )
CommentsPreview( CommentsPreview )
Image( Image )
Created( dateTime )
TargetResources( Collection of TargetResource )
PubDate( dateTime )
ResourceID( Collection of string )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
DiscussionSubjectID( string )
Visibility( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
CommentsPreview {
Comment( Collection of Comment )
Count( int )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
POST/discussions/{discussionID}/marksmarkDiscussion
Parameters
Accepts text/plain
Name
Type
Description
Model
discussionID
path
string
body
entity
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/discussions/{discussionID}/detailsgetDiscussionDetails
Parameters
Accepts */*
Name
Type
Description
Model
discussionID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
DiscussionDetails
DiscussionDetails {
Action {}
CommentDetails {
CommentDetail {
Comment {
BoardItemArtifact {
Discussion {
CommentsPreview {
Image {
TargetResource {
AuthoringUser {
Type( BoardItemType )
Action( Collection of Action )
State( string )
BoardItemAssignments( Collection of string )
CommentDetails( CommentDetails )
ItemID( string )
Discussion( Discussion )
TargetResources( Collection of TargetResource )
}
Action {}
CommentDetails {
totalResults( long )
startIndex( long )
CommentDetail( Collection of CommentDetail )
}
CommentDetail {
Comment( Comment )
Action( Collection of Action )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
Discussion {
DiscussionID( string )
Action( Collection of Action )
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
DescriptionMediaType( string )
DiscussionType( string )
Marks( int )
CommentsPreview( CommentsPreview )
Image( Image )
Created( dateTime )
TargetResources( Collection of TargetResource )
PubDate( dateTime )
ResourceID( Collection of string )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
DiscussionSubjectID( string )
Visibility( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
CommentsPreview {
Comment( Collection of Comment )
Count( int )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
POST/discussions/{discussionID}/commentscommentOnDiscussion
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
discussionID
path
string
body
entity
Comment
Comment {
Action {}
BoardItemArtifact {
Action( Collection of Action, required )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string, required )
Published( boolean )
MediaType( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string, required )
ContextID( string )
BaseUri( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/discussions/{discussionID}/commentsgetDiscussionComments
Parameters
Name
Type
Description
Model
discussionID
path
string
userID
query
string
IncludeCommentActions
query
boolean
start
query
integer
count
query
integer
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Comments
Comments {
Comment {
Action {}
BoardItemArtifact {
Comment( Collection of Comment )
totalResults( long )
startIndex( long )
}
Comment {
Action( Collection of Action )
UserName( string )
Updated( dateTime )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Marks( int )
CommentSubjectID( string )
CommentID( string )
Created( dateTime )
AvatarURL( anyURI )
WorkflowState( string )
Content( string )
UserID( string )
Published( boolean )
MediaType( string )
}
Action {}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
DELETE/discussions/{discussionID}/marks/{userID}unmarkDiscussion
Parameters
Accepts */*
Name
Type
Description
Model
discussionID
path
string
userID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/discussions/{discussionID}/comments/{commentID}/marksmarkComment
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
discussionID
path
string
commentID
path
string
body
entity
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/discussions/{discussionID}/comments/{commentID}/marks/{userID}unmarkComment
Parameters
Accepts */*
Name
Type
Description
Model
discussionID
path
string
commentID
path
string
userID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
