Project

General

Profile

Rest api » History » Version 89

Jean-Philippe Lang, 2013-01-27 14:54
User impersonation

1 26 Jean-Philippe Lang
{{>toc}}
2
3 1 Jean-Philippe Lang
h1. Redmine API
4
5 60 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. The API supports both "XML":http://en.wikipedia.org/wiki/Xml and "JSON":http://en.wikipedia.org/wiki/JSON formats.
6 1 Jean-Philippe Lang
7
h2. API Description
8
9 24 Jean-Philippe Lang
|_.Resource                     |_.Status     |_.Notes  |_.Availability|
10 56 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Stable        | Usable with some bugs and rough edges.  | 1.0 |
11
|[[Rest_Projects|Projects]]     | Stable        | Usable with some bugs and rough edges.  | 1.0 |
12 55 Jean-Philippe Lang
|[[Rest_Memberships|Project Memberships]]  | Alpha | | 1.4 |
13 56 Jean-Philippe Lang
|[[Rest_Users|Users]]           | Stable | | 1.1 |
14
|[[Rest_TimeEntries|Time Entries]]           | Stable | | 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
|[[Rest_Versions|Versions]]  | Alpha | | 1.3 |
18 85 Jean-Philippe Lang
|[[Rest_WikiPages|Wiki Pages]]  | Alpha | | 2.2 |
19 44 Jean-Philippe Lang
|[[Rest_Queries|Queries]]  | Alpha | | 1.3 |
20 63 Jean-Philippe Lang
|[[Rest_Attachments|Attachments]]  | Beta | Adding attachments via the API added in 1.4 | 1.3 |
21 53 Jean-Philippe Lang
|[[Rest_IssueStatuses|Issue Statuses]]  | Alpha | Provides the list of all statuses | 1.3 |
22 51 Jean-Philippe Lang
|[[Rest_Trackers|Trackers]]  | Alpha | Provides the list of all trackers | 1.3 |
23 84 Jean-Philippe Lang
|[[Rest_Enumerations|Enumerations]]  | Alpha | Provides the list of issue priorities and time tracking activities | 2.2 |
24 52 Jean-Philippe Lang
|[[Rest_IssueCategories|Issue Categories]]  | Alpha | | 1.3 |
25 55 Jean-Philippe Lang
|[[Rest_Roles|Roles]]  | Alpha | | 1.4 |
26 79 Jean-Philippe Lang
|[[Rest_Groups|Groups]]  | Alpha | | 2.1 |
27 24 Jean-Philippe Lang
28 15 Eric Davis
Status legend:
29 1 Jean-Philippe Lang
30
* Stable - feature complete, no major changes planned
31
* Beta - usable for integrations with some bugs or missing minor functionality
32
* Alpha - major functionality in place, needs feedback from API users and integrators
33
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
34
* Planned - planned in a future version, depending on developer availability
35
36 24 Jean-Philippe Lang
h2. General topics
37 1 Jean-Philippe Lang
38 78 Jean-Philippe Lang
h3. Specify @Content-Type@ on @POST@/@PUT@ requests
39 66 Etienne Massip
40 83 Jean-Philippe Lang
When creating or updating a remote element, the @Content-Type@ of the request *MUST* be specified even if the remote URL is suffixed accordingly (e.g. @POST ../issues.json@):
41 82 Jean-Philippe Lang
* for JSON content, it must be set to @Content-Type: application/json@.
42 78 Jean-Philippe Lang
* for XML content, to @Content-Type: application/xml@.
43 66 Etienne Massip
44 24 Jean-Philippe Lang
h3. Authentication
45
46
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:
47
* using your regular login/password via HTTP Basic authentication.
48 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:
49
** passed in as a "key" parameter
50
** passed in as a username with a random password via HTTP Basic authentication
51 46 John Galambos
** passed in as a "X-Redmine-API-Key" HTTP header (added in Redmine 1.1.0)
52 38 Jean-Philippe Lang
53
You can find your API key on your account page ( /my/account ) when logged in, on the right-hand pane of the default layout.
54 24 Jean-Philippe Lang
55 89 Jean-Philippe Lang
h3. User Impersonation
56
57
As of Redmine 2.2.0, you can impersonate user through the REST API by setting the @X-Redmine-Switch-User@ header of your API request. It must be set to a user login (eg. @X-Redmine-Switch-User: jsmith@). This only works when using the API with an administrator account, this header will be ignored when using the API with a regular user account.
58
59 24 Jean-Philippe Lang
h3. Collection resources and pagination
60
61 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:
62 24 Jean-Philippe Lang
63
* @offset@: the offset of the first object to retrieve
64
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
65
66
Examples:
67
68
<pre>
69
GET /issues.xml
70
=> returns the 25 first issues
71
72
GET /issues.xml?limit=100
73
=> returns the 100 first issues
74
75
GET /issues.xml?offset=30&limit=10
76
=> returns 10 issues from the 30th
77
</pre>
78
79
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:
80
81
<pre>
82
GET /issues.xml
83
84
<issues type="array" total_count="2595" limit="25" offset="0">
85
  ...
