Reviews

Reviews are used to evaluate products and channels.

On our tutorial page you can find some instructions on how to use reviews to rate products and channels.

Representations

Review

ReviewDraft

When creating a new review, at least one of title, text or rating should be set.

ReviewRatingStatistics

Get Review by ID

Endpoint: /{projectKey}/reviews/{id}
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: Review

Get Review by Key

Endpoint: /{projectKey}/reviews/key={key}
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: Review

Query Reviews

Endpoint: /{projectKey}/reviews
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: PagedQueryResult with the results array of Review
Query Parameters:

Create a Review

Endpoint: /{projectKey}/reviews
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Request Representation: ReviewDraft
Response Representation: Review

Update Review

Update Review by ID

Endpoint: /{projectKey}/reviews/{id}
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Response Representation: Review
Fields:

Update Review by Key

Endpoint: /{projectKey}/reviews/key={key}
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Response Representation: Review
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Set Key

Set Author Name

Set Customer

Set Rating

Set Target

Set Text

Set Title

Set Locale

Transition State

Transition to a new state. If there is no state yet, the new state must be an initial state. If the existing state has transitions set, there must be a direct transition to the new state. If transitions is not set, no validation is performed.
These validations can be turned off by using the force parameter. If the new state does not have the role ReviewIncludedInStatistics, the review is not taken into account in the ratings statistics of the target.

Set Custom Type

This action sets or removes the custom type for an existing review.

This action overwrites any existing custom type and fields.

Set CustomField

Delete Review

Delete Review by ID

Endpoint: /{projectKey}/reviews/{id}
Method: DELETE
OAuth2 Scopes: manage_products:{projectKey}
Query Parameters:

Delete Review by Key

Endpoint: /{projectKey}/reviews/key={key}
Method: DELETE
OAuth2 Scopes: manage_products:{projectKey}
Query Parameters:

comments powered by Disqus