Rest api » History » Version 55

Jean-Philippe Lang, 2012-02-06 11:14
API features for 1.4

1 26 Jean-Philippe Lang
{{>toc}}
2 26 Jean-Philippe Lang
3 1 Jean-Philippe Lang
h1. Redmine API
4 1 Jean-Philippe Lang
5 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.
6 1 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. API Description
8 1 Jean-Philippe Lang
9 24 Jean-Philippe Lang
|_.Resource                     |_.Status     |_.Notes  |_.Availability|
10 24 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Beta        | Usable with some bugs and rough edges.  | 1.0 |
11 24 Jean-Philippe Lang
|[[Rest_Projects|Projects]]     | Beta        | Usable with some bugs and rough edges.  | 1.0 |
12 55 Jean-Philippe Lang
|[[Rest_Memberships|Project Memberships]]  | Alpha | | 1.4 |
13 28 Jean-Philippe Lang
|[[Rest_Users|Users]]           | Beta | | 1.1 |
14 39 Jean-Philippe Lang
|[[Rest_TimeEntries|Time Entries]]           | Beta | | 1.1 |
15 28 Jean-Philippe Lang
|[[Rest_News|News]]             | Prototype | Prototype implementation for @index@ only | 1.1 |
16 43 Jean-Philippe Lang
|[[Rest_IssueRelations|Issue Relations]]  | Alpha | | 1.3 |
17 43 Jean-Philippe Lang
|[[Rest_Versions|Versions]]  | Alpha | | 1.3 |
18 44 Jean-Philippe Lang
|[[Rest_Queries|Queries]]  | Alpha | | 1.3 |
19 45 Jean-Philippe Lang
|[[Rest_Attachments|Attachments]]  | Alpha | | 1.3 |
20 53 Jean-Philippe Lang
|[[Rest_IssueStatuses|Issue Statuses]]  | Alpha | Provides the list of all statuses | 1.3 |
21 51 Jean-Philippe Lang
|[[Rest_Trackers|Trackers]]  | Alpha | Provides the list of all trackers | 1.3 |
22 52 Jean-Philippe Lang
|[[Rest_IssueCategories|Issue Categories]]  | Alpha | | 1.3 |
23 55 Jean-Philippe Lang
|[[Rest_Roles|Roles]]  | Alpha | | 1.4 |
24 24 Jean-Philippe Lang
25 15 Eric Davis
Status legend:
26 1 Jean-Philippe Lang
27 1 Jean-Philippe Lang
* Stable - feature complete, no major changes planned
28 1 Jean-Philippe Lang
* Beta - usable for integrations with some bugs or missing minor functionality
29 1 Jean-Philippe Lang
* Alpha - major functionality in place, needs feedback from API users and integrators
30 1 Jean-Philippe Lang
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
31 1 Jean-Philippe Lang
* Planned - planned in a future version, depending on developer availability
32 1 Jean-Philippe Lang
33 24 Jean-Philippe Lang
h2. General topics
34 1 Jean-Philippe Lang
35 24 Jean-Philippe Lang
h3. Authentication
36 24 Jean-Philippe Lang
37 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:
38 24 Jean-Philippe Lang
* using your regular login/password via HTTP Basic authentication.
39 38 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 in one of the following way:
40 38 Jean-Philippe Lang
** passed in as a "key" parameter
41 38 Jean-Philippe Lang
** passed in as a username with a random password via HTTP Basic authentication
42 46 John Galambos
** passed in as a "X-Redmine-API-Key" HTTP header (added in Redmine 1.1.0)
43 38 Jean-Philippe Lang
44 38 Jean-Philippe Lang
You can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.
45 24 Jean-Philippe Lang
46 24 Jean-Philippe Lang
h3. Collection resources and pagination
47 24 Jean-Philippe Lang
48 47 Tom Clegg
The response to a GET request on a collection ressources (eg. @/issues.xml@, @/users.xml@) generally won't return all the objects available in your database. Redmine version:1.1.0 introduces a common way to query such ressources using the following parameters:
49 24 Jean-Philippe Lang
50 24 Jean-Philippe Lang
* @offset@: the offset of the first object to retrieve
51 24 Jean-Philippe Lang
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
52 24 Jean-Philippe Lang
53 25 Jean-Philippe Lang
Alternatively, you can use the @page@ parameter, instead of @offset@, in conjunction with @limit@.
54 24 Jean-Philippe Lang
55 24 Jean-Philippe Lang
Examples:
56 24 Jean-Philippe Lang
57 24 Jean-Philippe Lang
<pre>
58 24 Jean-Philippe Lang
GET /issues.xml
59 24 Jean-Philippe Lang
=> returns the 25 first issues
60 24 Jean-Philippe Lang
61 24 Jean-Philippe Lang
GET /issues.xml?limit=100
62 24 Jean-Philippe Lang
=> returns the 100 first issues
63 24 Jean-Philippe Lang
64 24 Jean-Philippe Lang
GET /issues.xml?offset=30&limit=10
65 24 Jean-Philippe Lang
=> returns 10 issues from the 30th
66 24 Jean-Philippe Lang
67 24 Jean-Philippe Lang
GET /issues.xml?page=3&limit=10
68 24 Jean-Philippe Lang
=> same as above
69 24 Jean-Philippe Lang
</pre>
70 24 Jean-Philippe Lang
71 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:
72 24 Jean-Philippe Lang
73 24 Jean-Philippe Lang
<pre>
74 24 Jean-Philippe Lang
GET /issues.xml
75 24 Jean-Philippe Lang
76 24 Jean-Philippe Lang
<issues type="array" total_count="2595" limit="25" offset="0">
77 24 Jean-Philippe Lang
  ...