86
</issues>
87
</pre>
88
89
<pre>
90
GET /issues.json
91
92
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
93
</pre>
94
95
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:
96
97
<pre>
98
GET /issues.xml?nometa=1
99
100
<issues type="array">
101
  ...
102
</issues>
103
</pre>
104 23 Jean-Philippe Lang
105 29 Etienne Massip
h3. Fetching associated data
106
107
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 :
108
109
Example:
110
111 41 Jean-Philippe Lang
To retrieve issue journals with its description:
112 29 Etienne Massip
113
<pre>
114
GET /issues/296.xml?include=journals
115
116
<issue>
117
  <id>296</id>
118 30 Etienne Massip
  ...
119 29 Etienne Massip
  <journals type="array">
120
  ...
121 1 Jean-Philippe Lang
  </journals>
122 41 Jean-Philippe Lang
</issue>
123
</pre>
124
125
You can also load multiple associations using a coma separated list of items.
126
127
Example:
128
129
<pre>
130
GET /issues/296.xml?include=journals,changesets
131
132
<issue>
133
  <id>296</id>
134
  ...
135
  <journals type="array">
136
  ...
137
  </journals>
138
  <changesets type="array">
139
  ...
140
  </changesets>
141 29 Etienne Massip
</issue>
142
</pre>
143
144 42 Jean-Philippe Lang
h3. Working with custom fields
145
146
Most of the Redmine objects support custom fields. Their values can be found in the @custom_fields@ attributes.
147
148
XML Example:
149
150
<pre>
151
GET /issues/296.xml      # an issue with 2 custom fields
152
153
<issue>
154
  <id>296</id>
155
  ...
156
  <custom_fields type="array">
157
    <custom_field name="Affected version" id="1">
158
      <value>1.0.1</value>
159
    </custom_field>
160
    <custom_field name="Resolution" id="2">
161
      <value>Fixed</value>
162
    </custom_field>
163
  </custom_fields>
164
</issue>
165
</pre>
166
167
JSON Example:
168
169
<pre>
170
GET /issues/296.json      # an issue with 2 custom fields
171
172
{"issue":
173
  {
174
    "id":8471,
175
    ...
176
    "custom_fields":
177
      [
178
        {"value":"1.0.1","name":"Affected version","id":1},
179
        {"value":"Fixed","name":"Resolution","id":2}
180
      ]
181
  }
182
}
183
</pre>
184
185
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).
186
187
XML Example:
188
189
<pre>
190
PUT /issues/296.xml
191
192
<issue>
193
  <subject>Updating custom fields of an issue</subject>
194
  ...
195
  <custom_fields type="array">
196
    <custom_field id="1">
197
      <value>1.0.2</value>
198
    </custom_field>
199
    <custom_field id="2">
200
      <value>Invalid</value>
201
    </custom_field>
202
  </custom_fields>
