Rest api » History » Version 25

Jean-Philippe Lang, 2010-12-23 15:20

1 1 Jean-Philippe Lang
h1. Redmine API
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
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.
4 1 Jean-Philippe Lang
5 1 Jean-Philippe Lang
h2. API Description
6 1 Jean-Philippe Lang
7 24 Jean-Philippe Lang
|_.Resource                     |_.Status     |_.Notes  |_.Availability|
8 24 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  | 1.0 |
9 24 Jean-Philippe Lang
|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  | 1.0 |
10 24 Jean-Philippe Lang
|[[Rest_Users|Users]]           | Planned | | 1.1 |
11 24 Jean-Philippe Lang
|[[Rest_TimeEntries|TimeEntries]]           | Planned | | 1.1 |
12 24 Jean-Philippe Lang
|[[Rest_News|News]]             | Prototype, Planned | Prototype implementation for @index@ only | 1.1 |
13 24 Jean-Philippe Lang
|[[Rest_WikiPages|Wiki Pages]]  | Planned | | 1.2 |
14 24 Jean-Philippe Lang
15 15 Eric Davis
Status legend:
16 1 Jean-Philippe Lang
17 1 Jean-Philippe Lang
* Stable - feature complete, no major changes planned
18 1 Jean-Philippe Lang
* Beta - usable for integrations with some bugs or missing minor functionality
19 1 Jean-Philippe Lang
* Alpha - major functionality in place, needs feedback from API users and integrators
20 1 Jean-Philippe Lang
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
21 1 Jean-Philippe Lang
* Planned - planned in a future version, depending on developer availability
22 1 Jean-Philippe Lang
23 24 Jean-Philippe Lang
h2. General topics
24 1 Jean-Philippe Lang
25 24 Jean-Philippe Lang
h3. Authentication
26 24 Jean-Philippe Lang
27 24 Jean-Philippe Lang
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:
28 24 Jean-Philippe Lang
* using your regular login/password via HTTP Basic authentication.
29 24 Jean-Philippe Lang
* 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.
30 24 Jean-Philippe Lang
31 24 Jean-Philippe Lang
h3. Collection resources and pagination
32 24 Jean-Philippe Lang
33 24 Jean-Philippe Lang
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:
34 24 Jean-Philippe Lang
35 24 Jean-Philippe Lang
* @offset@: the offset of the first object to retrieve
36 24 Jean-Philippe Lang
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
37 24 Jean-Philippe Lang
38 25 Jean-Philippe Lang
Alternatively, you can use the @page@ parameter, instead of @offset@, in conjunction with @limit@.
39 24 Jean-Philippe Lang
40 24 Jean-Philippe Lang
Examples:
41 24 Jean-Philippe Lang
42 24 Jean-Philippe Lang
<pre>
43 24 Jean-Philippe Lang
GET /issues.xml
44 24 Jean-Philippe Lang
=> returns the 25 first issues
45 24 Jean-Philippe Lang
46 24 Jean-Philippe Lang
GET /issues.xml?limit=100
47 24 Jean-Philippe Lang
=> returns the 100 first issues
48 24 Jean-Philippe Lang
49 24 Jean-Philippe Lang
GET /issues.xml?offset=30&limit=10
50 24 Jean-Philippe Lang
=> returns 10 issues from the 30th
51 24 Jean-Philippe Lang
52 24 Jean-Philippe Lang
GET /issues.xml?page=3&limit=10
53 24 Jean-Philippe Lang
=> same as above
54 24 Jean-Philippe Lang
</pre>
55 24 Jean-Philippe Lang
56 24 Jean-Philippe Lang
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:
57 24 Jean-Philippe Lang
58 24 Jean-Philippe Lang
<pre>
59 24 Jean-Philippe Lang
GET /issues.xml
60 24 Jean-Philippe Lang
61 24 Jean-Philippe Lang
<issues type="array" total_count="2595" limit="25" offset="0">
62 24 Jean-Philippe Lang
  ...
63 24 Jean-Philippe Lang
</issues>
64 24 Jean-Philippe Lang
</pre>
65 24 Jean-Philippe Lang
66 24 Jean-Philippe Lang
<pre>
67 24 Jean-Philippe Lang
GET /issues.json
68 24 Jean-Philippe Lang
69 24 Jean-Philippe Lang
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
70 24 Jean-Philippe Lang
</pre>
71 24 Jean-Philippe Lang
72 24 Jean-Philippe Lang
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:
73 24 Jean-Philippe Lang
74 24 Jean-Philippe Lang
<pre>
75 24 Jean-Philippe Lang
GET /issues.xml?nometa=1
76 24 Jean-Philippe Lang
77 24 Jean-Philippe Lang
<issues type="array">
78 24 Jean-Philippe Lang
  ...
79 24 Jean-Philippe Lang
</issues>
80 24 Jean-Philippe Lang
</pre>
81 23 Jean-Philippe Lang
82 1 Jean-Philippe Lang
h2. API Usage in various languages/tools
83 5 Jean-Philippe Lang
84 1 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
85 1 Jean-Philippe Lang
* [[Rest_api_with_php|PHP]]
86 23 Jean-Philippe Lang
* [[Rest_api_with_python|Python]]
87 1 Jean-Philippe Lang
* [[Rest_api_with_curl|cURL]]