| Info | ||||
|---|---|---|---|---|
| ||||
|
Get a List of Events
| Description | Get a list of events from a project |
...
URL | /api/events |
| HTTP Method | GET |
| Response Formats | json | xml |
Security | Requires User role to get the list of events for a specific project |
...
Examples
| Use Case | Example Request |
|---|---|
| Get all the versions from project Sonar (key = org.codehaus.sonar:sonar) |
|
| Get all the versions and alerts from project Sonar (key = org.codehaus.sonar:sonar) between January 1st, 2012 and August 31st, 2012 | |
| Get global events from October 8th, 2012 |
Response Format
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"id":"573318",
"rk":"org.codehaus.sonar:sonar",
"n":"3.3-SNAPSHOT",
"c":"Version",
"dt":"2012-10-05T22:15:38+0000"
},
...
] |
...
Parameter | Description | Required | Default Value | Example Value | |
|---|---|---|---|---|---|
resource | id or key of the project | No | Get global events if not setYes | None | org.codehaus.sonar:sonar |
categories | Comma-separated list of category filters (case-sensitive) | No | None | Version,Alert | |
fromDateTime | ISO-8601 datetime (inclusive) | No | None | 2010-12-25T23:59:59+0100 | |
toDateTime | ISO-8601 datetime (inclusive) | No | None | 2010-12-25T23:59:59+0100 | |
fromDate | Date (inclusive) | No | None | 2010-12-25 | |
toDate | Date (inclusive) | No | None | 2010-12-25 | |
| format | Response format .Possible values can be set through:
| No | None | json |
Create an Event
| Description | Create an event |
URL | /api/events |
| HTTP Method | POST |
| Security | Requires Project Administrator role |
Examples
| Use Case | Example Request |
|---|---|
Create an event on project Sonar (key = org.codehaus.sonar:sonar) with administrator admin/admin:
|
|
Parameters
Parameter | Description | Required | Default Value | Example Value | |||
|---|---|---|---|---|---|---|---|
resource | id or key of the project | Yes | None | org.codehaus.sonar:sonar | |||
category | Event category | Yes | None | Alert | |||
name | Event name | Yes | None | abc | |||
description | Event description | No | None | blabla
If nothing is set, json is used. | No | None | json |