78 24 Jean-Philippe Lang
</issues>
79 24 Jean-Philippe Lang
</pre>
80 24 Jean-Philippe Lang
81 24 Jean-Philippe Lang
<pre>
82 24 Jean-Philippe Lang
GET /issues.json
83 24 Jean-Philippe Lang
84 24 Jean-Philippe Lang
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
85 24 Jean-Philippe Lang
</pre>
86 24 Jean-Philippe Lang
87 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:
88 24 Jean-Philippe Lang
89 24 Jean-Philippe Lang
<pre>
90 24 Jean-Philippe Lang
GET /issues.xml?nometa=1
91 24 Jean-Philippe Lang
92 24 Jean-Philippe Lang
<issues type="array">
93 24 Jean-Philippe Lang
  ...
94 24 Jean-Philippe Lang
</issues>
95 24 Jean-Philippe Lang
</pre>
96 23 Jean-Philippe Lang
97 29 Etienne Massip
h3. Fetching associated data
98 29 Etienne Massip
99 29 Etienne Massip
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 :
100 29 Etienne Massip
101 29 Etienne Massip
Example:
102 29 Etienne Massip
103 41 Jean-Philippe Lang
To retrieve issue journals with its description:
104 29 Etienne Massip
105 29 Etienne Massip
<pre>
106 29 Etienne Massip
GET /issues/296.xml?include=journals
107 29 Etienne Massip
108 29 Etienne Massip
<issue>
109 29 Etienne Massip
  <id>296</id>
110 30 Etienne Massip
  ...
111 29 Etienne Massip
  <journals type="array">
112 29 Etienne Massip
  ...
113 1 Jean-Philippe Lang
  </journals>
114 41 Jean-Philippe Lang
</issue>
115 41 Jean-Philippe Lang
</pre>
116 41 Jean-Philippe Lang
117 41 Jean-Philippe Lang
You can also load multiple associations using a coma separated list of items.
118 41 Jean-Philippe Lang
119 41 Jean-Philippe Lang
Example:
120 41 Jean-Philippe Lang
121 41 Jean-Philippe Lang
<pre>
122 41 Jean-Philippe Lang
GET /issues/296.xml?include=journals,changesets
123 41 Jean-Philippe Lang
124 41 Jean-Philippe Lang
<issue>
125 41 Jean-Philippe Lang
  <id>296</id>
