This page last changed on Nov 19, 2009 by edawson.
The content on this page is deprecated. Please see the separate documentation space for developer reference material about FishEye and Crucible.

On this page:

Reviewers

Add Reviewers


URL:

POST /reviews-v1/<review id>/reviewers

Description:
Add new reviewers to the review. Send a string of comma separated user names.

Status Code:
200 (OK) on success.

Get Finished Reviewers


URL:

GET /reviews-v1/<review id>/reviewers/completed

Description:
Return a list of the reviewers who have completed the review.

Status Code:
200 (OK) on success.

Example Return Data:
Return value as /reviews-v1/<review id>/reviewers, but only completed reviewers are included.

Get Incomplete Reviewers


URL:

GET /reviews-v1/<review id>/reviewers/uncompleted

Description:
Return a list of the reviewers who have not yet completed the review.

Status Code:
200 (OK) on success.

Example Return Data:
Return value as /reviews-v1/<review id>/reviewers, but only incomplete reviewers are included.

Get Reviewers


URL:

GET /reviews-v1/<review id>/reviewers

Description:
Return a list of the reviewers participating in the review.

Status Code:
200 (OK) on success.

Example XML Return Data:

<reviewers>
  <reviewer>
    <displayName>Conor MacNeill</displayName>
    <userName>conor</userName>
    <completed>false</completed>
  </reviewer>
  ... more reviewers ...
</reviewers>

Example JSON Return Data:

{"reviewers":{"reviewer":[
  {"displayName":"Peter Moore","userName":"pete","completed":false},
  {"displayName":"Brendan Humphreys","userName":"brendan","completed":false}]
}}



Remove Single Reviewer


URL:

DELETE /reviews-v1/<review id>/reviewers/<username>

Description:
Remove a reviewer from a review.

Status Code:
204 (No Content) on success.

Document generated by Confluence on Feb 23, 2010 02:04