Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Get all the violations from project Sonar (key = org.codehaus.sonar:sonar):

    Code Block
    languagenone
    GET http://nemo.sonarsource.org/api/violations?resource=org.codehaus.sonar:sonar&depth=-1



  2. Get all the versions blocker and alerts critical violations from project Sonar (key = org.codehaus.sonar:sonar between January 1st, 2012 and August 31st, 2012):

    Code Block
    languagenone
    GET httpGET http://nemo.sonarsource.org/api/eventsviolations?resource=org.codehaus.sonar:sonar&categories=Alert,Version&fromDate=2012-01-01&toDate=2012-08-31

    Get global events from October 8th, 2012:

    Code Block
    languagenone
    GET http://localhost:9000/api/events?fromDate=2012-10-08
    depth=-1&priorities=BLOCKER,CRITICAL

Parameters

Parameter

Description

Required

Default value

resource

id or key of the resource

Yes

 

depth

Used only when resource is set. 

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

0

scopes

Comma-separated list of scopes:

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

 

qualifiers

Comma-separated list of qualifiers: 

  • TRK: project 
  • BRC: module 
  • CLA: class 
  • UTS: unit test 
  • DIR: directory 
  • FIL: file
No

 

rules

Comma-separated list od rule keys or ids

No

 

priorities

Comma-separated list of priorities
Possible values: BLOCKER | CRITICAL | MAJOR | MINOR | INFO

No

 

limit

Maximum number of results

No

5000

include_review

Include review data into response.
Possible values: true | false

No

false

output

Output format of review comments. Ignored if include_review is false.
Possible values: PLAIN | HTML 

No

PLAIN

switched_off

If true, then return only switched-off violations (usually false-positives), 
else switched-off violations are excluded.
Possible values: true | false 

No

false