Project

General

Profile

Rest api » History » Version 30

Etienne Massip, 2011-02-16 10:43
Added documentation for the include parameter

1 26 Jean-Philippe Lang
{{>toc}}
2
3 1 Jean-Philippe Lang
h1. Redmine API
4
5
Redmine exposes some of its data through a REST API. This API provides access and basic CRUD operations (create, update, delete) for the resources described below.
6
7
h2. API Description
8
9 24 Jean-Philippe Lang
|_.Resource                     |_.Status     |_.Notes  |_.Availability|
10
|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  | 1.0 |
11
|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  | 1.0 |
12 28 Jean-Philippe Lang
|[[Rest_Users|Users]]           | Beta | | 1.1 |
13
|[[Rest_TimeEntries|TimeEntries]]           | Beta | | 1.1 |
14
|[[Rest_News|News]]             | Prototype | Prototype implementation for @index@ only | 1.1 |
15 24 Jean-Philippe Lang
|[[Rest_WikiPages|Wiki Pages]]  | Planned | | 1.2 |
16
17 15 Eric Davis
Status legend:
18 1 Jean-Philippe Lang
19
* Stable - feature complete, no major changes planned
20
* Beta - usable for integrations with some bugs or missing minor functionality
21
* Alpha - major functionality in place, needs feedback from API users and integrators
22
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
23
* Planned - planned in a future version, depending on developer availability
24
25 24 Jean-Philippe Lang
h2. General topics
26 1 Jean-Philippe Lang
27 24 Jean-Philippe Lang
h3. Authentication
28
29
Most of the time, the API requires authentication. To enable the API-style authentication, you have to check *Enable REST API* in Administration -> Settings -> Authentication. Then, authentication can be done in 2 different ways:
30
* using your regular login/password via HTTP Basic authentication.
31
* using your API key which is a handy way to avoid putting a password in a script. The API key may be attached to each request as a "key" parameter or it may be passed in as a username with a random password. You can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.
32
33
h3. Collection resources and pagination
34
35
The response to a GET request on a collection ressources (eg. @/issues.xml@, @/users.xml@) generally won't return all the objets available in your database. Redmine version:1.1.0 introduces a common way to query such ressources using the following parameters:
36
37
* @offset@: the offset of the first object to retrieve
38
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
39
40 25 Jean-Philippe Lang
Alternatively, you can use the @page@ parameter, instead of @offset@, in conjunction with @limit@.
41 24 Jean-Philippe Lang
42
Examples:
43
44
<pre>
45
GET /issues.xml
46
=> returns the 25 first issues
47
48
GET /issues.xml?limit=100
49
=> returns the 100 first issues
50
51
GET /issues.xml?offset=30&limit=10
52
=> returns 10 issues from the 30th
53
54
GET /issues.xml?page=3&limit=10
55
=> same as above
56
</pre>
57
58
Responses to GET requests on collection ressources provide information about the total object count available in Redmine and the offset/limit used for the response. Examples:
59
60
<pre>
61
GET /issues.xml
62
63
<issues type="array" total_count="2595" limit="25" offset="0">
64
  ...
65
</issues>
66
</pre>
67
68
<pre>
69
GET /issues.json
70
71
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
72
</pre>
73
74
Note: if you're using a REST client that does not support such top level attributes (total_count, limit, offset), you can set the @nometa@ parameter or @X-Redmine-Nometa@ HTTP header to 1 to get responses without them. Example:
75
76
<pre>
77
GET /issues.xml?nometa=1
78
79
<issues type="array">
80
  ...
81
</issues>
82
</pre>
83 23 Jean-Philippe Lang
84 29 Etienne Massip
h3. Fetching associated data
85
86
Since of version:1.1.0, you have to explicitly specify the associations you want to be included in the query result by appending the @include@ parameter to the query url :
87
88
Example:
89
90
To retrieve issue journals with its description :
91
92
<pre>
93
GET /issues/296.xml?include=journals
94
95
<issue>
96
  <id>296</id>
97 30 Etienne Massip
  ...
98 29 Etienne Massip
  <journals type="array">
99
  ...
100
  </journals>
101
</issue>
102
</pre>
103
104 1 Jean-Philippe Lang
h2. API Usage in various languages/tools
105 5 Jean-Philippe Lang
106 1 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
107
* [[Rest_api_with_php|PHP]]
108 23 Jean-Philippe Lang
* [[Rest_api_with_python|Python]]
109 27 Jean-Philippe Lang
* [[Rest_api_with_java|Java]]
110 1 Jean-Philippe Lang
* [[Rest_api_with_curl|cURL]]