Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

DescriptionGet a list of resources

URL

/api/resources

HTTP MethodGET
Response Formatsjson | xml

Security

Requires User role on resource

Examples

Use CaseExample Request
Get all the projects

GET http://nemo.sonarsource.org/api/resources

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

GET http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&depth=-1&scope=FIL

Hotspot of the ten files with the worst code coverage for project org.codehaus.sonar:sonar

GET http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&depth=-1&scope=FIL&metrics=coverage&limit=10

Get lines of code measure of direct children of org.codehaus.sonar:sonar

GET http://nemo.sonarsource.org/api/resources?resource=org.codehaus.sonar:sonar&depth=1&metrics=ncloc

Response Format

JSON

Parameters

Parameter

Description

RequiredDefault ValueExample Values

resource

id or key of the resource

NoNoneorg.codehaus.sonar:sonar

metrics

Comma-separated list of metric keys/ids.
Load measures on selected metrics. If only one metric is set, then measures are ordered by value.

NoNonelines,blocker_violations

depth

Used only when resource is set. 

  • 0: only selected resource 
  • -1: all children, including selected resource 
  • >0: depth toward the selected resource
No0-1

scopes

Comma-separated list of scopes:

  • PRJ: project/module 
  • DIR: directory (like Java package) 
  • FIL: file
NoNonePRJ,DIR

qualifiers

Comma-separated list of qualifiers

  • VW: view
  • SVW: sub-view
  • TRK: project 
  • BRC: module 
  • CLA: class 
  • UTS: unit test 
  • DIR: directory 
  • FIL: file
  • DEV: developer
NoNoneTRK,BRC

verbose

Add some data to response.
Possible values: true | false 

Nofalsetrue

limit

Limit the number of results. Only used if one metric, and only one, is set.

NoNone10

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.
Possible values: true | false 

Nofalsetrue

includealerts

Include alerts data: add nodes <alert> (ERROR, WARN, OK) and <alert_text>
Possible values: true | false  

Nofalsetrue

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', ...)
Possible values: true | false | list of rule ids 

Nofalsetrue

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', ...).
Possible values: true | false | list of priorities

NofalseBLOCKER,CRITICAL
formatResponse formats.
Possible values: json | xml
NoNonejson
  • No labels