You are viewing an old version of this page. View the current version.
Compare with Current ·
View Page History
| Table of Contents |
Get a List of Resources
| Description | Get a list of resources |
URL | /api/resources |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | Requires User role on resource |
Examples
| Use Case | Example Request |
|---|---|
| Get all the projects | |
| For each project, get lines of code and code coverage measures | |
| Get lines of code and code coverage measures for project org.codehaus.sonar:sonar | GET http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&metrics=ncloc,coverage |
| Get all the resources included in project org.codehaus.sonar:sonar: packages, files, etc. | GET http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&depth=-1 |
| Get all the files included in project org.codehaus.sonar:sonar |
|
| Hotspot of the ten files with the worst code coverage for project org.codehaus.sonar:sonar | |
| Get lines of code measure of direct children of org.codehaus.sonar:sonar |
|
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Values |
|---|---|---|---|---|
resource | id or key of the resource | No | None | org.codehaus.sonar:sonar |
metrics | Comma-separated list of metric keys/ids. | No | None | lines,blocker_violations |
depth | Used only when resource is set.
| No | 0 | -1 |
scopes | Comma-separated list of scopes:
| No | None | PRJ,DIR |
qualifiers | Comma-separated list of qualifiers:
| No | None | TRK,BRC |
verbose | Add some data to response. | No | false | true |
limit | Limit the number of results. Only used if one metric, and only one, is set. | No | None | 10 |
includetrends | Include trends and period variations in response: add <trend> (1 if better, else worse), <var> (1 if measure value increases) and nodes <p*> for period variations. | No | false | true |
includealerts | Include alerts data: add nodes <alert> (ERROR, WARN, OK) and <alert_text> | No | false | true |
rules | 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', ...) | No | false | true |
rule_priorities | 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', ...). | No | false | BLOCKER,CRITICAL |
| format | Response formats. Possible values: json | xml | No | None | json |
Search Resources by Name
| Description | Search resources by name |
URL | /api/resources/search |
| HTTP Method | GET |
| Response Formats | json |
Security | Requires User role on resources |
Examples
| Use Case | Example Request |
|---|---|
| Get all the projects and sub-projects with name containing 'com' |
|
Response Format
JSON
Parameters
Parameter | Description | Required | Default Value | Example Values |
|---|---|---|---|---|
s | String to look for. | No | None | com |
q | Comma-separated list of qualifiers:
| No | None | TRK,BRC |
| format | Response formats. Possible values: json | No | None | json |
Labels
