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 resources</td></tr><tr><td class="confluenceTd">URL</td><td class="confluenceTd">/api/resources</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 resource</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 projects</td><td class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources">http://nemo.sonarsource.org/api/resources</a></blockquote></td></tr><tr><td class="confluenceTd">For each project, get lines of code and code coverage measures</td><td class="confluenceTd"><div><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?metrics=ncloc,coverage">http://nemo.sonarsource.org/api/resources?metrics=ncloc,coverage</a></blockquote></div></td></tr><tr><td colspan="1" class="confluenceTd">Get lines of code and code coverage measures for project org.codehaus.sonar:sonar</td><td colspan="1" class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;metrics=ncloc,coverage">http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;metrics=ncloc,coverage</a></blockquote></td></tr><tr><td colspan="1" class="confluenceTd">Get all the resources included in project org.codehaus.sonar:sonar: packages, files, etc.</td><td colspan="1" class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=-1">http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=-1</a></blockquote></td></tr><tr><td colspan="1" class="confluenceTd">Get all the files included in project org.codehaus.sonar:sonar</td><td colspan="1" class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=-1&amp;scopes=FIL">http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=-1&amp;scopes=FIL</a></blockquote></td></tr><tr><td colspan="1" class="confluenceTd">Hotspot of the ten files with the worst code coverage for project org.codehaus.sonar:sonar</td><td colspan="1" class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=-1&amp;scopes=FIL&amp;metrics=coverage&amp;limit=10">http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=-1&amp;scopes=FIL&amp;metrics=coverage&amp;limit=10</a></blockquote></td></tr><tr><td colspan="1" class="confluenceTd">Get lines of code measure of direct children of org.codehaus.sonar:sonar</td><td colspan="1" class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=1&amp;metrics=ncloc">h</a><a>ttp://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;depth=1&amp;metrics=ncloc</a><a /></blockquote></td></tr><tr><td colspan="1" class="confluenceTd">Get code coverage on new code for project org.codehaus.sonar:sonar for all differential periods.</td><td colspan="1" class="confluenceTd"><blockquote>GET <a href="http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;metrics=new_coverage&amp;includetrends=true">http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&amp;metrics=new_coverage&amp;includetrends=true</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":2865,
 "key":"org.codehaus.sonar:sonar",
 "name":"Sonar",
 "scope":"PRJ",
 "qualifier":"TRK",
 "date":"2012-08-10T04:03:51+0200",
 "lname":"Sonar",
 "lang":"java",
 "version":"3.3-SNAPSHOT",
 "description":"Open source platform for continuous inspection of code quality",
 
 "p1":"previous_analysis",
 "p1p":"2012-08-09",
 "p1d":"2012-08-09T04:04:01+0200",
 "p2":"days","p2p":"7",
 "p2d":"2012-08-03T04:03:51+0200",
 ...
 
 "msr":[
 {
 "key":"coverage",
 "val":70.3,
 "frmt_val":"70.3%",
 "alert":null,
 "alert_text":null,
 "trend":0,
 "var":0,
 "var1":0.0,
 "var2":0.0,
 ...
 },
 ...
 ]
 }
]</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 500. See <a href="http://jira.codehaus.org/browse/SONAR-2920">SONAR-2920</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 colspan="1" class="confluenceTh">Default Value</th><th colspan="1" class="confluenceTh">Example Values</th></tr><tr><td class="confluenceTd">resource</td><td class="confluenceTd">id or key of the resource</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">org.codehaus.sonar:sonar</td></tr><tr><td class="confluenceTd">metrics</td><td class="confluenceTd">Comma-separated list of metric keys/ids. Load measures on selected metrics. If only one metric is set, then measures are ordered by value.</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">lines,blocker_violations</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 colspan="1" 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 colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">PRJ,DIR</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 colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">TRK,BRC</td></tr><tr><td colspan="1" class="confluenceTd">languages</td><td colspan="1" class="confluenceTd">Comma-separated list of language keys. Since version 3.4. </td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">java,js</td></tr><tr><td class="confluenceTd">verbose</td><td class="confluenceTd">Add some data to response. Possible values: true | false </td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">false</td><td colspan="1" class="confluenceTd">true</td></tr><tr><td class="confluenceTd">limit</td><td class="confluenceTd">Limit the number of results. Only used if one metric, and only one, is set.</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">None</td><td colspan="1" class="confluenceTd">10</td></tr><tr><td class="confluenceTd">includetrends</td><td class="confluenceTd">Include trends and period variations in response: add &lt;trend&gt; (1 if better, else worse), &lt;var&gt; (1 if measure value increases) and nodes &lt;p*&gt; for period variations. Possible values: true | false </td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">false</td><td colspan="1" class="confluenceTd">true</td></tr><tr><td class="confluenceTd">includealerts</td><td class="confluenceTd">Include alerts data: add nodes &lt;alert&gt; (ERROR, WARN, OK) and &lt;alert_text&gt; Possible values: true | false  </td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">false</td><td colspan="1" class="confluenceTd">true</td></tr><tr><td class="confluenceTd">rules</td><td class="confluenceTd">Filter on rules: setting it to true will return rules id and rule name for measure having such info (such as 'blocker_violations', 'critical_violations', ..., 'new_blocker_violations', ...) Possible values: true | false | list of rule ids </td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">false</td><td colspan="1" class="confluenceTd">true</td></tr><tr><td class="confluenceTd">rule_priorities</td><td class="confluenceTd">Filter on rule priority: setting it to true or to a list of priorities (BLOCKER, CRITICAL, MAJOR, MINOR, INFO) will return measures having such info (such as 'blocker_violations', 'critical_violations', ..., 'new_blocker_violations', ...). Possible values: true | false | list of priorities</td><td colspan="1" class="confluenceTd">No</td><td colspan="1" class="confluenceTd">false</td><td colspan="1" class="confluenceTd">BLOCKER,CRITICAL</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 style="list-style-type: none;"><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>