Rest api » History » Version 97

Jean-Philippe Lang, 2017-03-04 12:57
Adds a link to all API changes

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 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 1 Jean-Philippe Lang
h2. API Description
8 1 Jean-Philippe Lang
9 24 Jean-Philippe Lang
|_.Resource                     |_.Status     |_.Notes  |_.Availability|
10 91 Jean-Philippe Lang
|[[Rest_Issues|Issues]]         | Stable        |  | 1.0 |
11 91 Jean-Philippe Lang
|[[Rest_Projects|Projects]]     | Stable        |   | 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 56 Jean-Philippe Lang
|[[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 43 Jean-Philippe Lang
|[[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 92 Jean-Philippe Lang
|[[Rest_CustomFields|Custom Fields]]  | Alpha | | 2.4 |
28 95 Go MAEDA
|[[Rest_Search|Search]]  | Alpha | | 3.3 |
29 96 Go MAEDA
|[[Rest_Files|Files]]  | Alpha | | 3.4 |
30 24 Jean-Philippe Lang
31 15 Eric Davis
Status legend:
32 1 Jean-Philippe Lang
33 1 Jean-Philippe Lang
* Stable - feature complete, no major changes planned
34 1 Jean-Philippe Lang
* Beta - usable for integrations with some bugs or missing minor functionality
35 1 Jean-Philippe Lang
* Alpha - major functionality in place, needs feedback from API users and integrators
36 1 Jean-Philippe Lang
* Prototype - very rough implementation, possible major breaking changes mid-version. *Not recommended for integration*
37 1 Jean-Philippe Lang
* Planned - planned in a future version, depending on developer availability
38 1 Jean-Philippe Lang
39 97 Jean-Philippe Lang
You can review the list of all the "API changes for each version":/projects/redmine/issues?set_filter=1&status_id=c&fixed_version_id=*&category_id=32&c[]=tracker&c[]=subject&c[]=author&group_by=fixed_version&sort=fixed_version:desc,id.
40 97 Jean-Philippe Lang
41 24 Jean-Philippe Lang
h2. General topics
42 1 Jean-Philippe Lang
43 78 Jean-Philippe Lang
h3. Specify @Content-Type@ on @POST@/@PUT@ requests
44 66 Etienne Massip
45 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@):
46 82 Jean-Philippe Lang
* for JSON content, it must be set to @Content-Type: application/json@.
47 78 Jean-Philippe Lang
* for XML content, to @Content-Type: application/xml@.
48 66 Etienne Massip
49 24 Jean-Philippe Lang
h3. Authentication
50 24 Jean-Philippe Lang
51 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:
52 24 Jean-Philippe Lang
* using your regular login/password via HTTP Basic authentication.
53 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:
54 38 Jean-Philippe Lang
** passed in as a "key" parameter
55 38 Jean-Philippe Lang
** passed in as a username with a random password via HTTP Basic authentication
56 46 John Galambos
** passed in as a "X-Redmine-API-Key" HTTP header (added in Redmine 1.1.0)
57 38 Jean-Philippe Lang
58 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.
59 24 Jean-Philippe Lang
60 89 Jean-Philippe Lang
h3. User Impersonation
61 89 Jean-Philippe Lang
62 89 Jean-Philippe Lang
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.
63 89 Jean-Philippe Lang
64 90 Jean-Philippe Lang
If the login specified with the @X-Redmine-Switch-User@ header does not exist or is not active, you will receive a 412 error response.
65 90 Jean-Philippe Lang
66 24 Jean-Philippe Lang
h3. Collection resources and pagination
67 24 Jean-Philippe Lang
68 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:
69 24 Jean-Philippe Lang
70 24 Jean-Philippe Lang
* @offset@: the offset of the first object to retrieve
71 24 Jean-Philippe Lang
* @limit@: the number of items to be present in the response (default is 25, maximum is 100)
72 24 Jean-Philippe Lang
73 24 Jean-Philippe Lang
Examples:
74 24 Jean-Philippe Lang
75 24 Jean-Philippe Lang
<pre>
76 24 Jean-Philippe Lang
GET /issues.xml
77 24 Jean-Philippe Lang
=> returns the 25 first issues
78 24 Jean-Philippe Lang
79 24 Jean-Philippe Lang
GET /issues.xml?limit=100
80 24 Jean-Philippe Lang
=> returns the 100 first issues
81 24 Jean-Philippe Lang
82 24 Jean-Philippe Lang
GET /issues.xml?offset=30&limit=10
83 24 Jean-Philippe Lang
=> returns 10 issues from the 30th
84 24 Jean-Philippe Lang
</pre>
85 24 Jean-Philippe Lang
86 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:
87 24 Jean-Philippe Lang
88 24 Jean-Philippe Lang
<pre>
89 24 Jean-Philippe Lang
GET /issues.xml
90 24 Jean-Philippe Lang
91 24 Jean-Philippe Lang
<issues type="array" total_count="2595" limit="25" offset="0">
92 24 Jean-Philippe Lang
  ...
93 24 Jean-Philippe Lang
</issues>
94 24 Jean-Philippe Lang
</pre>
95 24 Jean-Philippe Lang
96 24 Jean-Philippe Lang
<pre>
97 24 Jean-Philippe Lang
GET /issues.json
98 24 Jean-Philippe Lang
99 24 Jean-Philippe Lang
{ "issues":[...], "total_count":2595, "limit":25, "offset":0 }
100 24 Jean-Philippe Lang
</pre>
101 24 Jean-Philippe Lang
102 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:
103 24 Jean-Philippe Lang
104 24 Jean-Philippe Lang
<pre>
105 24 Jean-Philippe Lang
GET /issues.xml?nometa=1
106 24 Jean-Philippe Lang
107 24 Jean-Philippe Lang
<issues type="array">
108 24 Jean-Philippe Lang
  ...
109 24 Jean-Philippe Lang
</issues>
110 24 Jean-Philippe Lang
</pre>
111 23 Jean-Philippe Lang
112 29 Etienne Massip
h3. Fetching associated data
113 29 Etienne Massip
114 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 :
115 29 Etienne Massip
116 29 Etienne Massip
Example:
117 29 Etienne Massip
118 41 Jean-Philippe Lang
To retrieve issue journals with its description:
119 29 Etienne Massip
120 29 Etienne Massip
<pre>
121 29 Etienne Massip
GET /issues/296.xml?include=journals
122 29 Etienne Massip
123 29 Etienne Massip
<issue>
124 29 Etienne Massip
  <id>296</id>
125 30 Etienne Massip
  ...
126 29 Etienne Massip
  <journals type="array">
127 29 Etienne Massip
  ...
128 1 Jean-Philippe Lang
  </journals>
129 41 Jean-Philippe Lang
</issue>
130 41 Jean-Philippe Lang
</pre>
131 41 Jean-Philippe Lang
132 41 Jean-Philippe Lang
You can also load multiple associations using a coma separated list of items.
133 41 Jean-Philippe Lang
134 41 Jean-Philippe Lang
Example:
135 41 Jean-Philippe Lang
136 41 Jean-Philippe Lang
<pre>
137 41 Jean-Philippe Lang
GET /issues/296.xml?include=journals,changesets
138 41 Jean-Philippe Lang
139 41 Jean-Philippe Lang
<issue>
140 41 Jean-Philippe Lang
  <id>296</id>
141 41 Jean-Philippe Lang
  ...
142 41 Jean-Philippe Lang
  <journals type="array">
143 41 Jean-Philippe Lang
  ...
144 41 Jean-Philippe Lang
  </journals>
145 41 Jean-Philippe Lang
  <changesets type="array">
146 41 Jean-Philippe Lang
  ...
147 41 Jean-Philippe Lang
  </changesets>
148 29 Etienne Massip
</issue>
149 29 Etienne Massip
</pre>
150 29 Etienne Massip
151 42 Jean-Philippe Lang
h3. Working with custom fields
152 42 Jean-Philippe Lang
153 42 Jean-Philippe Lang
Most of the Redmine objects support custom fields. Their values can be found in the @custom_fields@ attributes.
154 42 Jean-Philippe Lang
155 42 Jean-Philippe Lang
XML Example:
156 42 Jean-Philippe Lang
157 42 Jean-Philippe Lang
<pre>
158 42 Jean-Philippe Lang
GET /issues/296.xml      # an issue with 2 custom fields
159 42 Jean-Philippe Lang
160 42 Jean-Philippe Lang
<issue>
161 42 Jean-Philippe Lang
  <id>296</id>
162 42 Jean-Philippe Lang
  ...
163 42 Jean-Philippe Lang
  <custom_fields type="array">
164 42 Jean-Philippe Lang
    <custom_field name="Affected version" id="1">
165 42 Jean-Philippe Lang
      <value>1.0.1</value>
166 42 Jean-Philippe Lang
    </custom_field>
167 42 Jean-Philippe Lang
    <custom_field name="Resolution" id="2">
168 42 Jean-Philippe Lang
      <value>Fixed</value>
169 42 Jean-Philippe Lang
    </custom_field>
170 42 Jean-Philippe Lang
  </custom_fields>
171 42 Jean-Philippe Lang
</issue>
172 42 Jean-Philippe Lang
</pre>
173 42 Jean-Philippe Lang
174 42 Jean-Philippe Lang
JSON Example:
175 42 Jean-Philippe Lang
176 42 Jean-Philippe Lang
<pre>
177 42 Jean-Philippe Lang
GET /issues/296.json      # an issue with 2 custom fields
178 42 Jean-Philippe Lang
179 42 Jean-Philippe Lang
{"issue":
180 42 Jean-Philippe Lang
  {
181 42 Jean-Philippe Lang
    "id":8471,
182 42 Jean-Philippe Lang
    ...
183 42 Jean-Philippe Lang
    "custom_fields":
184 42 Jean-Philippe Lang
      [
185 42 Jean-Philippe Lang
        {"value":"1.0.1","name":"Affected version","id":1},
186 42 Jean-Philippe Lang
        {"value":"Fixed","name":"Resolution","id":2}
187 42 Jean-Philippe Lang
      ]
188 42 Jean-Philippe Lang
  }
189 42 Jean-Philippe Lang
}
190 42 Jean-Philippe Lang
</pre>
191 42 Jean-Philippe Lang
192 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).
193 42 Jean-Philippe Lang
194 42 Jean-Philippe Lang
XML Example:
195 42 Jean-Philippe Lang
196 42 Jean-Philippe Lang
<pre>
197 42 Jean-Philippe Lang
PUT /issues/296.xml
198 42 Jean-Philippe Lang
199 42 Jean-Philippe Lang
<issue>
200 42 Jean-Philippe Lang
  <subject>Updating custom fields of an issue</subject>
201 42 Jean-Philippe Lang
  ...
202 42 Jean-Philippe Lang
  <custom_fields type="array">
203 42 Jean-Philippe Lang
    <custom_field id="1">
204 42 Jean-Philippe Lang
      <value>1.0.2</value>
205 42 Jean-Philippe Lang
    </custom_field>
206 42 Jean-Philippe Lang
    <custom_field id="2">
207 42 Jean-Philippe Lang
      <value>Invalid</value>
208 42 Jean-Philippe Lang
    </custom_field>
209 42 Jean-Philippe Lang
  </custom_fields>
210 42 Jean-Philippe Lang
</issue>
211 42 Jean-Philippe Lang
</pre>
212 42 Jean-Philippe Lang
213 42 Jean-Philippe Lang
Note: the @type="array"@ attribute on @custom_fields@ XML tag is strictly required.
214 42 Jean-Philippe Lang
215 42 Jean-Philippe Lang
JSON Example:
216 42 Jean-Philippe Lang
217 42 Jean-Philippe Lang
<pre>
218 42 Jean-Philippe Lang
PUT /issues/296.json
219 42 Jean-Philippe Lang
220 42 Jean-Philippe Lang
{"issue":
221 42 Jean-Philippe Lang
  {
222 42 Jean-Philippe Lang
    "subject":"Updating custom fields of an issue",
223 42 Jean-Philippe Lang
    ...
224 42 Jean-Philippe Lang
    "custom_fields":
225 42 Jean-Philippe Lang
      [
226 42 Jean-Philippe Lang
        {"value":"1.0.2","id":1},
227 42 Jean-Philippe Lang
        {"value":"Invalid","id":2}
228 42 Jean-Philippe Lang
      ]
229 42 Jean-Philippe Lang
  }
230 42 Jean-Philippe Lang
}
231 42 Jean-Philippe Lang
</pre>
232 42 Jean-Philippe Lang
233 61 Jean-Philippe Lang
h3. Attaching files
234 61 Jean-Philippe Lang
235 61 Jean-Philippe Lang
Support for adding attachments through the REST API is added in Redmine version:1.4.0.
236 61 Jean-Philippe Lang
237 93 Jean-Philippe Lang
First, you need to upload each 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.
238 1 Jean-Philippe Lang
239 93 Jean-Philippe Lang
Then you can use this token to attach your uploaded file to a new or an existing issue.
240 93 Jean-Philippe Lang
241 93 Jean-Philippe Lang
+XML Example+
242 93 Jean-Philippe Lang
243 93 Jean-Philippe Lang
First, upload your file:
244 93 Jean-Philippe Lang
245 61 Jean-Philippe Lang
<pre>
246 61 Jean-Philippe Lang
POST /uploads.xml
247 61 Jean-Philippe Lang
Content-Type: application/octet-stream
248 61 Jean-Philippe Lang
...
249 61 Jean-Philippe Lang
(request body is the file content)
250 61 Jean-Philippe Lang
251 61 Jean-Philippe Lang
# 201 response
252 61 Jean-Philippe Lang
<upload>
253 61 Jean-Philippe Lang
  <token>7167.ed1ccdb093229ca1bd0b043618d88743</token>
254 61 Jean-Philippe Lang
</upload>
255 1 Jean-Philippe Lang
</pre>
256 61 Jean-Philippe Lang
257 93 Jean-Philippe Lang
Then create the issue using the upload token:
258 61 Jean-Philippe Lang
259 61 Jean-Philippe Lang
<pre>
260 61 Jean-Philippe Lang
POST /issues.xml
261 61 Jean-Philippe Lang
<issue>
262 61 Jean-Philippe Lang
  <project_id>1</project_id>
263 61 Jean-Philippe Lang
  <subject>Creating an issue with a uploaded file</subject>
264 62 Jean-Philippe Lang
  <uploads type="array">
265 61 Jean-Philippe Lang
    <upload>
266 61 Jean-Philippe Lang
      <token>7167.ed1ccdb093229ca1bd0b043618d88743</token>
267 61 Jean-Philippe Lang
      <filename>image.png</filename>
268 86 Etienne Massip
      <description>An optional description here</description>
269 61 Jean-Philippe Lang
      <content_type>image/png</content_type>
270 61 Jean-Philippe Lang
    </upload>
271 61 Jean-Philippe Lang
  </uploads>
272 61 Jean-Philippe Lang
</issue>
273 61 Jean-Philippe Lang
</pre>
274 61 Jean-Philippe Lang
275 64 Jean-Philippe Lang
If you try to upload a file that exceeds the maximum size allowed, you get a 422 response:
276 64 Jean-Philippe Lang
277 64 Jean-Philippe Lang
<pre>
278 64 Jean-Philippe Lang
POST /uploads.xml
279 64 Jean-Philippe Lang
Content-Type: application/octet-stream
280 64 Jean-Philippe Lang
...
281 64 Jean-Philippe Lang
(request body larger than the maximum size allowed)
282 64 Jean-Philippe Lang
283 64 Jean-Philippe Lang
# 422 response
284 64 Jean-Philippe Lang
<errors>
285 1 Jean-Philippe Lang
  <error>This file cannot be uploaded because it exceeds the maximum allowed file size (1024000)</error>
286 1 Jean-Philippe Lang
</errors>
287 93 Jean-Philippe Lang
</pre>
288 93 Jean-Philippe Lang
289 93 Jean-Philippe Lang
+JSON Example+
290 93 Jean-Philippe Lang
291 93 Jean-Philippe Lang
First, upload your file:
292 93 Jean-Philippe Lang
293 93 Jean-Philippe Lang
<pre>
294 93 Jean-Philippe Lang
POST /uploads.json
295 93 Jean-Philippe Lang
Content-Type: application/octet-stream
296 93 Jean-Philippe Lang
...
297 93 Jean-Philippe Lang
(request body is the file content)
298 93 Jean-Philippe Lang
299 93 Jean-Philippe Lang
# 201 response
300 93 Jean-Philippe Lang
{"upload":{"token":"7167.ed1ccdb093229ca1bd0b043618d88743"}}
301 93 Jean-Philippe Lang
</pre>
302 93 Jean-Philippe Lang
303 93 Jean-Philippe Lang
Then create the issue using the upload token:
304 93 Jean-Philippe Lang
305 93 Jean-Philippe Lang
<pre>
306 93 Jean-Philippe Lang
POST /issues.json
307 93 Jean-Philippe Lang
{
308 93 Jean-Philippe Lang
  "issue": {
309 93 Jean-Philippe Lang
    "project_id": "1",
310 93 Jean-Philippe Lang
    "subject": "Creating an issue with a uploaded file",
311 93 Jean-Philippe Lang
    "uploads": [
312 93 Jean-Philippe Lang
      {"token": "7167.ed1ccdb093229ca1bd0b043618d88743", "filename": "image.png", "content_type": "image/png"}
313 93 Jean-Philippe Lang
    ]
314 93 Jean-Philippe Lang
  }
315 93 Jean-Philippe Lang
}
316 93 Jean-Philippe Lang
</pre>
317 93 Jean-Philippe Lang
318 93 Jean-Philippe Lang
You can also upload multiple files (by doing multiple POST requests to @/uploads.json@), then create an issue with multiple attachments:
319 93 Jean-Philippe Lang
320 93 Jean-Philippe Lang
<pre>
321 93 Jean-Philippe Lang
POST /issues.json
322 93 Jean-Philippe Lang
{
323 93 Jean-Philippe Lang
  "issue": {
324 93 Jean-Philippe Lang
    "project_id": "1",
325 93 Jean-Philippe Lang
    "subject": "Creating an issue with a uploaded file",
326 93 Jean-Philippe Lang
    "uploads": [
327 93 Jean-Philippe Lang
      {"token": "7167.ed1ccdb093229ca1bd0b043618d88743", "filename": "image1.png", "content_type": "image/png"},
328 93 Jean-Philippe Lang
      {"token": "7168.d595398bbb104ed3bba0eed666785cc6", "filename": "image2.png", "content_type": "image/png"}
329 93 Jean-Philippe Lang
    ]
330 93 Jean-Philippe Lang
  }
331 93 Jean-Philippe Lang
}
332 64 Jean-Philippe Lang
</pre>
333 64 Jean-Philippe Lang
334 59 Jean-Philippe Lang
h3. Validation errors
335 59 Jean-Philippe Lang
336 59 Jean-Philippe Lang
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:
337 59 Jean-Philippe Lang
338 59 Jean-Philippe Lang
+XML Example+:
339 59 Jean-Philippe Lang
340 59 Jean-Philippe Lang
<pre>
341 59 Jean-Philippe Lang
# Request with invalid or missing attributes
342 59 Jean-Philippe Lang
POST /users.xml
343 59 Jean-Philippe Lang
<user>
344 59 Jean-Philippe Lang
  <login>john</login>
345 59 Jean-Philippe Lang
  <lastname>Smith</lastname>
346 59 Jean-Philippe Lang
  <mail>john</mail>
347 59 Jean-Philippe Lang
</uer>
348 59 Jean-Philippe Lang
349 59 Jean-Philippe Lang
# 422 response with the error messages in its body
350 65 Jean-Philippe Lang
<errors type="array">
351 59 Jean-Philippe Lang
  <error>First name can't be blank</error>
352 59 Jean-Philippe Lang
  <error>Email is invalid</error>
353 59 Jean-Philippe Lang
</errors>
354 59 Jean-Philippe Lang
</pre>
355 59 Jean-Philippe Lang
356 59 Jean-Philippe Lang
357 59 Jean-Philippe Lang
+JSON Example+:
358 59 Jean-Philippe Lang
359 59 Jean-Philippe Lang
<pre>
360 59 Jean-Philippe Lang
# Request with invalid or missing attributes
361 59 Jean-Philippe Lang
POST /users.json
362 59 Jean-Philippe Lang
{
363 59 Jean-Philippe Lang
  "user":{
364 59 Jean-Philippe Lang
    "login":"john",
365 59 Jean-Philippe Lang
    "lastname":"Smith",
366 59 Jean-Philippe Lang
    "mail":"john"
367 59 Jean-Philippe Lang
  }
368 59 Jean-Philippe Lang
}
369 59 Jean-Philippe Lang
370 59 Jean-Philippe Lang
# 422 response with the error messages in its body
371 59 Jean-Philippe Lang
{
372 59 Jean-Philippe Lang
  "errors":[
373 59 Jean-Philippe Lang
    "First name can't be blank",
374 59 Jean-Philippe Lang
    "Email is invalid"
375 59 Jean-Philippe Lang
  ]
376 59 Jean-Philippe Lang
}
377 59 Jean-Philippe Lang
</pre>
378 59 Jean-Philippe Lang
379 81 Jean-Philippe Lang
h3. JSONP Support
380 81 Jean-Philippe Lang
381 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.
382 81 Jean-Philippe Lang
383 81 Jean-Philippe Lang
Example:
384 81 Jean-Philippe Lang
385 81 Jean-Philippe Lang
<pre>
386 81 Jean-Philippe Lang
GET /issues.json?callback=myHandler
387 81 Jean-Philippe Lang
388 81 Jean-Philippe Lang
myHandler({"issues":[ ... ]})
389 81 Jean-Philippe Lang
</pre>
390 81 Jean-Philippe Lang
391 1 Jean-Philippe Lang
h2. API Usage in various languages/tools
392 5 Jean-Philippe Lang
393 1 Jean-Philippe Lang
* [[Rest_api_with_ruby|Ruby]]
394 1 Jean-Philippe Lang
* [[Rest_api_with_php|PHP]]
395 23 Jean-Philippe Lang
* [[Rest_api_with_python|Python]]
396 94 Go MAEDA
* [[Rest_api_with_perl|Perl]]
397 27 Jean-Philippe Lang
* [[Rest_api_with_java|Java]]
398 1 Jean-Philippe Lang
* [[Rest_api_with_curl|cURL]]
399 37 Bevan Rudge
* "Drupal Redmine API module, 2.x branch (currently not stable)":http://drupal.org/project/redmine
400 48 Dorin Huzum
* [[Rest_api_with_csharp|.NET]]
401 49 Rodrigo Carvalho
* [[Rest_api_with_delphi|Delphi]]
402 54 Jean-Philippe Lang
403 54 Jean-Philippe Lang
h2. API Change history
404 1 Jean-Philippe Lang
405 97 Jean-Philippe Lang
This section lists changes to the existing API features that may have broken backward compatibility. New features of the API are listed in the [[Rest_api#API-Description|API Description]].
406 57 Jean-Philippe Lang
407 54 Jean-Philippe Lang
h3. 2012-01-29: Multiselect custom fields (r8721, version:1.4.0)
408 54 Jean-Philippe Lang
409 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.
410 54 Jean-Philippe Lang
411 54 Jean-Philippe Lang
Example:
412 54 Jean-Philippe Lang
413 54 Jean-Philippe Lang
<pre>
414 54 Jean-Philippe Lang
GET /issues/296.json
415 54 Jean-Philippe Lang
416 54 Jean-Philippe Lang
{"issue":
417 54 Jean-Philippe Lang
  {
418 54 Jean-Philippe Lang
    "id":8471,
419 54 Jean-Philippe Lang
    ...
420 54 Jean-Philippe Lang
    "custom_fields":
421 54 Jean-Philippe Lang
      [
422 54 Jean-Philippe Lang
        {"value":["1.0.1","1.0.2"],"multiple":true,"name":"Affected version","id":1},
423 54 Jean-Philippe Lang
        {"value":"Fixed","name":"Resolution","id":2}
424 54 Jean-Philippe Lang
      ]
425 54 Jean-Philippe Lang
  }
426 54 Jean-Philippe Lang
}
427 54 Jean-Philippe Lang
</pre>