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.

<table class="confluenceTable"><tbody><tr><td colspan="1" class="confluenceTd">Description</td><td colspan="1" class="confluenceTd">Get a list of violations</td></tr><tr><td class="confluenceTd">URL</td><td class="confluenceTd">/api/violations</td></tr><tr><td colspan="1" class="confluenceTd">HTTP Method</td><td colspan="1" class="confluenceTd">GET</td></tr><tr><td colspan="1" class="confluenceTd">Response Formats</td><td colspan="1" class="confluenceTd">json | xml</td></tr><tr><td class="confluenceTd">Security</td><td class="confluenceTd">Requires User role on project</td></tr></tbody></table><h3>Examples</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Use Case</th><th class="confluenceTh">Example Request</th></tr><tr><td class="confluenceTd">Get all the violations from project Sonar (key = org.codehaus.sonar:sonar)</td><td class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&amp;depth=-1">http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&amp;depth=-1</a></blockquote></td></tr><tr><td class="confluenceTd">Get all the blocker and critical violations from project Sonar (key = org.codehaus.sonar:sonar)</td><td class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&amp;depth=-1&amp;priorities=BLOCKER,CRITICAL">http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&amp;depth=-1&amp;priorities=BLOCKER,CRITICAL</a></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":73907420,
 "message":"Bad comparison of nonnegative value with -1 in org.sonar.channel.CodeReader.peekTo(EndMatcher,Appendable)",
 "line":117,
 "priority":"CRITICAL",
 "createdAt":"2012-06-02T23:32:49+0000",
 "rule":
 {
 "key":"findbugs:INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE",
 "name":"Correctness - Bad comparison of nonnegative value with negative constant"
 },
 "resource":
 {
 "key":"org.codehaus.sonar:sonar-channel:org.sonar.channel.CodeReader",
 "name":"CodeReader",
 "scope":"FIL",
 "qualifier":"CLA",
 "language":"java"
 }
	"review":
 { see /api/review web service }
 },
 ...
]</pre></td></tr></table><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="title=Number of results" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86dGl0bGU9TnVtYmVyIG9mIHJlc3VsdHN9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">Note that the number of results is limited to 5,000. See <a href="http://jira.codehaus.org/browse/SONAR-3257">SONAR-3257</a>.</td></tr></table><h3>Parameters</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Parameter</th><th class="confluenceTh">Description</th><th colspan="1" class="confluenceTh">Required</th><th class="confluenceTh">Default Value</th><th colspan="1" class="confluenceTh">Example Value</th></tr><tr><td class="confluenceTd">resource</td><td class="confluenceTd">id or key of the resource.</td><td colspan="1" class="confluenceTd">Yes</td><td class="confluenceTd">None</td><td colspan="1" class="confluenceTd">org.codehaus.sonar:sonar</td></tr><tr><td class="confluenceTd">depth</td><td class="confluenceTd">Used only when resource is set. <ul><li>0: only selected resource </li><li>-1: all children, including selected resource </li><li>&gt;0: depth toward the selected resource</li></ul></td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">0</td><td colspan="1" class="confluenceTd">-1</td></tr><tr><td class="confluenceTd">scopes</td><td class="confluenceTd">Comma-separated list of scopes:<ul><li>PRJ: project/module </li><li>DIR: directory (like Java package) </li><li>FIL: file</li></ul></td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">None</td><td colspan="1" class="confluenceTd">PRJ,FIL</td></tr><tr><td class="confluenceTd">qualifiers</td><td class="confluenceTd">Comma-separated list of qualifiers: <ul><li>VW: view</li><li>SVW: sub-view</li><li>TRK: project </li><li>BRC: module </li><li>CLA: class </li><li>UTS: unit test </li><li>DIR: directory </li><li>FIL: file</li><li>DEV: developer</li></ul></td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">None</td><td colspan="1" class="confluenceTd">TRK,BRC</td></tr><tr><td class="confluenceTd">rules</td><td class="confluenceTd">Comma-separated list of rule keys or ids.</td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">None</td><td colspan="1" class="confluenceTd">squid:MethodCyclomatiComplexity,pmd:ConstructorCallsOverridableMethod</td></tr><tr><td class="confluenceTd">priorities</td><td class="confluenceTd">Comma-separated list of priorities. Possible values: BLOCKER | CRITICAL | MAJOR | MINOR | INFO</td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">None</td><td colspan="1" class="confluenceTd">BLOCKER,CRITICAL</td></tr><tr><td class="confluenceTd">limit</td><td class="confluenceTd">Maximum number of results</td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">5000</td><td colspan="1" class="confluenceTd">10</td></tr><tr><td class="confluenceTd">include_review</td><td class="confluenceTd">Include review data into response. Possible values: true | false</td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">false</td><td colspan="1" class="confluenceTd">true</td></tr><tr><td class="confluenceTd">output</td><td class="confluenceTd">Output format of review comments. Ignored if include_review is false. Possible values: PLAIN | HTML </td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">PLAIN</td><td colspan="1" class="confluenceTd">HTML</td></tr><tr><td class="confluenceTd">switched_off</td><td class="confluenceTd">If true, then return only switched-off violations (usually false-positives),  else switched-off violations are excluded. Possible values: true | false </td><td colspan="1" class="confluenceTd">No</td><td class="confluenceTd">false</td><td colspan="1" class="confluenceTd">true</td></tr><tr><td colspan="1" class="confluenceTd">format</td><td colspan="1" class="confluenceTd">Response format can be set through:<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">None</td><td colspan="1" class="confluenceTd">json</td></tr></tbody></table>