...
| Description | Get a list of reviews |
URL | /api/reviews |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | Requires User role on the project |
| Number or Results | Results are limited to 200 reviews, ordered by creation date (most recent to oldest) |
ExamplesExamples
| Use Case | Example Request |
|---|---|
| Get reviews whose ids are 47 and 48 |
...
...
| language | none |
|---|
|
...
| Get all the open reviews on project Sonar (key = org.codehaus.sonar:sonar |
...
| language | none |
|---|
...
Response Format
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"id":48,
"createdAt":"2011-05-28T22:17:55+0000",
"updatedAt":"2012-03-08T08:35:35+0000",
"author":"evgeny.mandrikov",
"assignee":"evgeny.mandrikov",
"title":"Substitute calls to size() == 0 (or size() != 0) with calls to isEmpty()",
"status":"CLOSED",
"severity":"MINOR",
"resource":"org.codehaus.sonar.plugins:sonar-dbcleaner-plugin:org.sonar.plugins.dbcleaner.purges.PurgeOrphanResources",
"line":45,
"violationId":41804608,
"comments":[
{
"id":62,
"author":"evgeny.mandrikov",
"updatedAt":"2011-05-28T22:17:55+0000",
"text":"Indeed - why not."
},
...
]
},
...
] |
Parameters
Parameter | Description | Required | Default valueValue | Example Value |
|---|---|---|---|---|
ids | List of review ids | No | None | 3245,3251 |
resources | Comma-separated list of resource ids or keys | No | None | org.codehaus.sonar:sonar-application:org.sonar.application.StartServer |
projects | Comma-separated list of root project ids or keys | No | None | org.codehaus.sonar:sonar |
statuses | Comma-separated list of status | No | None | OPEN,CLOSED |
resolutions | Comma-separated list of resolutions | No | None | FIXED,FALSE-POSTIVE |
severities | Comma-separated list of severities | No | None | BLOCKER,CRITICAL |
authors | Comma-separated list of author login | No | None | admin,simon.brandhof |
assignees | Comma-separated list of assignee login | No | None | admin,simon.brandhof |
review_type | Type of review | No | VIOLATION | VIOLATION,FALSE-POSITIVE |
output | Format of comments | No | PLAIN | HTML |
| format | Response format: xml or json | No | xml | json |
Notes
Results are limited to 200 reviews, ordered by creation date (most recent to oldest).
Create a Review
| Description | Create an review |
URL | /api/reviews |
| Method | POST |
| Security | Requires authentication |
Examples
| Use Case | Example Request |
|---|---|
| Create a review on |
...
violation of id '123':
|
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
violation_id | Violation on which the review should be created | Yes | None | 123 |
status | Initial status (can be 'OPEN' or 'RESOLVED') | Yes | None | OPEN |
comment | Text of initial comment | No | None | My comment |
resolution | If status 'RESOLVED', then resolution must be provided (can be 'FIXED' or 'FALSE-POSITIVE') | No | None | FIXED |
assignee | Login of initial assignee | No | None | simon.brandhof |
Add a Comment on a Review
| Description | Add a comment |
URL | /api/reviews/add_comment |
| Method | PUT |
| Security | Requires authentication |
Examples
| Use Case | Example Request |
|---|---|
| Add the following comment on |
...
| review of id '345': 'myComment' |
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
id | Review id | Yes | None | 345 |
comment | New comment | Yes | None | My comment |
Reassign a Review
| Description | Reassign a review |
URL | /api/reviews/reassign |
| Method | PUT |
| Security | Requires authentication |
Examples
| Use Case | Example Request |
|---|---|
| Reassign |
...
| review of id '345' to user 'admin' |
...
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
id | Review id | Yes | None | 345 |
assignee | Login of new assignee | Yes | None | simon.brandhof |
Resolve a Review
| Description | Resolve a review |
URL | /api/reviews/resolve |
| Method | PUT |
| Security | Requires authentication |
Examples
| Use Case | Example Request |
|---|---|
| Flag |
...
| review of id '345' as false-positive |
...
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
id | Review id | Yes | None | 345 |
| resolution | Can be 'FIXED' or 'FALSE-POSITIVE' | Yes | None | FIXED |
comment | Comment on the resolution | No | None | My comment |
Reopen a Review
| Description | Reopen a review |
URL | /api/reviews/reopen |
| Method | PUT |
| Security | Requires authentication |
Examples
| Use Case | Example Request |
|---|---|
| Reopen |
...
| review of id '345' |
...
...
| language | none |
|---|
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
id | Review id | Yes | None | 345 |
comment | Comment on the reopen action | No | None | My comment |