203
</issue>
204
</pre>
205
206
Note: the @type="array"@ attribute on @custom_fields@ XML tag is strictly required.
207
208
JSON Example:
209
210
<pre>
211
PUT /issues/296.json
212
213
{"issue":
214
  {
215
    "subject":"Updating custom fields of an issue",
216
    ...
217
    "custom_fields":
218
      [
219
        {"value":"1.0.2","id":1},
220
        {"value":"Invalid","id":2}
221
      ]
222
  }
223
}
224
</pre>
225
226 61 Jean-Philippe Lang
h3. Attaching files
227
228
Support for adding attachments through the REST API is added in Redmine version:1.4.0.
229
230
First, you need to upload your file with a POST request to @/uploads.xml@ (or @/uploads.json@). The request body should be the content of the file you want to attach and the @Content-Type@ header must be set to @application/octet-stream@ (otherwise you'll get a @406 Not Acceptable@ response). If the upload succeeds, you get a 201 response that contains a token for your uploaded file.
231
232
<pre>
233
POST /uploads.xml
234
Content-Type: application/octet-stream
235
...
236
(request body is the file content)
237
238
# 201 response
239
<upload>
240
  <token>7167.ed1ccdb093229ca1bd0b043618d88743</token>
241
</upload>
242
</pre>
243
244
Then you can use this token to attach your uploaded file to a new or an existing issue.
245
246
<pre>
247
POST /issues.xml
248
<issue>
249
  <project_id>1</project_id>
250
  <subject>Creating an issue with a uploaded file</subject>
251 62 Jean-Philippe Lang
  <uploads type="array">
252 61 Jean-Philippe Lang
    <upload>
253
      <token>7167.ed1ccdb093229ca1bd0b043618d88743</token>
254
      <filename>image.png</filename>
255 86 Etienne Massip
      <description>An optional description here</description>
256 61 Jean-Philippe Lang
      <content_type>image/png</content_type>
257
    </upload>
258
  </uploads>
259
</issue>
260
</pre>
261
262 64 Jean-Philippe Lang
If you try to upload a file that exceeds the maximum size allowed, you get a 422 response:
263
264
<pre>
265
POST /uploads.xml
266
Content-Type: application/octet-stream
267
...
268
(request body larger than the maximum size allowed)
269
270
# 422 response
271
<errors>
272
  <error>This file cannot be uploaded because it exceeds the maximum allowed file size (1024000)</error>
273
</errors>
274
</pre>
275
276 59 Jean-Philippe Lang
h3. Validation errors
277
278
When trying to create or update an object with invalid or missing attribute parameters, you will get a @422 Unprocessable Entity@ response. That means that the object could not be created or updated. In such cases, the response body contains the corresponding error messages:
279
280
+XML Example+:
281
282
<pre>
283
# Request with invalid or missing attributes
284
POST /users.xml
285
<user>
286
  <login>john</login>
287
  <lastname>Smith</lastname>
288
  <mail>john</mail>
289
</uer>
290
291
# 422 response with the error messages in its body
292 65 Jean-Philippe Lang
<errors type="array">
293 59 Jean-Philippe Lang
  <error>First name can't be blank</error>
294
  <error>Email is invalid</error>
295
</errors>
296
</pre>
297
298
299
+JSON Example+:
300
301
<pre>
302
# Request with invalid or missing attributes
303
POST /users.json
304
{
305
  "user":{
306
    "login":"john",
307
    "lastname":"Smith",
308
    "mail":"john"
309
  }
310
}
311
312
# 422 response with the error messages in its body
313
{
314
  "errors":[
315
    "First name can't be blank",
316
    "Email is invalid"
317
  ]
318
}
319
</pre>
320
321 81 Jean-Philippe Lang
h3. JSONP Support
322
323 88 Jean-Philippe Lang
Redmine 2.1.0+ API supports "JSONP":http://en.wikipedia.org/wiki/JSONP to request data from a Redmine server in a different domain (say, with JQuery). The callback can be passed using the @callback@ or @jsonp@ parameter. As of Redmine 2.3.0, JSONP support is optional and disabled by default, you can enable it by checking *Enable JSONP support* in Administration -> Settings -> Authentication.
324 81 Jean-Philippe Lang
325
Example:
326
327
<pre>
328
GET /issues.json?callback=myHandler
329
330
myHandler({"issues":[ ... ]})
331
</pre>
332
333 1 Jean-Philippe Lang
h2. API Usage in various languages/tools
334 5 Jean-Philippe Lang
335 1 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
336
* [[Rest_api_with_php|PHP]]
337 23 Jean-Philippe Lang
* [[Rest_api_with_python|Python]]
338 27 Jean-Philippe Lang
* [[Rest_api_with_java|Java]]
339 1 Jean-Philippe Lang
* [[Rest_api_with_curl|cURL]]
340 37 Bevan Rudge
* "Drupal Redmine API module, 2.x branch (currently not stable)":http://drupal.org/project/redmine
341 48 Dorin Huzum
* [[Rest_api_with_csharp|.NET]]
342 49 Rodrigo Carvalho
* [[Rest_api_with_delphi|Delphi]]
343 54 Jean-Philippe Lang
344
h2. API Change history
345
346 58 Jean-Philippe Lang
This section lists changes to the existing API features only. New features of the API are listed in the [[Rest_api#API-Description|API Description]].
347 57 Jean-Philippe Lang
348 54 Jean-Philippe Lang
h3. 2012-01-29: Multiselect custom fields (r8721, version:1.4.0)
349
350
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.
351
352
Example:
353
354
<pre>
355
GET /issues/296.json
356
357
{"issue":
358
  {
359
    "id":8471,
360
    ...
361
    "custom_fields":
362
      [
363
        {"value":["1.0.1","1.0.2"],"multiple":true,"name":"Affected version","id":1},
364
        {"value":"Fixed","name":"Resolution","id":2}
365
      ]
366
  }
367
}
368
</pre>