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:

Review Items

Add Revision to Review


URL:

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

Description:
Add a revision to a review. Send a reviewItem with the repository name, and from and to paths and revisions specified. Other values can be omitted. This returns the completed reviewItem structure.

Status Code:
201 (Created) on success. The reponse will contain the Location response header with the URL of the newly created resoure and the reviewItemData document in the response body.

Get Review Items


URL:

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

Description:
Get a list of the items in a review.

Status Code:
200 (OK) on success.

Example XML Return Data:

<reviewItems>
  <reviewItem>
    <permId>
      <id>CFR-1</id>
    </permId>
    <authorName>tomd</authorName>
    <commitDate>2008-01-29T14:41:43.202+1100</commitDate>
    <commitType>Modified</commitType>
    <fileType>File</fileType>
    <toContentUrl>/cru/CR-4/rawcontent/53/foo.txt</toContentUrl>
    <fromPath>foo.txt</fromPath>
    <fromRevision>21</fromRevision>
    <repositoryName>local</repositoryName>
    <toContentUrl>/cru/CR-4/rawcontent/51/foo.txt</toContentUrl>
    <toPath>foo.txt</toPath>
    <toRevision>22</toRevision>
  </reviewItem>
  ... more reviewItems ...
</reviewItems>

Example JSON Return Data:

{"reviewItems":{"reviewItem": [
  {"permId":{"id":"CFR-4"},
  "authorName":"ervzijst",
  "commitDate":"2008-10-16T17:19:52.119+1000",
  "commitType":"Modified",
  "fileType":"File",
  "fromContentUrl":"\/cru\/CR-4\/rawcontent\/53\/foo.txt",
  "fromPath":"path\/to\/file.txt",
  "fromRevision":"3",
  "repositoryName":"Local",
  "toContentUrl":"\/cru\/CR-4\/rawcontent\/51\/foo.txt",
  "toPath":"path\/to\/file.txt",
  "toRevision":"13"
  },
  ... more reviewItems ...
  ]
}}



Get Single Revision Details


URL:

GET /reviews-v1/<review id>/reviewitems/<review item id>

Description:
Get the details of a single revision in a review. Returns the reviewItem structure for the item.
Status Code:
200 (OK) on success.

Remove Revision from Review


URL:

DELETE /reviews-v1/<review id>/reviewitems/<review item id>

Description:
Remove a revision from a review.
Status Code:
204 (No Content) on success.

Document generated by Confluence on Jul 29, 2010 20:01