126 41 Jean-Philippe Lang
  ...
127 41 Jean-Philippe Lang
  <journals type="array">
128 41 Jean-Philippe Lang
  ...
129 41 Jean-Philippe Lang
  </journals>
130 41 Jean-Philippe Lang
  <changesets type="array">
131 41 Jean-Philippe Lang
  ...
132 41 Jean-Philippe Lang
  </changesets>
133 29 Etienne Massip
</issue>
134 29 Etienne Massip
</pre>
135 29 Etienne Massip
136 42 Jean-Philippe Lang
h3. Working with custom fields
137 42 Jean-Philippe Lang
138 42 Jean-Philippe Lang
Most of the Redmine objects support custom fields. Their values can be found in the @custom_fields@ attributes.
139 42 Jean-Philippe Lang
140 42 Jean-Philippe Lang
XML Example:
141 42 Jean-Philippe Lang
142 42 Jean-Philippe Lang
<pre>
143 42 Jean-Philippe Lang
GET /issues/296.xml      # an issue with 2 custom fields
144 42 Jean-Philippe Lang
145 42 Jean-Philippe Lang
<issue>
146 42 Jean-Philippe Lang
  <id>296</id>
147 42 Jean-Philippe Lang
  ...
148 42 Jean-Philippe Lang
  <custom_fields type="array">
149 42 Jean-Philippe Lang
    <custom_field name="Affected version" id="1">
150 42 Jean-Philippe Lang
      <value>1.0.1</value>
151 42 Jean-Philippe Lang
    </custom_field>
152 42 Jean-Philippe Lang
    <custom_field name="Resolution" id="2">
153 42 Jean-Philippe Lang
      <value>Fixed</value>
154 42 Jean-Philippe Lang
    </custom_field>
155 42 Jean-Philippe Lang
  </custom_fields>
156 42 Jean-Philippe Lang
</issue>
157 42 Jean-Philippe Lang
</pre>
158 42 Jean-Philippe Lang
159 42 Jean-Philippe Lang
JSON Example:
160 42 Jean-Philippe Lang
161 42 Jean-Philippe Lang
<pre>
162 42 Jean-Philippe Lang
GET /issues/296.json      # an issue with 2 custom fields
163 42 Jean-Philippe Lang
164 42 Jean-Philippe Lang
{"issue":
165 42 Jean-Philippe Lang
  {
166 42 Jean-Philippe Lang
    "id":8471,
167 42 Jean-Philippe Lang
    ...
168 42 Jean-Philippe Lang
    "custom_fields":
169 42 Jean-Philippe Lang
      [
170 42 Jean-Philippe Lang
        {"value":"1.0.1","name":"Affected version","id":1},
171 42 Jean-Philippe Lang
        {"value":"Fixed","name":"Resolution","id":2}
172 42 Jean-Philippe Lang
      ]
173 42 Jean-Philippe Lang
  }
174 42 Jean-Philippe Lang
}
175 42 Jean-Philippe Lang
</pre>
176 42 Jean-Philippe Lang
177 42 Jean-Philippe Lang
You can also set/change the values of the custom fields when creating/updating an object using the same syntax (except that the custom field name is not required).
178 42 Jean-Philippe Lang
179 42 Jean-Philippe Lang
XML Example:
180 42 Jean-Philippe Lang
181 42 Jean-Philippe Lang
<pre>
182 42 Jean-Philippe Lang
PUT /issues/296.xml
183 42 Jean-Philippe Lang
184 42 Jean-Philippe Lang
<issue>
185 42 Jean-Philippe Lang
  <subject>Updating custom fields of an issue</subject>
186 42 Jean-Philippe Lang
  ...
187 42 Jean-Philippe Lang
  <custom_fields type="array">
188 42 Jean-Philippe Lang
    <custom_field id="1">
189 42 Jean-Philippe Lang
      <value>1.0.2</value>
