Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<div><table class="wysiwyg-macro" data-macro-name="warning" data-macro-parameters="title=Deprecated since version 3.6" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3dhcm5pbmc6dGl0bGU9RGVwcmVjYXRlZCBzaW5jZSB2ZXJzaW9uIDMuNn0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>Use <a class="confluence-link" href="/pages/viewpage.action?pageId=231080558" data-linked-resource-id="231080558" data-linked-resource-type="page" data-linked-resource-default-alias="Web Service /api/issues" data-base-url="http://docs.codehaus.org">/api/issues</a> web service instead.</p></td></tr></table><p> </p><p> </p><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="icon=false|title=Table of Contents" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86aWNvbj1mYWxzZXx0aXRsZT1UYWJsZSBvZiBDb250ZW50c30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0xfQ&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="maxLevel=1"></p></td></tr></table><h1>Get a List of Reviews</h1></div><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Get a list of reviews</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/reviews</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd"><strong>Response Formats</strong></td><td colspan="1" class="confluenceTd">json | xml</td></tr><tr><td class="confluenceTd"><p><strong>Security</strong></p></td><td class="confluenceTd"><p>Requires User role on the project</p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Get reviews whose ids are 47 and 48</td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/reviews?ids=47,48">http://nemo.sonarsource.org/api/reviews?ids=47,48</a></p></blockquote></td></tr><tr><td class="confluenceTd">Get all the open reviews on project <code>org.codehaus.sonar:sonar</code></td><td class="confluenceTd"><blockquote><p>GET <a href="http://nemo.sonarsource.org/api/reviews?projects=org.codehaus.sonar:sonar&amp;statuses=OPEN">http://nemo.sonarsource.org/api/reviews?projects=org.codehaus.sonar:sonar&amp;statuses=OPEN</a></p></blockquote></td></tr></tbody></table><h3>Response Format</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=javascript|title=JSON" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9SlNPTnxsYW5ndWFnZT1qYXZhc2NyaXB0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>[
  {
    "id":48,
    "createdAt":"2011-05-28T22:17:55+0000",
    "updatedAt":"2012-03-08T08:35:35+0000",
    "author":"evgeny.mandrikov",
    "assignee":"evgeny.mandrikov",
    "title":"Substitute calls to size() == 0 (or size() != 0) with calls to isEmpty()",
    "status":"CLOSED",
    "severity":"MINOR",
    "resource":"org.codehaus.sonar.plugins:sonar-dbcleaner-plugin:org.sonar.plugins.dbcleaner.purges.PurgeOrphanResources",
    "line":45,
    "violationId":41804608,
    "comments":[
      {
        "id":62,
        "author":"evgeny.mandrikov",
        "updatedAt":"2011-05-28T22:17:55+0000",
        "text":"Indeed - why not."
      },
      ...
    ]
  },
  ...
]</pre></td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Required</span></th><th class="confluenceTh"><p>Default Value</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>ids</strong></p></td><td class="confluenceTd"><p>List of review ids</p></td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd"><p>None</p></td><td colspan="1" class="confluenceTd">3245,3251</td></tr><tr><td class="confluenceTd"><p><strong>resources</strong></p></td><td class="confluenceTd"><p>Comma-separated list of resource ids or keys</p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd">org.codehaus.sonar:sonar-application:org.sonar.application.StartServer</td></tr><tr><td class="confluenceTd"><p><strong>projects</strong></p></td><td class="confluenceTd"><p>Comma-separated list of root project ids or keys</p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd"><span>org.codehaus.sonar:sonar</span></td></tr><tr><td class="confluenceTd"><p><strong>statuses</strong></p></td><td class="confluenceTd"><p>Comma-separated list of status<br />Possible values: OPEN | CLOSED </p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd">OPEN,CLOSED</td></tr><tr><td class="confluenceTd"><p><strong>resolutions</strong></p></td><td class="confluenceTd"><p>Comma-separated list of resolutions<br /><span>Possible values: FIXED | FALSE-POSITIVE </span> </p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd">FIXED,FALSE-POSTIVE</td></tr><tr><td class="confluenceTd"><p><strong>severities</strong></p></td><td class="confluenceTd"><p>Comma-separated list of severities<br /><span>Possible values: <span>INFO <span>| </span>MINOR <span>| </span>MAJOR <span>| </span>CRITICAL <span>| </span>BLOCKER</span></span></p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd">BLOCKER,CRITICAL</td></tr><tr><td class="confluenceTd"><p><strong>authors</strong></p></td><td class="confluenceTd"><p>Comma-separated list of author login </p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd">admin,simon.brandhof</td></tr><tr><td class="confluenceTd"><p><strong>assignees</strong></p></td><td class="confluenceTd"><p>Comma-separated list of assignee login</p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p><span>None</span></p></td><td colspan="1" class="confluenceTd">admin,simon.brandhof</td></tr><tr><td class="confluenceTd"><p><strong>review_type</strong></p></td><td class="confluenceTd"><p>Type of review<br /><span>Possible values: </span><span>FALSE-POSITIVE | VIOLATION</span> </p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p>VIOLATION</p></td><td colspan="1" class="confluenceTd">VIOLATION,FALSE-POSITIVE</td></tr><tr><td class="confluenceTd"><p><strong>output</strong></p></td><td class="confluenceTd"><p>Format of comments<br /><span>Possible values: PLAIN</span><span>| HTML</span></p></td><td colspan="1" class="confluenceTd"><span>No</span></td><td class="confluenceTd"><p>PLAIN</p></td><td colspan="1" class="confluenceTd">HTML</td></tr><tr><td colspan="1" class="confluenceTd"><strong>format</strong></td><td colspan="1" class="confluenceTd"><p>Response format can be set through:</p><ul><li>Parameter format: xml | json</li><li>Or the 'Accept' property in the HTTP header:</li></ul><ul><li><ul><li>Accept:text/xml</li><li>Accept:application/json</li></ul></li></ul><div>If nothing is set, json is used.</div></td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">xml</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table><h3>Notes</h3><p><span>Results are limited to 200 reviews, ordered by creation date (most recent to oldest).</span></p><h1>Create a Review</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Create an review</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/reviews</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">POST</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p>Requires authentication</p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Create a review on violation of id '123':<br /><ul><li>Status: OPEN</li><li>Assignee: admin</li><li><p>Comment: myComment</p></li></ul></td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;violation_id=123&amp;status=OPEN&amp;comment=myComment&amp;assignee=admin&quot; -X POST http://localhost:9000/api/reviews</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>violation_id</strong></p></td><td class="confluenceTd"><p>Violation on which the review should be created</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">123</td></tr><tr><td class="confluenceTd"><p><strong>status</strong></p></td><td class="confluenceTd"><p>Initial status (can be 'OPEN' or 'RESOLVED')</p></td><td class="confluenceTd"><p><span>Yes</span></p></td><td colspan="1" class="confluenceTd"><span>None</span></td><td colspan="1" class="confluenceTd">OPEN</td></tr><tr><td class="confluenceTd"><p><strong>comment</strong></p></td><td class="confluenceTd"><p>Text of initial comment</p></td><td class="confluenceTd"><p><span>Yes</span></p></td><td colspan="1" class="confluenceTd"><span>None</span></td><td colspan="1" class="confluenceTd">My comment</td></tr><tr><td class="confluenceTd"><p><strong>resolution</strong></p></td><td class="confluenceTd"><p>If status 'RESOLVED', then resolution must be provided (can be 'FIXED' or 'FALSE-POSITIVE')</p></td><td class="confluenceTd"><p>No</p></td><td colspan="1" class="confluenceTd"><span>None</span></td><td colspan="1" class="confluenceTd">FIXED</td></tr><tr><td class="confluenceTd"><p><strong>assignee</strong></p></td><td class="confluenceTd"><p>Login of initial assignee</p></td><td class="confluenceTd"><p><span>No</span></p></td><td colspan="1" class="confluenceTd"><span>None</span></td><td colspan="1" class="confluenceTd">simon.brandhof</td></tr></tbody></table><h1>Add a Comment on a Review</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Add a comment</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/reviews/add_comment</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">PUT</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p><span>Requires authentication</span></p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Add the following comment on review of id '345': 'myComment'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;id=345&amp;comment=myComment&quot; -X PUT http://localhost:9000/api/reviews/add_comment</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>id</strong></p></td><td class="confluenceTd"><p>Review id</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">345</td></tr><tr><td class="confluenceTd"><p><strong>comment</strong></p></td><td class="confluenceTd"><p>New comment</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">My comment</td></tr></tbody></table><h1>Reassign a Review</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Reassign a review</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/reviews/reassign</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">PUT</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p><span>Requires authentication</span></p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Reassign review of id '345' to user 'admin'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;id=345&amp;assignee=admin&quot; -X PUT http://localhost:9000/api/reviews/reassign</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>id</strong></p></td><td class="confluenceTd"><p>Review id</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">345</td></tr><tr><td class="confluenceTd"><p><strong>assignee</strong></p></td><td class="confluenceTd"><p>Login of new assignee</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">simon.brandhof</td></tr></tbody></table><h1>Resolve a Review</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Resolve a review</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/reviews/resolve</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">PUT</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p><span>Requires authentication</span></p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Flag review of id '345' as false-positive</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;id=345&amp;resolution=FALSE-POSITIVE&amp;comment=myComment&quot; -X PUT http://localhost:9000/api/reviews/resolve</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value</span></th></tr><tr><td class="confluenceTd"><p><strong>id</strong></p></td><td class="confluenceTd"><p>Review id</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">345</td></tr><tr><td colspan="1" class="confluenceTd"><strong>resolution</strong></td><td colspan="1" class="confluenceTd">Can be 'FIXED' or 'FALSE-POSITIVE'</td><td colspan="1" class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">FIXED</td></tr><tr><td class="confluenceTd"><p><strong>comment</strong></p></td><td class="confluenceTd">Comment on the resolution</td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">My comment</td></tr></tbody></table><h1>Reopen a Review</h1><table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd"><strong>Description</strong></td><td colspan="1" class="confluenceTd">Reopen a review</td></tr><tr><td class="confluenceTd"><p><strong>URL</strong></p></td><td class="confluenceTd"><p>/api/reviews/reopen</p></td></tr><tr><td colspan="1" class="confluenceTd"><strong>HTTP Method</strong></td><td colspan="1" class="confluenceTd">PUT</td></tr><tr><td class="confluenceTd"><strong>Security</strong></td><td class="confluenceTd"><p><span>Requires authentication</span></p></td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><span style="color: rgb(0,51,102);">Use Case</span></th><th class="confluenceTh"><span style="color: rgb(0,51,102);">Example Request</span></th></tr><tr><td class="confluenceTd">Reopen review of id '345'</td><td class="confluenceTd"><blockquote><p>curl -u admin:admin -d &quot;id=345&amp;comment=myComment&quot; -X PUT http://localhost:9000/api/reviews/reopen</p></blockquote></td></tr></tbody></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Parameter</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Default Value</span></th><th colspan="1" class="confluenceTh"><span style="color: rgb(0,51,102);">Example Value </span></th></tr><tr><td class="confluenceTd"><p><strong>id</strong></p></td><td class="confluenceTd"><p>Review id</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">345</td></tr><tr><td class="confluenceTd"><p><strong>comment</strong></p></td><td class="confluenceTd"><p>Comment on the reopen action</p></td><td class="confluenceTd"><p>Yes</p></td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">My comment</td></tr></tbody></table>