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 Favourites
| Description | Get the logged in user's list of favourites |
URL | /api/favourites |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | Authentication required |
Examples
| Use Case | Example Request |
|---|---|
| Get the logged in user's list of favourites |
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
| format | Response formats. Possible values: xml | json | No | None | json |
Create a Favourite
| Description | Create a favourite |
URL | /api/favourites |
| HTTP Method | POST |
Security | Authentication required |
Examples
| Use Case | Example Request |
|---|---|
| Create a favourite on project Sonar (key = org.codehaus.sonar:sonar) for the user admin/admin |
|
Parameters
Parameter | Description | Required | Default Value | Example Value |
|---|---|---|---|---|
key | id or key of the resource | Yes | None | org.codehaus.sonar:sonar |
Delete a Favourite
| Description | Delete a favourite |
URL | /api/favourites/:key |
| HTTP Method | DELETE |
Security | Authentication required |
Examples
| Use Case | Example Request |
|---|---|
| Create a favourite on project Sonar (key = org.codehaus.sonar:sonar) for the user admin/admin |
|
Delete the favourite flag on project Sonar (key = org.codehaus.sonar:sonar) for the user admin/admin:
Parameters
Parameter | Description | Required | Default Value | Value |
|---|---|---|---|---|
key | id or key of the resource | Yes | None | org.codehaus.sonar:sonar |
Labels
