Versions Compared

キー

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

On this page:

目次

Review Items

Add Revision to Review

アンカー
AddRevisiontoReview
AddRevisiontoReview

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.

Get Review Items

アンカー
GetReviewItems
GetReviewItems

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:

コー​​ドブロック
XML
XML
<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>
    <fromPath>foo.txt</fromPath>
    <fromRevision>21</fromRevision>
    <repositoryName>local</repositoryName>
    <toPath>foo.txt</toPath>
    <toRevision>22</toRevision>
  </reviewItem>
  ... more reviewItems ...
</reviewItems>

Example JSON Return Data:

コー​​ドブロック
XML
XML
{"reviewItems":{"reviewItem": [
  {"permId":{"id":"CFR-4"},
  "authorName":"ervzijst",
  "commitDate":"2008-10-16T17:19:52.119+1000",
  "commitType":"Modified",
  "fileType":"File",
  "fromPath":"path\/to\/file.txt",
  "fromRevision":"3",
  "repositoryName":"Local",
  "toPath":"path\/to\/file.txt",
  "toRevision":"13"
  },
  ... more reviewItems ...
  ]
}}



Get Single Revision Details

アンカー
GetSingleRevisionDetails
GetSingleRevisionDetails

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

アンカー
RemoveRevisionfromReview
RemoveRevisionfromReview

URL:
コー​​ドブロック
DELETE /reviews-v1/<review id>/reviewitems/<review item id>

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