This method returns a single event JSON object with information about the element that has the specified id. You can change the format of the JSON response by specifying the format parameter.
Request
GET http://{hostname}:{port}
/events/{id}?{parameters}
Accept: application/json
Table 1. Request parameters
Parameter |
Type |
Required |
Description |
format |
string |
false |
One of the format options; this parameter determines what information is included in the JSON response. If not specified, or if an unrecognized value is specified, the default format of "detail" will be used. |
Table 2. URL parameters
Parameter |
Type |
Required |
Description |
id |
string |
true |
The ID of the event element. |
For the
format parameter, use one of the following format options:
list
- Primary properties with type and releases
detail
- Identical to 'list' format
For details about the full JSON that the server returns when you select one of these formats, see the related resource:
events resource.
Example
curl -k -u jsmith:passwd
"http://myserver.example.com:8080/events/?format=list"
-X GET
-H "Accept: application/json"
Example JSON response
[
{
"type": {
"color": "#ffd700",
"order": 0,
"name": "Holiday",
"description": "Company holiday",
"ghostedDate": 0,
"id": "00000000-0000-1100-0000-000000000013",
"version": 0,
"dateCreated": 0
},
"startDate": 1404446400000,
"endDate": 1404446400000,
"isOneDay": true,
"releases": [],
"description": "",
"name": "July 4",
"id": "b4cf5572-d4a2-43b8-a61c-075cde68b87e",
"version": 0,
"dateCreated": 1402065609393
}
]