ReviewAPI
{ urn:com.soa.review.service.impl } ReviewAPI
Provides operations that allow you to manage reviews of apps, APIs, or groups on the platform, including creating, deleting, and listing reviews and marking reviews as helpful.
GET/reviewslistReviews
Parameters
Accepts */*
Name
Type
Description
Model
ReviewSubjectID
query
string
RetrievingUserID
query
string
ItemID
query
string
ReviewAuthorID
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/jsonapplication/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
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 )
}
POST/reviewsaddReview
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
Review
Review {
BoardItemArtifact {
Image {
AuthoringUser {
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Comments( int )
Rating( int )
DescriptionMediaType( string )
ReviewSubjectID( string )
Marks( int )
Image( Image, required )
Created( dateTime )
PubDate( dateTime )
Content( string )
UserID( string, required )
AuthoringUser( AuthoringUser, required )
Published( boolean )
Visibility( string )
ReviewID( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string, required )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
AuthoringUser {
UserID( string, required )
Image( Image, required )
Name( 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
Review
Review {
BoardItemArtifact {
Image {
AuthoringUser {
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
Rating( int )
DescriptionMediaType( string )
ReviewSubjectID( string )
Marks( int )
Image( Image )
Created( dateTime )
PubDate( dateTime )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
Visibility( string )
ReviewID( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
PUT/reviews/{reviewID}updateReview
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
reviewID
path
string
body
entity
Review
Review {
BoardItemArtifact {
Image {
AuthoringUser {
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact, required )
Comments( int )
Rating( int )
DescriptionMediaType( string )
ReviewSubjectID( string )
Marks( int )
Image( Image, required )
Created( dateTime )
PubDate( dateTime )
Content( string )
UserID( string, required )
AuthoringUser( AuthoringUser, required )
Published( boolean )
Visibility( string )
ReviewID( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string, required )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
AuthoringUser {
UserID( string, required )
Image( Image, required )
Name( 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
Review
Review {
BoardItemArtifact {
Image {
AuthoringUser {
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
Rating( int )
DescriptionMediaType( string )
ReviewSubjectID( string )
Marks( int )
Image( Image )
Created( dateTime )
PubDate( dateTime )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
Visibility( string )
ReviewID( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
GET/reviews/{reviewID}getReview
Parameters
Accepts */*
Name
Type
Description
Model
reviewID
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
Review
Review {
BoardItemArtifact {
Image {
AuthoringUser {
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
Rating( int )
DescriptionMediaType( string )
ReviewSubjectID( string )
Marks( int )
Image( Image )
Created( dateTime )
PubDate( dateTime )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
Visibility( string )
ReviewID( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
DELETE/reviews/{reviewID}deleteReview
Parameters
Accepts */*
Name
Type
Description
Model
reviewID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/reviews/{reviewID}/marksmarkReview
Parameters
Accepts text/plain application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
reviewID
path
string
body
entity
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
string
POST/reviews/{reviewID}/commentscommentOnReview
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
reviewID
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/plainapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
string
GET/reviews/{reviewID}/commentsgetReviewComments
Parameters
Name
Type
Description
Model
reviewID
path
string
userID
query
string
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 )
}
GET/reviews/{reviewID}/detailsgetReviewDetails
Parameters
Accepts */*
Name
Type
Description
Model
reviewID
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
ReviewDetails
ReviewDetails {
Action {}
Review {
BoardItemArtifact {
Image {
AuthoringUser {
TargetResource {
Type( BoardItemType )
Action( Collection of Action )
State( string )
BoardItemAssignments( Collection of string )
Review( Review )
ItemID( string )
TargetResources( Collection of TargetResource )
}
Action {}
Review {
UserName( string )
IsMarked( boolean )
BoardItemArtifacts( Collection of BoardItemArtifact )
Comments( int )
Rating( int )
DescriptionMediaType( string )
ReviewSubjectID( string )
Marks( int )
Image( Image )
Created( dateTime )
PubDate( dateTime )
Content( string )
UserID( string )
AuthoringUser( AuthoringUser )
Published( boolean )
Visibility( string )
ReviewID( string )
Tag( Collection of string )
Topic( string )
Link( string )
}
BoardItemArtifact {
UriPath( string )
FileName( string )
ContextID( string )
BaseUri( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AuthoringUser {
UserID( string )
Image( Image )
Name( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
DELETE/reviews/{reviewID}/marks/{userID}unmarkReview
Parameters
Accepts */*
Name
Type
Description
Model
reviewID
path
string
userID
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
string
POST/reviews/{reviewID}/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
reviewID
path
string
commentID
path
string
body
entity
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
string
DELETE/reviews/{reviewID}/comments/{commentID}/marks/{userID}unmarkComment
Parameters
Accepts */*
Name
Type
Description
Model
reviewID
path
string
commentID
path
string
userID
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
string
