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 |
| Method | GET |
Security | Authentication required |
Examples
Return the logged in user's list of favourites:
Parameters
Parameter | Description | Required | Default Value |
|---|---|---|---|
| format | Response formats: xml or json | No | xml |
Create a Favourite
| Description | Create a favourite |
URL | /api/favourites |
| Method | POST |
Security | Authentication required |
Examples
Create a favourite on resource resourceToFlag 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 |
Delete a Favourite
| Description | Delete a favourite |
URL | /api/favourites/:key |
| Method | DELETE |
Security | Authentication required |
Examples
Delete the favourite flag on resource resourceToUnflag 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