190 42 Jean-Philippe Lang
    </custom_field>
191 42 Jean-Philippe Lang
    <custom_field id="2">
192 42 Jean-Philippe Lang
      <value>Invalid</value>
193 42 Jean-Philippe Lang
    </custom_field>
194 42 Jean-Philippe Lang
  </custom_fields>
195 42 Jean-Philippe Lang
</issue>
196 42 Jean-Philippe Lang
</pre>
197 42 Jean-Philippe Lang
198 42 Jean-Philippe Lang
Note: the @type="array"@ attribute on @custom_fields@ XML tag is strictly required.
199 42 Jean-Philippe Lang
200 42 Jean-Philippe Lang
JSON Example:
201 42 Jean-Philippe Lang
202 42 Jean-Philippe Lang
<pre>
203 42 Jean-Philippe Lang
PUT /issues/296.json
204 42 Jean-Philippe Lang
205 42 Jean-Philippe Lang
{"issue":
206 42 Jean-Philippe Lang
  {
207 42 Jean-Philippe Lang
    "subject":"Updating custom fields of an issue",
208 42 Jean-Philippe Lang
    ...
209 42 Jean-Philippe Lang
    "custom_fields":
210 42 Jean-Philippe Lang
      [
211 42 Jean-Philippe Lang
        {"value":"1.0.2","id":1},
212 42 Jean-Philippe Lang
        {"value":"Invalid","id":2}
213 42 Jean-Philippe Lang
      ]
214 42 Jean-Philippe Lang
  }
215 42 Jean-Philippe Lang
}
216 42 Jean-Philippe Lang
</pre>
217 42 Jean-Philippe Lang
218 1 Jean-Philippe Lang
h2. API Usage in various languages/tools
219 5 Jean-Philippe Lang
220 1 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
221 1 Jean-Philippe Lang
* [[Rest_api_with_php|PHP]]
222 23 Jean-Philippe Lang
* [[Rest_api_with_python|Python]]
223 27 Jean-Philippe Lang
* [[Rest_api_with_java|Java]]
224 1 Jean-Philippe Lang
* [[Rest_api_with_curl|cURL]]
225 37 Bevan Rudge
* "Drupal Redmine API module, 2.x branch (currently not stable)":http://drupal.org/project/redmine
226 48 Dorin Huzum
* [[Rest_api_with_csharp|.NET]]
227 49 Rodrigo Carvalho
* [[Rest_api_with_delphi|Delphi]]
228 54 Jean-Philippe Lang
229 54 Jean-Philippe Lang
h2. API Change history
230 54 Jean-Philippe Lang
231 54 Jean-Philippe Lang
h3. 2012-01-29: Multiselect custom fields (r8721, version:1.4.0)
232 54 Jean-Philippe Lang
233 54 Jean-Philippe Lang
Custom fields with multiple values are now supported in Redmine and may be found in API responses. These custom fields have a @multiple=true attribute@ and their @value@ attribute is an array.
234 54 Jean-Philippe Lang
235 54 Jean-Philippe Lang
Example:
236 54 Jean-Philippe Lang
237 54 Jean-Philippe Lang
<pre>
238 54 Jean-Philippe Lang
GET /issues/296.json
239 54 Jean-Philippe Lang
240 54 Jean-Philippe Lang
{"issue":
241 54 Jean-Philippe Lang
  {
242 54 Jean-Philippe Lang
    "id":8471,
243 54 Jean-Philippe Lang
    ...
244 54 Jean-Philippe Lang
    "custom_fields":
245 54 Jean-Philippe Lang
      [
246 54 Jean-Philippe Lang
        {"value":["1.0.1","1.0.2"],"multiple":true,"name":"Affected version","id":1},
247 54 Jean-Philippe Lang
        {"value":"Fixed","name":"Resolution","id":2}
248 54 Jean-Philippe Lang
      ]
249 54 Jean-Philippe Lang
  }
250 54 Jean-Philippe Lang
}
251 54 Jean-Philippe Lang
</pre>