Project

General

Profile

Rest api » History » Version 81

Jean-Philippe Lang, 2012-07-27 22:54
JSONP Support

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